enum_column3 0.1.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Nick Pohodnya
+
+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/README.txt

@@ -0,0 +1,60 @@
+Overview
+
+  This gem is an extension to ActiveRecord which enables native support of enumerations in the database schema using the ENUM type in MySQL.
+  Currently only MySQL is implemented.
+  Tested with Rails 3, for Rails 2 you should better use enum-column plugin (http://rubyforge.org/projects/enum-column/)
+  Works with Scaffolding.
+
+  Supported adapters:
+    mysql
+    mysql2
+    jdbcmysql (by Nilesh Trivedi)
+
+How to use it.
+
+In you Gemfile:
+
+  gem 'enum_column3'
+
+In your schema:
+
+  When you create your schema, specify the constraint as a limit:
+
+    create_table :enumerations, :force => true do |t|
+      t.column :severity, :enum, :limit => [:low, :medium, :high, :critical], :default => :medium
+      t.column :color, :enum, :limit => [:red, :blue, :green, :yellow]
+      ...
+    end
+
+
+In the model:
+
+  You can then automatically validate this column using:
+
+    validates_columns :severity, :color
+
+  The rest will be handled for you. All enumerated values will be given as symbols.
+
+    @e = Enumeration.new
+    @e.severity = :medium
+
+You can always use the column reflection to get the list of possible values from the database column.
+
+    Enumeration.columns_hash['color'].limit
+    or
+    @enumeration.column_for_attribute(:color).limit
+    
+    Will yield: [:red, :blue, :green, :yellow]
+   
+
+In views:
+
+  You can use enum_select helper to generate input for enumerated attribute as:
+
+     <%= enum_select(@enumeration, 'severity')%>
+     or
+     <%= form_for @enumeration do |f| %>
+        <%= f.label :severity %>
+        <%= f.enum_select :severity %>
+     <% end %>
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/enum/active_record_helper.rb

@@ -0,0 +1,63 @@
+if defined?(Rails::Generator)
+  module Rails
+    module Generator
+      class GeneratedAttribute
+        def field_type_with_enumerated_attribute
+          return (@field_type = :enum_select) if type == :enum
+          field_type_without_enumerated_attribute
+        end
+        alias_method_chain :field_type, :enumerated_attribute
+      end
+    end
+  end
+end
+
+if defined?(ActionView::Base)
+	module ActionView
+		module Helpers
+
+			#form_options_helper.rb
+			module FormOptionsHelper
+				#def select
+				def enum_select(object, method, options={}, html_options={})
+					InstanceTag.new(object, method, self, options.delete(:object)).to_enum_select_tag(options, html_options)
+				end
+			end
+
+			class InstanceTag
+				def to_enum_select_tag(options, html_options={})					
+					if self.object.respond_to?(method_name.to_sym)
+						choices = self.object.send("column_for_attribute", method_name).limit
+						if (value = self.object.__send__(method_name.to_sym))
+							options[:selected] ||= value.to_s
+						else
+              options[:include_blank] = enums.allows_nil? if options[:include_blank].nil?
+						end
+					end
+					to_select_tag(choices, options, html_options)
+				end
+
+				#initialize record_name, method, self
+				if respond_to?(:to_tag)
+  				def to_tag_with_enumerated_attribute(options={})
+  					#look for an enum
+  					if (column_type == :enum && self.object.class.respond_to?(method_name.to_sym))
+  						to_enum_select_tag(options)
+  					else
+  						to_tag_without_enumerated_attribute(options)
+  					end
+  				end
+  				alias_method_chain :to_tag, :enumerated_attribute
+				end
+
+			end
+
+			class FormBuilder
+				def enum_select(method, options={}, html_options={})
+					@template.enum_select(@object_name, method, objectify_options(options), @default_options.merge(html_options))
+				end
+			end
+
+		end
+	end
+end

data/lib/enum/enum_adapter.rb

@@ -0,0 +1,78 @@
+
+# This module provides all the column helper methods to deal with the
+# values and adds the common type management code for the adapters.
+
+column_class = if defined? ActiveRecord::ConnectionAdapters::Mysql2Column
+  ActiveRecord::ConnectionAdapters::Mysql2Column
+else
+  ActiveRecord::ConnectionAdapters::MysqlColumn
+end
+
+column_class.module_eval do
+
+  alias __klass_enum klass
+  # The class for enum is Symbol.
+  def klass
+    if type == :enum
+      Symbol
+    else
+      __klass_enum
+    end
+  end
+
+  alias __type_cast_enum type_cast
+  # Convert to a symbol.
+  def type_cast(value)
+    if type == :enum
+      self.class.value_to_symbol(value)
+    else
+      __type_cast_enum(value)
+    end
+  end
+
+  alias __type_cast_code_enum type_cast_code
+  # Code to convert to a symbol.
+  def type_cast_code(var_name)
+    if type == :enum
+      "#{self.class.name}.value_to_symbol(#{var_name})"
+    else
+      __type_cast_code_enum(var_name)
+    end
+  end
+
+  class << self
+    # Safely convert the value to a symbol.
+    def value_to_symbol(value)
+      case value
+      when Symbol
+        value
+      when String
+        value.empty? ? nil : value.intern
+      else
+        nil
+      end
+    end
+  end
+
+private
+  alias __simplified_type_enum simplified_type
+  # The enum simple type.
+  def simplified_type(field_type)
+    if field_type =~ /enum/i
+      :enum
+    else
+      __simplified_type_enum(field_type)
+    end
+  end
+  
+  alias __extract_limit_enum extract_limit
+  def extract_limit(sql_type)
+    if sql_type =~ /^enum/i
+      sql_type.sub(/^enum\('([^)]+)'\)/i, '\1').split("','").map { |v| v.intern }
+    else
+      __extract_limit_enum(sql_type)
+    end
+  end
+
+
+end

data/lib/enum/mysql_adapter.rb

@@ -0,0 +1,17 @@
+adapter_class = if defined? ActiveRecord::ConnectionAdapters::MySQLJdbcConnection
+  ActiveRecord::ConnectionAdapters::MySQLJdbcConnection
+elsif defined? ActiveRecord::ConnectionAdapters::Mysql2Adapter
+  ActiveRecord::ConnectionAdapters::Mysql2Adapter
+elsif defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
+  ActiveRecord::ConnectionAdapters::MysqlAdapter
+end
+
+adapter_class.module_eval do
+  alias __native_database_types_enum native_database_types
+
+  def native_database_types #:nodoc
+    types = __native_database_types_enum
+    types[:enum] = { :name => "enum" }
+    types
+  end
+end

data/lib/enum/quoting.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module Quoting
+      alias __quote_enum quote
+
+      # Quote a symbol as a normal string. This will support quoting of
+      # enumerated values.
+      def quote(value, column = nil)
+        if !value.is_a? Symbol
+          __quote_enum(value, column)
+        else
+          ActiveRecord::Base.send(:quote_bound_value, value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/enum/schema_definitions.rb

@@ -0,0 +1,12 @@
+
+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
+    end
+  end
+end

data/lib/enum/schema_statements.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      alias __type_to_sql_enum type_to_sql
+
+      # Add enumeration support for schema statement creation. This
+      # will have to be adapted for every adapter if the type requires
+      # anything by a list of allowed values. The overrides the standard
+      # type_to_sql method and chains back to the default. This could 
+      # be done on a per adapter basis, but is generalized here.
+      #
+      # will generate enum('a', 'b', 'c') for :limit => [:a, :b, :c]
+      def type_to_sql(type, limit = nil, precision = nil, scale = nil) #:nodoc:
+        if type == :enum
+          native = native_database_types[type]
+          column_type_sql = (native || {})[:name] || 'enum'
+
+          column_type_sql << "(#{limit.map { |v| quote(v) }.join(',')})"
+
+          column_type_sql
+        else
+          __type_to_sql_enum(type, limit, precision, scale)
+        end
+      end
+    end
+  end
+end

data/lib/enum/validations.rb

@@ -0,0 +1,40 @@
+
+module ActiveRecord
+  module Validations
+    module ClassMethods
+      # Automatically validates the column against the schema definition
+      # for nullability, format, and enumerations. Handles integers, floats,
+      # enumerations, and string limits.
+      #
+      # Usage: validates_columns :severity, :name
+      def validates_columns(*column_names)
+        begin
+          cols = columns_hash
+          column_names.each do |name|
+            col = cols[name.to_s]
+            raise ArgumentError, "Cannot find column #{name}" unless col
+            
+            # test for nullability
+            validates_presence_of(name) if !col.null
+            
+            # Test various known types.
+            case col.type
+            when :enum
+              validates_inclusion_of name, :in => col.limit, :allow_nil => true
+              
+            when :integer, :float
+              validates_numericality_of name, :allow_nil => true
+              
+            when :string
+              if col.limit
+                validates_length_of name, :maximum => col.limit, :allow_nil => true
+              end
+            end
+          end
+        rescue ActiveRecord::StatementInvalid=>e
+          raise e unless e.message.include?("42S02") # swallow the exception if its for a missing table
+        end
+      end
+    end
+  end
+end

data/lib/enum_column.rb

@@ -0,0 +1,18 @@
+if defined?(::Rails::Railtie)
+  class EnumColumnRailtie < Rails::Railtie
+    initializer 'enum_column.initialize', :after => 'active_record.initialize_database' do |app|
+      ActiveSupport.on_load :active_record do
+        require 'enum/mysql_adapter'
+        require 'enum/enum_adapter'
+        require 'enum/schema_statements'
+        require 'enum/schema_definitions'
+        require 'enum/quoting'
+        require 'enum/validations'
+      end
+
+      ActiveSupport.on_load :action_view do
+        require 'enum/active_record_helper'
+      end
+    end
+  end
+end

data/lib/enum_column3.rb

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

data/test/db/schema.rb

@@ -0,0 +1,28 @@
+
+ActiveRecord::Schema.define do
+  create_table :enumerations, :force => true do |t|
+    t.column :severity, :enum, :limit => [:low, :medium, :high, :critical],
+       :default => :medium
+    t.column :color, :enum, :limit => [:red, :blue, :green, :yellow]
+    t.column :string_field, :string, :limit => 8, :null => false
+    t.column :int_field, :integer
+  end
+
+
+  create_table :basic_enums, :force => true  do |t|
+    t.column :value, :enum, :limit => [:good, :working]
+  end
+  
+  create_table :basic_default_enums, :force => true  do |t|
+    t.column :value, :enum, :limit => [:good, :working],:default => :working
+  end
+
+  create_table :nonnull_enums, :force => true  do |t|
+    t.column :value, :enum, :limit => [:good, :working],:null => false
+  end
+
+  create_table :nonnull_default_enums, :force => true  do |t|
+    t.column :value, :enum, :limit => [:good, :working],:null => false,:default => :working
+  end
+
+end

data/test/enum_controller_test.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fixtures/enumeration'
+require 'fixtures/enum_controller'
+
+class EnumControllerTest < ActionController::TestCase
+
+  def setup
+    Enumeration.connection.execute 'DELETE FROM enumerations'
+
+    Rails.application.routes.draw do
+      match '/enum_select' => "enum#enum_select"
+    end
+  end
+
+  test "should render enum_select" do
+    get :enum_select
+    assert_response :success
+    assert_equal '<select id="test_severity" name="test[severity]"><option value="low">low</option>
+<option value="medium" selected="selected">medium</option>
+<option value="high">high</option>
+<option value="critical">critical</option></select>', @response.body
+  end
+
+end

data/test/enum_mysql_test.rb

@@ -0,0 +1,208 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fixtures/enumeration'
+
+class EnumerationsTest < Test::Unit::TestCase
+  def setup
+    Enumeration.connection.execute 'DELETE FROM enumerations'
+  end
+  
+  def test_column_values
+    columns = Enumeration.columns_hash
+    color_column = columns['color']
+    assert color_column
+    assert_equal [:red, :blue, :green, :yellow], color_column.limit
+
+    severity_column = columns['severity']
+    assert severity_column
+    assert_equal [:low, :medium, :high, :critical], severity_column.limit
+    assert_equal :medium, severity_column.default
+  end
+
+  def test_insert_enum
+    row = Enumeration.new
+    row.color = :blue
+    row.string_field = 'test'
+    assert_equal :medium, row.severity
+    assert row.save
+
+    db_row = Enumeration.find(row.id)
+    assert db_row
+    assert_equal :blue, row.color
+    assert_equal :medium, row.severity
+  end
+
+  # Uses the automatic validates_columns to create automatic validation rules
+  # for columns based on the schema information.
+  def test_bad_value
+    row = Enumeration.new
+    row.color = :violet
+    row.string_field = 'test'
+    assert !row.save
+    
+    assert row.errors
+    assert_equal ['is not included in the list'], row.errors['color']
+  end
+
+  def test_other_types
+    row = Enumeration.new
+    row.string_field = 'a' * 10
+    assert !row.save
+    assert_equal ['is too long (maximum is 8 characters)'], row.errors['string_field']
+
+    row = Enumeration.new
+    assert !row.save
+    assert_equal ['can\'t be blank'], row.errors['string_field']
+
+    row = Enumeration.new
+    row.string_field = 'test'
+    row.int_field = 'aaaa'
+    assert !row.save
+    assert_equal ['is not a number'], row.errors['int_field']
+
+    row = Enumeration.new
+    row.string_field = 'test'
+    row.int_field = '500'
+    assert row.save
+  end
+
+  def test_view_helper
+    request  = ActionController::TestRequest.new
+    response = ActionController::TestResponse.new
+    request.action = 'test1'
+    body = EnumController.process(request, response).body
+    assert_equal '<select id="test_severity" name="test[severity]"><option value="low">low</option><option value="medium" selected="selected">medium</option><option value="high">high</option><option value="critical">critical</option></select>', body
+  end
+
+  def test_radio_helper
+    request  = ActionController::TestRequest.new
+    response = ActionController::TestResponse.new
+    request.action = 'test2'
+    body = EnumController.process(request, response).body
+    assert_equal '<label>low: <input id="test_severity_low" name="test[severity]" type="radio" value="low" /></label><label>medium: <input checked="checked" id="test_severity_medium" name="test[severity]" type="radio" value="medium" /></label><label>high: <input id="test_severity_high" name="test[severity]" type="radio" value="high" /></label><label>critical: <input id="test_severity_critical" name="test[severity]" type="radio" value="critical" /></label>', body
+  end
+
+
+  # Basic tests
+  def test_create_basic_default
+    assert (object = BasicEnum.create)
+    assert_nil object.value,
+      "Enum columns without explicit default, default to null if allowed"
+    assert !object.new_record?
+  end
+
+  def test_create_basic_good
+    assert (object = BasicEnum.create(:value => :good))
+    assert_equal :good, object.value
+    assert !object.new_record?
+    assert (object = BasicEnum.create(:value => :working))
+    assert_equal :working, object.value
+    assert !object.new_record?
+  end
+
+  def test_create_basic_null
+    assert (object = BasicEnum.create(:value => nil))
+    assert_nil object.value
+    assert !object.new_record?
+  end
+
+  def test_create_basic_bad
+    assert (object = BasicEnum.create(:value => :bad))
+    assert object.new_record?
+  end
+
+  # Basic w/ Default
+
+  ######################################################################
+
+  def test_create_basic_wd_default
+    assert (object = BasicDefaultEnum.create)
+    assert_equal :working, object.value, "Explicit default ignored columns"
+    assert !object.new_record?
+  end
+
+  def test_create_basic_wd_good
+    assert (object = BasicDefaultEnum.create(:value => :good))
+    assert_equal :good, object.value
+    assert !object.new_record?
+    assert (object = BasicDefaultEnum.create(:value => :working))
+    assert_equal :working, object.value
+    assert !object.new_record?
+  end
+
+  def test_create_basic_wd_null
+    assert (object = BasicDefaultEnum.create(:value => nil))
+    assert_nil object.value
+    assert !object.new_record?
+  end
+
+  def test_create_basic_wd_bad
+    assert (object = BasicDefaultEnum.create(:value => :bad))
+    assert object.new_record?
+  end
+
+
+
+  # Nonnull
+
+  ######################################################################
+
+  def test_create_nonnull_default
+    assert (object = NonnullEnum.create)
+#    assert_equal :good, object.value,
+#      "Enum columns without explicit default, default to first value if null not allowed"
+    assert object.new_record?
+  end
+
+  def test_create_nonnull_good
+    assert (object = NonnullEnum.create(:value => :good))
+    assert_equal :good, object.value
+    assert !object.new_record?
+    assert (object = NonnullEnum.create(:value => :working))
+    assert_equal :working, object.value
+    assert !object.new_record?
+  end
+
+  def test_create_nonnull_null
+    assert (object = NonnullEnum.create(:value => nil))
+    assert object.new_record?
+  end
+
+  def test_create_nonnull_bad
+    assert (object = NonnullEnum.create(:value => :bad))
+    assert object.new_record?
+  end
+
+  # Nonnull w/ Default
+
+  ######################################################################
+
+  def test_create_nonnull_wd_default
+    assert (object = NonnullDefaultEnum.create)
+    assert_equal :working, object.value
+    assert !object.new_record?
+  end
+
+  def test_create_nonnull_wd_good
+    assert (object = NonnullDefaultEnum.create(:value => :good))
+    assert_equal :good, object.value
+    assert !object.new_record?
+    assert (object = NonnullDefaultEnum.create(:value => :working))
+    assert_equal :working, object.value
+    assert !object.new_record?
+  end
+
+  def test_create_nonnull_wd_null
+    assert (object = NonnullDefaultEnum.create(:value => nil))
+    assert object.new_record?
+  end
+
+  def test_create_nonnull_wd_bad
+    assert (object = NonnullDefaultEnum.create(:value => :bad))
+    assert object.new_record?
+  end
+
+  def test_quoting
+    value = Enumeration.send(:sanitize_sql, ["value = ? ", :"'" ] )
+    assert_equal "value = '\\'' ", value
+  end
+end

data/test/fixtures/enum_controller.rb

@@ -0,0 +1,9 @@
+class EnumController < ActionController::Base
+  layout false
+
+  def enum_select
+    @test = Enumeration.new
+    render :inline => "<%= enum_select('test', 'severity')%>"
+  end
+
+end

data/test/fixtures/enumeration.rb

@@ -0,0 +1,20 @@
+
+class Enumeration < ActiveRecord::Base
+  validates_columns :color, :severity, :string_field, :int_field
+end
+
+class BasicEnum < ActiveRecord::Base
+  validates_columns :value
+end
+
+class BasicDefaultEnum < ActiveRecord::Base
+  validates_columns :value
+end
+
+class NonnullEnum < ActiveRecord::Base
+  validates_columns :value
+end
+
+class NonnullDefaultEnum < ActiveRecord::Base
+  validates_columns :value
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# =============================================================================
+# Include the files required to test Engines.
+
+# Load the default rails test helper - this will load the environment.
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+
+plugin_path = File::dirname(__FILE__) + '/..'
+schema_file = plugin_path + "/test/db/schema.rb"
+load(schema_file) if File.exist?(schema_file)
+
+# set up the fixtures location to use your engine's fixtures
+fixture_path = File.dirname(__FILE__)  + "/fixtures/"
+ActiveSupport::TestCase.fixture_path = fixture_path
+$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+# =============================================================================
+
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: enum_column3
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
+platform: ruby
+authors: 
+- Nick Pohodnya
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-16 00:00:00 Z
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.txt
+- LICENSE
+- init.rb
+- lib/enum_column.rb
+- lib/enum_column3.rb
+- lib/enum/active_record_helper.rb
+- lib/enum/enum_adapter.rb
+- lib/enum/mysql_adapter.rb
+- lib/enum/quoting.rb
+- lib/enum/schema_definitions.rb
+- lib/enum/schema_statements.rb
+- lib/enum/validations.rb
+- test/test_helper.rb
+- test/db/schema.rb
+- test/fixtures/enumeration.rb
+- test/fixtures/enum_controller.rb
+- test/enum_controller_test.rb
+- test/enum_mysql_test.rb
+homepage: http://github.com/electronick/enum_column
+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: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Enable enum type for MySQL db.
+test_files: 
+- test/test_helper.rb
+- test/db/schema.rb
+- test/fixtures/enumeration.rb
+- test/fixtures/enum_controller.rb
+- test/enum_controller_test.rb
+- test/enum_mysql_test.rb