enum_type 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rvmrc
+.bundle
+
+## PROJECT: DOCS
+.yardoc
+doc

data/.rspec

@@ -0,0 +1 @@
+-cfs

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+# DEPENDENCIES
+gem 'activerecord', require: 'active_record'
+gem 'activesupport', require: 'active_support/core_ext/object/try'
+
+# DEVELOPMENT
+gem 'jeweler'
+gem 'yard'
+gem 'RedCloth', require: 'redcloth'
+
+# TEST
+gem 'rspec'
+group :test do
+  gem 'factory_girl'
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    factory_girl (1.3.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord
+  activesupport
+  factory_girl
+  jeweler
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Tim Morgan
+
+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.textile

@@ -0,0 +1,45 @@
+h1. enum_type -- Enumerated Types in ActiveRecord
+
+| *Author* | Tim Morgan |
+| *Version* | 1.0 (Oct 29, 2010) |
+| *License* | Released under the MIT license. |
+
+h2. About
+
+@enum_type@ allows you to effectively use the PostgreSQL @ENUM@ data type in
+your ActiveRecord models. It's a really simple gem that just adds a convenience
+method to take care of the usual "witch chant" that accompanies building an
+enumerated type in Rails.
+
+h2. Installation
+
+*Important Note:* This gem requires Ruby 1.9. Ruby 1.8 is not supported, and
+will never be.
+
+First, add the @enum_type@ gem to your @Gemfile@:
+
+<pre><code>
+gem 'enum_type'
+</code></pre>
+
+Then, extend your model with the @EnumType@ module:
+
+<pre><code>
+class MyModel < ActiveRecord::Base
+  extend EnumType
+end
+</code></pre>
+
+h2. Usage
+
+In your model, call the @enum_type@ method, providing one or more enumerated
+fields, and any additional options:
+
+<pre><code>
+class MyModel < ActiveRecord::Base
+  extend EnumType
+  enum_type :status, %w( active pending admin superadmin banned )
+end
+</code></pre>
+
+See the @enum_type@ method documentation for more information.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+begin
+  require 'bundler'
+rescue LoadError
+  puts "Bundler is not installed; install with `gem install bundler`."
+  exit 1
+end
+
+Bundler.require :default
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "enum_type"
+  gem.summary = %Q{PostgreSQL enumerated types in ActiveRecord}
+  gem.description = %Q{Allows ActiveRecord to better use PostgreSQL's ENUM types.}
+  gem.email = "git@timothymorgan.info"
+  gem.homepage = "http://github.com/riscfuture/enum_type"
+  gem.authors = [ "Tim Morgan" ]
+  gem.required_ruby_version = '>= 1.9'
+  gem.add_dependency "activerecord", ">= 0"
+end
+Jeweler::GemcutterTasks.new
+
+desc "Build API documentation"
+YARD::Rake::YardocTask.new('doc') do |doc|
+  doc.options << "-m" << "textile"
+  doc.options << "--protected"
+  doc.options << "-r" << "README.textile"
+  doc.options << "-o" << "doc"
+  doc.options << "--title" << "enum_type Documentation".inspect
+  
+  doc.files = [ 'lib/**/*', 'README.textile' ]
+end
+
+require 'rspec/core/rake_task'
+
+desc 'Run all RSpecs'
+task(default: :spec)
+
+desc 'Run all RSpecs'
+RSpec::Core::RakeTask.new
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = %w( --exclude spec )
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/enum_type.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enum_type}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Morgan"]
+  s.date = %q{2010-10-29}
+  s.description = %q{Allows ActiveRecord to better use PostgreSQL's ENUM types.}
+  s.email = %q{git@timothymorgan.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "enum_type.gemspec",
+     "lib/enum_type.rb",
+     "spec/enum_type_spec.rb",
+     "spec/factories.rb"
+  ]
+  s.homepage = %q{http://github.com/riscfuture/enum_type}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{PostgreSQL enumerated types in ActiveRecord}
+  s.test_files = [
+    "spec/enum_type_spec.rb",
+     "spec/factories.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/lib/enum_type.rb

@@ -0,0 +1,42 @@
+# Adds the @enum_type@ method to a model.
+#
+# @example Basic usage
+#   class MyModel < ActiveRecord::Base
+#     extend EnumType
+#     enum_type :status, %w( open closed flagged deleted )
+#   end
+
+module EnumType
+
+  # Defines a field whose type is an enumeration. Values are stored as strings
+  # in the backend (or your database's enumerated type), however in the Rails
+  # level they are represented as symbols.
+  #
+  # @overload enum_type(field, ..., options={})
+  #   @param [Symbol] field An enumerated field.
+  #   @param [Hash] options A hash of options.
+  #   @option options [true, false] :allow_nil (false) If @true@, a nil value
+  #   is allowed.
+  #   @option options [Array<String>] :values If given, restricts valid values
+  #   to those in the given array.
+  #
+  # @example Enumerated field with restricted types
+  #   enum_type :color, values: %w( red orange yellow green blue purple )
+
+  def enum_type(*fields)
+    options = fields.extract_options!
+    fields.each do |field|
+      define_method field do
+        value = read_attribute(field)
+        value ? value.to_sym : value
+      end
+
+      define_method :"#{field}=" do |value|
+        write_attribute field, value.try(:to_s)
+      end
+
+      validates_presence_of(field) unless options[:allow_nil]
+      validates_inclusion_of(field, in: options[:values]) if options[:values]
+    end
+  end
+end

data/spec/enum_type_spec.rb

@@ -0,0 +1,97 @@
+Bundler.require :default, :test
+require "#{File.dirname __FILE__}/../lib/enum_type"
+require 'factories'
+
+module SpecSupport
+  class EnumTypeTester
+    include ActiveModel::Validations
+    extend EnumType
+    
+    def self.set_field(field)
+      @field = field
+      reset_callbacks :validate
+      _validators.clear
+      enum_type @field
+    end
+
+    def self.field() @field end
+
+    def read_attribute(_)
+      instance_variable_get :"@#{self.class.field}"
+    end
+
+    def write_attribute(_, value)
+      instance_variable_set :"@#{self.class.field}", value
+    end
+
+    def set(value)
+      instance_variable_set :"@#{self.class.field}", value
+    end
+
+    def get
+      instance_variable_get :"@#{self.class.field}"
+    end
+  end
+end
+
+describe EnumType do
+  before :each do
+    @field = Factory.next(:enum_field)
+    SpecSupport::EnumTypeTester.set_field(@field)
+    @model = SpecSupport::EnumTypeTester.new
+  end
+
+  describe "#enum_type" do
+    context "getter" do
+      it "should return a symbol" do
+        @model.set 'string'
+        @model.send(@field).should eql(:string)
+      end
+
+      it "should return nil if the value is nil" do
+        @model.set nil
+        @model.send(@field).should be_nil
+      end
+    end
+
+    context "setter" do
+      it "should typecast the value to a string" do
+        @model.send :"#{@field}=", :string
+        @model.get.should eql('string')
+      end
+
+      it "should leave nil as nil" do
+        @model.send :"#{@field}=", nil
+        @model.get.should be_nil
+      end
+    end
+
+    it "should validate inclusion if :values option is given" do
+      SpecSupport::EnumTypeTester.enum_type @field, values: [ :a, :b ]
+      @model.send :"#{@field}=", :a
+      @model.get.should eql('a')
+      @model.should be_valid
+      @model.send :"#{@field}=", :c
+      @model.should_not be_valid
+    end
+
+    it "should not validate presence if :allow_nil is true" do
+      pending "Doesn't work"
+      SpecSupport::EnumTypeTester.enum_type @field, allow_nil: true
+      @model.send :"#{@field}=", nil
+      @model.should be_valid
+    end
+
+    it "should validate presence if :allow_nil is not given" do
+      SpecSupport::EnumTypeTester.enum_type @field
+      @model.send :"#{@field}=", nil
+      @model.should_not be_valid
+    end
+
+    it "should validate presence if :allow_nil is false" do
+      SpecSupport::EnumTypeTester.enum_type @field, allow_nil: false
+      @model.send :"#{@field}=", nil
+      @model.should_not be_valid
+    end
+  end
+end

data/spec/factories.rb

@@ -0,0 +1 @@
+Factory.sequence(:enum_field) { |i| :"field#{i}" }

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: enum_type
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: Allows ActiveRecord to better use PostgreSQL's ENUM types.
+email: git@timothymorgan.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- enum_type.gemspec
+- lib/enum_type.rb
+- spec/enum_type_spec.rb
+- spec/factories.rb
+has_rdoc: true
+homepage: http://github.com/riscfuture/enum_type
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: PostgreSQL enumerated types in ActiveRecord
+test_files: 
+- spec/enum_type_spec.rb
+- spec/factories.rb