chusaku 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ab5946d4be43df335d71e2cc2639c8c4f548230f3ba035a947b53d0008c20a
-  data.tar.gz: b396e52e72f519352e0bfee5d9bde697bd6047a1ba3a1ff79d25a56331ad523a
+  metadata.gz: 34e6c3d99896a2ad9665c71b82575bb40491b8bcafa507560deeda2bf33b612b
+  data.tar.gz: 0ddf816adf5f24ccd5eb29d186db0e4014cd6c349fd11b950b268dd35154c3df
 SHA512:
-  metadata.gz: a586a909a9c01f86555af6e5416d5c20ee3b6baf492c30cde206ec85b26767f9cdc058e08b71fa3ccd660687baa36436a83b545d3533d3ccab2c3156b29a7a0f
-  data.tar.gz: 981fd3e8225cf30346e50c7bc0654fc35b77528e82fabf444a3e25f6254c151f49ba96047e02e685337aa27fd69951f551b75fcf147f03937ac8b0f34cf416db
+  metadata.gz: fdec79c08e8a227a4e527c4325281a5499ecbbc3a511d9793b089da831aca609d260a60c013b770a1f2b49eb0cf643b222584af25f4f0d7ec719f2915f89a3a1
+  data.tar.gz: f48ff79a5d78e5e7a888f99f6e19e5e2a0e11e760f1085a0ec75c17b6f4375571cf48ab52ff9781d52cf6948131ea993bb6cc096ab63eda762df8470402e1aa5

data/.github/workflows/linting.yml

@@ -1,14 +1,18 @@
 name: Linting
 on: [pull_request]
 jobs:
-  standard:
+  lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3
+          ruby-version: 4.0
+          bundler: 4
           bundler-cache: true
+
       - name: Run Standard
         run: bundle exec standardrb --fail-level A

data/.github/workflows/testing.yml

@@ -5,13 +5,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.1", "3.2", "3.3"]
+        ruby-version: ["3.2", "3.3", "3.4", "4.0"]
+
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
+          bundler: 4
           bundler-cache: true
+
       - name: Run tests
-        run: bundle exec rake
+        run: bundle exec rake test

data/README.md

@@ -17,6 +17,21 @@ def update
 end
 ```
 
+With `--format=rdoc`:
+
+```ruby
+# Route:: GET /waterlilies/:id (waterlily)
+def show
+  # ...
+end
+
+# Route:: PATCH /waterlilies/:id (waterlily)
+# Route:: PUT /waterlilies/:id (waterlily)
+def update
+  # ...
+end
+```
+
 Based on your `routes.rb` file!
 
 
@@ -54,6 +69,7 @@ Usage: chusaku [options]
         --exit-with-error-on-annotation Fail if any file was annotated
     -c, --controllers-pattern=GLOB      Specify alternative controller files glob pattern
     -e, --exclusion-pattern=GLOB        Specify controller files exclusion glob pattern
+    -f, --format=FORMAT                 Annotation style: yard (default) or rdoc
         --verbose                       Print all annotated files
     -v, --version                       Show Chusaku version number and quit
     -h, --help                          Show this help message and quit

data/chusaku.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |spec|
     spec.metadata["source_code_uri"] = spec.homepage
     spec.metadata["changelog_uri"] = spec.homepage
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-          "public gem pushes."
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -39,10 +38,10 @@ Gem::Specification.new do |spec|
   spec.executables = "chusaku"
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "minitest", "~> 5.14"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "standardrb", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 4"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "standard", "~> 1"
 
   spec.add_dependency "railties", ">= 3.0"
 end

data/lib/chusaku/cli.rb

@@ -58,6 +58,7 @@ module Chusaku
         add_error_on_annotation_flag(opts)
         add_controllers_pattern_flag(opts)
         add_exclusion_pattern_flag(opts)
+        add_format_flag(opts)
         add_verbose_flag(opts)
         add_version_flag(opts)
         add_help_flag(opts)
@@ -104,6 +105,16 @@ module Chusaku
       end
     end
 
+    # Adds `--format` flag.
+    #
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
+    def add_format_flag(opts)
+      opts.on("-f", "--format=FORMAT", %w[yard rdoc], "Annotation style: yard (default) or rdoc") do |value|
+        @options[:format] = value.to_sym
+      end
+    end
+
     # Adds `--verbose` flag.
     #
     # @param opts [OptionParser] OptionParser instance

data/lib/chusaku/routes.rb

@@ -1,3 +1,5 @@
+require "active_support/inflector"
+
 module Chusaku
   # Handles extracting information about the Rails project's routes.
   class Routes
@@ -192,7 +194,8 @@ module Chusaku
         controller = defaults.delete(:controller)
         action = defaults.delete(:action)
 
-        controller_class = controller ? "#{controller.underscore.camelize}Controller".constantize : nil
+        controller_name = ActiveSupport::Inflector.camelize(ActiveSupport::Inflector.underscore(controller))
+        controller_class = controller ? ActiveSupport::Inflector.constantize("#{controller_name}Controller") : nil
         action_method_name = action&.to_sym
         source_path =
           if !action_method_name.nil? && controller_class&.method_defined?(action_method_name)

data/lib/chusaku/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/lib/chusaku.rb

@@ -105,6 +105,7 @@ module Chusaku
       return unless group[:type] == :comment
 
       group[:body] = group[:body].gsub(/^\s*#\s*@route.*$\n/, "")
+      group[:body] = group[:body].gsub(/^\s*#\s*Route::.*$\n/, "")
       group[:body] =
         group[:body].gsub(%r{^\s*# (GET|POST|PATCH/PUT|DELETE) /\S+$\n}, "")
     end
@@ -134,7 +135,8 @@ module Chusaku
     # @param source_path [String] Path to controller file
     # @return [String] "@route <verb> <path> {<defaults>} (<name>)"
     def annotate_route(verb:, path:, name:, defaults:, source_path:)
-      annotation = "@route #{verb} #{path}"
+      prefix = (@flags[:format] == :rdoc) ? "Route::" : "@route"
+      annotation = "#{prefix} #{verb} #{path}"
       if defaults&.any?
         defaults_str =
           defaults
@@ -188,7 +190,7 @@ module Chusaku
     #
     # @return [String] 'r' or 'w'
     def file_mode
-      File.instance_methods.include?(:test_write) ? "r" : "w"
+      File.method_defined?(:test_write) ? "r" : "w"
     end
 
     # Output results to user.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Nishiki Liu
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +15,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +113,6 @@ 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:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Annotate your Rails controllers with route info.
 test_files: []