chusaku 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2976318f89e26e31f77c54e1cc338812ac6a107ec033d53c077fd4eb1759be6
-  data.tar.gz: 8413d9353d6115929985f3d6275396abeb25d7b9df834ccd0d4e19fd834ef574
+  metadata.gz: 76adb49d62bcaeab5291f4b09b12318ea5e80dc7c4b77ff7bbfee697732a953f
+  data.tar.gz: 8434d642b81b5d4cb67b7f9852adef2da679c24f7c9ea287aba903653b9703ee
 SHA512:
-  metadata.gz: 44c12d0f6c0f970cd3a0e5c76cd14b18d8bfbf16f7d39e8789e4c09c87a8273a8b3e288de865533c7a39b81fe1dd51088a1ddc7c33edb0325e12a676153d5563
-  data.tar.gz: 5e01aeaa4eea9099c47445c88db326ff4ceb5d028088bbd6c2a328f21673c17d80c93bc8fda0c4135e76956f1439a26df758985a23bfe895d5f3f2ff14eb3982
+  metadata.gz: 7b5880ed576e31a7f80a970389dc559e81ec932005716122de67a5f2c25586f82e674e6bdf1aba100d13a5bc7cba41df458b6e439c825684fa51ef11f77c6337
+  data.tar.gz: fa2ed22e8e87762f4577f4e45765f22c1e2d8139eb8d02f18682f7859ac543bfad8977b545645717a5f6acb2fd75f1eac02de6697982de6eebc02cedd595c68c

data/.rubocop.yml

@@ -7,6 +7,9 @@ AllCops:
     - 'test/mock/app/**/*'
     - 'test/mock/examples/**/*'
 
+Layout/LineLength:
+  Max: 120
+
 Metrics/AbcSize:
   Exclude:
     - 'test/**/*'
@@ -16,6 +19,9 @@ Metrics/MethodLength:
   Exclude:
     - 'test/**/*'
 
+Metrics/ModuleLength:
+  Max: 250
+
 Style/ClassAndModuleChildren:
   Exclude:
     - 'test/**/*'

data/chusaku.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name = 'chusaku'
   spec.version = Chusaku::VERSION
   spec.authors = ['Nishiki Liu']
-  spec.email = ['nishiki.liu@gmail.com']
+  spec.email = ['nishiki@hey.com']
 
   spec.summary = 'Annotate your Rails controllers with route info.'
   spec.description = 'Annotate your Rails controllers with route info.'
@@ -37,8 +37,8 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir        = 'bin'
-  spec.executables   = 'chusaku'
+  spec.bindir = 'bin'
+  spec.executables = 'chusaku'
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'

data/lib/chusaku.rb

@@ -15,8 +15,8 @@ module Chusaku
     #     # ...
     #   end
     #
-    # @param {Hash} flags - CLI flags
-    # @return {Integer} - 0 on success, 1 on error
+    # @param flags [Hash] CLI flags
+    # @return [Integer] 0 on success, 1 on error
     def call(flags = {})
       @flags = flags
       @routes = Chusaku::Routes.call
@@ -38,10 +38,10 @@ module Chusaku
 
     # Adds annotations to the given file.
     #
-    # @param {String} path - Path to file
-    # @param {String} controller - Controller name
-    # @param {Array<String>} actions - List of valid actions for the controller
-    # @return {void}
+    # @param path [String] Path to file
+    # @param controller [String] Controller name
+    # @param actions [Array<String>] List of valid actions for the controller
+    # @return [void]
     def annotate_file(path:, controller:, actions:)
       parsed_file = Chusaku::Parser.call(path: path, actions: actions)
       parsed_file[:groups].each_cons(2) do |prev, curr|
@@ -59,7 +59,7 @@ module Chusaku
 
     # Given a parsed group, clean out its contents.
     #
-    # @param {Hash} group - { type: Symbol, body: String }
+    # @param group [Hash] { type => Symbol, body => String }
     # @return {void}
     def clean_group(group)
       return unless group[:type] == :comment
@@ -74,49 +74,85 @@ module Chusaku
     #
     #   @route GET /waterlilies/:id (waterlilies)
     #
-    # @param {Hash} group - Parsed content given by Chusaku::Parser
-    # @param {Hash} route_data - Individual route data given by Chusaku::Routes
-    # @return {void}
+    # @param group [Hash] Parsed content given by Chusaku::Parser
+    # @param route_data [Hash] Individual route data given by Chusaku::Routes
+    # @return [void]
     def annotate_group(group:, route_data:)
       whitespace = /^(\s*).*$/.match(group[:body])[1]
       route_data.reverse_each do |datum|
-        name = datum[:name]
-        annotation = "@route #{datum[:verb]} #{datum[:path]}"
-        annotation += " (#{name})" unless name.nil?
-        comment = "#{whitespace}# #{annotation}\n"
+        comment = "#{whitespace}# #{annotate_route(**datum)}\n"
         group[:body] = comment + group[:body]
       end
     end
 
+    # Generate route annotation.
+    #
+    # @param verb [String] HTTP verb for route
+    # @param path [String] Rails path for route
+    # @param name [String] Name used in route helpers
+    # @param defaults [Hash] Default parameters for route
+    # @return [String] "@route <verb> <path> {<defaults>} (<name>)"
+    def annotate_route(verb:, path:, name:, defaults:)
+      annotation = "@route #{verb} #{path}"
+      if defaults&.any?
+        defaults_str =
+          defaults
+          .map { |key, value| "#{key}: #{value.inspect}" }
+          .join(', ')
+        annotation += " {#{defaults_str}}"
+      end
+      annotation += " (#{name})" unless name.nil?
+      annotation
+    end
+
     # Write annotated content to a file if it differs from the original.
     #
-    # @param {String} path - File path to write to
-    # @param {Hash} parsed_file - Hash mutated by `annotate_group`
-    # @return {void}
+    # @param path [String] File path to write to
+    # @param parsed_file [Hash] Hash mutated by {#annotate_group}
+    # @return [void]
     def write_to_file(path:, parsed_file:)
-      content = parsed_file[:groups].map { |pf| pf[:body] }.join
-      return unless parsed_file[:content] != content
-
-      unless @flags.include?(:dry)
-        # When running the test suite, we want to make sure we're not
-        # overwriting any files. `r` mode ensures that.
-        mode = File.instance_methods.include?(:test_write) ? 'r' : 'w'
-
-        File.open(path, mode) do |file|
-          if file.respond_to?(:test_write)
-            file.test_write(content, path)
-          else
-            file.write(content)
-          end
+      new_content = new_content_for(parsed_file)
+      return unless parsed_file[:content] != new_content
+
+      !@flags.include?(:dry) && perform_write(path: path, content: new_content)
+      @annotated_paths.push(path)
+    end
+
+    # Extracts the new file content for the given parsed file.
+    #
+    # @param parsed_file [Hash] { groups => Array<Hash> }
+    # @return [String] New file content
+    def new_content_for(parsed_file)
+      parsed_file[:groups].map { |pf| pf[:body] }.join
+    end
+
+    # Wraps the write operation. Needed to clearly distinguish whether it's a
+    # write in the test suite or a write in actual use.
+    #
+    # @param path [String] File path
+    # @param content [String] File content
+    # @return [void]
+    def perform_write(path:, content:)
+      File.open(path, file_mode) do |file|
+        if file.respond_to?(:test_write)
+          file.test_write(content, path)
+        else
+          file.write(content)
         end
       end
+    end
 
-      @annotated_paths.push(path)
+    # When running the test suite, we want to make sure we're not overwriting
+    # any files. `r` mode ensures that, and `w` is used for actual usage.
+    #
+    # @return [String] 'r' or 'w'
+    def file_mode
+      File.instance_methods.include?(:test_write) ? 'r' : 'w'
     end
 
     # Output results to user.
     #
-    # @return {Integer} - 0 for success, 1 for error
+    # @return [Integer] 0 for success, 1 for error
     def output_results
       if @annotated_paths.any?
         puts("Annotated #{@annotated_paths.join(', ')}")

data/lib/chusaku/cli.rb

@@ -14,17 +14,17 @@ module Chusaku
     Finished = Class.new(RuntimeError)
     NotARailsProject = Class.new(RuntimeError)
 
-    # Initializes a new instance of Chusaku::CLI.
+    # Initializes a new instance of `Chusaku::CLI`.
     #
-    # @return {Chusaku::CLI} - Instance of this class
+    # @return [Chusaku::CLI] Instance of this class
     def initialize
       @options = {}
     end
 
     # Parse CLI flags, if any, and handle applicable behaviors.
     #
-    # @param {Array<String>} args - CLI arguments
-    # @return {Integer} - 0 on success, 1 on error
+    # @param args [Array<String>] CLI arguments
+    # @return [Integer] 0 on success, 1 on error
     def call(args = ARGV)
       optparser.parse!(args)
       check_for_rails_project
@@ -40,8 +40,8 @@ module Chusaku
 
     # Raises exception if Rails project cannot be detected.
     #
-    # @raise {Chusaku::CLI::NotARailsProject} - Exception if not Rails project
-    # @return {void}
+    # @raise [Chusaku::CLI::NotARailsProject] Exception if not Rails project
+    # @return [void]
     def check_for_rails_project
       has_controllers = File.directory?('./app/controllers')
       has_rakefile = File.exist?('./Rakefile')
@@ -50,7 +50,7 @@ module Chusaku
 
     # Returns an instance of OptionParser with supported flags.
     #
-    # @return {OptionParser} - Preconfigured OptionParser instance
+    # @return [OptionParser] Preconfigured OptionParser instance
     def optparser
       OptionParser.new do |opts|
         opts.banner = 'Usage: chusaku [options]'
@@ -63,8 +63,8 @@ module Chusaku
 
     # Adds `--exit-with-error-on-annotation` flag.
     #
-    # @param {OptionParser} opts - OptionParser instance
-    # @return {void}
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
     def add_error_on_annotation_flag(opts)
       opts.on(
         '--exit-with-error-on-annotation',
@@ -76,8 +76,8 @@ module Chusaku
 
     # Adds `--dry-run` flag.
     #
-    # @param {OptionParser} opts - OptionParser instance
-    # @return {void}
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
     def add_dry_run_flag(opts)
       opts.on(
         '--dry-run',
@@ -89,8 +89,8 @@ module Chusaku
 
     # Adds `--version` flag.
     #
-    # @param {OptionParser} opts - OptionParser instance
-    # @return {void}
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
     def add_version_flag(opts)
       opts.on(
         '-v',
@@ -104,8 +104,8 @@ module Chusaku
 
     # Adds `--help` flag.
     #
-    # @param {OptionParser} opts - OptionParser instance
-    # @return {void}
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
     def add_help_flag(opts)
       opts.on(
         '-h',

data/lib/chusaku/parser.rb

@@ -3,6 +3,8 @@
 module Chusaku
   # Handles parsing a file and groups its lines into categories.
   module Parser
+    # Primary method to call.
+    #
     # Example output:
     #
     #   {
@@ -31,9 +33,9 @@ module Chusaku
     #     ]
     #   }
     #
-    # @param {String} path - File path to parse
-    # @param {Array<String>} actions - List of valid actions for this route
-    # @return {Hash} - { content: String, groups: Array<Hash> }
+    # @param path [String] File path to parse
+    # @param actions [Array<String>] List of valid actions for this route
+    # @return [Hash] { content => String, groups => Array<Hash> }
     def self.call(path:, actions:)
       groups = []
       group = {}
@@ -58,20 +60,22 @@ module Chusaku
       { content: content, groups: groups }
     end
 
-    # Given a line and actions, returns the line's type:
+    # Given a line and actions, returns the line's type.
+    #
+    # A type can be one of:
     #
     #   1. comment - A line that is entirely commented. Lines that have trailing
     #                comments do not fall under this category.
     #   2. action  - A line that contains an action definition.
     #   3. code    - Anything else.
     #
-    # And give back a Hash in the form:
+    # Returns a Hash in the form:
     #
     #   { type: :action, body: 'def foo', action: 'foo' }
     #
-    # @param {String} line - A line of a file
-    # @param {Array<String>} actions - List of valid actions for this route
-    # @return {Hash} - { type: Symbol, body: String, action: String }
+    # @param line [String] A line of a file
+    # @param actions [Array<String>] List of valid actions for this route
+    # @return [Hash] { type => Symbol, body => String, action => String }
     def self.parse_line(line:, actions:)
       comment_match = /^\s*#.*$/.match(line)
       def_match = /^\s*def\s+(\w*)\s*\w*.*$/.match(line)

data/lib/chusaku/routes.rb

@@ -4,6 +4,8 @@ module Chusaku
   # Handles extracting information about the Rails project's routes.
   class Routes
     class << self
+      # Primary method to call.
+      #
       # Example output:
       #
       #   {
@@ -23,19 +25,21 @@ module Chusaku
       #     }
       #   }
       #
-      # @return {Hash} - Routes hash
+      # @return [Hash] Routes hash
       def call
         routes = {}
 
         Rails.application.routes.routes.each do |route|
-          controller, action = extract_controller_and_action_from(route)
+          controller, action, defaults = extract_data_from(route)
           routes[controller] ||= {}
           routes[controller][action] ||= []
 
-          verbs_for(route).each do |verb|
-            routes[controller][action].push(format(route: route, verb: verb))
-            routes[controller][action].uniq!
-          end
+          add_info_for \
+            route: route,
+            routes: routes,
+            controller: controller,
+            action: action,
+            defaults: defaults
         end
 
         backfill_routes(routes)
@@ -43,38 +47,56 @@ module Chusaku
 
       private
 
+      # Adds formatted route info for the given param combination.
+      #
+      # @param route [Hash] Route info
+      # @param routes [Hash] Collection of all route info
+      # @param controller [String] Controller key
+      # @param action [String] Action key
+      # @param defaults [Hash] Default parameters for route
+      # @return [void]
+      def add_info_for(route:, routes:, controller:, action:, defaults:)
+        verbs_for(route).each do |verb|
+          routes[controller][action]
+            .push(format(route: route, verb: verb, defaults: defaults))
+          routes[controller][action].uniq!
+        end
+      end
+
       # Extract the HTTP verbs for a Rails route. Required for older versions of
       # Rails that return regular expressions for a route verb which sometimes
       # contains multiple verbs.
       #
-      # @param {ActionDispatch::Journey::Route} route - Route given by Rails
-      # @return {Array<String>} - List of HTTP verbs for the given route
+      # @param route [ActionDispatch::Journey::Route] Route given by Rails
+      # @return [Array<String>] List of HTTP verbs for the given route
       def verbs_for(route)
         route_verb = route.verb.to_s
 
-        ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'].select do |verb|
+        %w[GET POST PUT PATCH DELETE].select do |verb|
           route_verb.include?(verb)
         end
       end
 
       # Formats information for a given route.
       #
-      # @param {ActionDispatch::Journey::Route} route - Route given by Rails
-      # @param {String} verb - HTTP verb
-      # @return {Hash} - { verb: String, path: String, name: String }
-      def format(route:, verb:)
+      # @param route [ActionDispatch::Journey::Route] Route given by Rails
+      # @param verb [String] HTTP verb
+      # @param defaults [Hash] Default parameters for route
+      # @return [Hash] { verb => String, path => String, name => String }
+      def format(route:, verb:, defaults:)
         {
           verb: verb,
           path: route.path.spec.to_s.gsub('(.:format)', ''),
-          name: route.name
+          name: route.name,
+          defaults: defaults
         }
       end
 
       # Given a routes hash, backfill entries that aren't already filled by
       # `Rails.application.routes`.
       #
-      # @param {Hash} routes - Routes hash generated by this class
-      # @return {Hash} - Backfilled routes hash
+      # @param routes [Hash] Routes hash generated by this class
+      # @return [Hash] Backfilled routes hash
       def backfill_routes(routes)
         paths = {}
 
@@ -92,14 +114,14 @@ module Chusaku
 
       # Given a route, extract the controller and action strings.
       #
-      # @param {ActionDispatch::Journey::Route} route - Route instance
-      # @return {Array<String>} - [String, String]
-      def extract_controller_and_action_from(route)
-        defaults = route.defaults
-        controller = defaults[:controller]
-        action = defaults[:action]
+      # @param route [ActionDispatch::Journey::Route] Route instance
+      # @return [Array<Object>] (String, String, Hash)
+      def extract_data_from(route)
+        defaults = route.defaults.dup
+        controller = defaults.delete(:controller)
+        action = defaults.delete(:action)
 
-        [controller, action]
+        [controller, action, defaults]
       end
     end
   end

data/lib/chusaku/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chusaku
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ dependencies:
         version: '2.0'
 description: Annotate your Rails controllers with route info.
 email:
-- nishiki.liu@gmail.com
+- nishiki@hey.com
 executables:
 - chusaku
 extensions: []
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Annotate your Rails controllers with route info.