chusaku 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 006eca0c4d1c3b87363edd35f9070dd48bc0693e1b56b01fd3900696fa50387d
-  data.tar.gz: d5d3816c84eaba7c36d4e06e30eb7b8783b1dbb69f3c42190a278bf82fd01619
+  metadata.gz: 46b0340d8c2c5cde79a47703b564be4bec987b2fed0e9561ce658227ac3a2076
+  data.tar.gz: 8d2384684ad0c72d2f763446177b16d97d76f2c84c95bf4a7b5ff8e08cf32c23
 SHA512:
-  metadata.gz: b103a27205545c18aba9e7570e0f0c63aafa558b0cb6b870520e8a25d60cbb73cdfceccc7937c09c3de5090cc304b08c1151a29ba16602802b0fdf685f8fe360
-  data.tar.gz: ff6eb6258eea5a27f0422d633975251827c114af744f229ab3f4eca101a6ce840b39c4bf47300f16813944b055502f78d1a88d89725d827edf90649003b43b22
+  metadata.gz: a8e8d607f077c5de894d5fd70989d595fda9f4fab5d5111eeedb4acfa526d4f94cc7cb64abc64b42ac2968ef9e7f16bbf413a4329b46e919f0b46d8e9bc5c527
+  data.tar.gz: 72a674b922b87067ea2c3276f111603ee377a25bff277862187aa879b11ac83909877749b6b0cd5ff3315429e95b482da211f54b74b460eff129015780734e6c

data/.github/workflows/linting.yml

@@ -0,0 +1,18 @@
+name: Linting
+on: [pull_request]
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: 3.0.0
+        bundler-cache: true
+    - name: Run RuboCop
+      uses: reviewdog/action-rubocop@v2
+      with:
+        rubocop_version: gemfile
+        github_token: ${{ secrets.github_token }}
+        reporter: github-pr-review

data/.github/workflows/testing.yml

@@ -0,0 +1,17 @@
+name: Testing
+on: [pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,12 +1,20 @@
 require:
   - rubocop-performance
 
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
+  NewCops: enable
   Exclude:
     - 'bin/**/*'
     - 'test/mock/app/**/*'
     - 'test/mock/examples/**/*'
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 

data/README.md

@@ -1,8 +1,6 @@
 # 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)
+[![Gem Version](https://badge.fury.io/rb/chusaku.svg)](https://badge.fury.io/rb/chusaku)
 
 Add comments above your Rails actions that look like:
 
@@ -54,9 +52,10 @@ 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
-        --dry-run                    Run without file modifications
+        --verbose                    Print all annotations
     -v, --version                    Show Chusaku version number and quit
     -h, --help                       Show this help message and quit
 ```

data/chusaku.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
     spec.metadata['changelog_uri'] = spec.homepage
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.

data/lib/chusaku/cli.rb

@@ -54,36 +54,41 @@ module Chusaku
     def optparser
       OptionParser.new do |opts|
         opts.banner = 'Usage: chusaku [options]'
-        add_error_on_annotation_flag(opts)
         add_dry_run_flag(opts)
+        add_error_on_annotation_flag(opts)
+        add_verbose_flag(opts)
         add_version_flag(opts)
         add_help_flag(opts)
       end
     end
 
+    # Adds `--dry-run` flag.
+    #
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
+    def add_dry_run_flag(opts)
+      opts.on('--dry-run', 'Run without file modifications') do
+        @options[:dry] = true
+      end
+    end
+
     # Adds `--exit-with-error-on-annotation` flag.
     #
     # @param opts [OptionParser] 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
+      opts.on('--exit-with-error-on-annotation', 'Fail if any file was annotated') do
         @options[:error_on_annotation] = true
       end
     end
 
-    # Adds `--dry-run` flag.
+    # Adds `--verbose` flag.
     #
     # @param opts [OptionParser] OptionParser instance
     # @return [void]
-    def add_dry_run_flag(opts)
-      opts.on(
-        '--dry-run',
-        'Run without file modifications'
-      ) do
-        @options[:dry] = true
+    def add_verbose_flag(opts)
+      opts.on('--verbose', 'Print all annotations') do
+        @options[:verbose] = true
       end
     end
 
@@ -92,11 +97,7 @@ module Chusaku
     # @param opts [OptionParser] OptionParser instance
     # @return [void]
     def add_version_flag(opts)
-      opts.on(
-        '-v',
-        '--version',
-        'Show Chusaku version number and quit'
-      ) do
+      opts.on('-v', '--version', 'Show Chusaku version number and quit') do
         puts(Chusaku::VERSION)
         raise Finished
       end
@@ -107,11 +108,7 @@ module Chusaku
     # @param opts [OptionParser] OptionParser instance
     # @return [void]
     def add_help_flag(opts)
-      opts.on(
-        '-h',
-        '--help',
-        'Show this help message and quit'
-      ) do
+      opts.on('-h', '--help', 'Show this help message and quit') do
         puts(opts)
         raise Finished
       end

data/lib/chusaku/parser.rb

@@ -13,22 +13,26 @@ module Chusaku
     #       {
     #         type: :code,
     #         body: 'class Foo\n',
-    #         action: nil
+    #         action: nil,
+    #         line_number: 1
     #       },
     #       {
     #         type: :comment,
     #         body: '  # Bar\n  # Baz\n',
-    #         action: nil
+    #         action: nil,
+    #         line_number: 2
     #       },
     #       {
     #         type: :action,
     #         body: '  def action_name; end\n',
-    #         action: 'action_name'
+    #         action: 'action_name',
+    #         line_number: 4
     #       }
     #       {
     #         type: :code,
     #         body: 'end # vanilla is the best flavor\n',
-    #         action: nil
+    #         action: nil,
+    #         line_number: 5
     #       }
     #     ]
     #   }
@@ -41,17 +45,17 @@ module Chusaku
       group = {}
       content = IO.read(path)
 
-      content.each_line do |line|
+      content.each_line.with_index do |line, index|
         parsed_line = parse_line(line: line, actions: actions)
 
-        if group[:type] != parsed_line[:type]
+        if group[:type] == parsed_line[:type]
+          # Same group. Push the current line into the current group.
+          group[:body] += line
+        else
           # Now looking at a new group. Push the current group onto the array
           # and start a new one.
           groups.push(group) unless group.empty?
-          group = parsed_line
-        else
-          # Same group. Push the current line into the current group.
-          group[:body] += line
+          group = parsed_line.merge(line_number: index + 1)
         end
       end
 

data/lib/chusaku/version.rb

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

data/lib/chusaku.rb

@@ -20,11 +20,11 @@ module Chusaku
     def call(flags = {})
       @flags = flags
       @routes = Chusaku::Routes.call
-      @annotated_paths = []
+      @changes = []
       controllers_pattern = 'app/controllers/**/*_controller.rb'
 
       Dir.glob(Rails.root.join(controllers_pattern)).each do |path|
-        controller = %r{controllers\/(.*)_controller\.rb}.match(path)[1]
+        controller = %r{controllers/(.*)_controller\.rb}.match(path)[1]
         actions = @routes[controller]
         next if actions.nil?
 
@@ -45,18 +45,46 @@ 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|
-        clean_group(prev)
+        record_change(group: prev, type: :clean, path: path)
         next unless curr[:type] == :action
 
         route_data = @routes[controller][curr[:action]]
         next unless route_data.any?
 
-        annotate_group(group: curr, route_data: route_data)
+        record_change(group: curr, type: :annotate, route_data: route_data, path: path)
       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 }
@@ -66,7 +94,7 @@ module Chusaku
 
       group[:body] = group[:body].gsub(/^\s*#\s*@route.*$\n/, '')
       group[:body] =
-        group[:body].gsub(%r{^\s*# (GET|POST|PATCH\/PUT|DELETE) \/\S+$\n}, '')
+        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
@@ -112,10 +140,9 @@ module Chusaku
     # @return [void]
     def write_to_file(path:, parsed_file:)
       new_content = new_content_for(parsed_file)
-      return unless parsed_file[:content] != new_content
+      return if 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.
@@ -156,7 +183,7 @@ module Chusaku
     def output_results
       puts(output_copy)
       exit_code = 0
-      exit_code = 1 if @annotated_paths.any? && @flags.include?(:error_on_annotation)
+      exit_code = 1 if @changes.any? && @flags.include?(:error_on_annotation)
       exit_code
     end
 
@@ -164,25 +191,36 @@ module Chusaku
     #
     # @return [String] Copy to be outputted to user
     def output_copy
-      return 'Nothing to annotate.' if @annotated_paths.empty?
-
-      annotated_paths = @annotated_paths.join(', ')
-      dry_run = @flags.include?(:dry)
-      error_on_annotation = @flags.include?(:error_on_annotation)
-
-      if dry_run && error_on_annotation
-        <<~COPY
-          Annotations missing in the following files: #{annotated_paths}
-
-          Run `chusaku` to annotate them. Exiting with status code 1.
-        COPY
-      elsif dry_run
-        "The following files would be annotated without `--dry-run`: #{annotated_paths}"
-      elsif error_on_annotation
-        "Annotated #{annotated_paths}.\n\nExiting with status code 1."
-      else
-        "Annotated #{annotated_paths}."
-      end
+      return 'Nothing to annotate.' if @changes.empty?
+
+      copy = changes_copy
+      copy += "\nChusaku 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.
+    #
+    # @return [String] Copy of recorded changes
+    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")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nishiki Liu
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,8 +102,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".codeclimate.yml"
+- ".github/workflows/linting.yml"
+- ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -127,7 +127,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Annotate your Rails controllers with route info.
 test_files: []

data/.circleci/config.yml

@@ -1,29 +0,0 @@
-version: 2
-jobs:
-  build:
-    working_directory: ~/chusaku
-    docker:
-      - image: circleci/ruby
-    steps:
-      - checkout
-      - run:
-          name: Install Bundler
-          command: |
-            gem install bundler
-      - restore_cache:
-          keys:
-            - dep-v1-{{ .Branch }}-{{ checksum "chusaku.gemspec" }}
-            - dep-v1-{{ .Branch }}
-            - dep-v1-
-      - run:
-          name: Install dependencies
-          command: |
-            bundle install --path vendor/bundle
-      - save_cache:
-          key: dep-v1-{{ .Branch }}-{{ checksum "chusaku.gemspec" }}
-          paths:
-            - vendor/bundle
-      - run:
-          name: Run tests
-          command: |
-            bundle exec rake test

data/.codeclimate.yml

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