synvert 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9b185412549d5579efb12b82033786c586cc6f7
-  data.tar.gz: cce0f663f05dc9a481edb2f46c41d4e3e0ee2ed2
+  metadata.gz: 263f00fa376f7527f7915d2239c759f134ef5749
+  data.tar.gz: f7f14d873285dfc5092e48a959e2e199186b504a
 SHA512:
-  metadata.gz: 796bf4d58f0a30083a1522b70ff8d6cc746d5c982e0081df157a073278dc0e99c45e977390211adaea88979e12019b5da69972eac7fe667ff7df076ab4c2b5fe
-  data.tar.gz: 05d8b0d8c84a2141fa93c245f4d5a7be3095b86c1782bee74fa2656db3386f4e20e33c9d5e34d9d14e3853fd440869f8619fbbf5cce9c396a3edac4fe98705dd
+  metadata.gz: 9d294b839f70a0f8a8243dbba1e6fa8735322016d9292db89992933129065dcffcee790becee77218eaaa47bfc85b14191f8df1b04616403f7649f47c38de54d
+  data.tar.gz: 1a3654f5b903b1398bfedf7078381505b69c83cbac8600bd0f3c57251240c343a2ea061b7b71339af39dd1c44826327d0a3b879075d958de5a72f40149eeb0da

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.1.1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.0.14
+
+* Complement code comments.
+* Add MethodNotSupported and RewriterNotFound exceptions.
+* Add description dsl to define multi lines description.
+* Improve cli, query snippets and show snippet.
+* Process rewriter in sandbox mode.
+
 ## 0.0.13
 
 * Add keys and values rules for hash node

data/README.md

@@ -26,17 +26,19 @@ $ synvert -h
 Usage: synvert [project_path]
     -d, --load SNIPPET_PATHS         load additional snippets, snippet paths can be local file path or remote http url
     -l, --list                       list all available snippets
+    -q, --query QUERY                query specified snippets
+    -s, --show SNIPPET_NAME          show specified snippet description
     -r, --run SNIPPET_NAMES          run specified snippets
 ```
 
 e.g.
 
 ```
-$ synvert --list-snippets
+$ synvert -l
 ```
 
 ```
-$ synvert --run-snippets factory_girl_short_syntax,upgrade_rails_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
+$ synvert -r factory_girl_short_syntax,upgrade_rails_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
 ```
 
 ## Snippets

data/lib/synvert/cli.rb

@@ -1,36 +1,83 @@
 # coding: utf-8
 require 'optparse'
-require 'find'
 require 'open-uri'
 
 module Synvert
+  # Synvert command line interface.
   class CLI
+    # Initialize the cli and run.
+    #
+    # @param args [Array] arguments, default is ARGV.
+    # @return [Boolean] true if command runs successfully.
     def self.run(args = ARGV)
       new.run(args)
     end
 
+    # Initialize a CLI.
+    def initialize
+      @options = {command: 'run', snippet_paths: [], snippet_names: []}
+    end
+
+    # Run the CLI.
+    # @param args [Array] arguments.
+    # @return [Boolean] true if command runs successfully.
     def run(args)
-      Configuration.instance.set 'snippet_paths', []
-      Configuration.instance.set 'snippet_names', []
+      run_option_parser(args)
+      load_rewriters
 
-      command = :run
+      case @options[:command]
+      when 'list' then list_available_rewriters
+      when 'query' then query_available_rewriters
+      when 'show' then show_rewriter
+      else
+        @options[:snippet_names].each do |snippet_name|
+          puts "===== #{snippet_name} started ====="
+          rewriter = Rewriter.call snippet_name
+          puts rewriter.todo if rewriter.todo
+          puts "===== #{snippet_name} done ====="
+        end
+      end
+      true
+    rescue SystemExit
+      true
+    rescue Exception => e
+      puts "Error: " + e.message
+      false
+    end
+
+  private
+
+    # Run OptionParser to parse arguments.
+    def run_option_parser(args)
       optparse = OptionParser.new do |opts|
         opts.banner = "Usage: synvert [project_path]"
         opts.on '-d', '--load SNIPPET_PATHS', 'load additional snippets, snippet paths can be local file path or remote http url' do |snippet_paths|
-          Configuration.instance.set 'snippet_paths', snippet_paths.split(',')
+          @options[:snippet_paths] = snippet_paths.split(',').map(&:strip)
         end
         opts.on '-l', '--list', 'list all available snippets' do
-          command = :list
+          @options[:command] = 'list'
+        end
+        opts.on '-q', '--query QUERY', 'query specified snippets' do |query|
+          @options[:command] = 'query'
+          @options[:query] = query
+        end
+        opts.on '-s', '--show SNIPPET_NAME', 'show specified snippet description' do |snippet_name|
+          @options[:command] = 'show'
+          @options[:snippet_name] = snippet_name
         end
         opts.on '-r', '--run SNIPPET_NAMES', 'run specified snippets' do |snippet_names|
-          Configuration.instance.set 'snippet_names', snippet_names.split(',')
+          @options[:snippet_names] = snippet_names.split(',').map(&:strip)
         end
       end
       paths = optparse.parse(args)
       Configuration.instance.set :path, paths.first || Dir.pwd
+    end
 
+    # Load all rewriters.
+    def load_rewriters
       Dir.glob(File.join(File.dirname(__FILE__), 'snippets/**/*.rb')).each { |file| eval(File.read(file)) }
-      Configuration.instance.get('snippet_paths').each do |snippet_path|
+
+      @options[:snippet_paths].each do |snippet_path|
         if snippet_path =~ /^http/
           uri = URI.parse snippet_path
           eval(uri.read)
@@ -38,19 +85,41 @@ module Synvert
           eval(File.read(snippet_path))
         end
       end
-      Configuration.instance.get('snippet_names').each do |snippet_name|
-        puts "===== #{snippet_name} started ====="
-        rewriter = Rewriter.call snippet_name
-        puts rewriter.todo_list if rewriter.todo_list
-        puts "===== #{snippet_name} done ====="
+    end
+
+    # List and print all available rewriters.
+    def list_available_rewriters
+      Rewriter.availables.each do |rewriter|
+        print rewriter.name + "  "
       end
+      puts
+    end
+
+    # Query and print available rewriters.
+    def query_available_rewriters
+      Rewriter.availables.each do |rewriter|
+        if rewriter.name.include? @options[:query]
+          print rewriter.name + "  "
+        end
+      end
+      puts
+    end
 
-      if :list == command
-        puts "%-40s %s" % ['name', 'description']
-        puts "%-40s %s" % ['----', '-----------']
-        Rewriter.availables.each do |rewriter|
-          puts "%-40s %s" % [rewriter.name, rewriter.description]
+    # Show and print one rewriter.
+    def show_rewriter
+      rewriter = Rewriter.fetch(@options[:snippet_name])
+      if rewriter
+        rewriter.process_with_sandbox
+        puts rewriter.description
+        rewriter.sub_snippets.each do |sub_rewriter|
+          puts
+          puts "=" * 80
+          puts "snippet: #{sub_rewriter.name}"
+          puts "=" * 80
+          puts sub_rewriter.description
         end
+      else
+        puts "snippet #{@options[:snippet_name]} not found"
       end
     end
   end

data/lib/synvert/configuration.rb

@@ -2,13 +2,22 @@
 require 'singleton'
 
 module Synvert
+  # Synvert global configuration.
   class Configuration < Hash
     include Singleton
 
+    # Set the configuration.
+    #
+    # @param key [String] configuration key.
+    # @param value [Object] configuration value.
     def set(key, value)
       self[key] = value
     end
 
+    # Get the configuration.
+    #
+    # @param key [String] configuration key.
+    # @return [Object] configuration value.
     def get(key)
       self[key]
     end

data/lib/synvert/exceptions.rb

@@ -0,0 +1,13 @@
+module Synvert
+  # Rewriter not found exception.
+  class RewriterNotFound < Exception
+  end
+
+  # Gemfile.lock not found exception.
+  class GemfileLockNotFound < Exception
+  end
+
+  # Method not supported exception.
+  class MethodNotSupported < Exception
+  end
+end

data/lib/synvert/node_ext.rb

@@ -1,4 +1,9 @@
+# Parser::AST::Node monkey patch.
 class Parser::AST::Node
+  # Get name node of :class, :module, :def and :defs node.
+  #
+  # @return [Parser::AST::Node] name node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def name
     case self.type
     when :class, :module, :def
@@ -6,26 +11,38 @@ class Parser::AST::Node
     when :defs
       self.children[1]
     else
-      raise NotImplementedError.new "name is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "name is not handled for #{self.inspect}"
     end
   end
 
+  # Get receiver node of :send node.
+  #
+  # @return [Parser::AST::Node] receiver node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def receiver
     if :send == self.type
       self.children[0]
     else
-      raise NotImplementedError.new "receiver is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "receiver is not handled for #{self.inspect}"
     end
   end
 
+  # Get message node of :send node.
+  #
+  # @return [Parser::AST::Node] mesage node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def message
     if :send == self.type
       self.children[1]
     else
-      raise NotImplementedError.new "message is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "message is not handled for #{self.inspect}"
     end
   end
 
+  # Get arguments node of :send, :block or :defined? node.
+  #
+  # @return [Array<Parser::AST::Node>] arguments node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def arguments
     case self.type
     when :send
@@ -35,18 +52,26 @@ class Parser::AST::Node
     when :defined?
       self.children
     else
-      raise NotImplementedError.new "arguments is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "arguments is not handled for #{self.inspect}"
     end
   end
 
+  # Get caller node of :block node.
+  #
+  # @return [Parser::AST::Node] caller node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def caller
     if :block == self.type
       self.children[0]
     else
-      raise NotImplementedError.new "caller is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "caller is not handled for #{self.inspect}"
     end
   end
 
+  # Get body node of :begin or :block node.
+  #
+  # @return [Array<Parser::AST::Node>] body node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def body
     case self.type
     when :begin
@@ -54,60 +79,91 @@ class Parser::AST::Node
     when :block
       :begin == self.children[2].type ? self.children[2].children : [self.children[2]]
     else
-      raise NotImplementedError.new "body is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "body is not handled for #{self.inspect}"
     end
   end
 
+  # Get condition node of :if node.
+  #
+  # @return [Parser::AST::Node] condition node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def condition
     if :if == self.type
       self.children[0]
     else
-      raise NotImplementedError.new "condition is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "condition is not handled for #{self.inspect}"
     end
   end
 
+  # Get keys node of :hash node.
+  #
+  # @return [Array<Parser::AST::Node>] keys node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def keys
     if :hash == self.type
       self.children.map { |child| child.children[0] }
     else
-      raise NotImplementedError.new "keys is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "keys is not handled for #{self.inspect}"
     end
   end
 
+  # Get values node of :hash node.
+  #
+  # @return [Array<Parser::AST::Node>] values node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def values
     if :hash == self.type
       self.children.map { |child| child.children[1] }
     else
-      raise NotImplementedError.new "keys is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "keys is not handled for #{self.inspect}"
     end
   end
 
+  # Get key node of hash :pair node.
+  #
+  # @return [Parser::AST::Node] key node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def key
     if :pair == self.type
       self.children.first
     else
-      raise NotImplementedError.new "key is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "key is not handled for #{self.inspect}"
     end
   end
 
+  # Get value node of hash :pair node.
+  #
+  # @return [Parser::AST::Node] value node.
+  # @raise [Synvert::MethodNotSupported] if calls on other node.
   def value
     if :pair == self.type
       self.children.last
     else
-      raise NotImplementedError.new "value is not handled for #{self.inspect}"
+      raise Synvert::MethodNotSupported.new "value is not handled for #{self.inspect}"
     end
   end
 
+  # Get the source code of current node.
+  #
+  # @param instance [Synvert::Rewriter::Instance]
+  # @return [String] source code.
   def source(instance)
     if self.loc.expression
       instance.current_source[self.loc.expression.begin_pos...self.loc.expression.end_pos]
     end
   end
 
+  # Get the indent of current node.
+  #
+  # @return [Integer] indent.
   def indent
     self.loc.expression.column
   end
 
+  # Recursively iterate all child nodes of current node.
+  #
+  # @yield [child] Gives a child node.
+  # @yieldparam child [Parser::AST::Node] child node
   def recursive_children
     self.children.each do |child|
       if Parser::AST::Node === child
@@ -117,6 +173,11 @@ class Parser::AST::Node
     end
   end
 
+  # Match current node with rules.
+  #
+  # @param instance [Synvert::Rewriter::Instance] used to get crrent source code.
+  # @param rules [Hash] rules to match.
+  # @return true if matches.
   def match?(instance, rules)
     flat_hash(rules).keys.all? do |multi_keys|
       if multi_keys.last == :any
@@ -135,6 +196,13 @@ class Parser::AST::Node
     end
   end
 
+  # Get rewritten source code.
+  # @example
+  #   node.rewritten_source("create({{arguments}})") #=> "create(:post)"
+  #
+  # @param code [String] raw code.
+  # @return [String] rewritten code, replace string in block {{ }} in raw code.
+  # @raise [Synvert::MethodNotSupported] if string in block {{ }} does not support.
   def rewritten_source(code)
     code.gsub(/{{(.*?)}}/m) do
       evaluated = self.instance_eval $1
@@ -152,13 +220,20 @@ class Parser::AST::Node
       when NilClass
         'nil'
       else
-        raise NotImplementedError.new "rewritten_source is not handled for #{evaluated.inspect}"
+        raise Synvert::MethodNotSupported.new "rewritten_source is not handled for #{evaluated.inspect}"
       end
     end
   end
 
 private
 
+  # Compare actual value with expected value.
+  #
+  # @param instance [Synvert::Rewriter::Instance] used to get source code.
+  # @param actual [Object] actual value.
+  # @param expected [Object] expected value.
+  # @return [Integer] -1, 0 or 1.
+  # @raise [Synvert::MethodNotSupported] if expected class is not supported.
   def match_value?(instance, actual, expected)
     case expected
     when Symbol
@@ -196,10 +271,17 @@ private
     when Parser::AST::Node
       actual == expected
     else
-      raise NotImplementedError.new "#{expected.class} is not handled for match_value?"
+      raise Synvert::MethodNotSupported.new "#{expected.class} is not handled for match_value?"
     end
   end
 
+  # Convert a hash to flat one.
+  #
+  # @example
+  #   flat_hash(type: 'block', caller: {type: 'send', receiver: 'RSpec'})
+  #     #=> {[:type] => 'block', [:caller, :type] => 'send', [:caller, :receiver] => 'RSpec'}
+  # @param h [Hash] original hash.
+  # @return flatten hash.
   def flat_hash(h, k = [])
     new_hash = {}
     h.each_pair do |key, val|
@@ -212,6 +294,12 @@ private
     new_hash
   end
 
+  # Get actual value from the node.
+  #
+  # @param node [Parser::AST::Node]
+  # @param instance [Synvert::Rewriter::Instance]
+  # @param multi_keys [Array<Symbol>]
+  # @return [Object] actual value.
   def actual_value(node, instance, multi_keys)
     multi_keys.inject(node) { |n, key|
       if n
@@ -220,6 +308,11 @@ private
     }
   end
 
+  # Get expected value from rules.
+  #
+  # @param rules [Hash]
+  # @param multi_keys [Array<Symbol>]
+  # @return [Object] expected value.
   def expected_value(rules, multi_keys)
     multi_keys.inject(rules) { |o, key| o[key] }
   end