chusaku 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91762a5b8314f0486e73067fd338cad5b440ca263d77c90322787ba86f318e58
-  data.tar.gz: c9dcc279a4401864a946b1c97115d9f759152166eea11fa633517474529b8f56
+  metadata.gz: 34e6c3d99896a2ad9665c71b82575bb40491b8bcafa507560deeda2bf33b612b
+  data.tar.gz: 0ddf816adf5f24ccd5eb29d186db0e4014cd6c349fd11b950b268dd35154c3df
 SHA512:
-  metadata.gz: 96bad9906074a576eefd8ec2e1bb30c3a3f6774f42127107feeb2a7414db41e493417bde9f97d8b7dacc32a8f71302abb47c4ffcf3250503e4c26b3e2975de9c
-  data.tar.gz: 278543a4dbe3f74fbb1de39ab06ab455896f1f255a9410e52902955180d2d02a4a15e9cce075f6db444acaccecfd1018cc38cba2e117725e1b43ed4d287a199b
+  metadata.gz: fdec79c08e8a227a4e527c4325281a5499ecbbc3a511d9793b089da831aca609d260a60c013b770a1f2b49eb0cf643b222584af25f4f0d7ec719f2915f89a3a1
+  data.tar.gz: f48ff79a5d78e5e7a888f99f6e19e5e2a0e11e760f1085a0ec75c17b6f4375571cf48ab52ff9781d52cf6948131ea993bb6cc096ab63eda762df8470402e1aa5

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/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/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.4.2"
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Nishiki Liu
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Annotate your Rails controllers with route info.
 test_files: []