arel_converter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47763feba6e20dbcb12a2980e34418cc44807028
+  data.tar.gz: 700c28866ae2ead78afe2cbea76814e3974cb568
+SHA512:
+  metadata.gz: da48e77635fe41e943295a766e8ef381daf2b6f6f0bbe307f982abe1daf73a208a2bdda8ea84a8ea4846f28ce9c13424935a3dca7ff7f2081a33fe19cf97ea0b
+  data.tar.gz: c68ee8ea1d2fe292ed6192b82cfbeef192eede810115a4afd1ee6a768d0b25ff8b7f2147cabf3385c5abb430dbcc2b5967f6d68c0f25753cfd2e95ca73546184

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 progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peer Allan
+
+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,124 @@
+# ArelConverter
+
+This gem add the 'arel_convert' command to your system. When run against
+a directory (or a single file) it will find and convert scopes,
+associations and ActiveRecord finders into Rails 4 compatible Arel
+syntax using Ruby 1.9 array syntax where appropriate. As you may expect
+it works best under >=1.9 (development and testing was done under 2.0).
+
+Here are some examples of what is converted,
+
+```ruby
+scope :active, :conditions => {:active => true}, :order => 'created_at'
+# becomes
+scope :active, -> { where(active: true).order('created_at') }
+
+Model.find(:all, :conditions => ['name = ?', params[:term]], :limit => 5)
+# becomes
+Model.where('name = ?', params[:term]).limit(5)
+
+has_many :articles, :class_name => "Post", :order => 'updated_at DESC'
+# becomes
+has_many :articles, -> { order('updated_at DESC') }, class_name: "Post"
+```
+
+The converters use Ruby2Ruby and RubyParser to convert to and translate
+s-expressions. This ensures the code is converter back into valid Ruby
+code. String parsing just doesn't work as well.
+
+There are 3 converters,
+
+### Scope
+
+Converts 'scope' statements into the updated Rails 4 syntax, i.e.
+wrapped in a lambda, with pre-Arel options converted to Arel
+
+### Associations
+
+Updates associations to use the updated Rails 4 syntax, i.e. wrapped in
+lambdas where necessary. Assocation types handled are,
+
+* belongs_to
+* has_one
+* has_many
+* has_and_belongs_to_many
+
+### Finders
+
+Updates old ActiveRecord (pre Rails 3) syntax into Arel syntax of
+chained Relations. This handles the following, including chained calls,
+
+* Object.find(:all
+* Object.find(:first
+* Object.find.*:conditions
+* Object.all(
+* Object.first(
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arel_converter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arel_converter
+
+## Usage
+
+    $ arel_convert [all,scope,association,finder] [PATH]
+
+## Notes/Warnings/Recommendations
+
+As with any software that could potentially update a wide swath of your
+codebase in one (terrible) moment, it is recommended that you are
+operating under some form of source control or have a reliable backup.
+
+The converters doesn't play well with multiline code blocks. This means
+that the parser will encounter a Exception (likely SyntaxError) when
+processing the first line. This is because the matching code is a simple
+grep of the file. Therefore, it would only grab the first line of a
+multiline statement. The good news is that these exceptions will show up
+in the results.
+
+If your tests/specs are good then everything should still pass. If your
+tests/specs are coupled to ActiveRecord finders then alot of them are
+going to break. The converters make no attempt to update tests/specs at
+this time. I've toyed with it and didn't get very far.
+
+
+## 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
+
+# License
+
+### This code is free to use under the terms of the 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/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/TODO.md

@@ -0,0 +1,6 @@
+# ArelConverter TODO
+
+* add specs for the CLI command
+* deal with multiline declarations
+* add converter find_or_create_by_*
+* convert in test files too?

data/arel_converter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arel_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arel_converter"
+  spec.version       = ArelConverter::VERSION
+  spec.authors       = ["Peer Allan"]
+  spec.email         = ["peer.allan@canadadrugs.com"]
+  spec.description   = %q{Converts existing AR finder syntax to AREL}
+  spec.summary       = %q{Converts AR finders, scopes and association arguments to AREL syntax}
+  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_dependency('ruby2ruby')
+  spec.add_dependency('ruby_parser')
+  spec.add_dependency('logging')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/bin/arel_convert

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'arel_converter'
+
+ArelConverter::Command.new(*ARGV).run!

data/lib/arel_converter.rb

@@ -0,0 +1,25 @@
+require "arel_converter/version"
+require 'ruby2ruby'
+require 'ruby_parser'
+require 'logging'
+
+$:.unshift(File.dirname(__FILE__))
+
+require File.join('arel_converter', 'base')
+require File.join('arel_converter', 'command')
+require File.join('arel_converter', 'formatter')
+require File.join('arel_converter', 'active_record_finder')
+require File.join('arel_converter', 'scope')
+require File.join('arel_converter', 'association')
+require File.join('arel_converter', 'replacement')
+
+# Translators
+require File.join('arel_converter', 'translators', 'base')
+require File.join('arel_converter', 'translators', 'options')
+require File.join('arel_converter', 'translators', 'scope')
+require File.join('arel_converter', 'translators', 'finder')
+require File.join('arel_converter', 'translators', 'association')
+
+module ArelConverter
+
+end

data/lib/arel_converter/active_record_finder.rb

@@ -0,0 +1,19 @@
+module ArelConverter
+  class ActiveRecordFinder < Base
+
+    def grep_matches_in_file(file)
+      raw_ar_finders = ''
+      ["find(:all", "find(:first", "find.*:conditions =>", '\.all(', '\.first('].each do |v|
+        raw_ar_finders += `grep -hr '#{v}' #{file}`
+      end
+
+      raw_ar_finders.split("\n")
+    end
+
+    def process_line(finder)
+      ArelConverter::Translator::Finder.translate(finder)
+    end
+
+  end
+
+end

data/lib/arel_converter/association.rb

@@ -0,0 +1,21 @@
+module ArelConverter
+  class Association < Base
+
+    def grep_matches_in_file(file)
+      raw_named_scopes = `grep -hr "^\s*has_\\|belongs_to" #{file}`
+      raw_named_scopes.split("\n")
+    end
+
+    def process_line(line)
+      ArelConverter::Translator::Association.translate(line)
+    end
+
+    def verify_line(line)
+      parser = RubyParser.new
+      sexp   = parser.process(line)
+      sexp.shift == :call
+    end
+
+  end
+
+end

data/lib/arel_converter/base.rb

@@ -0,0 +1,76 @@
+module ArelConverter
+  class Base
+
+    attr_accessor :options
+
+    def initialize(path, options = {})
+      @path    = path
+      @options = {dry_run: false}.merge(options)
+    end
+
+    def run!
+      File.directory?(@path) ? parse_directory(@path) : parse_file(@path)
+    end
+
+    def parse_directory(path)
+      Dir[File.join(path, '**/*.rb')].each do |file|
+        begin
+          parse_file(file)
+        rescue => e
+          Formatter.alert(file, [])
+        end
+      end
+    end
+
+    def parse_file(file)
+
+      lines_to_process = grep_matches_in_file(file)
+
+      return if lines_to_process.empty?
+
+      replacements = process_lines(lines_to_process)
+
+      unless (replacements.nil? || replacements.empty?)
+        Formatter.alert(file, replacements)
+        update_file(file, replacements) unless @options[:dry_run]
+      end
+    end
+
+    def process_lines(lines)
+      lines.map do |line|
+        r = Replacement.new(line)
+        begin
+          next unless verify_line(line)
+          r.new_content = process_line(line)
+        rescue SyntaxError => e
+          r.error = "SyntaxError when evaluating options for #{line}"
+        rescue Exception => e
+          r.error = "#{e.class} #{e.message} when evaluating options for \"#{line}\"\n#{e.backtrace.first}"
+        end
+        r
+      end.compact
+    end
+
+    def update_file(file, line_replacements)
+      contents = File.read(file)
+      line_replacements.each do |r|
+        contents.gsub!(r.old_content, r.new_content) if r.valid?
+      end
+
+      File.open(file, 'w') do |f|
+        f.puts contents
+      end
+    end
+
+    def grep_matches_in_file(file)
+      [] # abstract method overriden by subclasses
+    end
+
+  protected
+
+    def verify_line(line)
+      true
+    end
+
+  end
+end

data/lib/arel_converter/command.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+
+module ArelConverter
+
+  class Command
+
+    attr_accessor :options
+
+    def initialize(*args)
+      args << '--help' if args.empty?
+      @translators = ['scope','finder','association']
+      @options = {}
+      parse_argv(*args)
+    end
+
+    def run!
+      if @translators.include?('association')
+        puts "== Checking Associations"
+        ArelConverter::Association.new(options[:path], options).run!
+      end
+
+      if @translators.include?('scope')
+        puts "\n== Checking Scopes"
+        ArelConverter::Scope.new(options[:path], options).run!
+      end
+
+      if @translators.include?('finder')
+        puts "\n== Checking Finders"
+        ArelConverter::ActiveRecordFinder.new(options[:path], options).run!
+      end
+    end
+
+  private
+
+    def parse_argv(*args)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: arel_convert [options] [PATH]"
+        opts.on('-t', '--translators [scope,finder,association]', Array, 'Specify specific translators') { |list| @translators = list }
+        opts.on('--dry-run', 'Run a simulated update, files will not be updated' ) { |v| options[:dry_run] = true }
+        opts.on('-h', '--help', 'Display this screen' ) do
+          puts opts
+          exit 0
+        end
+      end.parse!(args)
+      options[:path] = args.empty? ? '.' : args.shift
+    end
+
+  end
+
+end

data/lib/arel_converter/formatter.rb

@@ -0,0 +1,46 @@
+module ArelConverter
+  class Formatter
+
+    # Terminal colors, borrowed from Thor
+    CLEAR      = "\e[0m"
+    BOLD       = "\e[1m"
+    RED        = "\e[31m"
+    YELLOW     = "\e[33m"
+    CYAN       = "\e[36m"
+    WHITE      = "\e[37m"
+
+    # Show an upgrade alert to the user
+    def self.alert(title, culprits, errors=nil)
+      if RbConfig::CONFIG['host_os'].downcase =~ /mswin|windows|mingw/
+        Formatter.basic_alert(title, culprits)
+      else
+        Formatter.color_alert(title, culprits)
+      end
+    end
+
+    # Show an upgrade alert to the user.  If we're on Windows, we can't
+    # use terminal colors, hence this method.
+    def self.basic_alert(title, culprits)
+      puts "** " + title
+      Array(culprits).each do |c|
+        puts c.valid? ? "  FROM: #{c.old_content}\n    TO: #{c.new_content}\n" :
+                        "** ERROR - #{c.error}"
+      end
+      puts
+    end
+
+    # Show a colorful alert to the user
+    def self.color_alert(file, culprits )
+      puts "#{RED}#{BOLD}#{file}#{CLEAR}"
+      Array(culprits).each do |c|
+        puts c.valid? ? "#{YELLOW}  FROM: #{c.old_content}\n    TO: #{c.new_content}\n" :
+                        "#{CYAN}#{BOLD}  - #{c.error}#{CLEAR}"
+
+      end
+    ensure
+      puts "#{CLEAR}"
+    end
+
+  end
+end
+