git_friendly_dumper 0.0.1

data/lib/git_friendly_dumper/version.rb

@@ -0,0 +1,3 @@
+class GitFriendlyDumper
+  VERSION = "0.0.1"
+end

data/lib/tasks/git_friendly_dumper_tasks.rake

@@ -0,0 +1,51 @@
+# All of these tasks can be modified with these environment vars:
+#
+#  DUMP_PATH=some/path    where the dump is         (default db/dump)
+#  TABLES=comma,sep,list  tables to dump/load       (default all)
+#  FORCE=true|1           answer 'yes'              (default false)
+#  PROGRESS=false|0       show progress             (default true)
+#  CLOBBER=false|0        clobber fixtures on dump  (default true)
+#  RAISE_ERROR=false|0    silence runtime errors    (default true)
+#  FIXTURES=comma,sep,list specific fixture files to load, invalid argument for dump tasks, should be relative filenames e.g. users/0000/0001.yml
+#  FIXTURES_FILE=filename of newline separated list of fixtures to load (use instead of FIXTURES option)
+
+require 'git_friendly_dumper'
+
+namespace :db do
+  desc "dump structure and data to db/dump (DUMP_PATH)"
+  task :dump => :environment do
+    GitFriendlyDumper.dump gfd_options.merge(:include_schema => true)
+  end
+  
+  desc "replace database with data and stucture in db/dump (DUMP_PATH)"
+  task :load => :environment do
+    GitFriendlyDumper.load gfd_options.merge(:include_schema => true)
+  end
+
+  namespace :data do
+    desc "dump table data to db/dump (DUMP_PATH)"
+    task :dump => :environment do
+      GitFriendlyDumper.dump gfd_options.merge(:include_schema => false)
+    end
+    
+    desc "load table data from db/dump (DUMP_PATH)"
+    task :load => :environment do
+      GitFriendlyDumper.load gfd_options.merge(:include_schema => false)
+    end
+  end
+  
+  def gfd_options
+    { 
+      :tables           => ENV['TABLES'].present? && ENV['TABLES'].split(',').map(&:squish),
+      :path             => ENV['DUMP_PATH'] || 'db/dump',
+      :force            => ['1', 'true'].include?(ENV['FORCE']) ? true : false,
+      :include_schema   => ['1', 'true'].include?(ENV['SCHEMA']) ? true : false,
+      :show_progress    => ['0', 'false'].include?(ENV['PROGRESS']) ? false : true,
+      :clobber_fixtures => ['1', 'true'].include?(ENV['CLOBBER']) ? true : false,
+      :limit            => ENV['LIMIT'] || 2500,
+      :raise_error      => ['0', 'false'].include?(ENV['RAISE_ERROR']) ? false : true,
+      :fixtures         => ENV['FIXTURES'] && ENV['FIXTURES'].split(','),
+      :fixtures_file    => ENV['FIXTURES_FILE']
+    }
+  end
+end

data/spec/git_friendly_dumper_spec.rb

@@ -0,0 +1,319 @@
+require 'spec_helper'
+
+module GitFriendlyDumperSpec
+  include FileUtils
+  
+  # sample app
+  class First < ActiveRecord::Base
+  end
+
+  class Second < ActiveRecord::Base
+  end
+
+  # spec helper methods
+  def reset_db
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table table
+    end
+  end
+
+  def migrate_up(version)
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migrator.migrate ['spec/resources/migrate'], version
+    end
+  end
+  
+  def remove_dump(path = @path)
+    rm_rf @path
+  end
+  
+  def dump_files_set(path = @path)
+    Dir["#{path}/**/*"].map{|f| f.sub("#{path}/", '')}.to_set
+  end
+  
+  def next_string
+    @next ||= 0
+    @next += 1
+    ['Foo', 'Bar', 'Baz'][rand(3)] + ("%04d" % @next)
+  end
+  
+  def connection
+    ActiveRecord::Base.connection
+  end
+  
+  describe 'GitFriendlyDumper' do
+    include GitFriendlyDumperSpec
+
+    before do
+      reset_db
+      @path = File.join(File.dirname(__FILE__), '../../tmp/dump')
+      remove_dump
+    end
+    
+    describe "when progressbar not installed" do
+      before do
+        if defined?(ProgressBar)
+          @progress_bar_class = ProgressBar
+          Object.send :remove_const, 'ProgressBar'
+        end
+      end
+
+      after do
+        if @progress_bar_class
+          ProgressBar = @progress_bar_class
+        end
+      end
+      
+      it ":show_progress => true should raise error" do
+        lambda { GitFriendlyDumper.new :show_progress => true }.should raise_error(RuntimeError)
+      end
+    end
+    
+    describe "when db data exists" do
+      before do
+        migrate_up(20070101010000)
+        First.create!(:name => next_string)
+        First.create!(:name => next_string)
+        Second.create!(:name => next_string)
+        Second.create!(:name => next_string)
+      end
+  
+      it "connection should have tables == ['firsts', 'seconds', 'schema_migrations']" do
+        ActiveRecord::Base.connection.tables.to_set.should == ['firsts', 'seconds', 'schema_migrations'].to_set
+      end
+
+      shared_examples_for "when dump files do not exist" do
+        it "should not require confirmation on dump" do
+          $stdin.should_not_receive(:gets)
+          @dumper.dump
+        end
+      end
+
+      shared_examples_for "when dump files exist" do
+        it "should require confirmation, and not proceed if not 'yes'" do
+          $stdin.should_receive(:gets).and_return("\n")
+          @dumper.should_not_receive(:dump_table)
+          @dumper.dump
+        end
+
+        it "should require confirmation, and proceed if 'yes'" do
+          $stdin.should_receive(:gets).and_return("yes\n")
+          @dumper.should_receive(:dump_table).at_least(1)
+          @dumper.dump
+        end
+
+        describe ", but :force => true" do
+          before do
+            @dumper.force = true
+          end
+
+          it "should not ask for confirmation" do
+            $stdin.should_not_receive(:gets)
+            @dumper.dump
+          end
+        end
+      end
+
+      describe "dump :include_schema => false" do
+        before do
+          @dumper = GitFriendlyDumper.new :include_schema => false, :path => @path
+        end
+
+        it_should_behave_like "when dump files do not exist"
+        
+        describe "when dump files exist" do
+          before { mkdir_p "#{@path}/firsts" }
+          it_should_behave_like "when dump files exist"
+        end
+      
+        describe "(after dump)" do
+          before do
+            @dumper.dump
+          end
+      
+          it "should create only dump/firsts and dump/seconds with record fixtures" do
+            dump_files_set.should == [
+              'firsts', 'firsts/0000', 'firsts/0000/0001.yml', 'firsts/0000/0002.yml',
+              'seconds', 'seconds/0000', 'seconds/0000/0001.yml', 'seconds/0000/0002.yml'
+            ].to_set
+          end
+    
+          it "should create fixtures for firsts" do
+            File.read("#{@path}/firsts/0000/0001.yml").should  == connection.select_one("SELECT * FROM firsts WHERE id=1").to_yaml
+            File.read("#{@path}/firsts/0000/0002.yml").should  == connection.select_one("SELECT * FROM firsts WHERE id=2").to_yaml
+          end
+        
+          it "should create fixtures for seconds" do
+            File.read("#{@path}/seconds/0000/0001.yml").should == connection.select_one("SELECT * FROM seconds WHERE id=1").to_yaml
+            File.read("#{@path}/seconds/0000/0002.yml").should == connection.select_one("SELECT * FROM seconds WHERE id=2").to_yaml
+          end
+        end
+      end
+      
+      describe "dump :include_schema => true" do
+        before do
+          @dumper = GitFriendlyDumper.new :include_schema => true, :path => @path
+        end
+
+        it_should_behave_like "when dump files do not exist"
+        
+        describe "when dump files exist" do
+          before { mkdir_p "#{@path}/firsts" }
+          it_should_behave_like "when dump files exist"
+        end
+      
+        describe "(after dump)" do
+          before do
+            @dumper.dump
+          end
+      
+          it "should create dump/firsts, dump/seconds dump/schema_migrations, with record fixtures, and table schemas" do
+            dump_files_set.should == [
+              'firsts', 'firsts/0000', 'firsts/0000/0001.yml', 'firsts/0000/0002.yml', 'firsts/schema.rb',
+              'seconds', 'seconds/0000', 'seconds/0000/0001.yml', 'seconds/0000/0002.yml', 'seconds/schema.rb',
+              'schema_migrations', 'schema_migrations/0000', 'schema_migrations/0000/0001.yml', 'schema_migrations/0000/0002.yml', 'schema_migrations/schema.rb'
+            ].to_set
+          end
+
+          it "should create fixtures for firsts" do
+            File.read("#{@path}/firsts/0000/0001.yml").should  == connection.select_one("SELECT * FROM firsts WHERE id=1").to_yaml
+            File.read("#{@path}/firsts/0000/0002.yml").should  == connection.select_one("SELECT * FROM firsts WHERE id=2").to_yaml
+          end
+        
+          it "should create fixtures for seconds" do
+            File.read("#{@path}/seconds/0000/0001.yml").should == connection.select_one("SELECT * FROM seconds WHERE id=1").to_yaml
+            File.read("#{@path}/seconds/0000/0002.yml").should == connection.select_one("SELECT * FROM seconds WHERE id=2").to_yaml
+          end
+        
+          it "should create fixtures for schema_migrations" do
+            YAML.load(File.read("#{@path}/schema_migrations/0000/0001.yml")).should == {"version" => "20070101000000"}
+            YAML.load(File.read("#{@path}/schema_migrations/0000/0002.yml")).should == {"version" => "20070101010000"}
+          end
+        
+          it "should contain create schema for firsts" do
+            File.read("#{@path}/firsts/schema.rb").should =~ /create_table "firsts".*string "name"/m
+          end
+        
+          it "should contain create schema for seconds" do
+            File.read("#{@path}/seconds/schema.rb").should =~ /create_table "seconds".*string "name"/m
+          end
+
+          it "should contain create schema for schema_migrations" do
+            File.read("#{@path}/schema_migrations/schema.rb").should =~ /create_table "schema_migrations".*:id => false.*string "version"/m
+          end
+        end
+      end
+      
+      
+      describe "dumping when RAISE_ERROR=false" do
+        let(:dumper) {GitFriendlyDumper.new(:include_schema => true, :raise_error => false, :path => @path)}
+        subject{ dumper }
+
+        describe "when #dump_records raises a runtime error" do
+          before(:each) do
+            dumper.should_receive(:dump_records).and_raise(RuntimeError)
+          end
+          
+          it "#dump should raise a runtime error" do
+            lambda { dumper.dump }.should raise_error(RuntimeError)                  
+          end
+        end
+        
+        describe "when #dump_records raises an ActiveRecord::Error" do
+          before(:each) do
+            dumper.should_receive(:dump_records).at_least(1).times.and_raise(ActiveRecord::ActiveRecordError)
+          end
+          
+          it "#dump should not raise a runtime error" do
+            lambda { dumper.dump }.should_not raise_error
+          end
+        end
+      end
+    end
+  
+    describe "when fixtures exist" do
+      before do
+        migrate_up(20070101010000)
+        First.create!(:name => next_string)
+        First.create!(:name => next_string)
+        Second.create!(:name => next_string)
+        Second.create!(:name => next_string)
+        GitFriendlyDumper.dump :include_schema => true, :force => true, :path => @path
+        reset_db
+      end
+      
+      shared_examples_for "when db data does not exist" do
+        it "should not require confirmation on load" do
+          $stdin.should_not_receive(:gets)
+          @dumper.load
+        end
+      end
+
+      shared_examples_for "when db data exists" do
+        it "should require confirmation, and not proceed if not 'yes'" do
+          $stdin.should_receive(:gets).and_return("\n")
+          @dumper.should_not_receive(:load_table)
+          @dumper.load
+        end
+
+        it "should require confirmation, and proceed if 'yes'" do
+          $stdin.should_receive(:gets).and_return("yes\n")
+          @dumper.should_receive(:load_table).at_least(1)
+          @dumper.load
+        end
+
+        describe ", but :force => true" do
+          before do
+            @dumper.force = true
+          end
+
+          it "should not ask for confirmation" do
+            $stdin.should_not_receive(:gets)
+            @dumper.load
+          end
+        end
+      end
+        
+      describe "load :include_schema => true" do
+        before do
+          @dumper = GitFriendlyDumper.new :include_schema => true, :path => @path
+        end
+
+        it_should_behave_like "when db data does not exist"
+        
+        describe "when db data exists" do
+          before do
+            migrate_up(20070101010000)
+          end
+          
+          it_should_behave_like "when db data exists"
+        end
+      end
+      
+      describe "loading when RAISE_ERROR=false" do
+        let(:dumper) {GitFriendlyDumper.new(:include_schema => true, :raise_error => false, :path => @path)}
+        subject{ dumper }
+
+        describe "when connection raises a runtime error" do
+          before(:each) do
+            dumper.connection.should_receive(:insert_fixture).and_raise(RuntimeError)
+          end
+          
+          it "#load should raise a runtime error" do
+            lambda { dumper.load }.should raise_error(RuntimeError)                  
+          end
+        end
+        
+        describe "when connection raises an ActiveRecord::Error" do
+          before(:each) do
+            dumper.connection.should_receive(:insert_fixture).at_least(1).times.and_raise(ActiveRecord::ActiveRecordError)
+          end
+          
+          it "#load should not raise a runtime error" do
+            lambda { dumper.load }.should_not raise_error
+          end
+        end
+      end
+    end
+  end
+end

data/spec/resources/migrate/20070101000000_create_firsts.rb

@@ -0,0 +1,11 @@
+class CreateFirsts < ActiveRecord::Migration
+  def self.up
+    create_table :firsts do |t|
+      t.string :name
+    end
+  end
+  
+  def self.down
+    drop_table :firsts
+  end
+end

data/spec/resources/migrate/20070101010000_create_seconds.rb

@@ -0,0 +1,11 @@
+class CreateSeconds < ActiveRecord::Migration
+  def self.up
+    create_table :seconds do |t|
+      t.string :name
+    end
+  end
+  
+  def self.down
+    drop_table :seconds
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+require 'git_friendly_dumper'

data/spec/support/connect.rb

@@ -0,0 +1,6 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => "tmp/db/test.sqlite3"
+)

data/spec/support/logger.rb

@@ -0,0 +1,7 @@
+require 'logger'
+require 'active_record'
+
+log_filename = File.join(File.dirname(__FILE__), '..', '..', 'tmp', 'test.log')
+`mkdir -p #{File.dirname(log_filename)}`
+log_file = File.open(log_filename, 'w')
+ActiveRecord::Base.logger = Logger.new(log_file)

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: git_friendly_dumper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70093535094440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70093535094440
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &70093535108500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535108500
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70093535105680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535105680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70093535104660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535104660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70093535103600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535103600
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70093535102400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535102400
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70093535117660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535117660
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: &70093535116980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70093535116980
+description: Use fixtures to create a db independent and git friendly db dump.  It's
+  git friendly because each record is in its own file (git doesn't do very well with
+  large files that are committed all at once).
+email:
+- ian.w.white@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/git_friendly_dumper/version.rb
+- lib/git_friendly_dumper.rb
+- lib/tasks/git_friendly_dumper_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- History.txt
+- README.rdoc
+- spec/git_friendly_dumper_spec.rb
+- spec/resources/migrate/20070101000000_create_firsts.rb
+- spec/resources/migrate/20070101010000_create_seconds.rb
+- spec/spec_helper.rb
+- spec/support/connect.rb
+- spec/support/logger.rb
+- features/dump/change_dump_path.feature
+- features/dump/data_dump.feature
+- features/dump/default_dump.feature
+- features/dump/dump_and_raise_error.feature
+- features/dump/dump_deleted_records_and_clobber.feature
+- features/dump/dump_specific_tables.feature
+- features/load/clobber_load.feature
+- features/load/db_dump_path_load.feature
+- features/load/default_load.feature
+- features/load/load_and_raise_error.feature
+- features/load/load_fixtures.feature
+- features/load/load_git_changes.feature
+- features/load/load_specific_tables.feature
+- features/step_definitions/app_steps.rb
+- features/step_definitions/database_steps.rb
+- features/support/announce.rb
+- features/support/env.rb
+- features/support/logger.rb
+homepage: http://github.com/ianwhite/git_friendly_dumper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 402944153813948199
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 402944153813948199
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Use fixtures to create a db independent and git friendly db dump.
+test_files:
+- spec/git_friendly_dumper_spec.rb
+- spec/resources/migrate/20070101000000_create_firsts.rb
+- spec/resources/migrate/20070101010000_create_seconds.rb
+- spec/spec_helper.rb
+- spec/support/connect.rb
+- spec/support/logger.rb
+- features/dump/change_dump_path.feature
+- features/dump/data_dump.feature
+- features/dump/default_dump.feature
+- features/dump/dump_and_raise_error.feature
+- features/dump/dump_deleted_records_and_clobber.feature
+- features/dump/dump_specific_tables.feature
+- features/load/clobber_load.feature
+- features/load/db_dump_path_load.feature
+- features/load/default_load.feature
+- features/load/load_and_raise_error.feature
+- features/load/load_fixtures.feature
+- features/load/load_git_changes.feature
+- features/load/load_specific_tables.feature
+- features/step_definitions/app_steps.rb
+- features/step_definitions/database_steps.rb
+- features/support/announce.rb
+- features/support/env.rb
+- features/support/logger.rb