Permalink
Cannot retrieve contributors at this time
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # frozen_string_literal: true | |
| require "bundler/gem_tasks" | |
| require "rake/testtask" | |
| require "yard" | |
| require "yard/mattr_accessor_handler" | |
| Rake::TestTask.new(:test) do |t| | |
| t.libs << "test" | |
| t.libs << "lib" | |
| t.test_files = FileList["test/**/*_test.rb"] | |
| end | |
| desc "Runs benchmarks against components" | |
| task :benchmark do | |
| ruby "./performance/benchmark.rb" | |
| end | |
| desc "Runs benchmarks against component content area/ slot implementations" | |
| task :slotable_benchmark do | |
| ruby "./performance/slotable_benchmark.rb" | |
| end | |
| task :translatable_benchmark do | |
| ruby "./performance/translatable_benchmark.rb" | |
| end | |
| namespace :coverage do | |
| task :report do | |
| require "simplecov" | |
| require "simplecov-console" | |
| SimpleCov.minimum_coverage 100 | |
| SimpleCov.collate Dir["simplecov-resultset-*/.resultset.json"], "rails" do | |
| formatter SimpleCov::Formatter::Console | |
| end | |
| end | |
| end | |
| namespace :docs do | |
| # Build api.md documentation page from YARD comments. | |
| task :build do | |
| YARD::Rake::YardocTask.new | |
| puts "Building YARD documentation." | |
| Rake::Task["yard"].execute | |
| puts "Converting YARD documentation to Markdown files." | |
| registry = YARD::RegistryStore.new | |
| registry.load!(".yardoc") | |
| meths = | |
| registry. | |
| get("ViewComponent::Base"). | |
| meths. | |
| select do |method| | |
| !method.tag(:private) && | |
| method.path.include?("ViewComponent::Base") && | |
| method.visibility == :public && | |
| !method[:name].to_s.start_with?("_") # Ignore methods we mark as internal by prefixing with underscores | |
| end.sort_by { |method| method[:name] } | |
| instance_methods_to_document = meths.select { |method| method.scope != :class } | |
| class_methods_to_document = meths.select { |method| method.scope == :class } | |
| configuration_methods_to_document = registry.get("ViewComponent::Base").meths.select { |method| | |
| method[:mattr_accessor] | |
| } | |
| test_helper_methods_to_document = registry. | |
| get("ViewComponent::TestHelpers"). | |
| meths. | |
| sort_by { |method| method[:name] }. | |
| select do |method| | |
| !method.tag(:private) && | |
| method.visibility == :public | |
| end | |
| require "rails" | |
| require "action_controller" | |
| require "view_component" | |
| require "view_component/docs_builder_component" | |
| docs = ActionController::Base.new.render_to_string( | |
| ViewComponent::DocsBuilderComponent.new( | |
| sections: [ | |
| ViewComponent::DocsBuilderComponent::Section.new(heading: "Class methods", | |
| methods: class_methods_to_document), | |
| ViewComponent::DocsBuilderComponent::Section.new(heading: "Instance methods", | |
| methods: instance_methods_to_document), | |
| ViewComponent::DocsBuilderComponent::Section.new(heading: "Configuration", | |
| methods: configuration_methods_to_document, | |
| show_types: false), | |
| ViewComponent::DocsBuilderComponent::Section.new(heading: "ViewComponent::TestHelpers", | |
| methods: test_helper_methods_to_document) | |
| ] | |
| ) | |
| ).chomp | |
| File.open("docs/api.md", "w") do |f| | |
| f.puts(docs) | |
| end | |
| end | |
| end | |
| task default: :test |