chusaku 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 243d9f7340595bb5fc64d98e587210773957dc1b41b1203f8736073c683dc5f0
+  data.tar.gz: c5ec7b5619878468e84cd959f98c05a954eb6b4bfeb5123df2044c4719407ff6
+SHA512:
+  metadata.gz: 1f335d87b266244f0fa2943aadc062d79afedc62280c0466d2e84004af797c00003e70784b32dc2b202a3a1f5c3200396e43abef0109e222784dfd992a163fae
+  data.tar.gz: a42ab21ab2f234b2692d3ee595becef92b399e2d2ee63ce16e837abe12a3971f5eed4dcd521debd5de69d7a0b132443076fdf7cb2daf583db33d4a598b3c7ced

data/.circleci/config.yml

@@ -0,0 +1,29 @@
+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/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Layout/IndentationConsistency:
+  EnforcedStyle: rails
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chusaku.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nishiki Liu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Chusaku
+
+| Build |
+|-------|
+|[![CircleCI](https://circleci.com/gh/nshki/chusaku.svg?style=svg&circle-token=e1917972632f242932171de0ca5443148e83151c)](https://circleci.com/gh/nshki/chusaku)|
+
+Add comments above your Rails actions that look like:
+
+```ruby
+# @route GET /waterlilies/:id (waterlily)
+def show
+  # ...
+end
+```
+
+Based on your `routes.rb` file!
+
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+group :development do
+  # ...
+  gem 'chusaku', require: false
+  # ...
+end
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+
+## Usage
+
+From the root of your Rails application, run:
+
+```
+$ 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/chusaku

@@ -0,0 +1,22 @@
+#!/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
+  # Use project's bundle.
+  require 'bundler'
+  Bundler.setup
+
+  # Use project's environment.
+  require 'rake'
+  load './Rakefile'
+  Rake::Task[:environment].invoke
+rescue StandardError
+end
+
+require 'chusaku'
+Chusaku.annotate

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'chusaku'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chusaku.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chusaku/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'chusaku'
+  spec.version = Chusaku::VERSION
+  spec.authors = ['Nishiki Liu']
+  spec.email = ['nishiki.liu@gmail.com']
+
+  spec.summary = 'Annotate your Rails controllers with route info.'
+  spec.description = 'Annotate your Rails controllers with route info.'
+  spec.homepage = 'https://github.com/nshki/chusaku'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  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', '~> 10.0'
+
+  spec.add_dependency 'rails', '> 4.2'
+end

data/lib/chusaku/parser.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Chusaku
+  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 } ]
+    #
+    # @param {String} path
+    # @param {Array<String>} actions
+    # @return {Array<Hash>}
+    def self.call(path:, actions:)
+      groups = []
+      group = {}
+
+      File.open(path, 'r').each_line do |line|
+        parsed_line = parse_line(line: line, actions: actions)
+
+        if group[:type] != parsed_line[:type]
+          # 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
+        end
+      end
+
+      # Push the last group onto the array and return.
+      groups.push(group)
+      groups
+    end
+
+    # Given a line and actions, returns the line's type:
+    #
+    #   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:
+    #
+    #   { type: :action, body: 'def foo', action: 'foo' }
+    #
+    # @param {String} line
+    # @param {Array<String>} actions
+    # @return {Hash}
+    def self.parse_line(line:, actions:)
+      comment_match = /^\s*#.*$/.match(line)
+      def_match = /^\s*def\s+(\w*)\s*\w*.*$/.match(line)
+
+      if !comment_match.nil?
+        { type: :comment, body: line, action: nil }
+      elsif !def_match.nil? && actions.include?(def_match[1])
+        { type: :action, body: line, action: def_match[1] }
+      else
+        { type: :code, body: line, action: nil }
+      end
+    end
+  end
+end

data/lib/chusaku/routes.rb

@@ -0,0 +1,39 @@
+# 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: 'PUT', path: '/users',     name: nil }
+    #     },
+    #     'empanadas' => {
+    #       'create' => { verb: 'POST', path: '/empanadas', name: nil }
+    #     }
+    #   }
+    #
+    # @return {Hash}
+    def self.call
+      routes = {}
+
+      Rails.application.routes.routes.each do |route|
+        defaults = route.defaults
+        action = defaults[:action]
+
+        routes[defaults[:controller]] ||= {}
+        routes[defaults[:controller]][action] =
+          {
+            verb: route.verb,
+            path: route.path.spec.to_s.gsub('(.:format)', ''),
+            name: route.name
+          }
+      end
+
+      routes
+    end
+  end
+end

data/lib/chusaku/version.rb

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

data/lib/chusaku.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'chusaku/version'
+
+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
+  def self.call
+    puts 'Chusaku starting...'
+    routes = Chusaku::Routes.call
+    controllers = 'app/controllers/**/*_controller.rb'
+
+    # Loop over all controller file paths.
+    Dir.glob(Rails.root.join(controllers)).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.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
+
+        # Only proceed if we are currently looking at an action.
+        next unless curr[:type] == :action
+
+        # Insert annotation comment.
+        action = curr[:action]
+        annotation = annotate(routes[controller][action])
+        whitespace = /^(\s*).*$/.match(curr[:body])[1]
+        comment = "#{whitespace}# #{annotation}\n"
+        curr[:body] = comment + curr[:body]
+      end
+
+      # Write to file.
+      parsed_content = parsed_file.map { |pf| pf[:body] }
+      write(path, parsed_content.join)
+      puts "Annotated #{controller}"
+    end
+
+    puts 'Chusaku finished!'
+  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
+  # @return {void}
+  def self.write(path, content)
+    File.open(path, 'r+') do |file|
+      if file.respond_to?(:test_write)
+        file.test_write(content, path)
+      else
+        file.write(content)
+      end
+    end
+  end
+
+  # Given a hash describing an action, generate an annotation in the form:
+  #
+  #   @route GET /waterlilies/:id (waterlilies)
+  #
+  # @param {Hash} action_info
+  # @return {String}
+  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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: chusaku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nishiki Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Annotate your Rails controllers with route info.
+email:
+- nishiki.liu@gmail.com
+executables:
+- chusaku
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/chusaku
+- bin/console
+- bin/setup
+- chusaku.gemspec
+- lib/chusaku.rb
+- lib/chusaku/parser.rb
+- lib/chusaku/routes.rb
+- lib/chusaku/version.rb
+homepage: https://github.com/nshki/chusaku
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Annotate your Rails controllers with route info.
+test_files: []