chusaku 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be8c03a0fe70a6b717b8fb204ae3d2d1b9eaaa89597c7ada8c169cb49919d2ef
-  data.tar.gz: 28736b04b639cba7eed34695691433a0cf4defd3f48eaf7a15faced2e04540e8
+  metadata.gz: cf3fc6d454cdeaf9c8c31019c1b0ec6dc4c676203a8c44cd40e24dee49ace832
+  data.tar.gz: ba06bb7b2868c6c2d53ac93504eb00fe0ef5527b1224f04c6c862fd27e7734fe
 SHA512:
-  metadata.gz: 178db8776a7bfeaccbe2eea70346753cf203531c7836f706988a65c3527ac6de733580ed6e324f93658fbbeec4812fff9196f460985abdab140eea99e794ab61
-  data.tar.gz: f8307518e4df5d74a3c5703efed73f167138c04ae2a0d2a1f314c16bc0b1e6d101c64355d994349dc238be2a486745dbea4703389bf485dbb681412e03ae21f8
+  metadata.gz: b932a1b72743a06701d7fa3d7a80068baf0e31df76d78a0dea7b892a46bb663c3dcd9e444599b3942a9a5eb3289b5b90b962ef39216e8f15ff04bde5bff0946b
+  data.tar.gz: c609bb26e27dc4018766e84d55aa38715385bff1fc444468481ff781649f9af3037e2078ada729814f9d92963e9b3752f48b1bb6cbdbe05a00000eae5ea169b4

data/.codeclimate.yml

@@ -0,0 +1,4 @@
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-77

data/.rubocop.yml

@@ -1,27 +1,21 @@
+require:
+  - rubocop-performance
+
 AllCops:
   Exclude:
     - 'bin/**/*'
-
-Layout/IndentationConsistency:
-  EnforcedStyle: rails
+    - 'test/mock/app/**/*'
+    - 'test/mock/examples/**/*'
 
 Metrics/AbcSize:
-  Enabled: false
+  Exclude:
+    - 'test/**/*'
 
 Metrics/MethodLength:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/CommentedKeyword:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
+  Max: 25
+  Exclude:
+    - 'test/**/*'
 
-Style/RegexpLiteral:
-  Enabled: false
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'

data/README.md

@@ -1,8 +1,8 @@
 # Chusaku
 
-| Build | Gem |
-|-------|-----|
-|[![CircleCI](https://circleci.com/gh/nshki/chusaku.svg?style=svg&circle-token=e1917972632f242932171de0ca5443148e83151c)](https://circleci.com/gh/nshki/chusaku)|[![Gem Version](https://badge.fury.io/rb/chusaku.svg)](https://badge.fury.io/rb/chusaku)|
+| Gem | CI | Quality |
+|-----|----|---------|
+|[![Gem Version](https://badge.fury.io/rb/chusaku.svg)](https://badge.fury.io/rb/chusaku)|[![CircleCI](https://circleci.com/gh/nshki/chusaku.svg?style=svg&circle-token=e1917972632f242932171de0ca5443148e83151c)](https://circleci.com/gh/nshki/chusaku)|[![Maintainability](https://api.codeclimate.com/v1/badges/e21235bd513aadf0407b/maintainability)](https://codeclimate.com/github/nshki/chusaku/maintainability)
 
 Add comments above your Rails actions that look like:
 
@@ -61,8 +61,20 @@ Usage: chusaku [options]
     -h, --help                       Show this help message and quit
 ```
 
-If you'd like to use Chusaku as a Git hook, take a look at
-[Lefthook](https://github.com/Arkweid/lefthook).
+
+## Pre-commit Hook
+
+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

data/chusaku.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.77'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
 
   spec.add_dependency 'rails', '> 2.0'
 end

data/lib/chusaku.rb

@@ -4,106 +4,123 @@ require 'chusaku/version'
 require 'chusaku/parser'
 require 'chusaku/routes'
 
+# Handles core functionality of annotating projects.
 module Chusaku
-  # The main method to run Chusaku. Annotate all actions in your Rails project
-  # as follows:
-  #
-  #   # @route GET /waterlilies/:id (waterlilies)
-  #   def show
-  #     # ...
-  #   end
-  #
-  # @param {Array<String>} args - CLI flags
-  # @return {Integer} 0 on success, 1 on error
-  def self.call(args = [])
-    routes = Chusaku::Routes.call
-    controller_pattern = 'app/controllers/**/*_controller.rb'
-    controller_paths = Dir.glob(Rails.root.join(controller_pattern))
-    annotated_paths = []
-
-    # Loop over all controller file paths.
-    controller_paths.each do |path|
-      controller = /controllers\/(.*)_controller\.rb/.match(path)[1]
-      actions = routes[controller]
-      next if actions.nil?
-
-      # Parse the file and iterate over the parsed content, two entries at a
-      # time.
-      parsed_file = Chusaku::Parser.call(path: path, actions: actions.keys)
-      parsed_file[:groups].each_cons(2) do |prev, curr|
-        # Remove all @route comments in the previous group.
-        if prev[:type] == :comment
-          prev[:body] = prev[:body].gsub(/^\s*#\s*@route.*$\n/, '')
-        end
+  class << self
+    # The main method to run Chusaku. Annotate all actions in a Rails project as
+    # follows:
+    #
+    #   # @route GET /waterlilies/:id (waterlilies)
+    #   def show
+    #     # ...
+    #   end
+    #
+    # @param {Hash} flags - CLI flags
+    # @return {Integer} - 0 on success, 1 on error
+    def call(flags = {})
+      @flags = flags
+      @routes = Chusaku::Routes.call
+      @annotated_paths = []
+      controllers_pattern = 'app/controllers/**/*_controller.rb'
+
+      Dir.glob(Rails.root.join(controllers_pattern)).each do |path|
+        controller = %r{controllers\/(.*)_controller\.rb}.match(path)[1]
+        actions = @routes[controller]
+        next if actions.nil?
+
+        annotate_file(path: path, controller: controller, actions: actions.keys)
+      end
+
+      output_results
+    end
 
-        # Only proceed if we are currently looking at an action.
+    private
+
+    # 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}
+    def annotate_file(path:, controller:, actions:)
+      parsed_file = Chusaku::Parser.call(path: path, actions: actions)
+      parsed_file[:groups].each_cons(2) do |prev, curr|
+        clean_group(prev)
         next unless curr[:type] == :action
 
-        # Fetch current action in routes.
-        action = curr[:action]
-        data = routes[controller][action]
-        next unless data.any?
-
-        # Add annotations.
-        whitespace = /^(\s*).*$/.match(curr[:body])[1]
-        data.reverse.each do |datum|
-          annotation = annotate(datum)
-          comment = "#{whitespace}# #{annotation}\n"
-          curr[:body] = comment + curr[:body]
-        end
+        route_data = @routes[controller][curr[:action]]
+        next unless route_data.any?
+
+        annotate_group(group: curr, route_data: route_data)
       end
 
-      # Write to file.
-      parsed_content = parsed_file[:groups].map { |pf| pf[:body] }
-      new_content = parsed_content.join
-      if parsed_file[:content] != new_content
-        write(path, new_content) unless args.include?(:dry)
-        annotated_paths << path
+      write_to_file(path: path, parsed_file: parsed_file)
+    end
+
+    # Given a parsed group, clean out its contents.
+    #
+    # @param {Hash} group - { type: Symbol, body: String }
+    # @return {void}
+    def clean_group(group)
+      return unless group[:type] == :comment
+
+      group[:body] = group[:body].gsub(/^\s*#\s*@route.*$\n/, '')
+      group[:body] =
+        group[:body].gsub(%r{^\s*# (GET|POST|PATCH\/PUT|DELETE) \/\S+$\n}, '')
+    end
+
+    # Add an annotation to the given group given by Chusaku::Parser that looks
+    # like:
+    #
+    #   @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}
+    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"
+        group[:body] = comment + group[:body]
       end
     end
 
-    # Output results to user.
-    if annotated_paths.any?
-      puts "Annotated #{annotated_paths.join(', ')}"
-      if args.include?(:error_on_annotation)
-        1
-      else
-        0
+    # 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}
+    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)
+        File.open(path, 'r+') do |file|
+          if file.respond_to?(:test_write)
+            file.test_write(content, path)
+          else
+            file.write(content)
+          end
+        end
       end
-    else
-      puts "Nothing to annotate"
-      0
+
+      @annotated_paths.push(path)
     end
-  end
 
-  # Write given content to a file. If we're using an overridden version of File,
-  # then use its method instead for testing purposes.
-  #
-  # @param {String} path - File path to write to
-  # @param {String} content - Contents of the file
-  # @return {void}
-  def self.write(path, content)
-    File.open(path, 'r+') do |file|
-      if file.respond_to?(:test_write)
-        file.test_write(content, path)
+    # Output results to user.
+    #
+    # @return {Integer} - 0 for success, 1 for error
+    def output_results
+      if @annotated_paths.any?
+        puts("Annotated #{@annotated_paths.join(', ')}")
+        @flags.include?(:error_on_annotation) ? 1 : 0
       else
-        file.write(content)
+        puts('Nothing to annotate')
+        0
       end
     end
   end
-
-  # Given a hash describing an action, generate an annotation in the form:
-  #
-  #   @route GET /waterlilies/:id (waterlilies)
-  #
-  # @param {Hash} action_info - Parsed line given by Chusaku::Parser
-  # @return {String} Annotation for given parsed line
-  def self.annotate(action_info)
-    verb = action_info[:verb]
-    path = action_info[:path]
-    name = action_info[:name]
-    annotation = "@route #{verb} #{path}"
-    annotation += " (#{name})" unless name.nil?
-    annotation
-  end
 end

data/lib/chusaku/cli.rb

@@ -4,18 +4,19 @@ require 'optparse'
 require 'chusaku'
 
 module Chusaku
+  # Enables flags for the `chusaku` executable.
   class CLI
+    attr_reader :options
+
     STATUS_SUCCESS = 0
     STATUS_ERROR = 1
 
-    attr_reader :options
-
     Finished = Class.new(RuntimeError)
     NotARailsProject = Class.new(RuntimeError)
 
     # 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
@@ -23,7 +24,7 @@ module Chusaku
     # Parse CLI flags, if any, and handle applicable behaviors.
     #
     # @param {Array<String>} args - CLI arguments
-    # @return {Integer} 0 on success, 1 on error
+    # @return {Integer} - 0 on success, 1 on error
     def call(args = ARGV)
       optparser.parse!(args)
       check_for_rails_project
@@ -37,55 +38,83 @@ module Chusaku
 
     private
 
-      # Raises exception if Rails project cannot be detected.
-      #
-      # @raise {Chusaku::CLI::NotARailsProject} Exception if not Rails project
-      # @return {void}
-      def check_for_rails_project
-        unless File.directory?('./app/controllers') && File.exist?('./Rakefile')
-          raise NotARailsProject
-        end
-      end
+    # Raises exception if Rails project cannot be detected.
+    #
+    # @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')
+      raise NotARailsProject unless has_controllers && has_rakefile
+    end
 
-      # Returns an instance of OptionParser with supported flags.
-      #
-      # @return {OptionParser} Preconfigured OptionParser instance
-      def optparser
-        OptionParser.new do |opts|
-          opts.banner = 'Usage: chusaku [options]'
+    # Returns an instance of OptionParser with supported flags.
+    #
+    # @return {OptionParser} - Preconfigured OptionParser instance
+    def optparser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: chusaku [options]'
+        add_error_on_annotation_flag(opts)
+        add_dry_run_flag(opts)
+        add_version_flag(opts)
+        add_help_flag(opts)
+      end
+    end
 
-          opts.on(
-            '--exit-with-error-on-annotation',
-            'Fail if any file was annotated'
-          ) do
-            @options[:error_on_annotation] = true
-          end
+    # Adds `--exit-with-error-on-annotation` flag.
+    #
+    # @param {OptionParser} opts - OptionParser instance
+    # @return {void}
+    def add_error_on_annotation_flag(opts)
+      opts.on(
+        '--exit-with-error-on-annotation',
+        'Fail if any file was annotated'
+      ) do
+        @options[:error_on_annotation] = true
+      end
+    end
 
-          opts.on(
-            '--dry-run',
-            'Run without file modifications'
-          ) do
-            @options[:dry] = true
-          end
+    # Adds `--dry-run` flag.
+    #
+    # @param {OptionParser} opts - OptionParser instance
+    # @return {void}
+    def add_dry_run_flag(opts)
+      opts.on(
+        '--dry-run',
+        'Run without file modifications'
+      ) do
+        @options[:dry] = true
+      end
+    end
 
-          opts.on(
-            '-v',
-            '--version',
-            'Show Chusaku version number and quit'
-          ) do
-            puts(Chusaku::VERSION)
-            raise Finished
-          end
+    # Adds `--version` flag.
+    #
+    # @param {OptionParser} opts - OptionParser instance
+    # @return {void}
+    def add_version_flag(opts)
+      opts.on(
+        '-v',
+        '--version',
+        'Show Chusaku version number and quit'
+      ) do
+        puts(Chusaku::VERSION)
+        raise Finished
+      end
+    end
 
-          opts.on(
-            '-h',
-            '--help',
-            'Show this help message and quit'
-          ) do
-            puts(opts)
-            raise Finished
-          end
-        end
+    # Adds `--help` flag.
+    #
+    # @param {OptionParser} opts - OptionParser instance
+    # @return {void}
+    def add_help_flag(opts)
+      opts.on(
+        '-h',
+        '--help',
+        'Show this help message and quit'
+      ) do
+        puts(opts)
+        raise Finished
       end
+    end
   end
 end

data/lib/chusaku/parser.rb

@@ -1,27 +1,39 @@
 # frozen_string_literal: true
 
 module Chusaku
+  # Handles parsing a file and groups its lines into categories.
   module Parser
-    # Parses a file and groups its lines into categories:
-    #
     # Example output:
     #
-    #   [ { type: :code,
-    #       body: 'class Foo\n',
-    #       action: nil },
-    #     { type: :comment,
-    #       body: '  # Bar\n  # Baz\n',
-    #       action: nil },
-    #     { type: :action,
-    #       body: '  def action_name; end\n',
-    #       action: 'action_name' }
-    #     { type: :code,
-    #       body: 'end # vanilla is the best flavor\n',
-    #       action: nil } ]
+    #   {
+    #     content: <Original file content>,
+    #     groups: [
+    #       {
+    #         type: :code,
+    #         body: 'class Foo\n',
+    #         action: nil
+    #       },
+    #       {
+    #         type: :comment,
+    #         body: '  # Bar\n  # Baz\n',
+    #         action: nil
+    #       },
+    #       {
+    #         type: :action,
+    #         body: '  def action_name; end\n',
+    #         action: 'action_name'
+    #       }
+    #       {
+    #         type: :code,
+    #         body: 'end # vanilla is the best flavor\n',
+    #         action: nil
+    #       }
+    #     ]
+    #   }
     #
     # @param {String} path - File path to parse
     # @param {Array<String>} actions - List of valid actions for this route
-    # @return {Hash} Parsed groups of the file and original content
+    # @return {Hash} - { content: String, groups: Array<Hash> }
     def self.call(path:, actions:)
       groups = []
       group = {}
@@ -43,10 +55,7 @@ module Chusaku
 
       # Push the last group onto the array and return.
       groups.push(group)
-      {
-        content: content,
-        groups: groups
-      }
+      { content: content, groups: groups }
     end
 
     # Given a line and actions, returns the line's type:
@@ -62,7 +71,7 @@ module Chusaku
     #
     # @param {String} line - A line of a file
     # @param {Array<String>} actions - List of valid actions for this route
-    # @return {Hash} Parsed line
+    # @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

@@ -1,49 +1,49 @@
 # frozen_string_literal: true
 
 module Chusaku
-  module Routes
-    # Extract information about the Rails project's routes.
-    #
-    # Example output:
-    #
-    #   {
-    #     'users' => {
-    #       'edit' => [
-    #         { verb: 'GET', path: '/users/:id', name: 'edit_user' }],
-    #       'update' => [
-    #         { verb: 'PATCH', path: '/users', name: 'edit_user' },
-    #         { verb: 'PUT', path: '/users', name: 'edit_user' }]
-    #     },
-    #     'empanadas' => {
-    #       'create' => [
-    #         { verb: 'POST', path: '/empanadas', name: nil }]
-    #     }
-    #   }
-    #
-    # @return {Hash} Routes hash
-    def self.call
-      routes = {}
+  # Handles extracting information about the Rails project's routes.
+  class Routes
+    class << self
+      # Example output:
+      #
+      #   {
+      #     'users' => {
+      #       'edit' => [
+      #         { verb: 'GET', path: '/users/:id', name: 'edit_user' }
+      #       ],
+      #       'update' => [
+      #         { verb: 'PATCH', path: '/users', name: 'edit_user' },
+      #         { verb: 'PUT', path: '/users', name: 'edit_user' }
+      #       ]
+      #     },
+      #     'empanadas' => {
+      #       'create' => [
+      #         { verb: 'POST', path: '/empanadas', name: nil }
+      #       ]
+      #     }
+      #   }
+      #
+      # @return {Hash} - Routes hash
+      def call
+        routes = {}
 
-      Rails.application.routes.routes.each do |route|
-        defaults = route.defaults
-        controller = defaults[:controller]
-        action = defaults[:action]
+        Rails.application.routes.routes.each do |route|
+          controller, action = extract_controller_and_action_from(route)
+          routes[controller] ||= {}
+          routes[controller][action] ||= []
+          routes[controller][action].push(format_route(route))
+        end
 
-        routes[controller] ||= {}
-        routes[controller][action] ||= []
-        routes[controller][action].push(format_route(route))
+        backfill_routes(routes)
       end
 
-      backfill_routes(routes)
-    end
-
-    private
+      private
 
       # Extract information of a given route.
       #
       # @param {ActionDispatch::Journey::Route} route - Route given by Rails
-      # @return {Hash} Formatted hash for given route
-      def self.format_route(route)
+      # @return {Hash} - { verb: String, path: String, name: String }
+      def format_route(route)
         {
           verb: route.verb,
           path: route.path.spec.to_s.gsub('(.:format)', ''),
@@ -55,8 +55,8 @@ module Chusaku
       # `Rails.application.routes`.
       #
       # @param {Hash} routes - Routes hash generated by this class
-      # @return {Hash} Backfilled routes
-      def self.backfill_routes(routes)
+      # @return {Hash} - Backfilled routes hash
+      def backfill_routes(routes)
         paths = {}
 
         routes.each do |_controller, actions|
@@ -70,5 +70,18 @@ module Chusaku
 
         routes
       end
+
+      # 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]
+
+        [controller, action]
+      end
+    end
   end
 end

data/lib/chusaku/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile