iron_fixture_extractor 1.0.0 → 1.1.0

data/lib/fe/version.rb

@@ -1,3 +1,3 @@
 module Fe
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/README_FOR_DEVELOPERS.md

@@ -0,0 +1,26 @@
+About Contributing to this Tool
+===============================
+
+All current and future work in managed via [GitHub issues and milestones](https://github.com/joegoggins/iron_fixture_extractor/issues?state=open).  Take a look there first.
+
+Running Tests
+-------------
+
+### Run the whole test suite:
+
+    rake
+
+### Run an individual spec
+
+    bundle exec spec/<A_SPEC_FILE>.rb
+
+Notes
+-----
+
+* Uses sqlite to do testing, if you run into a bug that only happens in
+  Oracle, MySQL, etc, you could try forking it, submoduling the gem into you project,
+  and hacking on it within your project.  Feel free to submit an
+  issue/pull request even if there isn't tests to cover your
+  changes--we'll find a way to test it.
+  
+* If you have other ideas for this tool, make a Github Issue.

data/spec/dummy_environments/sqlite/dummy1/config/database.yml

@@ -0,0 +1,11 @@
+source:
+  adapter: sqlite3
+  database: spec/tmp/source.sqlite3
+  pool: 5
+  timeout: 5000
+
+target:
+  adapter: sqlite3
+  database: spec/tmp/target.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy_environments/sqlite/dummy1/data_migrations/001_create_some_data.rb

@@ -0,0 +1,17 @@
+class CreateSomeData < ActiveRecord::Migration
+  def up
+    a=Author.create :name => "Joe"
+    p1=a.posts.create :name => "First post", :serialized_thing => ComplexThing.new
+      p1.comments.create :content => "This is crap"
+    p2=a.posts.create :name => "Second post", :serialized_thing => ComplexThing.new
+      p2.comments.create :content => "This is great"
+
+    a2=Author.create :name => "Bill"
+    g=Group.create :name => "Group 1"
+    g.authors << a2
+    g.save
+
+    User::Jerk.create(:name => "Jimmy the jerk")
+    User::Admin.create(:name => "Ron the admin")
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043601_create_posts.rb

@@ -0,0 +1,13 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.belongs_to :author
+      t.string :name
+      t.string :content
+      t.string :serialized_thing
+
+      t.timestamps
+    end
+    add_index :posts, :author_id
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043602_create_authors.rb

@@ -0,0 +1,9 @@
+class CreateAuthors < ActiveRecord::Migration
+  def change
+    create_table :authors do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043603_create_different_posts.rb

@@ -0,0 +1,14 @@
+class CreateDifferentPosts < ActiveRecord::Migration
+  # DUPLICATED FROM Posts
+  def change
+    create_table :different_posts do |t|
+      t.belongs_to :author
+      t.string :name
+      t.string :content
+      t.string :serialized_thing
+
+      t.timestamps
+    end
+    add_index :different_posts, :author_id
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043639_create_comments.rb

@@ -0,0 +1,13 @@
+class CreateComments < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.belongs_to :author
+      t.belongs_to :post
+      t.string :content
+
+      t.timestamps
+    end
+    add_index :comments, :author_id
+    add_index :comments, :post_id
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043808_create_group_members.rb

@@ -0,0 +1,13 @@
+class CreateGroupMembers < ActiveRecord::Migration
+  def change
+    create_table :group_members do |t|
+      t.belongs_to :author
+      t.belongs_to :group
+      t.string :role
+
+      t.timestamps
+    end
+    add_index :group_members, :author_id
+    add_index :group_members, :group_id
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043818_create_groups.rb

@@ -0,0 +1,9 @@
+class CreateGroups < ActiveRecord::Migration
+  def change
+    create_table :groups do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/migrations/20120604043819_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :type
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/models/author.rb

@@ -0,0 +1,5 @@
+class Author < ActiveRecord::Base
+  attr_accessible :name
+  has_many :posts
+  has_many :comments
+end

data/spec/dummy_environments/sqlite/dummy1/models/comment.rb

@@ -0,0 +1,5 @@
+class Comment < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :post
+  attr_accessible :content
+end

data/spec/dummy_environments/sqlite/dummy1/models/complex_thing.rb

@@ -0,0 +1,4 @@
+# This is serialized in the Post.serialized_thing attribute.
+#
+class ComplexThing
+end

data/spec/dummy_environments/sqlite/dummy1/models/different_post.rb

@@ -0,0 +1,9 @@
+require_relative './serialized_attribute_encoder'
+class DifferentPost < ActiveRecord::Base
+  # This is supposed to be identical to post
+  # and used to test fixture loading to a model
+  # different from the one it was extracted from
+  # so behavior doesn't matter
+  attr_accessible :content, :name, :serialized_thing
+  serialize :serialized_thing, SerializedAttributeEncoder.new
+end

data/spec/dummy_environments/sqlite/dummy1/models/group.rb

@@ -0,0 +1,5 @@
+class Group < ActiveRecord::Base
+  attr_accessible :name
+  has_many :group_members
+  has_many :authors, :through => :group_members
+end

data/spec/dummy_environments/sqlite/dummy1/models/group_member.rb

@@ -0,0 +1,5 @@
+class GroupMember < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :group
+  attr_accessible :role
+end

data/spec/dummy_environments/sqlite/dummy1/models/post.rb

@@ -0,0 +1,7 @@
+require_relative './serialized_attribute_encoder'
+class Post < ActiveRecord::Base
+  belongs_to :author
+  has_many :comments
+  attr_accessible :content, :name, :serialized_thing
+  serialize :serialized_thing, SerializedAttributeEncoder.new
+end

data/spec/dummy_environments/sqlite/dummy1/models/serialized_attribute_encoder.rb

@@ -0,0 +1,12 @@
+# This encoder just serializes complex attributes with the string
+# representation of their class. A +ComplexThing+ instance is stored in
+# the database as 'ComplexThing', not a marshalled Ruby object.
+#
+class SerializedAttributeEncoder
+  def load(value)
+    value.constantize.new
+  end
+  def dump(object)
+    object.class.to_s
+  end
+end

data/spec/dummy_environments/sqlite/dummy1/models/user.rb

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

data/spec/dummy_environments/sqlite/dummy1/models/user/admin.rb

@@ -0,0 +1,3 @@
+require_relative '../user'
+class User::Admin < User
+end

data/spec/dummy_environments/sqlite/dummy1/models/user/jerk.rb

@@ -0,0 +1,3 @@
+require_relative '../user'
+class User::Jerk < User
+end

data/spec/execute_extract_code_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Fe.execute_extract_code" do
+  include FirstPostWCommentsAndAuthors
+  it "provides the ability to execute the same query that built the fixtures" do
+    FeTestEnv.instance.connect_to_target
+    FeTestEnv.instance.create_tables_in('target')
+    Fe.load_db(@extract_name)
+    rows = Fe.execute_extract_code(@extract_name)
+    expect(rows.length).to eql(@extractor.row_counts['Post'])
+    expect(rows.first.association_cache.keys - [:comments,:author]).to be_empty, "Comments and authors should be eager loaded"
+  end
+
+  it "ensures the test env is all good..there are no rows" do
+    FeTestEnv.instance.connect_to_target
+    FeTestEnv.instance.create_tables_in('target')
+    @model_names.each do |mn|
+      expect(mn.constantize.count).to eql(0)
+    end   
+  end
+  it "has a loaded target database with the same number of rows than is in the source" do
+    FeTestEnv.instance.connect_to_target
+    FeTestEnv.instance.create_tables_in('target')
+    Fe.load_db(@extract_name)
+    @extractor.row_counts.each_pair do |m,c|
+      expect(m.constantize.count).to eql(c), "number of rows in the target should be the same as the counts from the source given the extract_code"
+    end
+  end
+end

data/spec/extract_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "Fe.extract and Fe::Extractor instances" do
+  include FirstPostWCommentsAndAuthors
+  it "should return an Fe::Extractor instance that exposes the extracted data information" do
+    expect(@extractor).to be_a_kind_of(Fe::Extractor)
+
+    # The stuff passed into the constructor
+    expect(@extract_name.to_sym).to eql(@extractor.name), "note that the extractor name is a symbol, even if given a string"
+    expect(@extract_code).to eql(@extractor.extract_code), "the code used to pull the data"
+
+    # The models involved
+    expect(@extractor.model_names - @model_names).to be_empty
+    expect(@extractor.models).to be_a_kind_of(Array)
+    expect(@extractor.models.first.ancestors).to include(ActiveRecord::Base)
+
+    # The fixture files involved
+    expect(@extractor.manifest_hash).to be_a_kind_of(Hash), "The hash representation of what is saved to fe_manifest.yml"
+    expect(@extractor.output_hash).to be_a_kind_of(Hash), "The hash representation all of the the extracted data"
+    @model_names.each do |mn|
+      @extractor.output_hash.keys
+    end 
+  end
+  it "should put data into the .yml files" do
+    expect(Post.table_name).to eql(@extractor.table_names['Post'])
+    expect(File.exists?(File.join(Fe.fixtures_root,'first_post_w_comments_and_authors','fe_manifest.yml'))).to eql(true)
+    @model_names.each do |mn|
+      expect(File.exists?(File.join(Fe.fixtures_root,'first_post_w_comments_and_authors',"#{mn.constantize.table_name}.yml"))).to eql(true)
+    end
+
+    # Asserting the state of the imported data--tied to the data_migrations
+    # brittle
+    expect(@extractor.row_counts['Post']).to eql(1)
+    expect(@extractor.row_counts['Author']).to eql(1)
+  end
+
+end

data/spec/extract_works_with_multiple_extract_queries_in_one_command_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "Fe.extract('[Post.includes(:comments).limit(1),Author.all]', :name => :two_tree) style usage works" do
+  it "provides the right output and puts files in the right place" do
+    @extract_code = '[Post.includes(:comments).limit(1),Author.all]'
+    @extract_name = :two_tree
+    extractor = Fe.extract(@extract_code, :name => @extract_name)
+    expect(%w(Post Comment Author) - extractor.model_names).to be_empty
+    expect(File.exists?(File.join(Fe.fixtures_root,'two_tree','fe_manifest.yml'))).to eql(true)
+    expect(extractor.row_counts['Post']).to eql(1)
+  end
+end

data/spec/fe_test_env_spec.rb

@@ -0,0 +1,65 @@
+# About
+# =====
+#
+# This tests FeTestEnv, the helper object used to create a dummy environment that the 
+# test cases can run.  You can almost definitely ignore this unless you suspect the testing
+# framework is broken.
+#
+require 'spec_helper'
+
+describe "desired behavior" do
+  before(:each) do
+    @sqlite_env_path = File.join(File.dirname(__FILE__),'dummy_environments','sqlite','dummy1')
+    @fe_test_env = FeTestEnv.new(@sqlite_env_path).initialize_tmp.load_models
+  end
+
+  it "lets us create data structures + data in source and switch to target with no problems",:focus => true do
+    @fe_test_env.create_tables_in('source')
+    expect(Post.first).to be_nil
+    @fe_test_env.create_rows_in('source')
+    expect(Post.first).to be_a_kind_of(Post)
+    @fe_test_env.connect_to_target
+    expect {Post.first}.to raise_exception
+    @fe_test_env.create_tables_in('target')
+    expect(Post.first).to be_nil
+  end
+end
+describe "structure of a dummy environment" do
+  before(:each) do
+    @sqlite_env_path = File.join(File.dirname(__FILE__),'dummy_environments','sqlite','dummy1')
+    @fe_test_env = FeTestEnv.new(@sqlite_env_path).initialize_tmp.load_models
+  end
+  it "key test env file paths & dirs exist" do
+    expect(File.directory?(@fe_test_env.root_path)).to eql(true)
+    expect(File.exist?(@fe_test_env.database_dot_yml_file)).to eql(true)
+    [:migration_files, :model_files].each do |f|
+      expect(@fe_test_env.send(f)).to be_a_kind_of(Array)
+      @fe_test_env.send(f).each do |tf|
+        expect { load tf }.to_not raise_exception
+      end
+    end
+
+    expect(File.directory?(@fe_test_env.tmp_dir)).to eql(true)
+    expect(File.directory?(@fe_test_env.fe_fixtures_dir)).to eql(true)
+    expect(File.directory?(@fe_test_env.sqlite_db_dir)).to eql(true)
+  end
+
+  it "can connect to source and target" do
+    # SOURCE
+    @fe_test_env.connect_to_source
+    source_db = @fe_test_env.database_dot_yml_hash['source']['database']
+    expect(ActiveRecord::Base.connection).to be_a_kind_of(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+    ActiveRecord::Base.connection.execute('create table t (id int)')
+    expect(ActiveRecord::Base.connection.tables.length).to eql(1)
+    expect(File.exists?(source_db)).to eql(true)
+
+    # TARGET
+    #
+    @fe_test_env.connect_to_target
+    target_db = @fe_test_env.database_dot_yml_hash['target']['database']
+    expect(ActiveRecord::Base.connection.instance_variable_get(:@config)[:database]).to eql(target_db)
+    expect(ActiveRecord::Base.connection.tables.length).to eql(0)  # there is no table in target
+    expect(File.exists?(target_db)).to eql(true)
+  end
+end
+

data/spec/get_hash_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "Fe.get_hash and .get_hashes" do
+  include FirstPostWCommentsAndAuthors
+  it "returns a hash with the right columns for different ways of invoking, fixture name, :first, :last" do
+    ['r1', # By the fixture hash name (auto-generated by Fe)
+     :first, # By the first fixture in the .yml file
+     :last   # By the last fixture in the yml file
+    ].each do |invoke_type| 
+      h = Fe.get_hash(:first_post_w_comments_and_authors, Post, invoke_type)
+      expect(h).to be_a_kind_of(Hash)
+      expect(h.keys - Post.column_names).to be_empty
+    end
+  end
+  it "allows you to get the whole yaml file with get_hash(...,:all)" do
+    another_extractor = Fe.extract('Post.all', :name => :all_posts)
+    all_way_1 = Fe.get_hash(:all_posts, Post, :all)
+    expect(all_way_1).to be_a_kind_of(Hash)
+    expect(all_way_1.keys).to eql(['r1','r2']), "This hash is essentially the entire .yml file gobbled up as a data-structure"
+  end
+  it "provides .get_hashes which returns an array (as syntactic sugar for get_hash...:all" do
+    another_extractor = Fe.extract('Post.all', :name => :all_posts)
+    all_way_1 = Fe.get_hash(:all_posts, Post, :all)
+    all_way_2 = Fe.get_hashes(:all_posts, Post)
+    expect(all_way_2).to eql(all_way_1.values)
+  end
+end

data/spec/load_db_map_option_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "Fe.load_db(..., :map)" do
+  before(:each) do
+    FeTestEnv.instance.bomb_and_rebuild
+    Fe.extract("Post.where('1=1')", :name => :all_posts)
+    FeTestEnv.instance.connect_to_target
+    FeTestEnv.instance.create_tables_in('target')
+  end
+
+  it "should allow you to load into a different table via Hash mapping" do
+    expect {
+      Fe.load_db(:all_posts, :map => {'posts' => 'different_posts'})
+    }.to change {
+      DifferentPost.count
+    }.from(0)
+    expect(Post.count).to eql(0)
+  end
+
+  it "should allow you to load into a different table via Proc mapping" do
+    expect {
+      Fe.load_db(:all_posts, :map => -> table_name { "different_#{table_name}" })
+    }.to change {
+      DifferentPost.count
+    }.from(0)
+    expect(Post.count).to eql(0)
+  end
+
+  it "should allow you to load into a different table but same model" do
+    begin
+      Post.connection.execute("ALTER TABLE posts RENAME TO foo_posts")
+      Post.table_name = 'foo_posts'
+      Fe.load_db(:all_posts, :map => -> table_name { "foo_#{table_name}" })
+      expect(Post.count).to be > 0
+    ensure
+      Post.table_name = 'posts'
+    end
+  end
+end