copy_machine 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+
+gem 'rails', '3.0.0.rc'
+gem 'sqlite3-ruby'
+gem 'minitest'
+gem 'mysql'
+gem 'growl'
+gem 'redgreen'
+gem 'mocha'

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      mail (~> 2.2.5)
+    actionpack (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.9)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.22)
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      arel (~> 0.4.0)
+      tzinfo (~> 0.3.22)
+    activeresource (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+    activesupport (3.0.0.rc)
+    arel (0.4.0)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    growl (1.0.3)
+    i18n (0.4.1)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    minitest (1.7.0)
+    mocha (0.9.8)
+      rake
+    mysql (2.8.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.9)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0.rc)
+      actionmailer (= 3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activerecord (= 3.0.0.rc)
+      activeresource (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      bundler (>= 1.0.0.rc.1)
+      railties (= 3.0.0.rc)
+    railties (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      rake (>= 0.8.3)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    redgreen (1.2.2)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  growl
+  minitest
+  mocha
+  mysql
+  rails (= 3.0.0.rc)
+  redgreen
+  sqlite3-ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 richmolj@gmail.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/README.md

@@ -0,0 +1,96 @@
+Copy Machine
+============
+
+Ever had to pull records from production to debug an issue, or had a sprawling legacy app with no seeds.rb and a need for development data? Using CopyMachine, this is fixed in two ways -  either dynamically pull data from a slave database whenever no records are found, or define dataset templates that pull in data with a rake task. Whenever a copy happens, you'll get a growl notice, a small button in the top left of your app, or both. These will contain the sql and line number that fired the copy (click the button for additional info).
+
+The main benefits of CopyMachine are 1) No hassles and easy set up 2) Easily pull associations and 3) never fire callbacks or validations.
+
+Install
+-------
+
+Make sure you have growl and growl_notifications set up.
+
+**Gemfile**
+
+    gem 'growl'
+    gem 'copy_machine'
+
+Then, add a 'copy_machine' entry to your database.yml for the alternate database you'd like to copy from.
+
+**Console**
+
+    rails g copy_machine_configuration
+    
+To create config/initializers/copy_machine.rb
+
+As you move through your app, hits to the database that return 0 records will attempt to copy records from the :copy_machine database from database.yml
+
+Datasets
+--------
+
+If you want to pull in specific sets of records, define a template that finds this data and run it via rake.
+
+**console**
+
+    rails g copy_machine_template person
+
+Gives you a templates directory off of Rails root that contains person_template.rb. Within this file:
+
+**Template**
+
+    define_dataset :by_id, :needs => [:id] do
+      Person.find(@id)
+    end 
+
+That you can call from rake
+
+    rake copy:person[by_id]
+
+You'll get prompted for the id you want to copy, and your response will set the @id instance variable. Similarly,
+
+**templates/my_model_template.rb**
+
+    define_dataset :foo, :needs => [:bar] do
+      MyModel.find_by_bar(@bar)
+    end  
+
+Could be called by
+
+    rake copy:my_model[foo]
+
+Which would prompt for foo and set @foo. You can call any associations or methods you need here, just like in your app. See the comments in the generated template for more examples.
+
+Configuration
+-------------
+
+Because apps can get funky, you may have special needs before or after the copy process takes place, or scrubbing the sql itself. There are hooks in place for this:
+
+**config/initializers/copy_machine.rb**
+
+    config.alter_sql do |sql|
+      # scrub the sql, ie sql.gsub(/whatever/,'somethingelse')
+    end
+
+    config.before_copy do
+      # your code
+    end
+
+    config.after_copy do
+      # your code
+    end     
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 richmolj@gmail.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "copy_machine"
+    gem.summary = %Q{Easily copy production or slave records into your development database}
+    gem.description = %Q{For sprawling legacy apps, seeds.rb and fixtures are sometimes not enough. Copy machine eases development by copying records from a slave database as you move through your app, or as you execute predefined templates}
+    gem.email = "richmolj@gmail.com"
+    gem.homepage = "http://github.com/richmolj/copy_machine"
+    gem.authors = ["Lee Richmond"]
+    gem.add_dependency 'growl'
+    gem.add_development_dependency "minitest", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "copy_machine #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/copy_machine.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{copy_machine}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lee Richmond"]
+  s.date = %q{2010-10-07}
+  s.description = %q{For sprawling legacy apps, seeds.rb and fixtures are sometimes not enough. Copy machine eases development by copying records from a slave database as you move through your app, or as you execute predefined templates}
+  s.email = %q{richmolj@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "copy_machine.gemspec",
+     "lib/copy_machine.rb",
+     "lib/copy_machine/action_controller_extensions/base.rb",
+     "lib/copy_machine/active_record_extensions/base.rb",
+     "lib/copy_machine/active_record_extensions/callbacks.rb",
+     "lib/copy_machine/active_record_extensions/constraints.rb",
+     "lib/copy_machine/autoloading.rb",
+     "lib/copy_machine/configuration.rb",
+     "lib/copy_machine/railtie.rb",
+     "lib/copy_machine/template.rb",
+     "lib/generators/copy_machine_configuration_generator.rb",
+     "lib/generators/copy_machine_template_generator.rb",
+     "lib/generators/templates/copy_machine.rb",
+     "lib/generators/templates/example_template.rb",
+     "lib/rack/copy_machine.rb",
+     "lib/rack/copy_machine/asset_server.rb",
+     "lib/rack/copy_machine/public/__rack_copy_machine__/copy_machine.css",
+     "lib/rack/copy_machine/public/__rack_copy_machine__/copy_machine.js",
+     "lib/rack/copy_machine/public/__rack_copy_machine__/jquery-1.4.2.min.js",
+     "lib/rack/views/notifications.html.erb",
+     "test/configuration_test.rb",
+     "test/copy_machine_integration_test.rb",
+     "test/database.yml",
+     "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/richmolj/copy_machine}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily copy production or slave records into your development database}
+  s.test_files = [
+    "test/configuration_test.rb",
+     "test/copy_machine_integration_test.rb",
+     "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<growl>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+    else
+      s.add_dependency(%q<growl>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<growl>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+  end
+end
+

data/lib/copy_machine.rb

@@ -0,0 +1,24 @@
+require 'copy_machine/autoloading'
+require 'copy_machine/railtie'
+
+module CopyMachine
+  mattr_accessor :notifications
+  self.notifications = []
+
+  class << self
+    def configure
+      yield CopyMachine::Configuration.config
+    end
+
+    def config
+      CopyMachine::Configuration.config
+    end
+
+    def growl_notification(message)
+      Growl.send("notify_warning", message, {
+        :title => "Copy Machine",
+        :sticky => false
+      })
+    end
+  end
+end

data/lib/copy_machine/action_controller_extensions/base.rb

@@ -0,0 +1,15 @@
+module CopyMachine
+  module ActionControllerExtensions
+    module Base
+
+      def self.included(klass)
+        klass.before_filter :reset_copy_machine
+      end
+
+      def reset_copy_machine
+        ::CopyMachine.notifications = []
+      end
+
+    end
+  end
+end

data/lib/copy_machine/active_record_extensions/base.rb

@@ -0,0 +1,79 @@
+module CopyMachine
+  module ActiveRecordExtensions
+    module Base
+
+      def self.included(klass)
+        klass.extend CopyMachine::ActiveRecordExtensions::Callbacks
+        klass.extend CopyMachine::ActiveRecordExtensions::Constraints
+
+        klass.extend ClassMethods
+        klass.singleton_class.alias_method_chain :find_by_sql, :override
+      end
+
+      module ClassMethods
+        def with_alternate_connection(sql, backtrace)
+          ActiveSupport::Notifications.instrument("copy_machine.sql",
+            :sql => sql, :name => self.name, :backtrace => backtrace) do
+
+            ActiveRecord::Base.establish_connection :copy_machine
+            yield
+            ActiveRecord::Base.establish_connection Rails.env
+          end
+        end
+
+        def find_by_sql_with_override(sql)
+          records = find_by_sql_without_override(sql)
+          
+          if records.empty? and !@avoid_copy
+            backtrace = Rails.backtrace_cleaner.clean(caller).first
+            backtrace = backtrace.split(':')[0..1].join(":") unless backtrace.nil?
+
+            copy_mode(sql, backtrace) do
+              unless (proc = CopyMachine.config.sql_alteration).nil?
+                sql = proc.call(sql)
+              end
+              records = find_by_sql_without_override(sql)
+            end
+
+            records.each { |r| cp r }
+          end
+
+          records
+        end
+
+        private
+
+        def cp(record)
+          record.class.reset_column_information
+          attrs         = build_copy_attributes(record)
+          new_record    = new(attrs)
+          new_record.id = record.id # have to set here or will be nil
+
+          @avoid_copy = true
+          new_record.save(:validate => false) unless exists?(new_record.id)
+          @avoid_copy = false
+          new_record
+        end
+
+        # TODO: obscurity logic here
+        def build_copy_attributes(record)
+          record.attributes.reject { |k,v| !record.class.column_names.include?(k) }
+        end
+
+        def copy_mode(sql, backtrace)
+          with_alternate_connection(sql, backtrace) do
+            hook = CopyMachine.config.before_copy_hook
+            instance_eval &hook unless hook.nil?
+
+            yield
+
+            hook = CopyMachine.config.after_copy_hook
+            instance_eval &hook unless hook.nil?
+          end
+        end
+
+      end
+
+    end
+  end
+end