low_card_tables 1.0.0

data/spec/low_card_tables/unit/low_card_table/table_unique_index_spec.rb

@@ -0,0 +1,117 @@
+require 'low_card_tables'
+
+describe LowCardTables::LowCardTable::TableUniqueIndex do
+  def klass
+    LowCardTables::LowCardTable::TableUniqueIndex
+  end
+
+  it "should require a low-card model for instantiation" do
+    low_card_model = double("low_card_model")
+    lambda { klass.new(low_card_model) }.should raise_error(ArgumentError)
+
+    allow(low_card_model).to receive(:is_low_card_table?).and_return(false)
+    lambda { klass.new(low_card_model) }.should raise_error(ArgumentError)
+  end
+
+  context "with an instance" do
+    before :each do
+      @low_card_model = double("low_card_model")
+      allow(@low_card_model).to receive(:is_low_card_table?).and_return(true)
+      allow(@low_card_model).to receive(:table_name).and_return("foobar")
+      allow(@low_card_model).to receive(:low_card_value_column_names).and_return(%w{foo bar baz})
+      allow(@low_card_model).to receive(:table_exists?).and_return(true)
+
+      @connection = double("connection")
+      allow(@low_card_model).to receive(:connection).and_return(@connection)
+
+      @non_unique_index = double("non_unique_index")
+      allow(@non_unique_index).to receive(:unique).and_return(false)
+      allow(@non_unique_index).to receive(:name).and_return("nui")
+
+      @unique_index_wrong_columns = double("unique_index_wrong_columns")
+      allow(@unique_index_wrong_columns).to receive(:unique).and_return(true)
+      allow(@unique_index_wrong_columns).to receive(:columns).and_return(%w{foo bar})
+      allow(@unique_index_wrong_columns).to receive(:name).and_return("uiwc")
+
+      @unique_index_right_columns = double("unique_index_right_columns")
+      allow(@unique_index_right_columns).to receive(:unique).and_return(true)
+      allow(@unique_index_right_columns).to receive(:columns).and_return(%w{bar foo baz})
+      allow(@unique_index_right_columns).to receive(:name).and_return("uirc")
+
+      @instance = klass.new(@low_card_model)
+    end
+
+    describe "#ensure_present!" do
+      it "should do nothing if the table doesn't exist" do
+        allow(@low_card_model).to receive(:table_exists?).and_return(false)
+
+        @instance.ensure_present!(false)
+        @instance.ensure_present!(true)
+      end
+
+      it "should do nothing if the index does exist" do
+        allow(@connection).to receive(:indexes).with("foobar").and_return([ @non_unique_index, @unique_index_wrong_columns, @unique_index_right_columns ])
+        @instance.ensure_present!(false)
+        @instance.ensure_present!(true)
+      end
+
+      it "should raise if the index doesn't exist, and not told to create it" do
+        allow(@connection).to receive(:indexes).with("foobar").and_return([ @non_unique_index, @unique_index_wrong_columns ])
+        lambda { @instance.ensure_present!(false) }.should raise_error(LowCardTables::Errors::LowCardNoUniqueIndexError, /uiwc/i)
+      end
+
+      it "should create the index if it doesn't exist, and told to" do
+        index_return_values = [
+          [ @non_unique_index, @unique_index_wrong_columns ],
+          [ @non_unique_index, @unique_index_wrong_columns ],
+          [ @non_unique_index, @unique_index_wrong_columns, @unique_index_right_columns ]
+        ]
+
+        allow(@connection).to receive(:indexes).with("foobar") { index_return_values.shift }
+
+        our_migration_class = Class.new
+        allow(Class).to receive(:new).once.with(::ActiveRecord::Migration).and_return(our_migration_class)
+
+        expect(our_migration_class).to receive(:migrate).once.with(:up)
+
+        expect(@low_card_model).to receive(:reset_column_information).once
+        expect(::LowCardTables::VersionSupport).to receive(:clear_schema_cache!).once.with(@low_card_model)
+
+        @instance.ensure_present!(true)
+
+        expect(our_migration_class).to receive(:remove_index).once.with("foobar", :name => "index_foobar_lc_on_all")
+        expect(our_migration_class).to receive(:add_index).once.with("foobar", %w{bar baz foo}, :unique => true, :name => "index_foobar_lc_on_all")
+        our_migration_class.up
+      end
+    end
+
+    describe "#remove!" do
+      it "should do nothing if there is no such index" do
+        allow(@connection).to receive(:indexes).with("foobar").and_return([ @non_unique_index, @unique_index_wrong_columns ])
+        @instance.remove!
+      end
+
+      it "should remove the index if there is one" do
+        index_return_values = [
+          [ @non_unique_index, @unique_index_wrong_columns, @unique_index_right_columns ],
+          [ @non_unique_index, @unique_index_wrong_columns ]
+        ]
+
+        allow(@connection).to receive(:indexes).with("foobar") { index_return_values.shift }
+
+        our_migration_class = Class.new
+        allow(Class).to receive(:new).once.with(::ActiveRecord::Migration).and_return(our_migration_class)
+
+        expect(our_migration_class).to receive(:migrate).once.with(:up)
+
+        expect(@low_card_model).to receive(:reset_column_information).once
+        expect(::LowCardTables::VersionSupport).to receive(:clear_schema_cache!).once.with(@low_card_model)
+
+        @instance.remove!
+
+        expect(our_migration_class).to receive(:remove_index).once.with("foobar", :name => "uirc")
+        our_migration_class.up
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification 
+name: low_card_tables
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrew Geweke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.14"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    - - <=
+      - !ruby/object:Gem::Version 
+        version: 4.99.99
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    - - <=
+      - !ruby/object:Gem::Version 
+        version: 4.99.99
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activerecord-import
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id008
+description: "\"Bitfields for ActiveRecord\": store low-cardinality columns in a separate table for vastly more flexibility and better performance."
+email: 
+- andrew@geweke.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/low_card_tables.rb
+- lib/low_card_tables/active_record/base.rb
+- lib/low_card_tables/active_record/migrations.rb
+- lib/low_card_tables/active_record/relation.rb
+- lib/low_card_tables/active_record/scoping.rb
+- lib/low_card_tables/errors.rb
+- lib/low_card_tables/has_low_card_table/base.rb
+- lib/low_card_tables/has_low_card_table/low_card_association.rb
+- lib/low_card_tables/has_low_card_table/low_card_associations_manager.rb
+- lib/low_card_tables/has_low_card_table/low_card_dynamic_method_manager.rb
+- lib/low_card_tables/has_low_card_table/low_card_objects_manager.rb
+- lib/low_card_tables/low_card_table/base.rb
+- lib/low_card_tables/low_card_table/cache.rb
+- lib/low_card_tables/low_card_table/cache_expiration/exponential_cache_expiration_policy.rb
+- lib/low_card_tables/low_card_table/cache_expiration/fixed_cache_expiration_policy.rb
+- lib/low_card_tables/low_card_table/cache_expiration/has_cache_expiration.rb
+- lib/low_card_tables/low_card_table/cache_expiration/no_caching_expiration_policy.rb
+- lib/low_card_tables/low_card_table/cache_expiration/unlimited_cache_expiration_policy.rb
+- lib/low_card_tables/low_card_table/row_collapser.rb
+- lib/low_card_tables/low_card_table/row_manager.rb
+- lib/low_card_tables/low_card_table/table_unique_index.rb
+- lib/low_card_tables/version.rb
+- lib/low_card_tables/version_support.rb
+- low_card_tables.gemspec
+- spec/low_card_tables/helpers/database_helper.rb
+- spec/low_card_tables/helpers/query_spy_helper.rb
+- spec/low_card_tables/helpers/system_helpers.rb
+- spec/low_card_tables/system/basic_system_spec.rb
+- spec/low_card_tables/system/bulk_system_spec.rb
+- spec/low_card_tables/system/caching_system_spec.rb
+- spec/low_card_tables/system/migrations_system_spec.rb
+- spec/low_card_tables/system/options_system_spec.rb
+- spec/low_card_tables/system/queries_system_spec.rb
+- spec/low_card_tables/system/validations_system_spec.rb
+- spec/low_card_tables/unit/active_record/base_spec.rb
+- spec/low_card_tables/unit/active_record/migrations_spec.rb
+- spec/low_card_tables/unit/active_record/relation_spec.rb
+- spec/low_card_tables/unit/active_record/scoping_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/base_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_association_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_associations_manager_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_dynamic_method_manager_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_objects_manager_spec.rb
+- spec/low_card_tables/unit/low_card_table/base_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/exponential_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/fixed_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/has_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/no_caching_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/unlimited_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_spec.rb
+- spec/low_card_tables/unit/low_card_table/row_collapser_spec.rb
+- spec/low_card_tables/unit/low_card_table/row_manager_spec.rb
+- spec/low_card_tables/unit/low_card_table/table_unique_index_spec.rb
+homepage: https://github.com/ageweke/low_card_tables
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.13
+signing_key: 
+specification_version: 4
+summary: "\"Bitfields for ActiveRecord\": instead of storing multiple columns with low cardinality (few distinct values) directly in a table, which results in performance and maintainability problems, break them out into a separate table with almost zero overhead. Trivially add new columns without migrating a main, enormous table. Query on combinations of values very efficiently."
+test_files: 
+- spec/low_card_tables/helpers/database_helper.rb
+- spec/low_card_tables/helpers/query_spy_helper.rb
+- spec/low_card_tables/helpers/system_helpers.rb
+- spec/low_card_tables/system/basic_system_spec.rb
+- spec/low_card_tables/system/bulk_system_spec.rb
+- spec/low_card_tables/system/caching_system_spec.rb
+- spec/low_card_tables/system/migrations_system_spec.rb
+- spec/low_card_tables/system/options_system_spec.rb
+- spec/low_card_tables/system/queries_system_spec.rb
+- spec/low_card_tables/system/validations_system_spec.rb
+- spec/low_card_tables/unit/active_record/base_spec.rb
+- spec/low_card_tables/unit/active_record/migrations_spec.rb
+- spec/low_card_tables/unit/active_record/relation_spec.rb
+- spec/low_card_tables/unit/active_record/scoping_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/base_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_association_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_associations_manager_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_dynamic_method_manager_spec.rb
+- spec/low_card_tables/unit/has_low_card_table/low_card_objects_manager_spec.rb
+- spec/low_card_tables/unit/low_card_table/base_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/exponential_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/fixed_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/has_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/no_caching_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_expiration/unlimited_cache_expiration_policy_spec.rb
+- spec/low_card_tables/unit/low_card_table/cache_spec.rb
+- spec/low_card_tables/unit/low_card_table/row_collapser_spec.rb
+- spec/low_card_tables/unit/low_card_table/row_manager_spec.rb
+- spec/low_card_tables/unit/low_card_table/table_unique_index_spec.rb