synvert-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee3374fb46922e5b590efa36db97d72a9e44abce
+  data.tar.gz: 3fe3c251671150387708c7e882078198956443fe
+SHA512:
+  metadata.gz: 6422babf1c7b32bf5c5201aa8eb8e56fb4cfe7b7082e5ab0c7e0d3cfd6fec55250475bcbf789c71cc25dcbcf4364e74d7e2c7aadf6e4c967c303ea8e26be9ed7
+  data.tar.gz: 71d807430eb04e21a047625d59786be237ef6f4de3465095a5a9524d7a5384eb001ddf6bee14b7a5092dbfd2580385941449aea62e8f7b7a22432da7e8c05fd5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+* Abstract from synvert

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in synvert.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Richard Huang
+
+MIT License
+
+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,38 @@
+# Synvert::Core
+
+[![Build Status](https://secure.travis-ci.org/xinminlabs/synvert-core.png)](http://travis-ci.org/xinminlabs/synvert-core)
+[![Coverage Status](https://coveralls.io/repos/xinminlabs/synvert-core/badge.png?branch=master)](https://coveralls.io/r/xinminlabs/synvert-core)
+[![Gem Version](https://badge.fury.io/rb/synvert-core.png)](http://badge.fury.io/rb/synvert-core)
+
+synvert-core provides a dsl to convert ruby source code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'synvert-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synvert-core
+
+
+## Documentation
+
+[Website][1]
+[RDoc][2]
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/synvert-core/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[1]: http://xinminlabs.github.io/synvert/
+[2]: http://rubydoc.info/github/xinminlabs/synvert-core/master/frames

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/synvert/core.rb

@@ -0,0 +1,24 @@
+require "synvert/core/version"
+
+# coding: utf-8
+require "synvert/core/version"
+require 'bundler'
+require 'parser'
+require 'parser/current'
+require 'ast'
+require 'active_support/inflector'
+require 'synvert/core/node_ext'
+
+module Synvert
+  module Core
+    autoload :Configuration, 'synvert/core/configuration'
+    autoload :Rewriter, 'synvert/core/rewriter'
+    autoload :RewriterNotFound, 'synvert/core/exceptions'
+    autoload :GemfileLockNotFound, 'synvert/core/exceptions'
+    autoload :MethodNotSupported, 'synvert/core/exceptions'
+  end
+end
+
+module Synvert
+  Rewriter = Core::Rewriter
+end

data/lib/synvert/core/cli.rb

@@ -0,0 +1,147 @@
+# coding: utf-8
+require 'optparse'
+require 'open-uri'
+
+module Synvert::Core
+  # 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: []}
+      Configuration.instance.set :skip_files, []
+    end
+
+    # Run the CLI.
+    # @param args [Array] arguments.
+    # @return [Boolean] true if command runs successfully.
+    def run(args)
+      run_option_parser(args)
+      load_rewriters
+
+      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 Parser::SyntaxError => e
+      puts "Syntax error: #{e.message}"
+      puts "file #{e.diagnostic.location.source_buffer.name}"
+      puts "line #{e.diagnostic.location.line}"
+      false
+    rescue Exception => e
+      print "Error: "
+      p e
+      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|
+          @options[:snippet_paths] = snippet_paths.split(',').map(&:strip)
+        end
+        opts.on '-l', '--list', 'list all available snippets' do
+          @options[:command] = 'list'
+        end
+        opts.on '-q', '--query QUERY', 'query specified snippets' do |query|
+          @options[:command] = 'query'
+          @options[:query] = query
+        end
+        opts.on '--skip FILE_PATTERNS', 'skip specified files or directories, separated by comma, e.g. app/models/post.rb,vendor/plugins/**/*.rb' do |file_patterns|
+          @options[:skip_file_patterns] = file_patterns.split(',')
+        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|
+          @options[:snippet_names] = snippet_names.split(',').map(&:strip)
+        end
+        opts.on '-v', '--version', 'show this version' do
+          puts Synvert::Core::VERSION
+          exit
+        end
+      end
+      paths = optparse.parse(args)
+      Configuration.instance.set :path, paths.first || Dir.pwd
+      if @options[:skip_file_patterns] && !@options[:skip_file_patterns].empty?
+        skip_files = @options[:skip_file_patterns].map { |file_pattern|
+          full_file_pattern = File.join(Configuration.instance.get(:path), file_pattern)
+          Dir.glob(full_file_pattern)
+        }.flatten
+        Configuration.instance.set :skip_files, skip_files
+      end
+    end
+
+    # Load all rewriters.
+    def load_rewriters
+      Dir.glob(File.join(File.dirname(__FILE__), 'snippets/**/*.rb')).each { |file| eval(File.read(file)) }
+
+      @options[:snippet_paths].each do |snippet_path|
+        if snippet_path =~ /^http/
+          uri = URI.parse snippet_path
+          eval(uri.read)
+        else
+          eval(File.read(snippet_path))
+        end
+      end
+    end
+
+    # List and print all available rewriters.
+    def list_available_rewriters
+      Rewriter.availables.each do |rewriter|
+        print rewriter.name.to_s + "  "
+      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
+
+    # 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
+end

data/lib/synvert/core/configuration.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'singleton'
+
+module Synvert::Core
+  # 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
+  end
+end

data/lib/synvert/core/exceptions.rb

@@ -0,0 +1,13 @@
+module Synvert::Core
+  # 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/core/node_ext.rb

@@ -0,0 +1,319 @@
+# 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::Core::MethodNotSupported] if calls on other node.
+  def name
+    case self.type
+    when :class, :module, :def
+      self.children[0]
+    when :defs
+      self.children[1]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def receiver
+    if :send == self.type
+      self.children[0]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def message
+    if :send == self.type
+      self.children[1]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def arguments
+    case self.type
+    when :send
+      self.children[2..-1]
+    when :block
+      self.children[1].children
+    when :defined?
+      self.children
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def caller
+    if :block == self.type
+      self.children[0]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def body
+    case self.type
+    when :begin
+      self.children
+    when :block
+      :begin == self.children[2].type ? self.children[2].children : [self.children[2]]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def condition
+    if :if == self.type
+      self.children[0]
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def keys
+    if :hash == self.type
+      self.children.map { |child| child.children[0] }
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def values
+    if :hash == self.type
+      self.children.map { |child| child.children[1] }
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def key
+    if :pair == self.type
+      self.children.first
+    else
+      raise Synvert::Core::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::Core::MethodNotSupported] if calls on other node.
+  def value
+    if :pair == self.type
+      self.children.last
+    else
+      raise Synvert::Core::MethodNotSupported.new "value is not handled for #{self.inspect}"
+    end
+  end
+
+  # Get the source code of current node.
+  #
+  # @param instance [Synvert::Core::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
+        yield child
+        child.recursive_children { |c| yield c }
+      end
+    end
+  end
+
+  # Match current node with rules.
+  #
+  # @param instance [Synvert::Core::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
+        actual_values = actual_value(self, instance, multi_keys[0...-1])
+        expected = expected_value(rules, multi_keys)
+        actual_values.any? { |actual| match_value?(instance, actual, expected) }
+      elsif multi_keys.last == :not
+        actual = actual_value(self, instance, multi_keys[0...-1])
+        expected = expected_value(rules, multi_keys)
+        !match_value?(instance, actual, expected)
+      else
+        actual = actual_value(self, instance, multi_keys)
+        expected = expected_value(rules, multi_keys)
+        match_value?(instance, actual, expected)
+      end
+    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::Core::MethodNotSupported] if string in block {{ }} does not support.
+  def rewritten_source(code)
+    code.gsub(/{{(.*?)}}/m) do
+      evaluated = self.instance_eval $1
+      case evaluated
+      when Parser::AST::Node
+        source = evaluated.loc.expression.source_buffer.source
+        source[evaluated.loc.expression.begin_pos...evaluated.loc.expression.end_pos]
+      when Array
+        if evaluated.size > 0
+          source = evaluated.first.loc.expression.source_buffer.source
+          source[evaluated.first.loc.expression.begin_pos...evaluated.last.loc.expression.end_pos]
+        end
+      when String
+        evaluated
+      when NilClass
+        'nil'
+      else
+        raise Synvert::Core::MethodNotSupported.new "rewritten_source is not handled for #{evaluated.inspect}"
+      end
+    end
+  end
+
+private
+
+  # Compare actual value with expected value.
+  #
+  # @param instance [Synvert::Core::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::Core::MethodNotSupported] if expected class is not supported.
+  def match_value?(instance, actual, expected)
+    case expected
+    when Symbol
+      if Parser::AST::Node === actual
+        actual.source(instance) == ":#{expected}"
+      else
+        actual.to_sym == expected
+      end
+    when String
+      if Parser::AST::Node === actual
+        actual.source(instance) == expected || actual.source(instance)[1...-1] == expected
+      else
+        actual.to_s == expected
+      end
+    when Regexp
+      if Parser::AST::Node === actual
+        actual.source(instance) =~ Regexp.new(expected.to_s, Regexp::MULTILINE)
+      else
+        actual.to_s =~ Regexp.new(expected.to_s, Regexp::MULTILINE)
+      end
+    when Array
+      actual.zip(expected).all? { |a, e| match_value?(instance, a, e) }
+    when NilClass
+      actual.nil?
+    when Numeric
+      if Parser::AST::Node === actual
+        actual.children[0] == expected
+      else
+        actual == expected
+      end
+    when TrueClass
+      :true == actual.type
+    when FalseClass
+      :false == actual.type
+    when Parser::AST::Node
+      actual == expected
+    else
+      raise Synvert::Core::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|
+      if val.is_a?(Hash)
+        new_hash.merge!(flat_hash(val, k + [key]))
+      else
+        new_hash[k + [key]] = val
+      end
+    end
+    new_hash
+  end
+
+  # Get actual value from the node.
+  #
+  # @param node [Parser::AST::Node]
+  # @param instance [Synvert::Core::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
+        key == :source ? n.send(key, instance) : n.send(key)
+      end
+    }
+  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
+end