chusaku 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 519cb59d3970def8c48a1f9995f8208e2455d17c6f3061ff56ceed1e9cd2e593
-  data.tar.gz: 4de2d9aae8d0e9d97d998a53b47fd4428855ed7f5898926ae3e1f14d1b6fe90e
+  metadata.gz: be8c03a0fe70a6b717b8fb204ae3d2d1b9eaaa89597c7ada8c169cb49919d2ef
+  data.tar.gz: 28736b04b639cba7eed34695691433a0cf4defd3f48eaf7a15faced2e04540e8
 SHA512:
-  metadata.gz: f619946e1d2a43aacec4d8bd2488d5b5af4c4e24f64bc233c294097ffc51e2c4bf3c3028530302397c026d099835d2587df1cc96356643102812bf93754a8265
-  data.tar.gz: 871f3aab82d32b5dff9dd508fbc8119ace1125cc88e14f0e36489b094228e3843bd47fa418a0314017fe974c5ee1a149fd86585f47f494e888de92e82fa3da54
+  metadata.gz: 178db8776a7bfeaccbe2eea70346753cf203531c7836f706988a65c3527ac6de733580ed6e324f93658fbbeec4812fff9196f460985abdab140eea99e794ab61
+  data.tar.gz: f8307518e4df5d74a3c5703efed73f167138c04ae2a0d2a1f314c16bc0b1e6d101c64355d994349dc238be2a486745dbea4703389bf485dbb681412e03ae21f8

data/README.md

@@ -49,6 +49,21 @@ From the root of your Rails application, run:
 $ bundle exec chusaku
 ```
 
+Chusaku has some flags available for use as well:
+
+```
+$ bundle exec chusaku --help
+Usage: chusaku [options]
+        --exit-with-error-on-annotation
+                                     Fail if any file was annotated
+        --dry-run                    Run without file modifications
+    -v, --version                    Show Chusaku version number and quit
+    -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).
+
 
 ## Development
 

data/bin/chusaku

@@ -1,9 +1,5 @@
 #!/usr/bin/env ruby
 
-unless File.directory?('./app/controllers') && File.exist?('./Rakefile')
-  abort 'Please run chusaku from the root of your project.'
-end
-
 require 'rubygems'
 
 begin
@@ -18,5 +14,6 @@ begin
 rescue StandardError
 end
 
-require 'chusaku'
-Chusaku.call
+require 'chusaku/cli'
+
+exit Chusaku::CLI.new.call

data/lib/chusaku.rb

@@ -12,10 +12,14 @@ module Chusaku
   #   def show
   #     # ...
   #   end
-  def self.call
+  #
+  # @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|
@@ -26,7 +30,7 @@ module Chusaku
       # 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.each_cons(2) do |prev, curr|
+      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/, '')
@@ -50,23 +54,33 @@ module Chusaku
       end
 
       # Write to file.
-      parsed_content = parsed_file.map { |pf| pf[:body] }
-      write(path, parsed_content.join)
+      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
+      end
     end
 
     # Output results to user.
-    if controller_paths.any?
-      puts "Annotated #{controller_paths.join(', ')}"
+    if annotated_paths.any?
+      puts "Annotated #{annotated_paths.join(', ')}"
+      if args.include?(:error_on_annotation)
+        1
+      else
+        0
+      end
     else
       puts "Nothing to annotate"
+      0
     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
-  # @param {String} content
+  # @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|
@@ -82,8 +96,8 @@ module Chusaku
   #
   #   @route GET /waterlilies/:id (waterlilies)
   #
-  # @param {Hash} action_info
-  # @return {String}
+  # @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]

data/lib/chusaku/cli.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'chusaku'
+
+module Chusaku
+  class CLI
+    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
+    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
+    def call(args = ARGV)
+      optparser.parse!(args)
+      check_for_rails_project
+      Chusaku.call(options)
+    rescue NotARailsProject
+      warn('Please run chusaku from the root of your project.')
+      STATUS_ERROR
+    rescue Finished
+      STATUS_SUCCESS
+    end
+
+    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
+
+      # Returns an instance of OptionParser with supported flags.
+      #
+      # @return {OptionParser} Preconfigured OptionParser instance
+      def optparser
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: chusaku [options]'
+
+          opts.on(
+            '--exit-with-error-on-annotation',
+            'Fail if any file was annotated'
+          ) do
+            @options[:error_on_annotation] = true
+          end
+
+          opts.on(
+            '--dry-run',
+            'Run without file modifications'
+          ) do
+            @options[:dry] = true
+          end
+
+          opts.on(
+            '-v',
+            '--version',
+            'Show Chusaku version number and quit'
+          ) do
+            puts(Chusaku::VERSION)
+            raise Finished
+          end
+
+          opts.on(
+            '-h',
+            '--help',
+            'Show this help message and quit'
+          ) do
+            puts(opts)
+            raise Finished
+          end
+        end
+      end
+  end
+end

data/lib/chusaku/parser.rb

@@ -19,14 +19,15 @@ module Chusaku
     #       body: 'end # vanilla is the best flavor\n',
     #       action: nil } ]
     #
-    # @param {String} path
-    # @param {Array<String>} actions
-    # @return {Array<Hash>}
+    # @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
     def self.call(path:, actions:)
       groups = []
       group = {}
+      content = IO.read(path)
 
-      File.open(path, 'r').each_line do |line|
+      content.each_line do |line|
         parsed_line = parse_line(line: line, actions: actions)
 
         if group[:type] != parsed_line[:type]
@@ -42,7 +43,10 @@ module Chusaku
 
       # Push the last group onto the array and return.
       groups.push(group)
-      groups
+      {
+        content: content,
+        groups: groups
+      }
     end
 
     # Given a line and actions, returns the line's type:
@@ -56,9 +60,9 @@ module Chusaku
     #
     #   { type: :action, body: 'def foo', action: 'foo' }
     #
-    # @param {String} line
-    # @param {Array<String>} actions
-    # @return {Hash}
+    # @param {String} line - A line of a file
+    # @param {Array<String>} actions - List of valid actions for this route
+    # @return {Hash} Parsed line
     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

@@ -9,11 +9,10 @@ module Chusaku
     #   {
     #     'users' => {
     #       'edit' => [
-    #         { verb: ['GET'], path: '/users/:id', name: ['edit_user'] }],
+    #         { verb: 'GET', path: '/users/:id', name: 'edit_user' }],
     #       'update' => [
-    #         { verb: ['PUT', 'PATCH'],
-    #           path: '/users', 
-    #           name: ['edit_user', 'edit_user2'] }]
+    #         { verb: 'PATCH', path: '/users', name: 'edit_user' },
+    #         { verb: 'PUT', path: '/users', name: 'edit_user' }]
     #     },
     #     'empanadas' => {
     #       'create' => [
@@ -61,7 +60,7 @@ module Chusaku
         paths = {}
 
         routes.each do |_controller, actions|
-          actions.each do |action, data|
+          actions.each do |_action, data|
             data.each do |datum|
               paths[datum[:path]] ||= datum[:name]
               datum[:name] ||= paths[datum[:path]]

data/lib/chusaku/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - bin/setup
 - chusaku.gemspec
 - lib/chusaku.rb
+- lib/chusaku/cli.rb
 - lib/chusaku/parser.rb
 - lib/chusaku/routes.rb
 - lib/chusaku/version.rb