rails_refactor 1.0

data/dummy/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/dummy/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/dummy/spec/controllers/dummies_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe DummiesController do
+
+end

data/dummy/spec/helpers/dummies_helper_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+# Specs in this file have access to a helper object that includes
+# the DummiesHelper. For example:
+#
+# describe DummiesHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       helper.concat_strings("this","that").should == "this that"
+#     end
+#   end
+# end
+describe DummiesHelper do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/dummy/spec/models/dummy_model_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe DummyModel do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/dummy/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/dummy/test/functional/dummies_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class DummiesControllerTest < ActionController::TestCase
+  test "should get index" do
+    get :index
+    assert_response :success
+  end
+
+end

data/dummy/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionDispatch::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/dummy/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/dummy/test/unit/helpers/dummies_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class DummiesHelperTest < ActionView::TestCase
+end

data/lib/rails_refactor.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+
+begin
+  require './config/environment.rb'
+rescue LoadError
+  puts "*** rails_refactor needs to be run from the root of a Rails 3 webapp ***"
+  exit
+end
+
+class Renamer
+  def initialize(from, to)
+    @from, @to = from, to
+  end
+
+  def model_rename
+    to_model_file = @to.underscore + ".rb"
+    `mv app/models/#{@from.underscore}.rb app/models/#{to_model_file}`
+    replace_in_file("app/models/#{to_model_file}", @from, @to)
+
+    to_spec_file = @to.underscore + "_spec.rb"
+    `mv spec/models/#{@from.underscore}_spec.rb spec/models/#{to_spec_file}`
+    replace_in_file("spec/models/#{to_spec_file}", @from, @to)
+
+    Dir["db/migrate/*_create_#{@from.underscore.pluralize}.rb"].each do |file|
+      timestamp_and_path = file.split('_')[0]
+      to_migration_path = "#{timestamp_and_path}_create_#{@to.underscore.pluralize}.rb"
+      `mv #{file} #{to_migration_path}`
+      replace_in_file(to_migration_path, "Create#{@from.pluralize}", "Create#{@to.pluralize}")
+      replace_in_file(to_migration_path, @from.underscore.pluralize, @to.underscore.pluralize)
+    end
+  end
+
+  def controller_rename
+    setup_for_controller_rename
+
+    to_controller_path = "app/controllers/#{@to.underscore}.rb"
+    to_resource_name   = @to.gsub(/Controller$/, "")
+    to_resource_path   = to_resource_name.underscore
+
+    `mv app/controllers/#{@from.underscore}.rb #{to_controller_path}`
+    replace_in_file(to_controller_path, @from, @to)
+
+    to_spec = "spec/controllers/#{to_resource_path}_controller_spec.rb"
+    `mv spec/controllers/#{@from.underscore}_spec.rb #{to_spec}`
+    replace_in_file(to_spec, @from, @to)
+
+    `mv app/views/#{@from_resource_path} app/views/#{to_resource_path}`
+
+    to_helper_path = "app/helpers/#{to_resource_path}_helper.rb"
+    `mv app/helpers/#{@from_resource_path}_helper.rb #{to_helper_path}`
+
+    replace_in_file(to_helper_path, @from_resource_name, to_resource_name)
+
+    replace_in_file('config/routes.rb', @from_resource_path, to_resource_path)
+  end
+
+  def controller_action_rename
+    setup_for_controller_rename
+    controller_path = "app/controllers/#{@from_controller.underscore}.rb"
+    replace_in_file(controller_path, @from_action, @to)
+    
+    views_for_action = "app/views/#{@from_resource_path}/#{@from_action}.*"
+
+    Dir[views_for_action].each do |file|
+      extension = file.split('.')[1..2].join('.')
+      `mv #{file} app/views/#{@from_resource_path}/#{@to}.#{extension}`
+    end
+  end
+
+  def setup_for_controller_rename
+    @from_controller, @from_action = @from.split(".")
+    @from_resource_name = @from_controller.gsub(/Controller$/, "")
+    @from_resource_path = @from_resource_name.underscore
+  end
+
+  def replace_in_file(path, find, replace)
+    contents = File.read(path)
+    contents.gsub!(find, replace)
+    File.open(path, "w+") { |f| f.write(contents) }
+  end
+
+end
+
+if ARGV.length == 3
+  command, from, to = ARGV
+  renamer = Renamer.new(from, to)
+
+  if command == "rename"
+    if from.include? "Controller"
+      if from.include? '.'
+        renamer.controller_action_rename 
+      else
+        renamer.controller_rename
+      end
+    else
+      renamer.model_rename
+    end
+  end
+elsif ARGV[0] == "test"
+  require 'test/unit'
+  class RailsRefactorTest < Test::Unit::TestCase
+
+    def setup
+      raise "Run tests in 'dummy' rails project" if !Dir.pwd.end_with? "dummy"
+    end
+
+    def teardown
+      `git checkout .`
+      `git clean -f`
+      `rm -rf app/views/hello_world`
+    end
+
+    def rename(from, to)
+      `../lib/rails_refactor.rb rename #{from} #{to}`
+    end
+
+    def assert_file_changed(path, from, to)
+      contents = File.read(path)
+      assert contents.include?(to) 
+      assert !contents.include?(from) 
+    end
+
+    def test_model_rename
+      rename("DummyModel", "NewModel")
+
+      assert File.exist?("app/models/new_model.rb")
+      assert !File.exist?("app/models/dummy_model.rb")
+      assert_file_changed("app/models/new_model.rb", 
+                          "DummyModel", "NewModel")
+
+      assert File.exist?("spec/models/new_model_spec.rb")
+      assert !File.exist?("spec/models/dummy_model_spec.rb")
+      assert_file_changed("spec/models/new_model_spec.rb", 
+                          "DummyModel", "NewModel")
+
+      assert File.exist?("db/migrate/20101230081247_create_new_models.rb")
+      assert !File.exist?("db/migrate/20101230081247_create_dummy_models.rb")
+      assert_file_changed("db/migrate/20101230081247_create_new_models.rb",
+                          "CreateDummyModels", "CreateNewModels")
+      assert_file_changed("db/migrate/20101230081247_create_new_models.rb",
+                          ":dummy_models", ":new_models")
+    end
+
+    def test_controller_action_rename
+      rename('DummiesController.index', 'new_action')
+      assert_file_changed("app/controllers/dummies_controller.rb", "index", "new_action")
+      assert File.exists?("app/views/dummies/new_action.html.erb")
+      assert !File.exists?("app/views/dummies/index.html.erb")
+    end
+
+    def test_controller_rename
+      rename("DummiesController", "HelloWorldController")
+      assert File.exist?("app/controllers/hello_world_controller.rb")
+      assert !File.exist?("app/controllers/dummies_controller.rb")
+
+      assert File.exist?("app/views/hello_world/index.html.erb")
+      assert !File.exist?("app/views/dummies/index.html.erb")
+
+      assert_file_changed("app/controllers/hello_world_controller.rb", 
+                          "DummiesController", "HelloWorldController")
+
+      routes_contents = File.read("config/routes.rb")
+      assert routes_contents.include?("hello_world") 
+      assert !routes_contents.include?("dummies") 
+
+      helper_contents = File.read("app/helpers/hello_world_helper.rb")
+      assert helper_contents.include?("HelloWorldHelper") 
+      assert !helper_contents.include?("DummiesHelper") 
+
+      assert File.exist?("spec/controllers/hello_world_controller_spec.rb")
+      assert !File.exist?("spec/controllers/dummies_controller_spec.rb")
+      assert_file_changed("spec/controllers/hello_world_controller_spec.rb", 
+                          "DummiesController", "HelloWorldController")
+    end
+  end
+else
+  puts "Usage:"
+  puts "  rails_refactor.rb rename DummyController NewController"
+  puts "  rails_refactor.rb rename DummyController.my_action new_action"
+  puts "  rails_refactor.rb rename DummyModel NewModel"
+  puts "  rails_refactor.rb test"
+end