uv_refactor 0.0.1

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem "activesupport", "~> 3.0.0"
+gem "i18n"
+
+group :test, :development do
+  gem "rspec"
+  gem "autotest"
+  gem "autotest-fsevent" if RUBY_PLATFORM =~ /darwin/
+  gem "ruby-debug19"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.4)
+    autotest-fsevent (0.2.3)
+      sys-uname
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mocha (0.9.9)
+      rake
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sys-uname (0.8.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.0)
+  autotest
+  autotest-fsevent
+  i18n
+  mocha
+  rspec
+  ruby-debug19

data/README.markdown

@@ -0,0 +1,78 @@
+# UV Refactor
+
+A mixin class which defines some methods to help you refactor your codebase.
+
+## Description
+
+If you want to rename methods or relations, it helps to get some reminders that a refactoring is in progress.
+Having methods which hold `refactor`, it becomes easier to spot those methods in your codebase.
+
+## Installation
+
+Standalone:
+
+    gem install uv_refactor
+
+With bundler:
+
+    gem "uv_refactor"
+    
+## Usage
+
+You have to include the Refactor module. Here is a silly example:
+Imagine you'd like to rename 
+
+    class User < ActiveRecord::Base
+      include Refactor
+
+      refactor_method :fullname, :name
+    end
+    
+### Refactor methods
+
+Creates an attribute accessor for `:new_method` and redirects `:old_method` to it.
+
+    refactor_method old_method, new_method
+    
+## Configure the Refactorer
+
+You are able to override the deprecation_method to fit your needs.
+
+    # config/initializers/currency_updater.rb
+    
+    Refactor.setup do |config|
+      config.deprecation_method = lambda {|old_method, new_method| 1.2345 }
+    end
+
+## Changelog
+
+* 2010-11-21: Project created (0.0.1)
+
+## Contributors
+
+* Jan Riethmayer (@riethmayer, maintainer)
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 [urbanvention](http://urbanvention.com).
+
+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/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/init.rb

@@ -0,0 +1 @@
+require 'uv_refactor'

data/lib/uv_refactor.rb

@@ -0,0 +1,37 @@
+module Refactor
+
+  autoload :Deprecation, 'uv_refactor/deprecation'
+
+  mattr_accessor :deprecation_method
+  @@deprecation_method = lambda {|old_method, new_method, klass|
+    if klass.instance_methods.include?(old_method)
+      Deprecation.remove_old_method(old_method,
+                                    klass,
+                                    eval("caller(0)", &lambda{}))
+    end
+
+    unless klass.instance_methods.include?(new_method)
+      Deprecation.missing_database_entry(new_method,klass)
+      define_method(new_method) do
+        self.class_eval { attr_accessor new_method }
+      end
+    end
+
+    define_method(old_method) do |*args, &block|
+      Deprecation.
+        renaming_warning(old_method,
+                         new_method,
+                         # 3rd stacktrace element from caller
+                         eval("caller(0)", &lambda {}))
+      send(new_method, *args, &block)
+    end
+  }
+
+  def self.setup
+    yield self
+  end
+
+  def self.included(base)
+    base.send(:include, Deprecation)
+  end
+end

data/lib/uv_refactor/deprecation.rb

@@ -0,0 +1,55 @@
+module Refactor
+  module Deprecation
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:include, Deprecation::InstanceMethods)
+    end
+
+    module ClassMethods
+      def refactor_method(old_method,new_method)
+        Refactor.deprecation_method.call(old_method,new_method, self)
+      end
+    end
+
+    module InstanceMethods
+      def refactor_warnings
+        Deprecation::Warnings
+      end
+    end
+
+    #----------------------------------------------------------------#
+    # Warnings
+    #----------------------------------------------------------------#
+    Warnings = []
+    class << self
+      def missing_database_entry new_method, klass
+        refactor_warning "Missing migration for #{klass} **#{new_method}**."
+      end
+
+      def renaming_warning(old_method,new_method,origin)
+        whereabout = prettify(origin)
+        refactor_warning "Remove **#{old_method}** with **#{new_method}** in #{whereabout}."
+      end
+
+      def remove_old_method(old_method,klass,origin)
+        whereabout = prettify(origin)
+        refactor_warning "Remove **#{old_method}** in #{klass}."
+      end
+
+      def refactor_warning(warning)
+        #         if defined?(logger)
+        #           logger.warn warning
+        #         else
+        Warnings << warning
+        warn warning
+        #         end
+      end
+
+      def prettify(origin)
+        stack_trace_line = origin[3]
+        only_file_and_filenumber = stack_trace_line.gsub(/:in.*$/,"")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "rspec"
+
+gem "activesupport"
+
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/load_error'
+require 'active_support/core_ext/module/attr_internal'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/name_error'
+require 'active_support/inflector'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib', 'uv_refactor')
+require "uv_refactor"
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/uv_refactor/deprecation_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+module Refactor
+  describe Deprecation do
+    class User
+      include Refactor
+      attr_accessor :foo
+
+      refactor_method :old_method, :new_method
+      refactor_method :old_foo, :foo
+
+      def existing_method
+        "this exists"
+      end
+
+      refactor_method :existing_method, :future_method
+    end
+
+    def migration_warning(method)
+      /Missing migration for Refactor::User \*\*#{method}\*\*/
+    end
+
+
+    before :each do
+      @user = User.new
+    end
+
+    it "should respond to old_method" do
+      @user.should respond_to(:old_method)
+    end
+
+    it "should add missing migration warning for new_method" do
+      @user.refactor_warnings.join(" ").should match(migration_warning("new_method"))
+    end
+
+    it "should respond_to new_method" do
+      @user.should respond_to(:new_method)
+    end
+
+    it "should respond_to old_foo" do
+      @user.should respond_to(:old_foo)
+    end
+
+    it "should not warn about a missing migration for foo" do
+      @user.refactor_warnings.join(" ").should_not match(migration_warning("foo"))
+    end
+
+    it "should hint if old method exists and you're refactoring" do
+      @user.refactor_warnings.join(" ").should match(/Remove \*\*existing_method\*\*/)
+    end
+
+    it "should warn about old methods" do
+      @user.old_foo
+      @user.refactor_warnings.join(" ").should match(/deprecation_spec.rb/)
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: uv_refactor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jan Riethmayer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :runtime
+  version_requirements: *id002
+description: Some refactoring helpers.
+email: jan@urbanvention.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- init.rb
+- lib/uv_refactor.rb
+- lib/uv_refactor/deprecation.rb
+- autotest/discover.rb
+- spec/spec_helper.rb
+- spec/uv_refactor/deprecation_spec.rb
+has_rdoc: true
+homepage: http://github.com/urbanvention/uv_refactor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Refactoring your rails application.
+test_files: 
+- autotest/discover.rb
+- spec/spec_helper.rb
+- spec/uv_refactor/deprecation_spec.rb