ar_fixtures 0.0.4

data/CHANGELOG

@@ -0,0 +1,14 @@
+
+== June 4, 2006
+
+* Clarified rake task descriptions to show where data is being dumped.
+
+== May 20, 2006
+
+* Added to_skeleton for writing fieldnames only. [Gunther Schmidl]
+* Added initial tests, thanks to Scott Barron's acts_as_state_machine
+
+== Jan 12 2006
+
+* Added code to handle single table inheritance. May need to be modified for non-standard use of STI.
+

data/History.txt

@@ -0,0 +1,16 @@
+== 0.0.4 / 2007-06-24
+
+* Converted to a gem
+
+== 0.0.3 / June 4, 2006
+
+* Clarified rake task descriptions to show where data is being dumped.
+
+== 0.0.2 / May 20, 2006
+
+* Added to_skeleton for writing fieldnames only. [Gunther Schmidl]
+* Added initial tests, thanks to Scott Barron's acts_as_state_machine
+
+== 0.0.1 / Jan 12 2006
+
+* Added code to handle single table inheritance. May need to be modified for non-standard use of STI.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Geoffrey Grosenbach
+
+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/Manifest.txt

@@ -0,0 +1,21 @@
+CHANGELOG
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+about.yml
+init.rb
+lib/ar_fixtures.rb
+tasks/ar_fixtures.rake
+test/ar_fixtures_test.rb
+test/database.yml
+test/fixtures/beer.rb
+test/fixtures/beers.yml
+test/fixtures/beers_drunkards.yml
+test/fixtures/drunkard.rb
+test/fixtures/drunkards.yml
+test/fixtures/glass.rb
+test/fixtures/glasses.yml
+test/schema.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,19 @@
+= ar_fixtures
+
+This library makes it easy to save ActiveRecord objects to reloadable files or fixtures.  ActiveRecord is required.
+
+See tasks/ar_fixtures.rake for what can be done from the command-line, or use "rake -T" and look for items in the "db" namespace.
+
+== Resources
+
+Subversion
+
+* http://topfunky.net/svn/plugins/ar_fixtures
+
+Blog
+
+* http://nubyonrails.com
+
+Author
+
+* Geoffrey Grosenbach boss [at] topfunky [dot] com

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'hoe'
+
+Hoe.new("ar_fixtures", '0.0.4') do |p|
+  p.summary =     "Creates test fixtures from data in the database."
+  p.description = "Creates test fixtures from data in the database."
+  p.rubyforge_name = 'seattlerb'
+  p.author = 'Geoffrey Grosenbach'
+  p.email = 'boss AT topfunky.com'
+  p.url = "http://rubyforge.org/projects/seattlerb"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end

data/about.yml

@@ -0,0 +1,7 @@
+author: topfunky
+summary: Use the existing data in your database to generate fixtures, fixture skeletons, and reference YAML files.
+homepage: http://nubyonrails.com
+plugin: http://topfunky.net/svn/plugins/ar_fixtures
+license: MIT
+version: 0.2
+rails_version: 1.0+

data/init.rb

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

data/lib/ar_fixtures.rb

@@ -0,0 +1,103 @@
+# Extension to make it easy to read and write data to a file.
+class ActiveRecord::Base
+
+  class << self
+
+    # Writes content of this table to db/table_name.yml, or the specified file.
+    #
+    # Writes all content by default, but can be limited.
+    def dump_to_file(path=nil, limit=nil)
+      opts = {}
+      opts[:limit] = limit if limit
+      path ||= "db/#{table_name}.yml"
+      write_file(File.expand_path(path, RAILS_ROOT), self.find(:all, opts).to_yaml)
+    end
+  
+    # Delete existing data in database and load fresh from file in db/table_name.yml
+    def load_from_file(path=nil)
+      path ||= "db/#{table_name}.yml"
+
+      self.destroy_all
+
+      if connection.respond_to?(:reset_pk_sequence!)
+       connection.reset_pk_sequence!(table_name)
+      end
+
+      records = YAML::load( File.open( File.expand_path(path, RAILS_ROOT) ) )
+      records.each do |record|
+        record_copy = self.new(record.attributes)
+        record_copy.id = record.id
+
+        # For Single Table Inheritance
+        klass_col = record.class.inheritance_column.to_sym
+        if record[klass_col]
+           record_copy.type = record[klass_col]
+        end
+      
+        record_copy.save
+      end
+ 
+      if connection.respond_to?(:reset_pk_sequence!)
+       connection.reset_pk_sequence!(table_name)
+      end
+    end
+
+    # Write a file that can be loaded with +fixture :some_table+ in tests.
+    # Uses existing data in the database.
+    #
+    # Will be written to +test/fixtures/table_name.yml+. Can be restricted to some number of rows.
+    def to_fixture(limit=nil)
+      opts = {}
+      opts[:limit] = limit if limit
+
+      write_file(File.expand_path("test/fixtures/#{table_name}.yml", RAILS_ROOT), 
+          self.find(:all, opts).inject({}) { |hsh, record| 
+              hsh.merge("#{table_name.singularize}_#{'%05i' % record.id}" => record.attributes) 
+            }.to_yaml(:SortKeys => true))
+      habtm_to_fixture
+    end
+
+    # Write the habtm association table
+    def habtm_to_fixture
+      joins = self.reflect_on_all_associations.select { |j|
+        j.macro == :has_and_belongs_to_many
+      }
+      joins.each do |join|
+        hsh = {}
+        connection.select_all("SELECT * FROM #{join.options[:join_table]}").each_with_index { |record, i|
+          hsh["join_#{'%05i' % i}"] = record
+        }
+        write_file(File.expand_path("test/fixtures/#{join.options[:join_table]}.yml", RAILS_ROOT), hsh.to_yaml(:SortKeys => true))
+      end
+    end
+    
+    # Generates a basic fixture file in test/fixtures that lists the table's field names.
+    #
+    # You can use it as a starting point for your own fixtures.
+    #
+    #  record_1:
+    #    name:
+    #    rating:
+    #  record_2:
+    #    name:
+    #    rating:
+    #
+    # TODO Automatically add :id field if there is one.
+    def to_skeleton
+      record = { 
+          "record_1" => self.new.attributes,
+          "record_2" => self.new.attributes
+         }
+      write_file(File.expand_path("test/fixtures/#{table_name}.yml", RAILS_ROOT),
+        record.to_yaml)
+    end
+
+    def write_file(path, content) # :nodoc:
+      f = File.new(path, "w+")
+      f.puts content
+      f.close
+    end
+
+  end
+
+end

data/tasks/ar_fixtures.rake

@@ -0,0 +1,38 @@
+
+def env_or_raise(var_name, human_name)
+  if ENV[var_name].blank?
+    raise "No #{var_name} value given. Set #{var_name}=#{human_name}"
+  else
+    return ENV[var_name]
+  end  
+end
+
+def model_or_raise
+  return env_or_raise('MODEL', 'ModelName')
+end
+
+def limit_or_nil_string
+  ENV['LIMIT'].blank? ? 'nil' : ENV['LIMIT']
+end
+
+namespace :db do
+  namespace :fixtures do
+    desc "Dump data to the test/fixtures/ directory. Use MODEL=ModelName and LIMIT (optional)"
+    task :dump => :environment do
+      eval "#{model_or_raise}.to_fixture(#{limit_or_nil_string})"
+    end
+  end
+    
+  namespace :data do
+    desc "Dump data to the db/ directory. Use MODEL=ModelName and LIMIT (optional)"
+    task :dump => :environment do
+      eval "#{model_or_raise}.dump_to_file(nil, #{limit_or_nil_string})"
+      puts "#{model_or_raise} has been dumped to the db folder."
+    end
+
+    desc "Load data from the db/ directory. Use MODEL=ModelName"
+    task :load => :environment do
+      eval "#{model_or_raise}.load_from_file"
+    end
+  end
+end

data/test/ar_fixtures_test.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fileutils'
+
+# TODO Test limit params
+# TODO Test renaming
+# TODO Examine contents of fixture and skeleton dump
+class ArFixturesTest < Test::Unit::TestCase
+  fixtures :beers, :drunkards, :beers_drunkards
+  include FileUtils
+
+  def setup
+    %w(db test/fixtures).each { |dir| mkdir_p File.join(RAILS_ROOT, dir) }
+  end
+  
+  def test_dump_to_file
+    Beer.dump_to_file
+    assert File.exist?(File.join(RAILS_ROOT, 'db', 'beers.yml'))
+    
+    Beer.destroy_all
+    assert_equal 0, Beer.count
+    Beer.load_from_file
+    assert_equal 2, Beer.count
+  end
+
+  def test_load_from_file
+    cp  File.join(RAILS_ROOT, 'fixtures', 'glasses.yml'), 
+        File.join(RAILS_ROOT, 'db', 'glasses.yml')
+    assert_equal 0, Glass.count
+    Glass.load_from_file
+    assert_equal 2, Glass.count
+  end
+
+  def test_to_fixture
+    Beer.to_fixture
+    assert File.exist?(File.join(RAILS_ROOT, 'test', 'fixtures', 'beers.yml'))
+    assert File.exist?(File.join(RAILS_ROOT, 'test', 'fixtures', 'beers_drunkards.yml'))
+  end
+  
+  def test_habtm_to_fixture
+    Beer.habtm_to_fixture
+    assert File.exist?(File.join(RAILS_ROOT, 'test', 'fixtures', 'beers_drunkards.yml'))
+  end
+  
+  def test_to_skeleton
+    Beer.to_skeleton
+    assert File.exist?(File.join(RAILS_ROOT, 'test', 'fixtures', 'beers.yml'))
+  end
+
+  def teardown
+    %w(db test).each { |dir| rm_rf File.join(RAILS_ROOT, dir) }    
+  end
+  
+end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: ":memory:"
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: plugin_test

data/test/fixtures/beer.rb

@@ -0,0 +1,5 @@
+class Beer < ActiveRecord::Base
+
+  has_and_belongs_to_many :drunkards
+  
+end

data/test/fixtures/beers.yml

@@ -0,0 +1,9 @@
+stout:
+  id: 1
+  name: stout
+  rating: 5
+  
+ipa:
+  id: 2
+  name: india pale ale
+  rating: 4

data/test/fixtures/beers_drunkards.yml

@@ -0,0 +1,8 @@
+one:
+  beer_id: 1
+  drunkard_id: 1
+  
+two:
+  beer_id: 2
+  drunkard_id: 1
+

data/test/fixtures/drunkard.rb

@@ -0,0 +1,6 @@
+
+class Drunkard < ActiveRecord::Base
+  
+  has_and_belongs_to_many :beers
+  
+end

data/test/fixtures/drunkards.yml

@@ -0,0 +1,8 @@
+bert:
+  id: 1
+  name: bert
+  
+ernie:
+  id: 2
+  name: ernie
+

data/test/fixtures/glass.rb

@@ -0,0 +1,2 @@
+class Glass < ActiveRecord::Base
+end

data/test/fixtures/glasses.yml

@@ -0,0 +1,9 @@
+--- 
+- !ruby/object:Glass 
+  attributes: 
+    name: pilsner
+    id: "1"
+- !ruby/object:Glass 
+  attributes: 
+    name: snifter
+    id: "2"

data/test/schema.rb

@@ -0,0 +1,21 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :beers do |t|
+    t.column :name,       :string
+    t.column :rating,        :integer
+  end
+  
+  create_table :glasses do |t|
+    t.column :name, :string
+  end
+
+  create_table :drunkards do |t|
+    t.column :name, :string
+  end
+
+  create_table :beers_drunkards, :id => false do |t|
+    t.column :beer_id, :integer
+    t.column :drunkard_id, :integer
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+RAILS_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/binding_of_caller'
+require 'active_support/breakpoint'
+require "#{File.dirname(__FILE__)}/../init"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+
+  # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
+  self.use_transactional_fixtures = true
+  
+  # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
+  self.use_instantiated_fixtures  = false
+
+  # Add more helper methods to be used by all tests here...
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: ar_fixtures
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+date: 2007-06-24 00:00:00 -07:00
+summary: Creates test fixtures from data in the database.
+require_paths: 
+- lib
+email: boss AT topfunky.com
+homepage: http://rubyforge.org/projects/seattlerb
+rubyforge_project: seattlerb
+description: Creates test fixtures from data in the database.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Geoffrey Grosenbach
+files: 
+- CHANGELOG
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- about.yml
+- init.rb
+- lib/ar_fixtures.rb
+- tasks/ar_fixtures.rake
+- test/ar_fixtures_test.rb
+- test/database.yml
+- test/fixtures/beer.rb
+- test/fixtures/beers.yml
+- test/fixtures/beers_drunkards.yml
+- test/fixtures/drunkard.rb
+- test/fixtures/drunkards.yml
+- test/fixtures/glass.rb
+- test/fixtures/glasses.yml
+- test/schema.rb
+- test/test_helper.rb
+test_files: 
+- test/test_helper.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: