synvert 0.0.3 → 0.0.4

data/lib/synvert/rewriter/scope.rb

@@ -2,19 +2,35 @@
 
 module Synvert
   class Rewriter::Scope
-    def initialize(options)
+    def initialize(instance, options, &block)
+      @instance = instance
       @options = options
+      @block = block
     end
 
-    def matching_nodes(nodes)
-      matching_nodes = []
-      while node = nodes.shift
-        matching_nodes << node if node.match?(@options)
-        node.recursive_children do |child_node|
-          matching_nodes << child_node if child_node.match?(@options)
+    def process
+      current_node = @instance.current_node
+      return unless current_node
+      process_with_node current_node do
+        matching_nodes = []
+        matching_nodes << current_node if current_node.match? @instance, @options
+        current_node.recursive_children do |child_node|
+          matching_nodes << child_node if child_node.match? @instance, @options
+        end
+        matching_nodes.each do |matching_node|
+          process_with_node matching_node do
+            @instance.instance_eval &@block
+          end
         end
       end
-      matching_nodes
+    end
+
+  private
+
+    def process_with_node(node)
+      @instance.current_node = node
+      yield
+      @instance.current_node = node
     end
   end
 end

data/lib/synvert/snippets/factory_girl/syntax_methods.rb

@@ -1,35 +1,46 @@
 Synvert::Rewriter.new "FactoryGirl uses short syntax" do
   gem_spec 'factory_girl', '2.0.0'
 
+  # insert include FactoryGirl::Syntax::Methods
   within_file 'spec/spec_helper.rb' do
     within_node type: 'block', caller: {receiver: 'RSpec', message: 'configure'} do
-      unless_exist_node type: 'send', message: 'include', arguments: {first: {to_s: 'FactoryGirl::Syntax::Methods'}} do
-        insert "{{self.arguments.first}}.include FactoryGirl::Syntax::Methods"
+      unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
+        insert "{{arguments.first}}.include FactoryGirl::Syntax::Methods"
       end
     end
   end
 
-  %w(Test::Unit::TestCase ActiveSupport::TestCase MiniTest::Unit::TestCase MiniTest::Spec MiniTest::Rails::ActiveSupport::TestCase).each do |class_name|
-    within_file 'test/test_helper.rb' do
+  # insert include FactoryGirl::Syntax::Methods
+  within_file 'test/test_helper.rb' do
+    %w(Test::Unit::TestCase ActiveSupport::TestCase MiniTest::Unit::TestCase MiniTest::Spec MiniTest::Rails::ActiveSupport::TestCase).each do |class_name|
       within_node type: 'class', name: class_name do
-        unless_exist_node type: 'send', message: 'include', arguments: {first: {to_s: 'FactoryGirl::Syntax::Methods'}} do
+        unless_exist_node type: 'send', message: 'include', arguments: ['FactoryGirl::Syntax::Methods'] do
           insert "include FactoryGirl::Syntax::Methods"
         end
       end
     end
   end
 
+  # insert World(FactoryGirl::Syntax::Methods)
   within_file 'features/support/env.rb' do
-    unless_exist_node type: 'send', message: 'World', arguments: {first: {to_s: 'FactoryGirl::Syntax::Methods'}} do
+    unless_exist_node type: 'send', message: 'World', arguments: ['FactoryGirl::Syntax::Methods'] do
       insert "World(FactoryGirl::Syntax::Methods)"
     end
   end
 
+  # FactoryGirl.create(...) => create(...)
+  # FactoryGirl.build(...) => build(...)
+  # FactoryGirl.attributes_for(...) => attributes_for(...)
+  # FactoryGirl.build_stubbed(...) => build_stubbed(...)
+  # FactoryGirl.create_list(...) => create_list(...)
+  # FactoryGirl.build_list(...) => build_list(...)
+  # FactoryGirl.create_pair(...) => create_pair(...)
+  # FactoryGirl.build_pair(...) => build_pair(...)
   %w(test/**/*.rb spec/**/*.rb features/**/*.rb).each do |file_pattern|
-    %w(create build attributes_for build_stubbed create_list build_list ccreate_pair build_pair).each do |message|
-      within_files file_pattern do
+    within_files file_pattern do
+      %w(create build attributes_for build_stubbed create_list build_list create_pair build_pair).each do |message|
         with_node type: 'send', receiver: 'FactoryGirl', message: message do
-          replace_with "#{message}({{self.arguments}})"
+          replace_with "#{message}({{arguments}})"
         end
       end
     end

data/lib/synvert/snippets/rails/upgrade_3_2_to_4_0.rb

@@ -1,13 +1,15 @@
 require 'securerandom'
 
-def dynamic_finder_to_hash(node, prefix)
-  fields = node.message.to_s[prefix.length..-1].split("_and_")
-  fields.length.times.map { |i|
-    fields[i] + ": " + node.arguments[i].to_s
-  }.join(", ")
+class Synvert::Rewriter::Instance
+  def dynamic_finder_to_hash(node, prefix)
+    fields = node.message.to_s[prefix.length..-1].split("_and_")
+    fields.length.times.map { |i|
+      fields[i] + ": " + node.arguments[i].source(self)
+    }.join(", ")
+  end
 end
 
-Synvert::Rewriter.new "Upgrade from rails 3.2 to rails 4.0" do
+Synvert::Rewriter.new "Upgrade rails from 3.2 to 4.0" do
   gem_spec 'rails', '3.2.0'
 
   within_file 'config/application.rb' do
@@ -15,128 +17,166 @@ Synvert::Rewriter.new "Upgrade from rails 3.2 to rails 4.0" do
     #   Bundler.require(*Rails.groups(:assets => %w(development test)))
     # end
     # => Bundler.require(:default, Rails.env)
-    with_node type: 'if', condition: {type: 'defined?', arguments: {first: 'Bundler'}} do
+    with_node type: 'if', condition: {type: 'defined?', arguments: ['Bundler']} do
       replace_with 'Bundler.require(:default, Rails.env)'
     end
   end
 
-  within_file 'config/environments/production.rb' do
+  within_file 'config/**/*.rb' do
     # remove config.active_record.identity_map = true
     with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'active_record'}, message: 'identity_map=' do
       remove
     end
   end
 
-  within_file 'app/models/**/*.rb' do
-    # self.serialized_attributes => self.class.serialized_attributes
-    with_node type: 'send', receiver: 'self', message: 'serialized_attributes' do
-      replace_with 'self.class.serialized_attributes'
-    end
-  end
-
-  within_file 'app/models/**/*.rb' do
-    # scope :active, where(active: true) => scope :active, -> { where(active: true) }
-    with_node type: 'send', receiver: nil, message: 'scope' do
-      replace_with 'scope {{self.arguments.first}}, -> { {{self.arguments.last}} }'
-    end
-  end
-
-  within_file 'test/unit/**/*.rb' do
-    # ActiveRecord::TestCase => ActiveSupport::TestCase
-    with_node type: 'const', to_s: 'ActiveRecord::TestCase' do
-      replace_with 'ActiveSupport::TestCase'
+  within_file 'config/initializers/wrap_parameters.rb' do
+    # remove self.include_root_in_json = false
+    with_node type: 'block', caller: {receiver: 'ActiveSupport', message: 'on_load', arguments: [':active_record']} do
+      if_only_exist_node to_ast: Parser::CurrentRuby.parse('self.include_root_in_json = false') do
+        remove
+      end
     end
   end
 
-  within_file 'app/**/*.rb' do
-    # find_all_by_... => where(...)
-    with_node type: 'send', message: /find_all_by_(.*)/ do
-      hash_params = '{{find_all_by(self, "find_last_by_")}}'
-      replace_with "{{self.receiver}}.where(#{hash_params})"
+  within_file 'config/initializers/secret_token.rb' do
+    # insert Application.config.secret_key_base = '...'
+    unless_exist_node type: 'send', message: 'secret_key_base=' do
+      with_node type: 'send', message: 'secret_token=' do
+        secret = SecureRandom.hex(64)
+        insert_after "{{receiver}}.secret_key_base = \"#{secret}\""
+      end
     end
   end
 
-  within_file 'app/**/*.rb' do
-    # find_last_by_... => where(...).last
-    with_node type: 'send', message: /find_last_by_(.*)/ do
-      hash_params = '{{dynamic_finder_to_hash(self, "find_last_by_")}}'
-      replace_with "{{self.receiver}}.where(#{hash_params}).last"
+  within_files 'config/**/*.rb' do
+    # remove config.action_dispatch.best_standards_support = ...
+    with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'action_dispatch'}, message: 'best_standards_support=' do
+      remove
     end
   end
 
-  within_file 'app/**/*.rb' do
-    # scoped_by_... => where(...)
-    with_node type: 'send', message: /scoped_by_(.*)/ do
-      hash_params = '{{dynamic_finder_to_hash(self, "scoped_by_")}}'
-      replace_with "{{self.receiver}}.where(#{hash_params})"
+  within_files 'config/**/*.rb' do
+    # remove config.active_record.whitelist_attributes = ...
+    with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'active_record'}, message: 'whitelist_attributes=' do
+      remove
     end
   end
 
-  within_file 'app/**/*.rb' do
-    # find_or_initialize_by_... => find_or_initialize_by(...)
-    with_node type: 'send', message: /find_or_initialize_by_(.*)/ do
-      hash_params = '{{dynamic_finder_to_hash(self, "find_or_initialize_by_")}}'
-      replace_with "{{self.receiver}}.find_or_initialize_by(#{hash_params})"
+  within_file 'config/environments/production.rb' do
+    # insert config.eager_load = true
+    unless_exist_node type: 'send', message: 'eager_load=' do
+      insert 'config.eager_load = true'
     end
   end
 
-  within_file 'app/**/*.rb' do
-    # find_or_create_by_... => find_or_create_by(...)
-    with_node type: 'send', message: /find_or_create_by_(.*)/ do
-      hash_params = '{{dynamic_finder_to_hash(self, "find_or_create_by_")}}'
-      replace_with "{{self.receiver}}.find_or_create_by(#{hash_params})"
+  within_file 'config/environments/development.rb' do
+    # insert config.eager_load = false
+    unless_exist_node type: 'send', message: 'eager_load=' do
+      insert 'config.eager_load = false'
     end
   end
 
-  within_file 'config/initializers/wrap_parameters.rb' do
-    # remove self.include_root_in_json = false
-    with_node type: 'block', caller: {receiver: 'ActiveSupport', message: 'on_load', arguments: {first: ':active_record'}} do
-      if_only_exist_node to_ast: Parser::CurrentRuby.parse('self.include_root_in_json = false') do
-        remove
-      end
+  within_file 'config/environments/test.rb' do
+    # insert config.eager_load = false
+    unless_exist_node type: 'send', message: 'eager_load=' do
+      insert 'config.eager_load = false'
     end
   end
 
-  within_file 'config/initializers/secret_token.rb' do
-    # insert Application.config.secret_key_base = '...'
-    unless_exist_node type: 'send', message: 'secret_key_base=' do
-      with_node type: 'send', message: 'secret_token=' do
-        secret = SecureRandom.hex(64)
-        insert_after "{{self.receiver}}.secret_key_base = '#{secret}'"
-      end
+  within_files 'config/**/*.rb' do
+    # remove config.middleware.xxx(..., ActionDispatch::BestStandardsSupport)
+    with_node type: 'send', arguments: {any: 'ActionDispatch::BestStandardsSupport'} do
+      remove
     end
   end
 
-  within_file 'config/**/*.rb' do
-    # remove ActionController::Base.page_cache_extension => ActionController::Base.default_static_extension
+  within_files 'config/**/*.rb' do
+    # remove ActionController::Base.page_cache_extension = ... => ActionController::Base.default_static_extension = ...
     with_node type: 'send', message: 'page_cache_extension=' do
-      replace_with 'ActionController::Base.default_static_extension = {{self.arguments}}'
+      replace_with 'ActionController::Base.default_static_extension = {{arguments}}'
     end
   end
 
   within_file 'config/routes.rb' do
     # Rack::Utils.escape('こんにちは') => 'こんにちは'
     with_node type: 'send', receiver: 'Rack::Utils', message: 'escape' do
-      replace_with '{{self.arguments}}'
+      replace_with '{{arguments}}'
     end
   end
 
   within_file 'config/routes.rb' do
     # match "/" => "root#index" => get "/" => "root#index"
     with_node type: 'send', message: 'match' do
-      replace_with 'get {{self.arguments}}'
+      replace_with 'get {{arguments}}'
     end
   end
 
-  within_file 'config/**/*.rb' do
-    with_node type: 'send', arguments: {any: 'ActionDispatch::BestStandardsSupport'} do
-      remove
+  within_files 'app/models/**/*.rb' do
+    # self.serialized_attributes => self.class.serialized_attributes
+    with_node type: 'send', receiver: 'self', message: 'serialized_attributes' do
+      replace_with 'self.class.serialized_attributes'
     end
   end
 
-  within_file 'config/**/*.rb' do
-    with_node type: 'send', message: 'best_standards_support=' do
-      remove
+  within_files 'app/models/**/*.rb' do
+    # scope :active, where(active: true) => scope :active, -> { where(active: true) }
+    with_node type: 'send', receiver: nil, message: 'scope' do
+      replace_with 'scope {{arguments.first}}, -> { {{arguments.last}} }'
+    end
+  end
+
+  within_files 'test/unit/**/*.rb' do
+    # ActiveRecord::TestCase => ActiveSupport::TestCase
+    with_node source: 'ActiveRecord::TestCase' do
+      replace_with 'ActiveSupport::TestCase'
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # find_all_by_... => where(...)
+    with_node type: 'send', message: /find_all_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "find_all_by_")
+      replace_with "{{receiver}}.where(#{hash_params})"
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # find_by_... => where(...).first
+    with_node type: 'send', message: /find_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "find_by_")
+      replace_with "{{receiver}}.where(#{hash_params}).first"
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # find_last_by_... => where(...).last
+    with_node type: 'send', message: /find_last_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "find_last_by_")
+      replace_with "{{receiver}}.where(#{hash_params}).last"
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # scoped_by_... => where(...)
+    with_node type: 'send', message: /scoped_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "scoped_by_")
+      replace_with "{{receiver}}.where(#{hash_params})"
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # find_or_initialize_by_... => find_or_initialize_by(...)
+    with_node type: 'send', message: /find_or_initialize_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "find_or_initialize_by_")
+      replace_with "{{receiver}}.find_or_initialize_by(#{hash_params})"
+    end
+  end
+
+  within_files 'app/**/*.rb' do
+    # find_or_create_by_... => find_or_create_by(...)
+    with_node type: 'send', message: /find_or_create_by_(.*)/ do
+      hash_params = dynamic_finder_to_hash(node, "find_or_create_by_")
+      replace_with "{{receiver}}.find_or_create_by(#{hash_params})"
     end
   end
 
@@ -148,10 +188,46 @@ Synvert::Rewriter.new "Upgrade from rails 3.2 to rails 4.0" do
    'ActionController::AbstractResponse' => 'ActionDispatch::Response',
    'ActionController::Response' => 'ActionDispatch::Response',
    'ActionController::Routing' => 'ActionDispatch::Routing'}.each do |deprecated, favor|
-    within_file '**/*.rb' do
-      with_node to_s: deprecated do
+    within_files '**/*.rb' do
+      with_node source: deprecated do
         replace_with favor
       end
     end
   end
+
+  #####################
+  # strong_parameters #
+  #####################
+  within_files 'app/models/**/*.rb' do
+    # assign and remove attr_accessible ...
+    within_node type: 'class' do
+      class_node = node
+      with_node type: 'send', message: 'attr_accessible' do
+        assign 'parameters', class_node.name.source(self).underscore, node.arguments.map { |key| key.source(self) }.join(', ')
+        remove
+      end
+    end
+  end
+
+  within_file 'app/controllers/**/*.rb' do
+    within_node type: 'class' do
+      # insert def xxx_params; ...; end
+      object_name = node.name.source(self).sub('Controller', '').singularize.underscore
+      if fetch('parameters', object_name)
+        unless_exist_node type: 'def', name: "#{object_name}_params" do
+          append """def #{object_name}_params
+  params.require(:#{object_name}).permit(#{fetch 'parameters', object_name})
+end"""
+        end
+
+        # params[:xxx] => xxx_params
+        with_node type: 'send', receiver: 'params', message: '[]' do
+          object_name = eval(node.arguments.first.source(self)).to_s
+          if fetch('parameters', object_name)
+            replace_with "#{object_name}_params"
+          end
+        end
+      end
+    end
+  end
 end

data/lib/synvert/version.rb

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

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 require 'synvert'
+require 'fakefs/spec_helpers'
 
 Dir[File.join(File.dirname(__FILE__), 'support', '*')].each do |path|
   require path
@@ -8,6 +9,7 @@ end
 
 RSpec.configure do |config|
   config.include ParserHelper
+  config.include FakeFS::SpecHelpers, fakefs: true
 
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/synvert/node_ext_spec.rb

@@ -9,6 +9,11 @@ describe Parser::AST::Node do
       node = parse('class Synvert::Rewriter::Instance; end')
       expect(node.name).to eq parse('Synvert::Rewriter::Instance')
     end
+
+    it 'gets for def node' do
+      node = parse('def current_node; end')
+      expect(node.name).to eq :current_node
+    end
   end
 
   describe '#receiver' do
@@ -32,8 +37,10 @@ describe Parser::AST::Node do
     end
 
     it 'gets for block node' do
-      node = parse('RSpec.configure do |config|; end')
-      expect(node.arguments.map(&:to_s)).to eq ['config']
+      source = 'RSpec.configure do |config|; end'
+      node = parse(source)
+      instance = double(current_source: source)
+      expect(node.arguments.map { |argument| argument.source(instance) }).to eq ['config']
     end
 
     it 'gets for defined? node' do
@@ -63,48 +70,12 @@ describe Parser::AST::Node do
     end
   end
 
-  describe '#to_s' do
-    it 'gets for const node' do
-      node = parse('Synvert')
-      expect(node.to_s).to eq 'Synvert'
-
-      node = parse('Synvert::Rewriter::Instance')
-      expect(node.to_s).to eq 'Synvert::Rewriter::Instance'
-    end
-
-    it 'gets for sym node' do
-      node = parse(':synvert')
-      expect(node.to_s).to eq ':synvert'
-    end
-
-    it 'gets for str node' do
-      node = parse("'synvert'")
-      expect(node.to_s).to eq "'synvert'"
-    end
-
-    it 'gets for lvar node' do
-      node = parse("user = User.find 1; user.valid?").grep_node(type: 'lvar')
-      expect(node.to_s).to eq 'user'
-    end
-
-    it 'gets for ivar node' do
-      node = parse('@user')
-      expect(node.to_s).to eq '@user'
-    end
-
-    it 'gets for arg node' do
-      node = parse("RSpec.configure do |config|; end").grep_node(type: 'arg')
-      expect(node.to_s).to eq 'config'
-    end
-
-    it 'gets for self node' do
-      node = parse('self')
-      expect(node.to_s).to eq 'self'
-    end
-
-    it 'gets for send node' do
-      node = parse('email')
-      expect(node.to_s).to eq 'email'
+  describe '#source' do
+    it 'gets for node' do
+      source = 'params[:user][:email]'
+      instance = double(current_source: source)
+      node = parse(source)
+      expect(node.source(instance)).to eq 'params[:user][:email]'
     end
   end