synvert-core 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 060a67494f8695693b472fe25ed39d9af6021a28
-  data.tar.gz: 67485c8861388275535bd8e3a0ab775ae558220d
+  metadata.gz: 6ed207188d4ec855b1b3e7f89bbd8fe237fdcfd4
+  data.tar.gz: dbe3386bcd2c13ab431afd27111290979ab20e62
 SHA512:
-  metadata.gz: a2e3ecbb02ee560b8fed9c0a968bfbc35d2eea5598a94147bbab9a26895813e6de414a94375cbfd5e24987dbe9960f87a1518b7a957e2cbf660a25fe55f16fff
-  data.tar.gz: e0926950d6b9b55c3ab138a095706dcdbf99cbc92a2789e33db9c83e47c2a8026b4adccd07c6bb2a1c55aebea9ad9ceedce542cd023b993cb05ef1b01882c10a
+  metadata.gz: fef1237ad08c20bee81b382f67efa36e0f2d137eb7f4fb5289daf35dfe6053b57a99020e127394d1b7f5f12b9ab4b4983feb01ad6f0ce680db175574cd9d687e
+  data.tar.gz: 80c1a8239eea4c895a3c5f5fac37c30f919c70daa60fc4f7f55b789f4e5e43f7329bc5fe3f9aafdebfab6ac3441957eea5c851ccbd0bf7fd9dc73614e9258c98

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.2.0
+
+* Add remove_file dsl
+* Add warn dsl
+
 ## 0.1.1
 
 * Return empty array if no available rewriters

data/lib/synvert/core/node_ext.rb

@@ -76,8 +76,8 @@ class Parser::AST::Node
     case self.type
     when :begin
       self.children
-    when :block
-      :begin == self.children[2].type ? self.children[2].children : [self.children[2]]
+    when :def, :block
+      :begin == self.children[2].type ? self.children[2].body : self.children[2..-1]
     else
       raise Synvert::Core::MethodNotSupported.new "body is not handled for #{self.inspect}"
     end

data/lib/synvert/core/rewriter/action.rb

@@ -13,7 +13,7 @@ module Synvert::Core
       @node = @instance.current_node
     end
 
-    # Line number of the node.
+    # Line number of current node.
     #
     # @return [Integer] line number.
     def line

data/lib/synvert/core/rewriter/instance.rb

@@ -16,13 +16,16 @@ module Synvert::Core
 
     # Initialize an instance.
     #
+    # @param rewriter [Synvert::Core::Rewriter]
     # @param file_pattern [String] pattern to find files, e.g. spec/**/*_spec.rb
     # @param block [Block] block code to find nodes, match conditions and rewrite code.
     # @return [Synvert::Core::Rewriter::Instance]
-    def initialize(file_pattern, &block)
+    def initialize(rewriter, file_pattern, &block)
+      @rewriter = rewriter
       @actions = []
       @file_pattern = file_pattern
       @block = block
+      rewriter.helpers.each { |helper| self.singleton_class.send(:define_method, helper[:name], &helper[:block]) }
     end
 
     # Process the instance.
@@ -148,6 +151,13 @@ module Synvert::Core
       @actions << Rewriter::RemoveAction.new(self)
     end
 
+    # Parse warn dsl, it creates a [Synvert::Core::Rewriter::Warning] to save warning message.
+    #
+    # @param message [String] warning message.
+    def warn(message)
+      @rewriter.add_warning Rewriter::Warning.new(self, message)
+    end
+
   private
 
     # It changes source code from bottom to top, and it can change source code twice at the same time.

data/lib/synvert/core/rewriter/warning.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Synvert::Core
+  # Warning is used to save warning message.
+  class Rewriter::Warning
+    # Initialize a warning.
+    #
+    # @param instance [Synvert::Core::Rewriter::Instance]
+    # @param message [String] warning message.
+    def initialize(instance, message)
+      @file_path = instance.current_file
+      @line = instance.current_node.loc.expression.line
+      @message = message
+    end
+
+    # Warning message.
+    #
+    # @return [String] warning message.
+    def message
+      "#{@file_path}##{@line}: #{@message}"
+    end
+  end
+end

data/lib/synvert/core/rewriter.rb

@@ -23,6 +23,8 @@ module Synvert::Core
     autoload :ReplaceWithAction, 'synvert/core/rewriter/action'
     autoload :RemoveAction, 'synvert/core/rewriter/action'
 
+    autoload :Warning, 'synvert/core/rewriter/warning'
+
     autoload :Instance, 'synvert/core/rewriter/instance'
 
     autoload :Scope, 'synvert/core/rewriter/scope'
@@ -83,7 +85,11 @@ module Synvert::Core
     #   @return [String] the unique name of rewriter
     # @!attribute [r] sub_snippets
     #   @return [Array<Synvert::Core::Rewriter>] all rewriters this rewiter calls.
-    attr_reader :name, :sub_snippets
+    # @!attribute [r] helper
+    #   @return [Array] helper methods.
+    # @!attribute [r] warnings
+    #   @return [Array<Synvert::Core::Rewriter::Warning>] warning messages.
+    attr_reader :name, :sub_snippets, :helpers, :warnings
 
     # Initialize a rewriter.
     # When a rewriter is initialized, it is also registered.
@@ -96,6 +102,7 @@ module Synvert::Core
       @block = block
       @helpers = []
       @sub_snippets = []
+      @warnings = []
       self.class.register(@name, self)
     end
 
@@ -113,6 +120,13 @@ module Synvert::Core
       @sandbox = false
     end
 
+    # Add a warning.
+    #
+    # @param warning [Synvert::Core::Rewriter::Warning]
+    def add_warning(warning)
+      @warnings << warning
+    end
+
     #######
     # DSL #
     #######
@@ -148,9 +162,7 @@ module Synvert::Core
       return if @sandbox
 
       if !@gem_spec || @gem_spec.match?
-        instance = Rewriter::Instance.new(file_pattern, &block)
-        @helpers.each { |helper| instance.singleton_class.send(:define_method, helper[:name], &helper[:block]) }
-        instance.process
+        Rewriter::Instance.new(self, file_pattern, &block).process
       end
     end
 
@@ -164,11 +176,21 @@ module Synvert::Core
     def add_file(filename, content)
       return if @sandbox
 
-      File.open filename, 'w' do |file|
+      File.open File.join(Configuration.instance.get(:path), filename), 'w' do |file|
         file.write content
       end
     end
 
+    # Parses remove_file dsl, it removes a file.
+    #
+    # @param filename [String] file name.
+    def remove_file(filename)
+      return if @sandbox
+
+      file_path = File.join(Configuration.instance.get(:path), filename)
+      File.delete(file_path) if File.exist?(file_path)
+    end
+
     # Parse add_snippet dsl, it calls anther rewriter.
     #
     # @param name [String] name of another rewriter.

data/lib/synvert/core/version.rb

@@ -2,6 +2,6 @@
 
 module Synvert
   module Core
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ RSpec.configure do |config|
   config.order = 'random'
 
   config.before do
+    Synvert::Core::Configuration.instance.set :path, '.'
     Synvert::Core::Configuration.instance.set :skip_files, []
   end
 end

data/spec/synvert/core/node_ext_spec.rb

@@ -81,6 +81,11 @@ describe Parser::AST::Node do
       node = parse('foo; bar')
       expect(node.body).to eq [parse('foo'), parse('bar')]
     end
+
+    it 'gets for def node' do
+      node = parse('def test; foo; bar; end')
+      expect(node.body).to eq [parse('foo'), parse('bar')]
+    end
   end
 
   describe "#keys" do
@@ -147,7 +152,10 @@ describe Parser::AST::Node do
   end
 
   describe '#match?' do
-    let(:instance) { Synvert::Core::Rewriter::Instance.new('file pattern') }
+    let(:instance) {
+      rewriter = Synvert::Core::Rewriter.new('foobar')
+      Synvert::Core::Rewriter::Instance.new(rewriter, 'file pattern')
+    }
 
     it 'matches class name' do
       source = 'class Synvert; end'

data/spec/synvert/core/rewriter/action_spec.rb

@@ -1,12 +1,25 @@
 require 'spec_helper'
 
 module Synvert::Core
+  describe Rewriter::Action do
+    subject {
+      source = "before_save do\n  return false\nend"
+      block_node = Parser::CurrentRuby.parse(source).body.first
+      instance = double(current_node: block_node)
+      Rewriter::Action.new(instance, source)
+    }
+
+    it 'gets line' do
+      expect(subject.line).to eq 2
+    end
+  end
+
   describe Rewriter::ReplaceWithAction do
     context "replace with single line" do
       subject {
         source = "post = FactoryGirl.create_list :post, 2"
         send_node = Parser::CurrentRuby.parse(source).children[1]
-        instance = double(:current_node => send_node)
+        instance = double(current_node: send_node)
         Rewriter::ReplaceWithAction.new(instance, 'create_list {{arguments}}')
       }
 
@@ -27,7 +40,7 @@ module Synvert::Core
       subject {
         source = "  its(:size) { should == 1 }"
         send_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => send_node)
+        instance = double(current_node: send_node)
         Rewriter::ReplaceWithAction.new(instance, """describe '#size' do
   subject { super().size }
   it { {{body}} }
@@ -56,7 +69,7 @@ end""")
       subject do
         source = "class User\n  has_many :posts\nend"
         class_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => class_node)
+        instance = double(current_node: class_node)
         Rewriter::AppendAction.new(instance, "def as_json\n  super\nend")
       end
 
@@ -77,7 +90,7 @@ end""")
       subject do
         source = "gem 'rails'\ngem 'mysql2'"
         begin_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => begin_node)
+        instance = double(current_node: begin_node)
         Rewriter::AppendAction.new(instance, "gem 'twitter'")
       end
 
@@ -100,7 +113,7 @@ end""")
       subject {
         source = "Synvert::Application.configure do\nend"
         block_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => block_node)
+        instance = double(current_node: block_node)
         Rewriter::InsertAction.new(instance, 'config.eager_load = true')
       }
 
@@ -121,7 +134,7 @@ end""")
       subject {
         source = "RSpec.configure do |config|\nend"
         block_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => block_node)
+        instance = double(current_node: block_node)
         Rewriter::InsertAction.new(instance, '{{arguments.first}}.include FactoryGirl::Syntax::Methods')
       }
 
@@ -142,7 +155,7 @@ end""")
       subject {
         source = "class User\n  has_many :posts\nend"
         class_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => class_node)
+        instance = double(current_node: class_node)
         Rewriter::InsertAction.new(instance, 'include Deletable')
       }
 
@@ -163,7 +176,7 @@ end""")
       subject {
         source = "class User < ActiveRecord::Base\n  has_many :posts\nend"
         class_node = Parser::CurrentRuby.parse(source)
-        instance = double(:current_node => class_node)
+        instance = double(current_node: class_node)
         Rewriter::InsertAction.new(instance, 'include Deletable')
       }
 
@@ -185,7 +198,7 @@ end""")
     subject {
       source = "  include Foo"
       node = Parser::CurrentRuby.parse(source)
-      instance = double(:current_node => node)
+      instance = double(current_node: node)
       Rewriter::InsertAfterAction.new(instance, 'include Bar')
     }
 
@@ -206,7 +219,7 @@ end""")
     subject {
       source = "user = User.new params[:user]\nuser.save\nrender\n"
       send_node = Parser::CurrentRuby.parse(source).children[1]
-      instance = double(:current_node => send_node)
+      instance = double(current_node: send_node)
       Rewriter::RemoveAction.new(instance)
     }
 

data/spec/synvert/core/rewriter/gem_spec_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::GemSpec do
-    before { Configuration.instance.set :path, '.' }
     let(:gemfile_lock_content) { """
 GEM
   remote: https://rubygems.org/

data/spec/synvert/core/rewriter/instance_spec.rb

@@ -2,7 +2,10 @@ require 'spec_helper'
 
 module Synvert::Core
   describe Rewriter::Instance do
-    let(:instance) { Rewriter::Instance.new('file pattern') }
+    let(:instance) {
+      rewriter = Rewriter.new('foobar')
+      Rewriter::Instance.new(rewriter, 'file pattern')
+    }
 
     it 'parses within_node' do
       scope = double()
@@ -69,11 +72,16 @@ module Synvert::Core
       instance.remove
     end
 
+    it 'parses warn' do
+      expect(Rewriter::Warning).to receive(:new).with(instance, 'foobar')
+      instance.warn 'foobar'
+    end
+
     describe '#process' do
-      before { Configuration.instance.set :path, '.' }
+      let(:rewriter) { Rewriter.new('foobar') }
 
       it 'FactoryGirl uses short syntax' do
-        instance = Rewriter::Instance.new 'spec/**/*_spec.rb' do
+        instance = Rewriter::Instance.new rewriter, 'spec/**/*_spec.rb' do
           with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
             replace_with 'create {{arguments}}'
           end
@@ -99,7 +107,7 @@ end
       end
 
       it 'includes FactoryGirl::Syntax::Methods' do
-        instance = Rewriter::Instance.new 'spec/spec_helper.rb'  do
+        instance = Rewriter::Instance.new rewriter, 'spec/spec_helper.rb'  do
           with_node type: 'block', caller: {receiver: 'RSpec', message: 'configure'} do
             unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
               insert "{{arguments.first}}.include FactoryGirl::Syntax::Methods"
@@ -122,7 +130,7 @@ end
       end
 
       it 'does not include FactoryGirl::Syntax::Methods' do
-        instance = Rewriter::Instance.new 'spec/spec_helper.rb' do
+        instance = Rewriter::Instance.new rewriter, 'spec/spec_helper.rb' do
           with_node type: 'block', caller: {receiver: 'RSpec', message: 'configure'} do
             unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
               insert "{{arguments.first}}.include FactoryGirl::Syntax::Methods"
@@ -146,7 +154,7 @@ end
       end
 
       it 'process nested send nodes' do
-        instance = Rewriter::Instance.new 'config/*.rb'  do
+        instance = Rewriter::Instance.new rewriter, 'config/*.rb'  do
           with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'active_record'}, message: 'identity_map=' do
             remove
           end

data/spec/synvert/core/rewriter/warning_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Synvert::Core
+  describe Rewriter::Warning do
+    subject {
+      source = "def test\n  debugger\nend"
+      send_node = Parser::CurrentRuby.parse(source).body.first
+      instance = double(current_node: send_node, current_file: 'app/test.rb')
+      Rewriter::Warning.new(instance, 'remove debugger')
+    }
+
+    it 'gets message with filename and line number' do
+      expect(subject.message).to eq 'app/test.rb#2: remove debugger'
+    end
+  end
+end

data/spec/synvert/core/rewriter_spec.rb

@@ -61,7 +61,7 @@ module Synvert::Core
     describe 'parses add_file' do
       it 'creates a new file' do
         rewriter = Rewriter.new 'rewriter2' do
-          add_file './foo.bar', 'FooBar'
+          add_file 'foo.bar', 'FooBar'
         end
         rewriter.process
         expect(File.read './foo.bar').to eq 'FooBar'
@@ -70,13 +70,42 @@ module Synvert::Core
 
       it 'does nothing in sandbox mode' do
         rewriter = Rewriter.new 'rewriter2' do
-          add_file './foo.bar', 'FooBar'
+          add_file 'foo.bar', 'FooBar'
         end
         rewriter.process_with_sandbox
         expect(File.exist?('./foo.bar')).to be_false
       end
     end
 
+    describe 'parses remove_file' do
+      it 'removes a file' do
+        FileUtils.touch './foo.bar'
+        rewriter = Rewriter.new 'rewriter2' do
+          remove_file 'foo.bar'
+        end
+        rewriter.process
+        expect(File.exist? './foo.bar').to be_false
+      end
+
+      it 'does nothing if file not exist' do
+        rewriter = Rewriter.new 'rewriter2' do
+          remove_file 'foo.bar'
+        end
+        rewriter.process
+        expect(File.exist? './foo.bar').to be_false
+      end
+
+      it 'does nothing in sandbox mode' do
+        FileUtils.touch './foo.bar'
+        rewriter = Rewriter.new 'rewriter2' do
+          add_file 'foo.bar', 'FooBar'
+        end
+        rewriter.process_with_sandbox
+        expect(File.exist?('./foo.bar')).to be_true
+        FileUtils.rm './foo.bar'
+      end
+    end
+
     describe 'parses add_snippet' do
       it 'processes the rewritter' do
         rewriter1 = Rewriter.new 'rewriter1'
@@ -106,16 +135,13 @@ module Synvert::Core
     end
 
     it 'parses helper_method' do
-      instance = double
-      expect(Rewriter::Instance).to receive(:new).and_return(instance)
-      expect(instance).to receive(:process)
       rewriter = Rewriter.new 'name' do
         helper_method 'dynamic_helper' do |arg1, arg2|
           'dynamic result'
         end
-        within_file 'spec/spec_helper.rb' do; end
       end
       rewriter.process
+      instance = Rewriter::Instance.new(rewriter, '*.rb')
       expect(instance.dynamic_helper('arg1', 'arg2')).to eq 'dynamic result'
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-04 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -105,6 +105,7 @@ files:
 - lib/synvert/core/rewriter/gem_spec.rb
 - lib/synvert/core/rewriter/instance.rb
 - lib/synvert/core/rewriter/scope.rb
+- lib/synvert/core/rewriter/warning.rb
 - lib/synvert/core/version.rb
 - spec/spec_helper.rb
 - spec/support/parser_helper.rb
@@ -115,6 +116,7 @@ files:
 - spec/synvert/core/rewriter/gem_spec_spec.rb
 - spec/synvert/core/rewriter/instance_spec.rb
 - spec/synvert/core/rewriter/scope_spec.rb
+- spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb
 - synvert-core.gemspec
 homepage: https://github.com/xinminlabs/synvert-core
@@ -151,4 +153,5 @@ test_files:
 - spec/synvert/core/rewriter/gem_spec_spec.rb
 - spec/synvert/core/rewriter/instance_spec.rb
 - spec/synvert/core/rewriter/scope_spec.rb
+- spec/synvert/core/rewriter/warning_spec.rb
 - spec/synvert/core/rewriter_spec.rb