synvert 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47c3b4007ea038ef098234f243fda7f4c06c438d
-  data.tar.gz: 9d0dda20ef90c44233491bfb065bf4cfe6c56255
+  metadata.gz: 53dc07e96c595d0758c95577c4fdaf4ea7a04b57
+  data.tar.gz: b37e73a7935d1356ee536f6581630a8c8d81d6ed
 SHA512:
-  metadata.gz: 2dcb64bb14b43046117ee51f63ecb233286c78669c226acc06e9ee937b0bd24cb63a710745123c00cc7060f910937f0b8f68bdfe128d79c18145a0c1bb4b978e
-  data.tar.gz: bfffd97409a6cd17c34688dfbec0c037836d8e7f0f71687549b3252cb16187bb7e862bf788f54efd6c6e42b6fe770ea15514f7bf35e4d287761dd80073e463e1
+  metadata.gz: 5c6c5dd69f4d294ec4763a0445dd6d7cd58d452a4c38efc2f85590aadd82698f8fe4818c00f7d87729563ab7053bc30caca7a7d024d0ec4dcc3abcd76a2444f5
+  data.tar.gz: 8fe105b04c5901462a58e1b2add48190b7cf208b8f20090b03ef6adc1ec12f1e7ce7e65094547a166d45d6b6ae99e14db5f6ff259478a71a68e78719acd7ca3d

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+_site

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.0.7
+
+* Able to run run specified snippets
+* Able to load additional snippets
+* Able to list available snippets
+* Add helper_method dsl
+* Add todo dsl
+* Improve rails 3.2 upgrade to 4.0 snippet
+
 ## 0.0.6
 
 * Add -> {} only when not exist in rails upgrade snippet

data/README.md

@@ -11,42 +11,55 @@ automatically.
 
 Add this line to your application's Gemfile:
 
-    gem 'synvert'
+```ruby
+gem 'synvert'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install synvert
+```
+$ gem install synvert
+```
 
 ## Usage
 
-    synvert PROJECT_PATH
-
-Currently it supports
+```
+$ synvert -h
+Usage: synvert [options] [project_path]
+        --load-snippets SNIPPET_PATHS
+                                     load additional snippets, snippet paths can be local file path or remote http url
+        --list-snippets              list all available snippets
+        --run-snippets SNIPPET_NAMES run specified snippets
+```
 
-* convert to FactoryGirl short syntax
-* upgrade rails from 3.2.x to 4.0.0
+e.g.
 
-## Example
+```
+$ synvert --list-snippets
+```
 
-```ruby
-Synvert::Rewriter.new "factory_girl_short_syntax", "FactoryGirl uses short syntax" do
-  within_file 'sepc/**/*.rb' do
-    with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
-      replace_with "create({{arguments}})"
-    end
-  end
-end
 ```
+$ synvert --run-snippets factory_girl_short_syntax,upgrade_rails_3_2_to_4_0 ~/Sites/railsbp/rails-bestpractices.com
+```
+
+## Snippets
 
-This snippet will convert `post = FactoryGirl.create(:post)` to `post =
-create(:post)`.
+name | description
+--- | ---
+factory_girl_short_syntax | FactoryGirl uses short syntax
+convert_dynamic_finders | Convert dynamic finders
+strong_parameters | Use strong_parameters syntax
+upgrade_rails_3_2_to_4_0 | Upgrade rails from 3.2 to 4.0, it contains convert_dynamic_finder and strong_parameters snippets
 
-There are more examples [here][1], I will write down the Documents
-later.
+## Documentation
+
+[http://xinminlabs.github.io/synvert/][1]
 
 ## Contributing
 
@@ -56,5 +69,4 @@ later.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-
-[1]: https://github.com/xinminlabs/synvert/tree/master/lib/synvert/snippets
+[1]: http://xinminlabs.github.io/synvert/

data/lib/synvert/cli.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 require 'optparse'
 require 'find'
+require 'open-uri'
 
 module Synvert
   class CLI
@@ -9,16 +10,47 @@ module Synvert
     end
 
     def run(args)
+      Configuration.instance.set 'snippet_paths', []
+      Configuration.instance.set 'snippet_names', []
+
+      command = :run
       optparse = OptionParser.new do |opts|
-        opts.banner = "Usage: synvert path"
+        opts.banner = "Usage: synvert [project_path]"
+        opts.on '--load-snippets 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(',')
+        end
+        opts.on '--list-snippets', 'list all available snippets' do
+          command = :list
+        end
+        opts.on '--run-snippets SNIPPET_NAMES', 'run specified snippets' do |snippet_names|
+          Configuration.instance.set 'snippet_names', snippet_names.split(',')
+        end
       end
       paths = optparse.parse(args)
       Configuration.instance.set :path, paths.first || Dir.pwd
 
-      rewriters = Dir.glob(File.join(File.dirname(__FILE__), 'snippets/**/*.rb')).map do |file|
-        eval(File.read(file))
+      Dir.glob(File.join(File.dirname(__FILE__), 'snippets/**/*.rb')).each { |file| eval(File.read(file)) }
+      Configuration.instance.get('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
+      Configuration.instance.get('snippet_names').each do |snippet_name|
+        rewriter = Rewriter.call snippet_name
+        puts "-------#{snippet_name} todo-------"
+        puts rewriter.todo_list
+      end
+
+      if :list == command
+        puts "%-40s %s" % ['name', 'description']
+        puts "%-40s %s" % ['----', '-----------']
+        Rewriter.availables.each do |rewriter|
+          puts "%-40s %s" % [rewriter.name, rewriter.description]
+        end
       end
-      rewriters.map(&:process)
     end
   end
 end

data/lib/synvert/rewriter/gem_spec.rb

@@ -11,7 +11,11 @@ module Synvert
       gemfile_lock_path = File.join(Configuration.instance.get(:path), 'Gemfile.lock')
       if File.exists? gemfile_lock_path
         parser = Bundler::LockfileParser.new(File.read(gemfile_lock_path))
-        Gem::Version.new(parser.specs.find { |spec| spec.name == @name }.version) >= @version
+        if spec = parser.specs.find { |spec| spec.name == @name }
+          Gem::Version.new(spec.version) >= @version
+        else
+          false
+        end
       else
         raise LoadError.new 'Gemfile.lock does not exist'
       end

data/lib/synvert/rewriter.rb

@@ -25,18 +25,30 @@ module Synvert
       end
 
       def call(name)
-        if @rewriters[name.to_s]
-          @rewriters[name.to_s].process
+        if (rewriter = @rewriters[name.to_s])
+          rewriter.process
+          rewriter
         else
           raise RewriterNotFound.new "Rewriter #{name} not found"
         end
       end
+
+      def availables
+        @rewriters.values
+      end
+
+      def clear
+        @rewriters.clear
+      end
     end
 
+    attr_reader :name, :description, :todo_list
+
     def initialize(name, description, &block)
       @name = name
       @description = description
       @block = block
+      @helpers = []
       self.class.register(name, self)
     end
 
@@ -50,7 +62,9 @@ module Synvert
 
     def within_file(file_pattern, &block)
       if !@gem_spec || @gem_spec.match?
-        Rewriter::Instance.new(file_pattern, &block).process
+        instance = Rewriter::Instance.new(file_pattern, &block)
+        @helpers.each { |helper| instance.singleton_class.send(:define_method, helper[:name], &helper[:block]) }
+        instance.process
       end
     end
 
@@ -59,5 +73,13 @@ module Synvert
     def add_snippet(name)
       self.class.call(name)
     end
+
+    def helper_method(name, &block)
+      @helpers << {name: name, block: block}
+    end
+
+    def todo(list)
+      @todo_list = list
+    end
   end
 end

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

@@ -1,19 +1,15 @@
-require 'securerandom'
-
-class Synvert::Rewriter::Instance
-  def dynamic_finder_to_hash(node, prefix)
+Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
+  helper_method 'dynamic_finder_to_hash' do |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 "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.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_")
+      hash_params = dynamic_finder_to_hash("find_all_by_")
       replace_with "{{receiver}}.where(#{hash_params})"
     end
   end
@@ -21,7 +17,7 @@ Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.rb' do
     # find_by_... => where(...).first
     with_node type: 'send', message: /find_by_(.*)/ do
-      hash_params = dynamic_finder_to_hash(node, "find_by_")
+      hash_params = dynamic_finder_to_hash("find_by_")
       replace_with "{{receiver}}.where(#{hash_params}).first"
     end
   end
@@ -29,7 +25,7 @@ Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.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_")
+      hash_params = dynamic_finder_to_hash("find_last_by_")
       replace_with "{{receiver}}.where(#{hash_params}).last"
     end
   end
@@ -37,7 +33,7 @@ Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.rb' do
     # scoped_by_... => where(...)
     with_node type: 'send', message: /scoped_by_(.*)/ do
-      hash_params = dynamic_finder_to_hash(node, "scoped_by_")
+      hash_params = dynamic_finder_to_hash("scoped_by_")
       replace_with "{{receiver}}.where(#{hash_params})"
     end
   end
@@ -45,7 +41,7 @@ Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.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_")
+      hash_params = dynamic_finder_to_hash("find_or_initialize_by_")
       replace_with "{{receiver}}.find_or_initialize_by(#{hash_params})"
     end
   end
@@ -53,7 +49,7 @@ Synvert::Rewriter.new "convert_dynamic_finders", "Convert dynamic finders" do
   within_files '**/*.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_")
+      hash_params = dynamic_finder_to_hash("find_or_create_by_")
       replace_with "{{receiver}}.find_or_create_by(#{hash_params})"
     end
   end

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

@@ -1,4 +1,4 @@
-Synvert::Rewriter.new "strong_parameters", "use strong_parameters syntax" do
+Synvert::Rewriter.new "strong_parameters", "Use strong_parameters syntax" do
   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
@@ -6,6 +6,13 @@ Synvert::Rewriter.new "strong_parameters", "use strong_parameters syntax" do
     end
   end
 
+  within_files 'config/**/*.rb' do
+    # remove config.active_record.mass_assignment_sanitizer = ...
+    with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'active_record'}, message: 'mass_assignment_sanitizer=' do
+      remove
+    end
+  end
+
   parameters = {}
   within_files 'app/models/**/*.rb' do
     # assign and remove attr_accessible ...

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

@@ -1,6 +1,6 @@
 require 'securerandom'
 
-Synvert::Rewriter.new "upgrade_rails_3_2_to_4_0", "Upgrade rails from 3.2 to 4.0" do
+Synvert::Rewriter.new "upgrade_rails_3_2_to_4_0", "Upgrade rails from 3.2 to 4.0, it contains convert_dynamic_finder and strong_parameters snippets" do
   gem_spec 'rails', '3.2.0'
 
   within_file 'config/application.rb' do
@@ -20,6 +20,13 @@ Synvert::Rewriter.new "upgrade_rails_3_2_to_4_0", "Upgrade rails from 3.2 to 4.0
     end
   end
 
+  within_file 'config/**/*.rb' do
+    # config.assets.compress = ... => config.assets.js_compressor = ...
+    with_node type: 'send', receiver: {type: 'send', receiver: {type: 'send', message: 'config'}, message: 'assets'}, message: 'compress=' do
+      replace_with "config.assets.js_compressor = {{arguments}}"
+    end
+  end
+
   within_file 'config/initializers/wrap_parameters.rb' do
     # remove
     # ActiveSupport.on_load(:active_record) do
@@ -98,6 +105,13 @@ Synvert::Rewriter.new "upgrade_rails_3_2_to_4_0", "Upgrade rails from 3.2 to 4.0
     end
   end
 
+  within_files 'db/migrate/*.rb' do
+    # remove rename_index ...
+    with_node type: 'send', message: 'rename_index' do
+      remove
+    end
+  end
+
   within_files 'app/models/**/*.rb' do
     # self.serialized_attributes => self.class.serialized_attributes
     with_node type: 'send', receiver: 'self', message: 'serialized_attributes' do
@@ -138,4 +152,8 @@ Synvert::Rewriter.new "upgrade_rails_3_2_to_4_0", "Upgrade rails from 3.2 to 4.0
 
   add_snippet 'convert_dynamic_finders'
   add_snippet 'strong_parameters'
+
+  todo <<-EOF
+Rails 4.0 no longer supports loading plugins from vendor/plugins. You must replace any plugins by extracting them to gems and adding them to your Gemfile. If you choose not to make them gems, you can move them into, say, lib/my_plugin/* and add an appropriate initializer in config/initializers/my_plugin.rb.
+  EOF
 end

data/lib/synvert/version.rb

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

data/spec/synvert/rewriter/gem_spec_spec.rb

@@ -36,6 +36,13 @@ GEM
       expect(gem_spec).not_to be_match
     end
 
+    it 'returns false if gem does not exist in Gemfile.lock' do
+      expect(File).to receive(:exists?).with('./Gemfile.lock').and_return(true)
+      expect(File).to receive(:read).with('./Gemfile.lock').and_return(gemfile_lock_content)
+      gem_spec = Rewriter::GemSpec.new('synvert', '1.0.0')
+      expect(gem_spec).not_to be_match
+    end
+
     it 'raise LoadError if Gemfile.lock does not exist' do
       expect(File).to receive(:exists?).with('./Gemfile.lock').and_return(false)
       gem_spec = Rewriter::GemSpec.new('ast', '1.1.0')

data/spec/synvert/rewriter_spec.rb

@@ -42,8 +42,8 @@ module Synvert
 
     describe 'parses add_snippet' do
       it 'process the rewritter' do
-        rewriter1 = Synvert::Rewriter.new 'rewriter1', 'description1'
-        rewriter2 = Synvert::Rewriter.new 'rewriter2', 'description2' do
+        rewriter1 = Rewriter.new 'rewriter1', 'description1'
+        rewriter2 = Rewriter.new 'rewriter2', 'description2' do
           add_snippet :rewriter1
         end
         expect(rewriter1).to receive(:process)
@@ -51,10 +51,54 @@ module Synvert
       end
 
       it 'raises RewriterNotFound' do
-        rewriter = Synvert::Rewriter.new 'name', 'description' do
+        rewriter = Rewriter.new 'name', 'description' do
           add_snippet :not_exist
         end
-        expect { rewriter.process }.to raise_error(Synvert::RewriterNotFound)
+        expect { rewriter.process }.to raise_error(RewriterNotFound)
+      end
+    end
+
+    describe 'parses helper_method' do
+      it 'adds helper method to new instance' do
+        instance = double
+        expect(Rewriter::Instance).to receive(:new).and_return(instance)
+        expect(instance).to receive(:process)
+        rewriter = Rewriter.new 'name', 'description' do
+          helper_method 'dynamic_helper' do |arg1, arg2|
+            'dynamic result'
+          end
+          within_file 'spec/spec_helper.rb' do; end
+        end
+        rewriter.process
+        expect(instance.dynamic_helper('arg1', 'arg2')).to eq 'dynamic result'
+      end
+    end
+
+    describe 'parses todo' do
+      it 'sets todo_list' do
+        rewriter = Rewriter.new 'name', 'description' do
+          todo "this rewriter doesn't do blah blah blah"
+        end
+        rewriter.process
+        expect(rewriter.todo_list).to eq "this rewriter doesn't do blah blah blah"
+      end
+    end
+
+    describe 'class methods' do
+      before :each do
+        Rewriter.clear
+      end
+
+      it 'registers and calls rewriter' do
+        rewriter = Rewriter.new 'rewriter', 'description'
+        expect(rewriter).to receive(:process)
+        Rewriter.call 'rewriter'
+      end
+
+      it 'registers and list all available rewriters' do
+        rewriter1 = Rewriter.new 'rewriter1', 'description1'
+        rewriter2 = Rewriter.new 'rewriter2', 'description2'
+        expect(Rewriter.availables).to eq [rewriter1, rewriter2]
       end
     end
   end

data/spec/synvert/snippets/rails/strong_parameters_spec.rb

@@ -13,6 +13,7 @@ describe 'rails strong_parameters snippet' do
 module Synvert
   class Application < Rails::Application
     config.active_record.whitelist_attributes = true
+    config.active_record.mass_assignment_sanitizer = :strict
   end
 end
     '''}

data/spec/synvert/snippets/rails/upgrade_3_2_to_4_0_spec.rb

@@ -23,6 +23,8 @@ end
 module Synvert
   class Application < Rails::Application
     config.active_record.whitelist_attributes = true
+    config.active_record.mass_assignment_sanitizer = :strict
+    config.assets.compress = :uglifier
     config.middleware.insert_before(Rack::Lock, ActionDispatch::BestStandardsSupport)
   end
 end
@@ -31,6 +33,7 @@ end
 Bundler.require(:default, Rails.env)
 module Synvert
   class Application < Rails::Application
+    config.assets.js_compressor = :uglifier
   end
 end
     '''}
@@ -105,6 +108,25 @@ Synvert::Application.routes.draw do
   get 'こんにちは', controller: 'welcome', action: 'index'
   get '/' => 'root#index'
   get 'new', to: 'episodes#new'
+end
+    """}
+    let(:migration_content) {"""
+class RenamePeopleToUsers < ActiveRecord::Migration
+  def change
+    change_table :posts do |t|
+      t.rename :user_id, :account_id
+      t.rename_index :user_id, :account_id
+    end
+  end
+end
+    """}
+    let(:migration_rewritten_content) {"""
+class RenamePeopleToUsers < ActiveRecord::Migration
+  def change
+    change_table :posts do |t|
+      t.rename :user_id, :account_id
+    end
+  end
 end
     """}
     let(:post_model_content) {'''
@@ -241,6 +263,7 @@ end
     it 'process' do
       FileUtils.mkdir_p 'config/environments'
       FileUtils.mkdir_p 'config/initializers'
+      FileUtils.mkdir_p 'db/migrate'
       FileUtils.mkdir_p 'app/models'
       FileUtils.mkdir_p 'app/controllers'
       FileUtils.mkdir_p 'test/unit'
@@ -251,6 +274,7 @@ end
       File.write 'config/initializers/wrap_parameters.rb', wrap_parameters_content
       File.write 'config/initializers/secret_token.rb', secret_token_content
       File.write 'config/routes.rb', routes_content
+      File.write 'db/migrate/20140101000000_change_posts.rb', migration_content
       File.write 'app/models/post.rb', post_model_content
       File.write 'app/controllers/users_controller.rb', users_controller_content
       File.write 'app/controllers/posts_controller.rb', posts_controller_content
@@ -264,6 +288,7 @@ end
       expect(File.read 'config/initializers/wrap_parameters.rb').to eq wrap_parameters_rewritten_content
       expect(File.read 'config/initializers/secret_token.rb').to eq secret_token_rewritten_content
       expect(File.read 'config/routes.rb').to eq routes_rewritten_content
+      expect(File.read 'db/migrate/20140101000000_change_posts.rb').to eq migration_rewritten_content
       expect(File.read 'app/models/post.rb').to eq post_model_rewritten_content
       expect(File.read 'app/controllers/users_controller.rb').to eq users_controller_rewritten_content
       expect(File.read 'app/controllers/posts_controller.rb').to eq posts_controller_rewritten_content

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synvert
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser