chusaku 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8295890eb74a89ebc38a8651d4a5d5c8f87112a7336658e8dea1117d525a1a1a
-  data.tar.gz: 6cb5e53d089e0996c0b6b7e9e0b7128902fa60bc54c3f458d737e56e5c5a7a2c
+  metadata.gz: f73db691fb40f399f999f495736dca02bd8c372934aa4122824d086a723d0479
+  data.tar.gz: dea436d47f3101f5d3112c3722b04c00b317fc32c7ad3ee2c2594ca12fbe3c01
 SHA512:
-  metadata.gz: 885022690966e86943484029fc383572ea254487d18f4b9f43ac1fa225e99b5cfd75f8e7f1787929cf7bbccae872ce63149a260ec5c5ef00f8e1e61added54db
-  data.tar.gz: 2d6151abb44a539dbd662af25f8f961a21ec72c2bd012268eff9a749da4affbe02589f38036a3926dadb430340c6fa4d84a2ceff052e4c1ca1045723bd1b8600
+  metadata.gz: 03bff26c3f0a2de5ed0b4c64feb3c2a198c4704f53f3683d5bbcf0699f2c36081672324ea871ed664836d0a6d09f9314b1b4c23d886885597c7e9f03bcb13821
+  data.tar.gz: 8d4def4efa795ac278608c7d9c8f19dd361e361b4e1ff4da7a9434fa85d865acb3de28e183d67f74bf244023220ad84464735da275516a236576c29dde9d9d64

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,5 @@
 /spec/reports/
 /tmp/
 
+.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:
@@ -52,25 +50,40 @@ 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
+        --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 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

@@ -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,12 +82,22 @@ 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
     # @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/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/chusaku.rb

@@ -18,9 +18,8 @@ module Chusaku
     def call(flags = {})
       @flags = flags
       @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]
@@ -33,6 +32,15 @@ module Chusaku
       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.
@@ -44,46 +52,18 @@ module Chusaku
     def annotate_file(path:, controller:, actions:)
       parsed_file = Chusaku::Parser.call(path: path, actions: actions)
       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]]
         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 +171,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.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2024-01-06 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.17
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Annotate your Rails controllers with route info.