activerecord_enum 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activerecord_enum.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,16 @@
+# ActiveRecord Enum
+
+Provides ActiveRecord support for the nonstandard `ENUM` and `SET` data types.
+
+## Hypothetically asked questions
+
+### Y U NO WORK?!
+Sorry, it currently only works with Rails 3.0.x and the mysql2 adapter. I plan to support 3.1.x and other adapters at some point.
+
+### Why doesn't it validate anything?
+Right now it really only supports schema operations - attribute access is left untouched. I'll be working on that too at some point.
+
+### Nonstandard SQL?! What's your problem, jerkweed?
+This isn't a plugin everyone should use. There are a number of plugins to simulate enum behavior backed by standard datatypes. Personally, I like [https://github.com/nofxx/symbolize].
+
+However, sometimes we can't or won't avoid working with these data types. When that happens, I got you covered.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+desc 'Default: run unit tests.'
+task :default => :spec
+
+require "rspec/core/rake_task"
+desc 'Run the test suite.'
+RSpec::Core::RakeTask.new(:spec)

data/activerecord_enum.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "activerecord_enum/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activerecord_enum"
+  s.version     = ActiverecordEnum::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ian Young"]
+  s.email       = ["ian.greenleaf+github@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Enum data types for ActiveRecord}
+  s.description = %q{Adds the ENUM data type natively to ActiveRecord.}
+
+  s.rubyforge_project = "activerecord_enum"
+
+  s.add_dependency "activerecord", "~> 3.0.9"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "mysql2", "~> 0.2.0"
+  s.add_development_dependency "rspec", "~> 2.6.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/activerecord_enum/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordEnum
+  VERSION = "0.0.1"
+end

data/lib/activerecord_enum.rb

@@ -0,0 +1,89 @@
+require 'active_record'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'active_record/connection_adapters/abstract/schema_definitions.rb'
+
+module ActiverecordEnum
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Mysql2Adapter < AbstractAdapter
+      def native_database_types_with_enum
+        native_database_types_without_enum.merge( :enum => { :name => "enum" }, :set => { :name => "set" } )
+      end
+      alias_method :native_database_types_without_enum, :native_database_types
+      alias_method :native_database_types, :native_database_types_with_enum
+
+      def type_to_sql_with_enum type, limit=nil, *args
+        if type.to_s == "enum" || type.to_s == "set"
+          "#{type}(#{quoted_comma_list limit})"
+        else
+          type_to_sql_without_enum type, limit, *args
+        end
+      end
+      alias_method :type_to_sql_without_enum, :type_to_sql
+      alias_method :type_to_sql, :type_to_sql_with_enum
+
+      private
+      def quoted_comma_list list
+        list.to_a.map{|n| "'#{n}'"}.join(",")
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    class Column
+      def initialize_with_enum name, default, sql_type=nil, *args
+        initialize_without_enum name, default, sql_type, *args
+        @type = simplified_type_with_enum sql_type
+        @limit = extract_limit_with_enum sql_type
+        @default = extract_default_with_enum default
+      end
+      alias_method :initialize_without_enum, :initialize
+      alias_method :initialize, :initialize_with_enum
+
+      def simplified_type_with_enum field_type
+        if field_type =~ /enum|set/i
+          $&.to_sym
+        else
+          simplified_type field_type
+        end
+      end
+
+      def extract_limit_with_enum field_type
+        if field_type =~ /(?:enum|set)\(([^)]+)\)/i
+          $1.scan( /'([^']*)'/ ).flatten
+        else
+          extract_limit field_type
+        end
+      end
+
+      def extract_default_with_enum default
+        if type == :set
+          default.split "," if default.present?
+        else
+          extract_default default
+        end
+      end
+    end
+  end
+end
+module ActiveRecord
+  module ConnectionAdapters
+    class TableDefinition
+      def enum *args
+        options = args.extract_options!
+        column_names = args
+        column_names.each { |name| column(name, :enum, options) }
+      end
+      def set *args
+        options = args.extract_options!
+        options[:default] = options[:default].join "," if options[:default].present?
+        column_names = args
+        column_names.each { |name| column(name, :set, options) }
+      end
+    end
+  end
+end

data/spec/enum_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "ENUM datatype" do
+
+  describe "schema dump" do
+    before { load_schema "enum_old" }
+    subject { dumped_schema }
+
+    it "dumps native format" do
+      subject.should match %r{t\.enum\s+"color",\s+:limit => \["blue", "red", "yellow"\]}
+    end
+
+    it "dumps default option" do
+      subject.should match %r{t\.enum\s+"color",.+:default => "red"}
+    end
+
+    it "dumps null option" do
+      subject.should match %r{t\.enum\s+"color",.+:null => false$}
+    end
+  end
+
+  describe "schema loading" do
+    before { load_schema "enum_new" }
+    subject { ActiveRecord::Base.connection.select_one "SHOW FIELDS FROM balloons WHERE Field='color'" }
+
+    it "loads native format" do
+      subject[ "Type" ].should == "enum('red','gold')"
+    end
+
+    it "loads default option" do
+      subject[ "Default" ].should == "gold"
+    end
+
+    it "loads null option" do
+      subject[ "Null" ].should == "NO"
+    end
+
+    it "loads native column format" do
+      subject = ActiveRecord::Base.connection.select_one "SHOW FIELDS FROM balloons WHERE Field='size'"
+      subject[ "Type" ].should == "enum('small','medium','large')"
+    end
+  end
+
+  describe "validation" do
+    it "validates assigned value is member of the list"
+    it "allows nil when null enabled"
+  end
+end

data/spec/schema/enum_new.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  create_table :balloons, :force => true do |t|
+    t.integer "id"
+    t.enum "color", :limit => ['red', 'gold'], :default => 'gold', :null => false
+    t.column "size", :enum, :limit => ['small', 'medium', 'large']
+  end
+end

data/spec/schema/enum_old.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table :aircraft, :force => true do |t|
+    t.integer "id"
+    t.column "color", "enum('blue','red','yellow')", :default => 'red', :null => false
+  end
+end

data/spec/schema/set_new.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  create_table :balloons, :force => true do |t|
+    t.integer "id"
+    t.set "ribbons", :limit => ['red', 'green', 'gold'], :default => ['gold', 'green'], :null => false
+    t.column "gasses", :set, :limit => ['helium', 'hydrogen']
+  end
+end

data/spec/schema/set_old.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table :aircraft, :force => true do |t|
+    t.integer "id"
+    t.column "gadgets", "set('propeller','tail gun','gps')", :default => 'propeller,gps', :null => false
+  end
+end

data/spec/set_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe "SET datatype" do
+
+  describe "schema dump" do
+    before { load_schema "set_old" }
+    subject { dumped_schema }
+
+    it "dumps native format" do
+      subject.should match %r{t\.set\s+"gadgets",\s+:limit => \["propeller", "tail gun", "gps"\]}
+    end
+
+    it "dumps default option" do
+      subject.should match %r{t\.set\s+"gadgets",.+:default => \["propeller", "gps"\]}
+    end
+
+    it "dumps null option" do
+      subject.should match %r{t\.set\s+"gadgets",.+:null => false$}
+    end
+  end
+
+  describe "schema loading" do
+    before { load_schema "set_new" }
+    subject { ActiveRecord::Base.connection.select_one "SHOW FIELDS FROM balloons WHERE Field='ribbons'" }
+
+    it "loads native format" do
+      subject[ "Type" ].should == "set('red','green','gold')"
+    end
+
+    it "loads default option" do
+      subject[ "Default" ].should == "green,gold"
+    end
+
+    it "loads null option" do
+      subject[ "Null" ].should == "NO"
+    end
+
+    it "loads native column format" do
+      subject = ActiveRecord::Base.connection.select_one "SHOW FIELDS FROM balloons WHERE Field='gasses'"
+      subject[ "Type" ].should == "set('helium','hydrogen')"
+    end
+  end
+
+  describe "assignment" do
+    it "accepts single value"
+    it "accepts array of values"
+    it "accepts comma-separated values"
+  end
+
+  describe "validation" do
+    it "validates assigned values are members of the list"
+    it "allows nil when null enabled"
+    it "allows empty list"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+require 'activerecord_enum'
+
+def load_schema filename
+  # silence verbose schema loading
+  original_stdout = $stdout
+  $stdout = StringIO.new
+
+  root = File.expand_path(File.dirname(__FILE__))
+  load root + "/schema/#{filename}.rb"
+
+ensure
+  $stdout = original_stdout
+end
+
+def dumped_schema
+  stream = StringIO.new
+  ActiveRecord::SchemaDumper.ignore_tables = []
+  ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+  stream.string.lines.select {|l| /^\s*#/.match(l).nil? }.join
+end
+
+ActiveRecord::Base.configurations = {
+  "enum_test" => {
+    :adapter => "mysql2",
+    :host => "localhost",
+    :username => "enum_test",
+    :password => "enum_test",
+    :database => "enum_test",
+    :socket => "/tmp/mysql.sock"
+  },
+}
+ActiveRecord::Base.establish_connection "enum_test"

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord_enum
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ian Young
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 3
+        - 0
+        - 9
+        version: 3.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id005
+description: Adds the ENUM data type natively to ActiveRecord.
+email: 
+- ian.greenleaf+github@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- activerecord_enum.gemspec
+- lib/activerecord_enum.rb
+- lib/activerecord_enum/version.rb
+- spec/enum_spec.rb
+- spec/schema/enum_new.rb
+- spec/schema/enum_old.rb
+- spec/schema/set_new.rb
+- spec/schema/set_old.rb
+- spec/set_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: activerecord_enum
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Enum data types for ActiveRecord
+test_files: 
+- spec/enum_spec.rb
+- spec/schema/enum_new.rb
+- spec/schema/enum_old.rb
+- spec/schema/set_new.rb
+- spec/schema/set_old.rb
+- spec/set_spec.rb
+- spec/spec_helper.rb