synvert 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aefc7425f57552493435e868b3bbaae081a97ba
+  data.tar.gz: d679d3dd07f996bf238f540a842c9f99a758d7d4
+SHA512:
+  metadata.gz: b213405f6988e2041a4e087128319ed1cc5fead180dc58a269f6852c426f50b5bb5b322fc93839a2055d6d5f01809086ba6bd3d95052c47fcf64396af60bc6bc
+  data.tar.gz: 630fbc831d76015d8ca0ea2ff958a87efab5a7be7ff5afd1d9d3a3a766039ad5ad59d67c8be6b7f969f48e96dff58cc65e28499ba5eea3ba00845716026e1f5d

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/Gemfile

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

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,29 @@
+# Synvert
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'synvert'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synvert
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/bin/synvert

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'synvert'
+require 'synvert/cli'
+
+result = Synvert::CLI.run
+exit(result ? 0 : 1)

data/lib/synvert.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+require "synvert/version"
+require 'parser'
+require 'parser/current'
+require 'ast'
+
+module Synvert
+  autoload :BaseConverter, 'synvert/base_converter'
+  autoload :CheckingVisitor, 'synvert/checking_visitor'
+  autoload :SexpHelper, 'synvert/sexp_helper'
+  module FactoryGirl
+    autoload :SyntaxMethodsConverter, 'synvert/factory_girl/syntax_methods_converter'
+  end
+end

data/lib/synvert/base_converter.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+module Synvert
+  class BaseConverter < Parser::Rewriter
+    include AST::Sexp
+    include SexpHelper
+
+    attr_reader :filename
+
+    def rewrite(source_buffer, ast)
+      @filename = source_buffer.name
+
+      new_ast = AST::Node.new(:program, [ast])
+      super(source_buffer, new_ast)
+    end
+
+    def append_to(node, content)
+      if node.children.last
+        indent = indent(node.children.last)
+        insert_after node.children.last.loc.expression, "\n#{' '*indent}#{content}"
+      else
+        indent = indent(node) + 2
+        insert_after node.children.first.loc.expression, "\n#{' '*indent}#{content}"
+      end
+    end
+
+    def append_after(node, content)
+      indent = indent(node)
+      insert_after node.loc.expression, "\n#{' '*indent}#{content}"
+    end
+
+    def indent(node)
+      node.loc.expression.column
+    end
+  end
+end

data/lib/synvert/checking_visitor.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+module Synvert
+  class CheckingVisitor
+    attr_reader :converters
+
+    def initialize(options={})
+      @converters = options[:converters] || [
+        Synvert::FactoryGirl::SyntaxMethodsConverter.new
+      ]
+    end
+
+    def convert_file(filename)
+      source = File.read filename
+      converted_source = convert(filename, source)
+      if source != converted_source
+        File.write(filename, converted_source)
+      end
+    end
+
+    def convert(filename, source)
+      source_buffer = Parser::Source::Buffer.new filename
+      source_buffer.source = source
+
+      parser = Parser::CurrentRuby.new
+      ast = parser.parse source_buffer
+
+      converted_source = source
+      @converters.each do |converter|
+        if Array(converter.interesting_files).any? { |file_pattern| filename =~ file_pattern }
+          converted_source = converter.rewrite(source_buffer, ast)
+        end
+      end
+
+      converted_source
+    end
+  end
+end

data/lib/synvert/cli.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+require 'find'
+
+module Synvert
+  class CLI
+    def self.run
+      new.run
+    end
+
+    def initialize
+      @checking_visitor = CheckingVisitor.new
+    end
+
+    def run
+      Find.find(".") do |path|
+        if FileTest.directory?(path)
+          next
+        else
+          @checking_visitor.convert_file(path) if path =~ /\.rb$/
+        end
+      end
+    end
+  end
+end

data/lib/synvert/factory_girl/syntax_methods_converter.rb

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+module Synvert
+  module FactoryGirl
+    class SyntaxMethodsConverter < BaseConverter
+      def interesting_files
+        [/spec\/spec_helper\.rb/, /spec\/support\/.*\.rb/, /spec\/.*_spec\.rb/] +
+          [/test\/test_helper\.rb/, /test\/support\/.*\.rb/, /test\/.*_test\.rb/] +
+          [/features\/support\/env\.rb/, /features\/.*\.rb/]
+      end
+
+      def on_class(node)
+        if (name(node) == to_ast("ActiveSupport::TestCase") || name(node) == to_ast("Test::Unit::TestCase")) &&
+           !contains_statement?(body(node), "include FactoryGirl::Syntax::Methods")
+          append_to node, "include FactoryGirl::Syntax::Methods"
+        end
+
+        super
+      end
+
+      def on_block(node)
+        if receiver(node) == to_ast("RSpec") &&
+           message(node) == :configure &&
+           !contains_statement?(body(node), "config.include FactoryGirl::Syntax::Methods")
+          append_to node, "config.include FactoryGirl::Syntax::Methods"
+        end
+
+        super
+      end
+
+      def on_send(node)
+        if receiver(node) == to_ast("FactoryGirl") &&
+           [:create, :build, :attributes_for, :build_stubbed, :create_list, :build_list, :create_pair, :build_pair].include?(message(node))
+          replace node.loc.expression.resize("FactoryGirl.".size), ''
+        end
+
+        super
+      end
+
+      def on_program(node)
+        if filename == "features/support/env.rb" && !contains_statement?(node, "World(FactoryGirl::Syntax::Methods)")
+          append_after node.children[0], "World(FactoryGirl::Syntax::Methods)"
+        end
+
+        node.updated(nil, process_all(node))
+      end
+    end
+  end
+end

data/lib/synvert/sexp_helper.rb

@@ -0,0 +1,51 @@
+module Synvert
+  module SexpHelper
+    def name(node)
+      case node.type
+      when :class
+        node.children[0]
+      else
+      end
+    end
+
+    def body(node)
+      case node.type
+      when :class
+        node.children[1]
+      when :block
+        node.children[2]
+      else
+      end
+    end
+
+    def receiver(node)
+      case node.type
+      when :send
+        node.children[0]
+      when :block
+        receiver(node.children[0])
+      else
+      end
+    end
+
+    def message(node)
+      case node.type
+      when :send
+        node.children[1]
+      when :block
+        message(node.children[0])
+      else
+      end
+    end
+
+    def contains_statement?(node, statement)
+      node && (node.type == :begin ? node.children : [node]).any? { |child_node|
+        child_node == to_ast(statement)
+      }
+    end
+
+    def to_ast(str)
+      Parser::CurrentRuby.parse(str)
+    end
+  end
+end

data/lib/synvert/version.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+
+module Synvert
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'synvert'
+
+Dir[File.join(File.dirname(__FILE__), 'support', '*')].each do |path|
+  require path
+end
+
+require 'mocha/api'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/support/shared_context.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+shared_context "expect to convert" do
+  it "expects to convert" do
+    converter = described_class.new
+    source_buffer = Parser::Source::Buffer.new filename
+    source_buffer.source = source
+
+    parser = Parser::CurrentRuby.new
+    ast = parser.parse source_buffer
+
+    expect(converter.rewrite(source_buffer, ast)).to eq expected_source
+  end
+end
+
+shared_context "not expect to convert" do
+  it "does not expect to convert" do
+    converter = described_class.new
+    source_buffer = Parser::Source::Buffer.new filename
+    source_buffer.source = source
+
+    parser = Parser::CurrentRuby.new
+    ast = parser.parse source_buffer
+
+    expect(converter.rewrite(source_buffer, ast)).to eq source
+  end
+end
+
+shared_context "interesting file" do
+  it "interests file" do
+    converter = described_class.new
+    expect(converter.interesting_files.any? { |file_pattern| filename =~ file_pattern }).to eq true
+  end
+end
+
+shared_context "not interesting file" do
+  it "does not interest file" do
+    converter = described_class.new
+    expect(converter.interesting_files.none? { |file_pattern| filename =~ file_pattern }).to eq true
+  end
+end

data/spec/synvert/checking_visitor_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+require 'spec_helper'
+
+module Synvert
+  describe CheckingVisitor do
+    subject { CheckingVisitor.new }
+
+    context "initialize" do
+      it "factory_girl syntax methods converter is one of default converts" do
+        expect(subject.converters.first).is_a? FactoryGirl::SyntaxMethodsConverter
+      end
+    end
+
+    context "#convert_file" do
+      it "writes converted source" do
+        File.expects(:read).with('test.rb').returns('source')
+        subject.expects(:convert).with('test.rb', 'source').returns('converted source')
+        File.expects(:write).with('test.rb', 'converted source')
+        subject.convert_file 'test.rb'
+      end
+
+      it "doesn't write if converted source is same to source" do
+        File.expects(:read).with('test.rb').returns('source')
+        subject.expects(:convert).with('test.rb', 'source').returns('source')
+        File.expects(:write).never
+        subject.convert_file 'test.rb'
+      end
+    end
+
+    context "#convert" do
+      it "gets converted source" do
+        subject.converters.first.stubs(:rewrite).returns("converted source")
+        expect(subject.convert("spec/spec_helper.rb", "source")).to eq "converted source"
+      end
+
+      it "gets source if none of converter works" do
+        subject.converters.first.stubs(:rewrite).returns("converted source")
+        expect(subject.convert("(string)", "source")).to eq "source"
+      end
+    end
+  end
+end

data/spec/synvert/factory_girl/syntax_methods_converter_spec.rb

@@ -0,0 +1,148 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe Synvert::FactoryGirl::SyntaxMethodsConverter do
+  describe "#interesting_files" do
+    ["spec/spec_helper.rb", "test/test_helper.rb", "features/support/env.rb",
+    "spec/support/shared_context.rb", "test/support/shared_context.rb",
+    "spec/models/post_spec.rb", "test/unit/post_test.rb", "features/step_definitions/post_steps.rb"].each do |file_path|
+      context file_path do
+        let(:filename) { file_path }
+        include_context "interesting file"
+      end
+    end
+
+    context "app/models/post.rb" do
+      let(:filename) { "app/models/post.rb" }
+      include_context "not interesting file"
+    end
+  end
+
+  context "spec_helper.rb" do
+    let(:filename) { "spec/spec_helper.rb" }
+    let(:source) {
+      <<-EOF
+      RSpec.configure do |config|
+        config.include EmailSpec::Helpers
+      end
+      EOF
+    }
+    let(:expected_source) {
+      <<-EOF
+      RSpec.configure do |config|
+        config.include EmailSpec::Helpers
+        config.include FactoryGirl::Syntax::Methods
+      end
+      EOF
+    }
+    include_context "expect to convert"
+  end
+
+  context "test_helper.rb" do
+    context "Test::Unit::TestCase" do
+      let(:filename) { "test/test_helper.rb" }
+      let(:source) {
+        <<-EOF
+        class Test::Unit::TestCase
+        end
+        EOF
+      }
+      let(:expected_source) {
+        <<-EOF
+        class Test::Unit::TestCase
+          include FactoryGirl::Syntax::Methods
+        end
+        EOF
+      }
+      include_context "expect to convert"
+    end
+
+    context "ActiveSupport::TestCase" do
+      let(:filename) { "test/test_helper.rb" }
+      let(:source) {
+        <<-EOF
+        class ActiveSupport::TestCase
+          include EmailSpec::Helpers
+        end
+        EOF
+      }
+      let(:expected_source) {
+        <<-EOF
+        class ActiveSupport::TestCase
+          include EmailSpec::Helpers
+          include FactoryGirl::Syntax::Methods
+        end
+        EOF
+      }
+      include_context "expect to convert"
+    end
+  end
+
+  context "features/support/env.rb" do
+    let(:filename) { "features/support/env.rb" }
+    let(:source) {
+      <<-EOF
+      require 'cucumber/rails'
+      EOF
+    }
+    let(:expected_source) {
+      <<-EOF
+      require 'cucumber/rails'
+      World(FactoryGirl::Syntax::Methods)
+      EOF
+    }
+    include_context "expect to convert"
+  end
+
+  [:create, :build, :attributes_for, :build_stubbed].each do |method|
+    class_eval do
+      context "FactoryGirl.#{method}" do
+        let(:filename) { "spec/models/post_spec.rb" }
+        let(:source) {
+          <<-EOF
+          it "valids post" do
+            post = FactoryGirl.#{method}(:post)
+            expect(post).to be_valid
+          end
+          EOF
+        }
+        let(:expected_source) {
+          <<-EOF
+          it "valids post" do
+            post = #{method}(:post)
+            expect(post).to be_valid
+          end
+          EOF
+        }
+
+        include_context "expect to convert"
+      end
+    end
+  end
+
+  [:create_list, :build_list, :create_pair, :build_pair].each do |method|
+    class_eval do
+      context "FactoryGirl.#{method}" do
+        let(:filename) { "spec/models/post_spec.rb" }
+        let(:source) {
+          <<-EOF
+          it "valids posts" do
+            posts = FactoryGirl.#{method}(:post)
+            expect(posts).to be_valid
+          end
+          EOF
+        }
+        let(:expected_source) {
+          <<-EOF
+          it "valids posts" do
+            posts = #{method}(:post)
+            expect(posts).to be_valid
+          end
+          EOF
+        }
+
+        include_context "expect to convert"
+      end
+    end
+  end
+end

data/synvert.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synvert/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "synvert"
+  spec.version       = Synvert::VERSION
+  spec.authors       = ["Richard Huang"]
+  spec.email         = ["flyerhzm@gmail.com"]
+  spec.description   = %q{synvert is used to convert ruby code to better syntax.}
+  spec.summary       = %q{synvert = syntax + convert.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "parser"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: synvert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: synvert is used to convert ruby code to better syntax.
+email:
+- flyerhzm@gmail.com
+executables:
+- synvert
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/synvert
+- lib/synvert.rb
+- lib/synvert/base_converter.rb
+- lib/synvert/checking_visitor.rb
+- lib/synvert/cli.rb
+- lib/synvert/factory_girl/syntax_methods_converter.rb
+- lib/synvert/sexp_helper.rb
+- lib/synvert/version.rb
+- spec/spec_helper.rb
+- spec/support/shared_context.rb
+- spec/synvert/base_converter_spec.rb
+- spec/synvert/checking_visitor_spec.rb
+- spec/synvert/factory_girl/syntax_methods_converter_spec.rb
+- synvert.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: synvert = syntax + convert.
+test_files:
+- spec/spec_helper.rb
+- spec/support/shared_context.rb
+- spec/synvert/base_converter_spec.rb
+- spec/synvert/checking_visitor_spec.rb
+- spec/synvert/factory_girl/syntax_methods_converter_spec.rb