chusaku 0.6.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714c60f9b5f8e9ebd4db391daa894dfa96a1ec95b7773900988df7b9a24677da
-  data.tar.gz: 1d7adffa9c39bb7dd7cd2f6d6b86fd7844bfbe77a207988eebd1469d5a74d0de
+  metadata.gz: 62bb838dd76c648a120303c3a0bde8c67ea7232f90accb9f3e739a3b69764026
+  data.tar.gz: 9af1726825550cb4ce7d642e6a80217b8810cb6a56e8703c6d7f4f23a8643f3a
 SHA512:
-  metadata.gz: 0bc70bbe88b4cde24d236ac000bf13533fdad892413dc03cf8b8c4eca9f6eb7f21bd8f5a6df382521898a7baddc07f74e1444067ec0f2febd828603c79cfe020
-  data.tar.gz: 9a51c9476b1585c1f382f3845a202b6ea4eeed70e30d2cb450de4d01ed59c084ec2d7c1b11930bd6f62a9264129d21b545e0270bf9ea52d2cb92724d520cf924
+  metadata.gz: 0baeb0a41404f911ef11b3d12709773a44ecc18aa542f5dcb854e1b67023b7fd79f640d10d7d8a4368121a33714327c5120ed701c9a67c238537023db78603e7
+  data.tar.gz: 1e5026ac8d35af5ff8c5d8c02d32d7d634716966dad3a61947398ee870203795ff91286bb43b7daf6802c4bace3df42b1ffb325c130e88b1fe26495d72100118

data/README.md

@@ -52,34 +52,20 @@ Chusaku has some flags available for use as well:
 ```
 $ bundle exec chusaku --help
 Usage: chusaku [options]
-        --dry-run                    Run without file modifications
-        --exit-with-error-on-annotation
-                                     Fail if any file was annotated
-        --verbose                    Print all annotations
-    -v, --version                    Show Chusaku version number and quit
-    -h, --help                       Show this help message and quit
-```
-
-
-## Pre-commit Hook
+        --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
+    -v, --version                       Show Chusaku version number and quit
+    -h, --help                          Show this help message and quit
 
-Here's an example setup that you could use for automating Chusaku as a Git hook
-with the [Lefthook](https://github.com/Arkweid/lefthook) gem.
-
-```yaml
-pre-commit:
-  commands:
-    chusaku:
-      run: eval "! git diff --staged --name-only | grep -q 'routes.rb' && exit 0 || bundle exec chusaku --exit-with-error-on-annotation"
 ```
 
-This example config only runs Chusaku if `routes.rb` was modified.
-
 
 ## Development
 
 Read the blog post explaining how the gem works at a high level:
-https://nshki.com/chusaku-a-controller-annotation-gem/.
+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

data/lib/chusaku/cli.rb

@@ -52,8 +52,10 @@ module Chusaku
     def optparser
       OptionParser.new do |opts|
         opts.banner = "Usage: chusaku [options]"
+        opts.set_summary_width(35)
         add_dry_run_flag(opts)
         add_error_on_annotation_flag(opts)
+        add_controllers_pattern_flag(opts)
         add_verbose_flag(opts)
         add_version_flag(opts)
         add_help_flag(opts)
@@ -80,6 +82,16 @@ module Chusaku
       end
     end
 
+    # Adds `--controllers-pattern` flag.
+    #
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
+    def add_controllers_pattern_flag(opts)
+      opts.on("-c", "--controllers-pattern", "=GLOB", "Specify alternative controller files glob pattern") do |value|
+        @options[:controllers_pattern] = value
+      end
+    end
+
     # Adds `--verbose` flag.
     #
     # @param opts [OptionParser] OptionParser instance

data/lib/chusaku/routes.rb

@@ -98,11 +98,36 @@ module Chusaku
       def backfill_routes(routes)
         paths = {}
 
+        # Map paths to their verbs and names.
+        #
+        # Resulting hash looks like:
+        #
+        # ```ruby
+        # {
+        #   "/users/:id" => {
+        #     "GET" => "edit_user",
+        #     "PATCH" => "edit_user"
+        #   }
+        # }
+        # ````
         routes.each do |_controller, actions|
           actions.each do |_action, data|
             data.each do |datum|
-              paths[datum[:path]] ||= datum[:name]
-              datum[:name] ||= paths[datum[:path]]
+              paths[datum[:path]] ||= {}
+              paths[datum[:path]][datum[:verb]] ||= datum[:name]
+            end
+          end
+        end
+
+        # Backfill names for routes that don't have them.
+        #
+        # First try to match based on the path and verb. If that doesn't work,
+        # try to match based on the path alone.
+        routes.each do |_controller, actions|
+          actions.each do |_action, data|
+            data.each do |datum|
+              datum[:name] ||= paths.dig(datum[:path], datum[:verb])
+              datum[:name] ||= paths[datum[:path]]&.values&.compact&.first
             end
           end
         end

data/lib/chusaku/version.rb

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

data/lib/chusaku.rb

@@ -20,7 +20,7 @@ module Chusaku
       @routes = Chusaku::Routes.call
       @changes = []
       @changed_files = []
-      controllers_pattern = "app/controllers/**/*_controller.rb"
+      controllers_pattern = @flags[:controllers_pattern] || "app/controllers/**/*_controller.rb"
 
       Dir.glob(Rails.root.join(controllers_pattern)).each do |path|
         controller = %r{controllers/(.*)_controller\.rb}.match(path)[1]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Nishiki Liu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-13 00:00:00.000000000 Z
+date: 2023-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,7 @@ metadata:
   homepage_uri: https://github.com/nshki/chusaku
   source_code_uri: https://github.com/nshki/chusaku
   changelog_uri: https://github.com/nshki/chusaku
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Annotate your Rails controllers with route info.
 test_files: []