enum_table 0.0.1

data/test/enum_table/test_reflection.rb

@@ -0,0 +1,114 @@
+require_relative '../test_helper'
+
+describe EnumTable::Reflection do
+  let(:reflection) { EnumTable::Reflection.new(:gender, female: 1, male: 2) }
+
+  describe "#initialize" do
+    it "uses symbol values if :type is :symbol" do
+      reflection = EnumTable::Reflection.new(:gender, type: :symbol)
+      reflection.add_value 1, 'female'
+      reflection.value(1).must_equal(:female)
+    end
+
+    it "uses string values if :type is :string" do
+      reflection = EnumTable::Reflection.new(:gender, type: :string)
+      reflection.add_value 1, :female
+      reflection.value(1).must_equal('female')
+    end
+
+    it "raises an ArgumentError if :type is something else" do
+      ->{ EnumTable::Reflection.new :gender, type: :other }.must_raise ArgumentError, /invalid type/
+    end
+  end
+
+  describe "#initialize_copy" do
+    it "sets the same name" do
+      reflection = EnumTable::Reflection.new(:gender)
+      copy = reflection.dup
+      copy.name.must_equal :gender
+    end
+
+    it "sets the same values" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      copy = reflection.dup
+      copy.value(1).must_equal :female
+    end
+
+    it "sets a separate collection of values" do
+      reflection = EnumTable::Reflection.new(:gender)
+      copy = reflection.dup
+      copy.add_value(1, :female)
+      reflection.value(1).must_be_nil
+      copy.value(1).must_equal :female
+    end
+
+    it "sets the same type" do
+      reflection = EnumTable::Reflection.new(:gender, type: :string)
+      copy = reflection.dup
+      copy.type.must_equal :string
+    end
+
+    it "sets the same id_name" do
+      reflection = EnumTable::Reflection.new(:gender, id_name: :status_id)
+      copy = reflection.dup
+      copy.id_name.must_equal :status_id
+    end
+  end
+
+  describe '#name' do
+    it "returns the name of the reflection" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.name.must_equal :gender
+    end
+  end
+
+  describe '#id_name' do
+    it "can be set with an :id_name option" do
+      reflection = EnumTable::Reflection.new(:gender, id_name: :gender_number)
+      reflection.id_name.must_equal :gender_number
+    end
+
+    it "is the name suffixed with '_id' by default" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.id_name.must_equal :gender_id
+    end
+  end
+
+  describe '#value' do
+    it "returns the value for the given id" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      reflection.value(1).must_equal :female
+    end
+
+    it "returns nil if no value is defined for the given id" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      reflection.value(2).must_be_nil
+    end
+  end
+
+  describe '#id' do
+    it "returns the value for the given value" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      reflection.id(:female).must_equal 1
+    end
+
+    it "returns nil if no value is defined for the given id" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      reflection.id(:male).must_be_nil
+    end
+  end
+
+  describe "#values" do
+    it "returns the list of enum values" do
+      reflection = EnumTable::Reflection.new(:gender)
+      reflection.add_value 1, :female
+      reflection.add_value 2, :male
+      reflection.values.must_equal [:female, :male]
+    end
+  end
+end

data/test/enum_table/test_schema_dumper.rb

@@ -0,0 +1,75 @@
+require_relative '../test_helper'
+
+describe EnumTable::SchemaDumper do
+  use_database
+
+  describe "#dump" do
+    let(:stream) { StringIO.new }
+
+    describe "when there are enum tables" do
+      it "does not dump the enum_tables with create_table" do
+        connection.create_enum_table :user_genders
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.wont_match(/create_table.*user_genders/)
+      end
+
+      it "dumps the enum tables with create_enum_table" do
+        connection.create_enum_table :user_genders
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.must_match(/create_enum_table.*user_genders.*force: true/)
+      end
+
+      it "populates the enum tables" do
+        connection.instance_eval do
+          create_enum_table :user_genders do |t|
+            t.add :female, 1
+            t.add :male
+          end
+        end
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.must_include(<<-EOS.gsub(/^ *\|/, ''))
+          |  create_enum_table "user_genders", force: true do |t|
+          |    t.add "female", 1
+          |    t.add "male", 2
+          |  end
+        EOS
+      end
+
+      it "dumps custom id column attributes" do
+        connection.create_enum_table :user_genders do |t|
+          t.id type: :string, limit: 20, null: true
+        end
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.must_include(<<-EOS.gsub(/^ *\|/, ''))
+          |  create_enum_table "user_genders", force: true do |t|
+          |    t.id type: :string, limit: 20, null: true
+          |  end
+        EOS
+      end
+
+      it "dumps custom value column attributes" do
+        connection.create_enum_table :user_genders do |t|
+          t.value type: :binary, limit: 20, null: true
+        end
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.must_include(<<-EOS.gsub(/^ *\|/, ''))
+          |  create_enum_table "user_genders", force: true do |t|
+          |    t.value type: :binary, limit: 20, null: true
+          |  end
+        EOS
+      end
+    end
+
+    describe "when there are no enum tables" do
+      it "populates no enum tables if there are none" do
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.wont_include('change_enum_table')
+      end
+
+      it "does not populate enum_tables" do
+        ActiveRecord::SchemaDumper.dump(connection, stream)
+        stream.string.wont_include "INSERT INTO enum_tables"
+      end
+    end
+  end
+end

data/test/enum_table/test_schema_statements.rb

@@ -0,0 +1,131 @@
+require_relative '../test_helper'
+
+describe EnumTable::SchemaStatements do
+  use_database
+
+  describe "#create_enum_table" do
+    it "creates an enum table with the default name and default schema if none are given" do
+      connection.create_enum_table :genders
+      connection.tables.sort.must_equal ['enum_tables', 'genders']
+      connection.columns(:genders).map(&:name).must_equal ['id', 'value']
+      connection.columns(:genders).map(&:type).must_equal [:integer, :string]
+      connection.columns(:genders).map(&:null).must_equal [false, false]
+    end
+
+    it "accepts :values as a Hash" do
+      connection.create_enum_table :genders, values: {female: 2, male: 5}
+      read_table('genders').must_equal [[2, 'female'], [5, 'male']]
+    end
+
+    it "accepts :values as an Array" do
+      connection.create_enum_table :genders, values: [:female, :male]
+      read_table('genders').must_equal [[1, 'female'], [2, 'male']]
+    end
+
+    it "passes on other options to create_table" do
+      connection.create_table :genders
+      ->{ connection.create_enum_table :genders }.must_raise(ActiveRecord::StatementInvalid)
+      connection.create_enum_table :genders, force: true
+    end
+
+    it "allows configuring the id column in the block" do
+      connection.create_enum_table :genders do |t|
+        t.id type: :string, limit: 20
+      end
+      column = connection.columns(:genders).find { |c| c.name == 'id' }
+      column.type.must_equal :string
+      column.limit.must_equal 20
+    end
+
+    it "allows configuring the type column in the block" do
+      connection.create_enum_table :genders do |t|
+        t.value type: :binary, limit: 20
+      end
+      column = connection.columns(:genders).find { |c| c.name == 'value' }
+      column.type.must_equal :binary
+      column.limit.must_equal 20
+    end
+
+    it "records the enum_table" do
+      connection.create_enum_table :genders
+      result = connection.execute "SELECT table_name FROM enum_tables"
+      result.map { |row| row[0] }.must_equal ['genders']
+    end
+
+    it "does not populate the table if no values are given" do
+      connection.create_enum_table :genders
+      read_table('genders').must_equal []
+    end
+
+    it "populates the table from values given in the block" do
+      connection.create_enum_table :genders do |t|
+        t.add :female, 1
+        t.add :male, 2
+      end
+      read_table('genders').must_equal [[1, 'female'], [2, 'male']]
+    end
+  end
+
+  describe "#change_enum_table" do
+    before do
+      connection.execute "CREATE TABLE genders(id integer, value varchar(20))"
+      connection.execute "INSERT INTO genders (id, value) VALUES (1, 'female'), (2, 'male')"
+    end
+
+    it "inserts values added in the block" do
+      connection.change_enum_table :genders do |t|
+        t.add :other, 3
+      end
+      read_table('genders').must_equal [[1, 'female'], [2, 'male'], [3, 'other']]
+    end
+
+    it "defaults the ID to the next available" do
+      connection.change_enum_table :genders do |t|
+        t.add :other
+      end
+      read_table('genders').must_equal [[1, 'female'], [2, 'male'], [3, 'other']]
+    end
+
+    it "deletes values removed in the block" do
+      connection.change_enum_table :genders do |t|
+        t.remove :male
+      end
+      read_table('genders').must_equal [[1, 'female']]
+    end
+  end
+
+  describe "#drop_enum_table" do
+    it "removes the table from enum_tables if required" do
+      connection.create_enum_table :genders
+      connection.drop_enum_table :genders
+      result = connection.execute "SELECT table_name FROM enum_tables"
+      result.to_a.must_equal []
+    end
+  end
+
+  describe "#enum_tables" do
+    it "returns the names of the enum tables" do
+      connection.create_enum_table :genders
+      connection.create_enum_table :statuses
+      connection.enum_tables.must_equal ['genders', 'statuses']
+    end
+
+    it "returns no tables if no enum tables have ever existed" do
+      connection.enum_tables.must_equal []
+    end
+
+    it "returns no tables if all enum tables have been dropped" do
+      connection.create_enum_table :genders
+      connection.drop_enum_table :genders
+      connection.enum_tables.must_equal []
+    end
+  end
+
+  def read_table(name)
+    rows = []
+    connection.execute("SELECT id, value FROM #{name} ORDER BY id").each do |row|
+      rows << [row[0], row[1]]
+    end
+    rows
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,53 @@
+ROOT = File.expand_path('..', File.dirname(__FILE__))
+$:.unshift "#{ROOT}/lib"
+
+require 'minitest/spec'
+require 'active_record'
+require 'enum_table'
+
+ADAPTER = ENV['ENUM_TABLE_ADAPTER'] || 'sqlite3'
+CONFIG = YAML.load_file("#{ROOT}/test/database.yml")[ADAPTER].merge(adapter: ADAPTER)
+case ADAPTER
+when /sqlite/
+  ActiveRecord::Base.establish_connection(CONFIG)
+when /postgres/
+  ActiveRecord::Base.establish_connection(CONFIG.merge('database' => 'postgres'))
+else
+  ActiveRecord::Base.establish_connection(CONFIG.merge('database' => nil))
+end
+
+MiniTest::Spec.class_eval do
+  def recreate_database
+    drop_database
+    create_database
+  end
+
+  def connection
+    ActiveRecord::Base.connection
+  end
+
+  def create_database
+    unless ADAPTER =~ /sqlite/
+      connection.create_database CONFIG['database']
+    end
+    ActiveRecord::Base.establish_connection(CONFIG)
+  end
+
+  def drop_database
+    case ADAPTER
+    when /sqlite/
+      # Nothing to do - in-memory database.
+    when /postgres/
+      # Postgres barfs if you drop the selected database.
+      ActiveRecord::Base.establish_connection(CONFIG.merge('database' => 'postgres'))
+      connection.drop_database CONFIG['database']
+    else
+      connection.drop_database CONFIG['database']
+    end
+  end
+
+  def self.use_database
+    before { recreate_database }
+    after { drop_database }
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: enum_table
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- George Ogata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: ritual
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: 
+email:
+- george.ogata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- enum_table.gemspec
+- lib/enum_table.rb
+- lib/enum_table/railtie.rb
+- lib/enum_table/record.rb
+- lib/enum_table/reflection.rb
+- lib/enum_table/schema_dumper.rb
+- lib/enum_table/schema_statements.rb
+- lib/enum_table/version.rb
+- test/database.yml
+- test/enum_table/test_record.rb
+- test/enum_table/test_reflection.rb
+- test/enum_table/test_schema_dumper.rb
+- test/enum_table/test_schema_statements.rb
+- test/test_helper.rb
+homepage: http://github.com/howaboutwe/enum_table
+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: 123907201229092467
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 123907201229092467
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enumeration tables for ActiveRecord
+test_files:
+- test/database.yml
+- test/enum_table/test_record.rb
+- test/enum_table/test_reflection.rb
+- test/enum_table/test_schema_dumper.rb
+- test/enum_table/test_schema_statements.rb
+- test/test_helper.rb