chusaku 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2976318f89e26e31f77c54e1cc338812ac6a107ec033d53c077fd4eb1759be6
-  data.tar.gz: 8413d9353d6115929985f3d6275396abeb25d7b9df834ccd0d4e19fd834ef574
+  metadata.gz: 46b0340d8c2c5cde79a47703b564be4bec987b2fed0e9561ce658227ac3a2076
+  data.tar.gz: 8d2384684ad0c72d2f763446177b16d97d76f2c84c95bf4a7b5ff8e08cf32c23
 SHA512:
-  metadata.gz: 44c12d0f6c0f970cd3a0e5c76cd14b18d8bfbf16f7d39e8789e4c09c87a8273a8b3e288de865533c7a39b81fe1dd51088a1ddc7c33edb0325e12a676153d5563
-  data.tar.gz: 5e01aeaa4eea9099c47445c88db326ff4ceb5d028088bbd6c2a328f21673c17d80c93bc8fda0c4135e76956f1439a26df758985a23bfe895d5f3f2ff14eb3982
+  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,23 @@
 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
+
 Metrics/AbcSize:
   Exclude:
     - 'test/**/*'
@@ -16,6 +27,9 @@ Metrics/MethodLength:
   Exclude:
     - 'test/**/*'
 
+Metrics/ModuleLength:
+  Max: 250
+
 Style/ClassAndModuleChildren:
   Exclude:
     - 'test/**/*'

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

@@ -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.'
@@ -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.
@@ -37,15 +37,15 @@ 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'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rubocop', '~> 0.77'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  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 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.9'
 
-  spec.add_dependency 'rails', '> 2.0'
+  spec.add_dependency 'railties', '>= 3.0'
 end

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,53 +50,54 @@ 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]'
-        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 {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',
-        '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 {OptionParser} opts - OptionParser instance
-    # @return {void}
-    def add_dry_run_flag(opts)
-      opts.on(
-        '--dry-run',
-        'Run without file modifications'
-      ) do
-        @options[:dry] = true
+    # @param opts [OptionParser] OptionParser instance
+    # @return [void]
+    def add_verbose_flag(opts)
+      opts.on('--verbose', 'Print all annotations') do
+        @options[:verbose] = true
       end
     end
 
     # 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',
-        '--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
@@ -104,14 +105,10 @@ 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',
-        '--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

@@ -3,6 +3,8 @@
 module Chusaku
   # Handles parsing a file and groups its lines into categories.
   module Parser
+    # Primary method to call.
+    #
     # Example output:
     #
     #   {
@@ -11,45 +13,49 @@ 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
     #       }
     #     ]
     #   }
     #
-    # @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 = {}
       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
 
@@ -58,20 +64,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.6.0'
 end

data/lib/chusaku.rb

@@ -15,16 +15,16 @@ 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
-      @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?
 
@@ -38,35 +38,63 @@ 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|
-        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 {Hash} group - { type: Symbol, body: String }
+    # @param group [Hash] { 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}, '')
+        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
@@ -74,57 +102,125 @@ 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 if parsed_file[:content] == new_content
+
+      !@flags.include?(:dry) && perform_write(path: path, content: new_content)
+    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(', ')}")
-        @flags.include?(:error_on_annotation) ? 1 : 0
-      else
-        puts('Nothing to annotate')
-        0
-      end
+      puts(output_copy)
+      exit_code = 0
+      exit_code = 1 if @changes.any? && @flags.include?(:error_on_annotation)
+      exit_code
+    end
+
+    # Determines the copy to be used in the program output.
+    #
+    # @return [String] Copy to be outputted to user
+    def output_copy
+      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.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2021-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,94 +16,94 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Annotate your Rails controllers with route info.
 email:
-- nishiki.liu@gmail.com
+- nishiki@hey.com
 executables:
 - chusaku
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".codeclimate.yml"
+- ".github/workflows/linting.yml"
+- ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -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.6
 signing_key: 
 specification_version: 4
 summary: Annotate your Rails controllers with route info.

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