chusaku 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7fd38001d891049886a95d54019ce4636dee3762e19f50e83bf7b0d53732cd6
-  data.tar.gz: a55e1bd009ad426e9258a6d6098d029d45bfb043a6736d9dda492a64b83d6ddf
+  metadata.gz: 519cb59d3970def8c48a1f9995f8208e2455d17c6f3061ff56ceed1e9cd2e593
+  data.tar.gz: 4de2d9aae8d0e9d97d998a53b47fd4428855ed7f5898926ae3e1f14d1b6fe90e
 SHA512:
-  metadata.gz: f135d7d2979a67bf3b9f883f5775511a78088b9c8468676da7d028551d4bfbc80ba89b44c182c88da98bd3adbed2deed425a97f2d5fe7b46fe6ebdbac85dc966
-  data.tar.gz: 7efc39dbd3e86b1f4672900535d1f3556b907d7c6f5220a61182a4aa3b44685a333d41c67fa78fc923e41df33b39ba49bc520743a3e9b5186179b86eb78cdbf7
+  metadata.gz: f619946e1d2a43aacec4d8bd2488d5b5af4c4e24f64bc233c294097ffc51e2c4bf3c3028530302397c026d099835d2587df1cc96356643102812bf93754a8265
+  data.tar.gz: 871f3aab82d32b5dff9dd508fbc8119ace1125cc88e14f0e36489b094228e3843bd47fa418a0314017fe974c5ee1a149fd86585f47f494e888de92e82fa3da54

data/README.md

@@ -7,10 +7,16 @@
 Add comments above your Rails actions that look like:
 
 ```ruby
-# @route [GET] /waterlilies/:id (waterlily)
+# @route GET /waterlilies/:id (waterlily)
 def show
   # ...
 end
+
+# @route PATCH /waterlilies/:id (waterlily)
+# @route PUT /waterlilies/:id (waterlily)
+def update
+  # ...
+end
 ```
 
 Based on your `routes.rb` file!
@@ -46,16 +52,14 @@ $ bundle exec chusaku
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/nshki/chusaku.
-
+Read the blog post explaining how the gem works at a high level:
+https://nshki.com/chusaku-a-controller-annotation-gem/.
 
-## License
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).

data/chusaku.gemspec

@@ -45,6 +45,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
 
-  spec.add_dependency 'rails', '> 4.2'
-  spec.add_dependency 'ruby-progressbar', '~> 1.10.1'
+  spec.add_dependency 'rails', '> 2.0'
 end

data/lib/chusaku.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'ruby-progressbar'
 require 'chusaku/version'
 require 'chusaku/parser'
 require 'chusaku/routes'
@@ -9,7 +8,7 @@ module Chusaku
   # The main method to run Chusaku. Annotate all actions in your Rails project
   # as follows:
   #
-  #   # @route [GET] /waterlilies/:id (waterlilies)
+  #   # @route GET /waterlilies/:id (waterlilies)
   #   def show
   #     # ...
   #   end
@@ -18,14 +17,8 @@ module Chusaku
     controller_pattern = 'app/controllers/**/*_controller.rb'
     controller_paths = Dir.glob(Rails.root.join(controller_pattern))
 
-    # Start progress bar.
-    progressbar = ProgressBar.create \
-      title: 'Chusaku',
-      total: controller_paths.count
-
     # Loop over all controller file paths.
     controller_paths.each do |path|
-      progressbar.increment
       controller = /controllers\/(.*)_controller\.rb/.match(path)[1]
       actions = routes[controller]
       next if actions.nil?
@@ -42,18 +35,31 @@ module Chusaku
         # Only proceed if we are currently looking at an action.
         next unless curr[:type] == :action
 
-        # Insert annotation comment.
+        # Fetch current action in routes.
         action = curr[:action]
-        annotation = annotate(routes[controller][action])
+        data = routes[controller][action]
+        next unless data.any?
+
+        # Add annotations.
         whitespace = /^(\s*).*$/.match(curr[:body])[1]
-        comment = "#{whitespace}# #{annotation}\n"
-        curr[:body] = comment + curr[:body]
+        data.reverse.each do |datum|
+          annotation = annotate(datum)
+          comment = "#{whitespace}# #{annotation}\n"
+          curr[:body] = comment + curr[:body]
+        end
       end
 
       # Write to file.
       parsed_content = parsed_file.map { |pf| pf[:body] }
       write(path, parsed_content.join)
     end
+
+    # Output results to user.
+    if controller_paths.any?
+      puts "Annotated #{controller_paths.join(', ')}"
+    else
+      puts "Nothing to annotate"
+    end
   end
 
   # Write given content to a file. If we're using an overridden version of File,
@@ -74,15 +80,15 @@ module Chusaku
 
   # Given a hash describing an action, generate an annotation in the form:
   #
-  #   @route [GET] /waterlilies/:id (waterlilies)
+  #   @route GET /waterlilies/:id (waterlilies)
   #
   # @param {Hash} action_info
   # @return {String}
   def self.annotate(action_info)
-    verbs = action_info[:verbs]
+    verb = action_info[:verb]
     path = action_info[:path]
     name = action_info[:name]
-    annotation = "@route [#{verbs.join(', ')}] #{path}"
+    annotation = "@route #{verb} #{path}"
     annotation += " (#{name})" unless name.nil?
     annotation
   end

data/lib/chusaku/routes.rb

@@ -8,27 +8,20 @@ module Chusaku
     #
     #   {
     #     'users' => {
-    #       'edit' => {
-    #         verbs: ['GET'],
-    #         path: '/users/:id',
-    #         name: 'edit_user'
-    #       },
-    #       'update' => {
-    #         verbs: ['PUT', 'PATCH'],
-    #         path: '/users', 
-    #         name: nil
-    #       }
+    #       'edit' => [
+    #         { verb: ['GET'], path: '/users/:id', name: ['edit_user'] }],
+    #       'update' => [
+    #         { verb: ['PUT', 'PATCH'],
+    #           path: '/users', 
+    #           name: ['edit_user', 'edit_user2'] }]
     #     },
     #     'empanadas' => {
-    #       'create' => {
-    #         verbs: ['POST'],
-    #         path: '/empanadas',
-    #         name: nil
-    #       }
+    #       'create' => [
+    #         { verb: 'POST', path: '/empanadas', name: nil }]
     #     }
     #   }
     #
-    # @return {Hash}
+    # @return {Hash} Routes hash
     def self.call
       routes = {}
 
@@ -38,28 +31,45 @@ module Chusaku
         action = defaults[:action]
 
         routes[controller] ||= {}
-        if routes[controller][action].nil?
-          routes[controller][action] = format_action(route)
-        else
-          routes[controller][action][:verbs].push(route.verb)
-        end
+        routes[controller][action] ||= []
+        routes[controller][action].push(format_route(route))
       end
 
-      routes
+      backfill_routes(routes)
     end
 
     private
 
       # Extract information of a given route.
       #
-      # @param {ActionDispatch::Journey::Route} route
-      # @return {Hash}
-      def self.format_action(route)
+      # @param {ActionDispatch::Journey::Route} route - Route given by Rails
+      # @return {Hash} Formatted hash for given route
+      def self.format_route(route)
         {
-          verbs: [route.verb],
+          verb: route.verb,
           path: route.path.spec.to_s.gsub('(.:format)', ''),
           name: route.name
         }
       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
+      def self.backfill_routes(routes)
+        paths = {}
+
+        routes.each do |_controller, actions|
+          actions.each do |action, data|
+            data.each do |datum|
+              paths[datum[:path]] ||= datum[:name]
+              datum[:name] ||= paths[datum[:path]]
+            end
+          end
+        end
+
+        routes
+      end
   end
 end

data/lib/chusaku/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2019-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: ruby-progressbar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.10.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '2.0'
 description: Annotate your Rails controllers with route info.
 email:
 - nishiki.liu@gmail.com