chusaku 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62bb838dd76c648a120303c3a0bde8c67ea7232f90accb9f3e739a3b69764026
-  data.tar.gz: 9af1726825550cb4ce7d642e6a80217b8810cb6a56e8703c6d7f4f23a8643f3a
+  metadata.gz: 48034ba3796c8cd1ab1a16b0db1065dcdf487ea5e6bc1b08a7fcd18db4ad1d33
+  data.tar.gz: 65cf7dbbf5571f547aeb9cefc8cd804ccab9467b0765edcc00691c777c158554
 SHA512:
-  metadata.gz: 0baeb0a41404f911ef11b3d12709773a44ecc18aa542f5dcb854e1b67023b7fd79f640d10d7d8a4368121a33714327c5120ed701c9a67c238537023db78603e7
-  data.tar.gz: 1e5026ac8d35af5ff8c5d8c02d32d7d634716966dad3a61947398ee870203795ff91286bb43b7daf6802c4bace3df42b1ffb325c130e88b1fe26495d72100118
+  metadata.gz: 83c00966e23c6d8a63f9b68e35cc48a975689f21473e83344927764ac200d9eb378274c6ad82fa90a0ac6a06d286763f45661f4b2433983f903cf93371158167
+  data.tar.gz: 70afe36985465e34f3fa18e5eea3d51d130daaada6414a51b680a0e4f32f31e14a3e3225f8f70b594d19d8c23e9ad3b00ac9f43c4dd83c493bdd5befba483e8a

data/.github/workflows/linting.yml

@@ -6,9 +6,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: 3.3
           bundler-cache: true
       - name: Run Standard
         run: bundle exec standardrb --fail-level A

data/.github/workflows/testing.yml

@@ -5,11 +5,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0"]
+        ruby-version: ["3.1", "3.2", "3.3"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby
-        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true

data/.gitignore

@@ -7,4 +7,7 @@
 /spec/reports/
 /tmp/
 
+.DS_Store
+
+.ruby-version
 Gemfile.lock

data/README.md

@@ -26,16 +26,14 @@ Add this line to your Rails application's Gemfile:
 
 ```ruby
 group :development do
-  # ...
   gem "chusaku", require: false
-  # ...
 end
 ```
 
 And then execute:
 
-```
-$ bundle install
+```sh
+bundle install
 ```
 
 
@@ -43,8 +41,8 @@ $ bundle install
 
 From the root of your Rails application, run:
 
-```
-$ bundle exec chusaku
+```sh
+bundle exec chusaku
 ```
 
 Chusaku has some flags available for use as well:
@@ -55,23 +53,37 @@ Usage: chusaku [options]
         --dry-run                       Run without file modifications
         --exit-with-error-on-annotation Fail if any file was annotated
     -c, --controllers-pattern=GLOB      Specify alternative controller files glob pattern
-        --verbose                       Print all annotations
+        --verbose                       Print all annotated files
     -v, --version                       Show Chusaku version number and quit
     -h, --help                          Show this help message and quit
+```
+
+### Rake usage
+
+If you'd like to use Chusaku as a Rake task, add the following line to your `Rakefile`:
+
+```ruby
+require "chusaku"
+Chusaku.load_tasks
+```
+
+This will then allow you to call:
+
+```sh
+bin/rake chusaku
+```
+
+To pass flags, pass them like you would from the CLI executable:
 
+```sh
+bin/rake chusaku -- --dry-run --exit-with-error-on-annotation
 ```
 
 
 ## Development
 
-Read the blog post explaining how the gem works at a high level:
-https://nshki.com/chusaku-a-controller-annotation-gem.
+Read the blog post explaining how the gem works at a high level: https://nshki.com/chusaku-a-controller-annotation-gem.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bundle exec rake test` to run the tests. You can also run `bin/console` for an
-interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/chusaku/cli.rb

@@ -41,7 +41,8 @@ module Chusaku
     # @raise [Chusaku::CLI::NotARailsProject] Exception if not Rails project
     # @return [void]
     def check_for_rails_project
-      has_controllers = File.directory?("./app/controllers")
+      controllers_pattern = options[:controllers_pattern] || DEFAULT_CONTROLLERS_PATTERN
+      has_controllers = !Dir.glob(Rails.root.join(controllers_pattern)).empty?
       has_rakefile = File.exist?("./Rakefile")
       raise NotARailsProject unless has_controllers && has_rakefile
     end
@@ -97,7 +98,7 @@ module Chusaku
     # @param opts [OptionParser] OptionParser instance
     # @return [void]
     def add_verbose_flag(opts)
-      opts.on("--verbose", "Print all annotations") do
+      opts.on("--verbose", "Print all annotated files") do
         @options[:verbose] = true
       end
     end

data/lib/chusaku/routes.rb

@@ -27,7 +27,19 @@ module Chusaku
       def call
         routes = {}
 
-        Rails.application.routes.routes.each do |route|
+        populate_routes(Rails.application, routes)
+        backfill_routes(routes)
+      end
+
+      private
+
+      def populate_routes(app, routes)
+        app.routes.routes.each do |route|
+          if route.app.engine?
+            populate_routes(route.app.app, routes)
+            next
+          end
+
           controller, action, defaults = extract_data_from(route)
           routes[controller] ||= {}
           routes[controller][action] ||= []
@@ -39,12 +51,8 @@ module Chusaku
             action: action,
             defaults: defaults
         end
-
-        backfill_routes(routes)
       end
 
-      private
-
       # Adds formatted route info for the given param combination.
       #
       # @param route [Hash] Route info

data/lib/chusaku/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/chusaku.rb

@@ -4,6 +4,8 @@ require "chusaku/routes"
 
 # Handles core functionality of annotating projects.
 module Chusaku
+  DEFAULT_CONTROLLERS_PATTERN = "**/*_controller.rb".freeze
+
   class << self
     # The main method to run Chusaku. Annotate all actions in a Rails project as
     # follows:
@@ -18,72 +20,57 @@ module Chusaku
     def call(flags = {})
       @flags = flags
       @routes = Chusaku::Routes.call
-      @changes = []
       @changed_files = []
-      controllers_pattern = @flags[:controllers_pattern] || "app/controllers/**/*_controller.rb"
+      controllers_pattern = @flags[:controllers_pattern] || DEFAULT_CONTROLLERS_PATTERN
+      controllers_paths = Dir.glob(Rails.root.join(controllers_pattern))
+
+      @routes.each do |controller, actions|
+        next unless controller
 
-      Dir.glob(Rails.root.join(controllers_pattern)).each do |path|
-        controller = %r{controllers/(.*)_controller\.rb}.match(path)[1]
-        actions = @routes[controller]
-        next if actions.nil?
+        controller_class = "#{controller.underscore.camelize}Controller".constantize
+        action_method_name = actions.keys.first&.to_sym
+        next unless !action_method_name.nil? && controller_class.method_defined?(action_method_name)
 
-        annotate_file(path: path, controller: controller, actions: actions.keys)
+        source_path = controller_class.instance_method(action_method_name).source_location&.[](0)
+        next unless controllers_paths.include?(source_path)
+
+        annotate_file(path: source_path, actions: actions)
       end
 
       output_results
     end
 
+    # Load Rake tasks for Chusaku. Should be called in your project's `Rakefile`.
+    #
+    # @return [void]
+    def load_tasks
+      Dir[File.join(File.dirname(__FILE__), "tasks", "**/*.rake")].each do |task|
+        load(task)
+      end
+    end
+
     private
 
     # Adds annotations to the given file.
     #
     # @param path [String] Path to file
-    # @param controller [String] Controller name
-    # @param actions [Array<String>] List of valid actions for the controller
+    # @param actions [Hash<String, Hash>] List of valid action data for the controller
     # @return [void]
-    def annotate_file(path:, controller:, actions:)
-      parsed_file = Chusaku::Parser.call(path: path, actions: actions)
+    def annotate_file(path:, actions:)
+      parsed_file = Chusaku::Parser.call(path: path, actions: actions.keys)
       parsed_file[:groups].each_cons(2) do |prev, curr|
-        record_change(group: prev, type: :clean, path: path)
+        clean_group(prev)
         next unless curr[:type] == :action
 
-        route_data = @routes[controller][curr[:action]]
+        route_data = actions[curr[:action]]
         next unless route_data.any?
 
-        record_change(group: curr, type: :annotate, route_data: route_data, path: path)
+        annotate_group(group: curr, route_data: route_data)
       end
 
       write_to_file(path: path, parsed_file: parsed_file)
     end
 
-    # Clean or annotate a group and track the group as changed if applicable.
-    #
-    # @param group [Hash] { type => Symbol, body => String }
-    # @param type [Symbol] [:clean, :annotate]
-    # @param path [String] File path
-    # @param route_data [Array<Hash>] [{
-    #   verb: String,
-    #   path: String,
-    #   name: String }]
-    # @return [void]
-    def record_change(group:, type:, path:, route_data: [])
-      old_body = group[:body]
-
-      case type
-      when :clean
-        clean_group(group)
-      when :annotate
-        annotate_group(group: group, route_data: route_data)
-      end
-      return if old_body == group[:body]
-
-      @changes.push \
-        old_body: old_body,
-        new_body: group[:body],
-        path: path,
-        line_number: group[:line_number]
-    end
-
     # Given a parsed group, clean out its contents.
     #
     # @param group [Hash] { type => Symbol, body => String }
@@ -191,36 +178,22 @@ module Chusaku
     #
     # @return [String] Copy to be outputted to user
     def output_copy
-      return "Nothing to annotate." if @changed_files.empty?
+      return "Controller files unchanged." if @changed_files.empty?
 
       copy = changes_copy
-      copy += "\nChusaku has finished running."
+      copy += "Chusaku has finished running."
       copy += "\nThis was a dry run so no files were changed." if @flags.include?(:dry)
       copy += "\nExited with status code 1." if @flags.include?(:error_on_annotation)
       copy
     end
 
-    # Returns the copy for recorded changes if `--verbose` flag is passed.
+    # Returns the copy for changed files if `--verbose` flag is passed.
     #
-    # @return [String] Copy of recorded changes
+    # @return [String] Copy for changed files
     def changes_copy
       return "" unless @flags.include?(:verbose)
 
-      @changes.map do |change|
-        <<~CHANGE_OUTPUT
-          [#{change[:path]}:#{change[:line_number]}]
-
-          Before:
-          ```ruby
-          #{change[:old_body].chomp}
-          ```
-
-          After:
-          ```ruby
-          #{change[:new_body].chomp}
-          ```
-        CHANGE_OUTPUT
-      end.join("\n")
+      @changed_files.map { |file| "Annotated #{file}" }.join("\n") + "\n"
     end
   end
 end

data/lib/tasks/chusaku.rake

@@ -0,0 +1,8 @@
+chusaku_lib = File.expand_path(File.dirname(__FILE__, 2))
+
+desc "Add route annotations to your Rails actions"
+task chusaku: :environment do
+  require "#{chusaku_lib}/chusaku/cli"
+
+  Chusaku::CLI.new.call(ARGV[2...] || [])
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - lib/chusaku/parser.rb
 - lib/chusaku/routes.rb
 - lib/chusaku/version.rb
+- lib/tasks/chusaku.rake
 homepage: https://github.com/nshki/chusaku
 licenses:
 - MIT
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Annotate your Rails controllers with route info.