enum_column 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Stephan Kaag
+
+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/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "enum_column"
+    gem.summary = %Q{Ruby on Rails Enumerated Column Constraints}
+    gem.description = %Q{Ruby on Rails Enumerated Column Constraints}
+    gem.email = "stephan.kaag@gmail.com"
+    gem.homepage = "http://github.com/stephankaag/enum_column"
+    gem.authors = ["Stephan Kaag"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "enum_column #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/enum_column.gemspec

@@ -0,0 +1,108 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enum_column}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stephan Kaag"]
+  s.date = %q{2009-10-14}
+  s.description = %q{Ruby on Rails Enumerated Column Constraints}
+  s.email = %q{stephan.kaag@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "enum_column.gemspec",
+     "lib/enum/active_record_helper.rb",
+     "lib/enum/enum_adapter.rb",
+     "lib/enum/mysql_adapter.rb",
+     "lib/enum/postgresql_adapter.rb",
+     "lib/enum/quoting.rb",
+     "lib/enum/schema_definitions.rb",
+     "lib/enum/schema_statements.rb",
+     "lib/enum/sqlite3_adapter.rb",
+     "lib/enum/validations.rb",
+     "lib/enum_column.rb",
+     "readme.html",
+     "test/db/schema.rb",
+     "test/enum_mysql_test.rb",
+     "test/fixtures/db_definitions/mysql.drop.sql",
+     "test/fixtures/db_definitions/mysql.sql",
+     "test/fixtures/enumeration.rb",
+     "test/mock_app/.gitignore",
+     "test/mock_app/README",
+     "test/mock_app/Rakefile",
+     "test/mock_app/app/controllers/application_controller.rb",
+     "test/mock_app/app/controllers/contents_controller.rb",
+     "test/mock_app/app/models/content.rb",
+     "test/mock_app/config/boot.rb",
+     "test/mock_app/config/database.yml",
+     "test/mock_app/config/environment.rb",
+     "test/mock_app/config/environments/development.rb",
+     "test/mock_app/config/environments/production.rb",
+     "test/mock_app/config/environments/test.rb",
+     "test/mock_app/config/initializers/backtrace_silencers.rb",
+     "test/mock_app/config/initializers/inflections.rb",
+     "test/mock_app/config/initializers/mime_types.rb",
+     "test/mock_app/config/initializers/new_rails_defaults.rb",
+     "test/mock_app/config/initializers/session_store.rb",
+     "test/mock_app/config/locales/en.yml",
+     "test/mock_app/config/routes.rb",
+     "test/mock_app/config/sitemap.rb",
+     "test/mock_app/db/migrate/20090826121911_create_contents.rb",
+     "test/mock_app/db/schema.rb",
+     "test/mock_app/db/test.sqlite3",
+     "test/mock_app/public/index.html",
+     "test/mock_app/script/console",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/stephankaag/enum_column}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby on Rails Enumerated Column Constraints}
+  s.test_files = [
+    "test/db/schema.rb",
+     "test/enum_mysql_test.rb",
+     "test/fixtures/enumeration.rb",
+     "test/mock_app/app/controllers/application_controller.rb",
+     "test/mock_app/app/controllers/contents_controller.rb",
+     "test/mock_app/app/models/content.rb",
+     "test/mock_app/config/boot.rb",
+     "test/mock_app/config/environment.rb",
+     "test/mock_app/config/environments/development.rb",
+     "test/mock_app/config/environments/production.rb",
+     "test/mock_app/config/environments/test.rb",
+     "test/mock_app/config/initializers/backtrace_silencers.rb",
+     "test/mock_app/config/initializers/inflections.rb",
+     "test/mock_app/config/initializers/mime_types.rb",
+     "test/mock_app/config/initializers/new_rails_defaults.rb",
+     "test/mock_app/config/initializers/session_store.rb",
+     "test/mock_app/config/routes.rb",
+     "test/mock_app/config/sitemap.rb",
+     "test/mock_app/db/migrate/20090826121911_create_contents.rb",
+     "test/mock_app/db/schema.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/enum/active_record_helper.rb

@@ -0,0 +1,107 @@
+
+module ActionView
+  module Helpers
+    module FormHelper
+      # helper to create a select drop down list for the enumerated values. This
+      # is the default input tag.
+      def enum_select(object_name, method, options = {})
+        if RAILS_GEM_VERSION < '2.2.0'
+          tag = InstanceTag.new(object_name, method, self, nil, options.delete(:object))
+        else
+          tag = InstanceTag.new(object_name, method, self, options.delete(:object))
+        end
+        tag.to_enum_select_tag(options)
+      end
+
+      # Creates a set of radio buttons for all the enumerated values.
+      def enum_radio(object_name, method, options = {})
+        if RAILS_GEM_VERSION < '2.2.0'
+          tag = InstanceTag.new(object_name, method, self, nil, options.delete(:object))
+        else
+          tag = InstanceTag.new(object_name, method, self, options.delete(:object))
+        end
+        tag.to_enum_radio_tag(options)        
+      end
+    end
+
+    class FormBuilder
+      def enum_select(method, options = { })
+        @template.enum_select(@object_name, method, options)
+      end
+
+      def enum_radio(method, options = { })
+        @template.enum_radio(@object_name, method, options)
+      end
+    end
+    
+    class InstanceTag #:nodoc:
+      alias __to_tag_enum to_tag
+
+      # Add the enumeration tag support. Defaults using the select tag to
+      # display the options.
+      def to_tag(options = {})
+        if column_type == :enum
+          to_enum_select_tag(options)
+        else
+          __to_tag_enum(options)
+        end
+      end
+
+      # Create a select tag and one option for each of the
+      # enumeration values.
+      def to_enum_select_tag(options = {})
+        # Remove when we no longer support 1.1.
+        begin
+          v = value(object)
+        rescue ArgumentError
+          v = value
+        end
+        add_default_name_and_id(options)
+        tag_text = "<select"
+        tag_text << tag_options(options)
+        tag_text << ">"
+        values = enum_values
+        raise ArgumentError, "No values for enum select tag" unless values
+        if options[:include_blank]
+          tag_text << "<option value=\"\"></option>\n"
+        end
+        values.each do |enum|
+          tag_text << "<option value=\"#{enum}\""
+          tag_text << ' selected="selected"' if v and v == enum
+          tag_text << ">#{enum}</option>"
+        end
+        tag_text << "</select>"
+      end
+
+      # Creates a set of radio buttons and labels.
+      def to_enum_radio_tag(options = {})
+        # Remove when we no longer support 1.1.
+        begin
+          v = value(object)
+        rescue ArgumentError
+          v = value
+        end
+        add_default_name_and_id(options)
+        values = enum_values
+        raise ArgumentError, "No values for enum select tag" unless values
+        tag_text = ''
+        template = options.dup
+        template.delete('checked')
+        values.each do |enum|
+          opts = template.dup
+          opts['checked'] = 'checked' if v and v == enum
+          opts['id'] = "#{opts['id']}_#{enum}"
+          tag_text << "<label>#{enum}: "
+          tag_text << to_radio_button_tag(enum, opts)
+          tag_text << "</label>"
+        end
+        tag_text
+      end
+
+      # Gets the list of values for the column.
+      def enum_values
+        object.send("column_for_attribute", @method_name).values
+      end
+    end
+  end
+end

data/lib/enum/enum_adapter.rb

@@ -0,0 +1,76 @@
+
+# This module provides all the column helper methods to deal with the
+# values and adds the common type management code for the adapters.
+module ActiveRecordEnumerations
+  module Column
+    # Add the values accessor to the column class.
+    def self.included(klass)
+      klass.module_eval <<-EOE
+        def values; @limit; end
+      EOE
+    end
+
+    # Add the type to the native database types. This will most
+    # likely need to be modified in the adapter as well.
+    def native_database_types
+      types = super
+      types[:enum] = { :name => "enum" }
+      types
+    end
+
+    # The new constructor with a values argument.
+    def initialize(name, default, sql_type = nil, null = true, values = nil)
+      super(name, default, sql_type, null)
+      @limit = values if type == :enum
+    end
+
+    # The class for enum is Symbol.
+    def klass
+      if type == :enum
+        Symbol
+      else
+        super
+      end
+    end
+
+    # Convert to a symbol.
+    def type_cast(value)
+      return nil if value.nil?
+      if type == :enum
+        ActiveRecordEnumerations::Column.value_to_symbol(value)
+      else
+        super
+      end
+    end
+
+    # Code to convert to a symbol.
+    def type_cast_code(var_name)
+      if type == :enum
+        "ActiveRecordEnumerations::Column.value_to_symbol(#{var_name})"
+      else
+        super
+      end
+    end
+
+    # The enum simple type.
+    def simplified_type(field_type)
+      if field_type =~ /enum/i
+        :enum
+      else
+        super
+      end
+    end
+
+    # Safely convert the value to a symbol. 
+    def self.value_to_symbol(value)
+      case value
+      when Symbol
+        value
+      when String
+        value.empty? ? nil : value.intern
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/enum/mysql_adapter.rb

@@ -0,0 +1,33 @@
+
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter
+      alias __native_database_types_enum native_database_types
+      
+      def native_database_types #:nodoc
+        types = __native_database_types_enum
+        types[:enum] = { :name => "enum" }
+        types
+      end
+
+      def columns(table_name, name = nil)#:nodoc:
+        sql = "SHOW FIELDS FROM #{table_name}"
+        columns = []
+        execute(sql, name).each { |field| columns << MysqlColumnWithEnum.new(field[0], field[4], field[1], field[2] == "YES") }
+        columns
+      end
+    end
+    
+    class MysqlColumnWithEnum < MysqlColumn
+      include ActiveRecordEnumerations::Column
+      
+      def initialize(name, default, sql_type = nil, null = true)
+        if sql_type =~ /^enum/i
+          values = sql_type.sub(/^enum\('([^)]+)'\)/i, '\1').split("','").map { |v| v.intern }
+          default = default.intern if default and !default.empty?
+        end
+        super(name, default, sql_type, null, values)
+      end
+    end
+  end
+end

data/lib/enum/postgresql_adapter.rb

@@ -0,0 +1,64 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter
+      alias __native_database_types_enum native_database_types
+      
+      def native_database_types #:nodoc
+        types = __native_database_types_enum
+        types[:enum] = { :name => "character varying(32)" }
+        types
+      end
+
+      def columns(table_name, name = nil)#:nodoc:
+        column_definitions(table_name).collect do |name, type, default, notnull, consrc|
+          values = nil
+          if consrc and consrc =~ /ANY \(\(ARRAY(\[[^]]+\])/o and type == native_database_types[:enum][:name]
+            values = eval $1.gsub(/::character varying/, '')
+            type = 'enum'
+          end
+          
+          # typmod now unused as limit, precision, scale all handled by superclass
+          PostgreSQLColumnWithEnum.new(name, default_value(default),
+                                       translate_field_type(type), notnull == "f",
+                                       values)
+        end
+      end
+
+      # Add constraints to the list of columns. This will only pick up check constraints.
+      # We'll filter the constraint for the column type and ANY ((ARRAY[ type.
+      def column_definitions(table_name)
+        query <<-end_sql
+          SELECT a.attname, format_type(a.atttypid, a.atttypmod), d.adsrc, a.attnotnull, c.consrc
+            FROM pg_attribute a LEFT JOIN pg_attrdef d
+              ON a.attrelid = d.adrelid AND a.attnum = d.adnum
+              LEFT JOIN pg_constraint c ON a.attrelid = c.conrelid AND 
+                c.contype = 'c' AND c.conkey[1] = a.attnum
+            WHERE a.attrelid = '#{table_name}'::regclass
+              AND a.attnum > 0 AND NOT a.attisdropped
+            ORDER BY a.attnum
+        end_sql
+      end
+
+      def add_column_options!(sql, options)
+        unless sql =~ /\(32\)\('[^']+'/
+          super(sql, options)
+        else
+          sql.gsub!(/("[^"]+")([^3]+32\))(.+)/, '\1\2 CHECK(\1 in \3)')
+          super(sql, options)
+        end
+      end
+    end
+    
+    class PostgreSQLColumnWithEnum < Column
+      include ActiveRecordEnumerations::Column
+      
+      def initialize(name, default, sql_type = nil, null = true, values = nil)
+        if values
+          values = values.map { |v| v.intern }
+          default = default.intern if default and !default.empty?
+        end
+        super(name, default, sql_type, null, values)
+      end
+    end
+  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,32 @@
+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
+          # Edge rails fallback for Rails 1.1.6. We can remove the
+          # rescue once everyone has upgraded to 1.2.
+          begin
+            __type_to_sql_enum(type, limit, precision, scale)
+          rescue ArgumentError
+            __type_to_sql_enum(type, limit)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enum/sqlite3_adapter.rb

@@ -0,0 +1,52 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class SQLite3Adapter
+      alias __native_database_types_enum native_database_types
+      
+      def native_database_types #:nodoc
+        types = __native_database_types_enum
+        types[:enum] = { :name => "varchar(32)" }
+        types
+      end
+
+      def columns(table_name, name = nil)#:nodoc:
+        constraints = { }
+        @connection.execute "SELECT sql FROM sqlite_master WHERE name = '#{table_name}'" do |row|
+          sql = row[0]
+          sql.scan(/, \"(\w+)\" varchar\(32\) CHECK\(\"\w+\" in \(([^\)]+)\)/i) do |column, constraint|
+            constraints[column] = constraint
+          end
+        end
+        table_structure(table_name).map do |field|
+          name = field['name']
+          type = field['type']
+          if (const = constraints[name])
+            type = "enum(#{const.strip})"
+          end
+          SQLite3ColumnWithEnum.new(name, field['dflt_value'], type, field['notnull'] == "0")
+        end
+      end
+
+      def add_column_options!(sql, options)
+        unless sql =~ /\(32\)\('[^']+'/
+          super(sql, options)
+        else
+          sql.gsub!(/("[^"]+")([^3]+32\))(.+)/, '\1\2 CHECK(\1 in \3)')
+          super(sql, options)
+        end
+      end
+    end
+    
+    class SQLite3ColumnWithEnum < SQLiteColumn
+      include ActiveRecordEnumerations::Column
+      
+      def initialize(name, default, sql_type = nil, null = true)
+        if sql_type =~ /^enum/i
+          values = sql_type.sub(/^enum\('([^)]+)'\)/i, '\1').split("','").map { |v| v.intern }
+          default = default.intern if default and !default.empty?
+        end
+        super(name, default, sql_type, null, values)
+      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.values, :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,9 @@
+require 'enum/enum_adapter'
+require 'enum/mysql_adapter' if defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
+require 'enum/postgresql_adapter' if defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+require 'enum/sqlite3_adapter' if defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
+require 'enum/schema_statements'
+require 'enum/schema_definitions'
+require 'enum/quoting'
+require 'enum/validations'
+require 'enum/active_record_helper'

data/readme.html

@@ -0,0 +1,18 @@
+= enum_column
+
+Gemified fork of http://github.com/adamsalter/enum_column-plugin
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Stephan Kaag. See LICENSE for details.