activerecord_composed_of_enum 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Hanlon
+
+MIT License
+
+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.md

@@ -0,0 +1,30 @@
+# ActiveRecord::ComposedOfEnum
+
+Provides a ```composed_of_enum``` method for ActiveRecord models that binds
+enum classes with an enum integer column.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'composed_of_enum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install composed_of_enum
+
+## Usage
+
+See ```lib/active_record/composed_of_enum.rb for details```.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/activerecord_composed_of_enum.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_record/composed_of_enum/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Rob Hanlon']
+  gem.email         = ['rob@mediapiston.com']
+  gem.description   = 'Provides syntax for composing models of enums.'
+  gem.summary       = 'Provides a composed_of_enum method for ActiveRecord '\
+                      'models that binds enum classes with an enum integer '\
+                      'column.'
+  gem.homepage      = 'http://www.github.com/ohwillie/activerecord_composed_of_enum'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'activerecord_composed_of_enum'
+  gem.require_paths = %w[lib]
+  gem.version       = ActiveRecord::ComposedOfEnum::VERSION
+
+  gem.add_development_dependency 'rspec', '2.10.0'
+  gem.add_development_dependency 'activerecord', '3.2.6'
+  gem.add_development_dependency 'sqlite3', '1.3.6'
+
+  gem.add_dependency 'rbx-require-relative', '0.0.9'
+end

data/lib/active_record/composed_of_enum/version.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module ComposedOfEnum
+    unless defined? ActiveRecord::ComposedOfEnum::VERSION
+      VERSION = '0.0.2'
+    end
+  end
+end

data/lib/active_record/composed_of_enum.rb

@@ -0,0 +1,51 @@
+require 'require_relative'
+
+require_relative 'composed_of_enum/version'
+
+module ActiveRecord
+  module ComposedOfEnum
+    def composed_of_enum(part, options = {})
+      unless options.has_key?(:base)
+        raise ArgumentError, 'must provide :base option'
+      end
+
+      unless options.has_key?(:enumeration)
+        raise ArgumentError, 'must provide :enumeration option'
+      end
+
+      base = options[:base]
+      enum_column = :"#{part}_cd"
+
+      base.class_attribute(
+        enum_column,
+        :instance_reader => false,
+        :instance_reader => false
+      )
+
+      enumeration = options[:enumeration]
+
+      enumeration.each_with_index do |enum, cd|
+        enum.send(:"#{enum_column}=", cd)
+      end
+
+      validates(
+        enum_column,
+        :presence => true,
+        :inclusion => 0...enumeration.size
+      )
+
+      if options.has_key?(:default)
+        after_initialize do
+          send(:"#{part}=", options[:default]) unless send(part).present?
+        end
+      end
+
+      composed_of(
+        part,
+        :class_name => base.name,
+        :mapping => [enum_column.to_s],
+        :constructor => lambda { |cd| cd.present? ? enumeration[cd] : nil }
+      )
+    end
+  end
+end

data/spec/active_record/composed_of_enum_spec.rb

@@ -0,0 +1,112 @@
+require 'require_relative'
+require 'active_record'
+
+require_relative '../../lib/active_record/composed_of_enum'
+
+describe ActiveRecord::ComposedOfEnum do
+  let(:model_class) do
+    Class.new(ActiveRecord::Base) do
+      self.table_name = 'models'
+
+      # Needed because this is an anonymous class.
+      def self.model_name
+        ActiveModel::Name.new(nil, nil, 'Model')
+      end
+
+      extend ActiveRecord::ComposedOfEnum
+    end
+  end
+
+  before do
+    ActiveRecord::Base.establish_connection(
+      :adapter => 'sqlite3',
+      :database => ':memory:'
+    )
+
+    ActiveRecord::Base.connection.create_table(:models) do |t|
+      t.integer(:enum_cd)
+    end
+  end
+
+  after do
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  context 'ArgumentErrors' do
+    it 'should raise an ArgumentError if the :base option is missing' do
+      expect {
+        model_class.composed_of_enum(:enum, :enumeration => [Object])
+      }.to raise_error(ArgumentError, /:base/)
+    end
+
+    it 'should raise an ArgumentError if the :enumeration option is missing' do
+      expect {
+        model_class.composed_of_enum(:enum, :base => Object)
+      }.to raise_error(ArgumentError, /:enumeration/)
+    end
+  end
+
+  context 'success' do
+    let(:base) do
+      # This hack is here because we need an anonymous class, but it has to
+      # return itself when name.constantize is called.
+      Class.new.tap { |c| c.stub(:name) { double(:constantize => c) } }
+    end
+    let(:enumeration) { 3.times.map { Class.new(base) } }
+
+    context 'without a default' do
+      before do
+        model_class.composed_of_enum(
+          :enum,
+          :base => base,
+          :enumeration => enumeration
+        )
+      end
+
+      it 'should make an enum_cd method on base' do
+        base.enum_cd.should be_nil
+      end
+
+      it 'should set enum_cds for all enumeration classes' do
+        enumeration.each_with_index do |enum, index|
+          enum.enum_cd.should == index
+        end
+      end
+
+      it 'should not allow a model instance with a negative enum_cd value' do
+        model_class.new(:enum_cd => -1).should_not be_valid
+      end
+
+      it 'should allow a model instance with a valid enum_cd value' do
+        enumeration.each_with_index do |enum, index|
+          model_class.new(:enum_cd => index).should be_valid
+        end
+      end
+
+      it 'should not allow a model instance with too large an enum_cd value' do
+        model_class.new(:enum_cd => enumeration.size).should_not be_valid
+      end
+
+      it 'should set the enum and enum_cd if fed an enum' do
+        enumeration.each do |enum|
+          model = model_class.create(:enum => enum)
+          model.enum.should == enum
+          model.enum_cd.should == enum.enum_cd
+        end
+      end
+    end
+
+    it 'should set a default after initialize if provided' do
+      model_class.composed_of_enum(
+        :enum,
+        :base => base,
+        :enumeration => enumeration,
+        :default => enumeration.first
+      )
+
+      model = model_class.create
+      model.enum.should == enumeration.first
+      model.enum_cd.should == enumeration.first.enum_cd
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_composed_of_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Rob Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rbx-require-relative
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+description: Provides syntax for composing models of enums.
+email:
+- rob@mediapiston.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord_composed_of_enum.gemspec
+- lib/active_record/composed_of_enum.rb
+- lib/active_record/composed_of_enum/version.rb
+- spec/active_record/composed_of_enum_spec.rb
+homepage: http://www.github.com/ohwillie/activerecord_composed_of_enum
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a composed_of_enum method for ActiveRecord models that binds enum
+  classes with an enum integer column.
+test_files:
+- spec/active_record/composed_of_enum_spec.rb