enumerative 1.0.0

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,4 @@
+rvm ruby-1.9.2-p320@enumerative --create
+if [ `uname -s` = "Darwin" ]; then
+  rvm current
+fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ninja Loss
+
+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,66 @@
+# Enumerative
+
+Provides enumeration functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumerative'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerative
+
+## Usage
+
+Create an enumeration class and include the modiule.
+
+    class Color
+    
+      def self.valid_keys
+        %w(
+          black
+          blue
+          green
+        )
+      end
+    
+      include Enumerative::Enumeration # this must come after ::valid_keys
+    
+    end
+
+Declare the enumeration in an ActiveModel.
+
+    class Vehicle
+
+      include Enumerative::HasEnumeration
+
+      # add_column :vehicles, :color, :string, :limit => 35
+
+      has_enumeration :color, :from => Color
+
+    end
+
+Translate the enumeration using localization:
+
+    en:
+      enumerations:
+        color:
+          black: Black
+          blue: Blue
+          green: Green
+
+Use the enumeration:
+
+    vehicle = Vehicle.create( :color => 'black' )
+
+    vehicle.attributes['color'] # => black
+    vehicle.color               # => #<Color:0x10702d5e8 @key="black">
+    vehicle.color.key           # => black
+    vehicle.color.value         # => Black
+    vehicle.color.to_s          # => black

data/Rakefile

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

data/enumerative.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/enumerative/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nils Jonsson", "C. Jason Harrelson"]
+  gem.email         = ["ninja.loss@gmail.com"]
+  gem.description   = %q{Tools for defining and using enumerations.}
+  gem.summary       = %q{Tools for enumerations.}
+  gem.homepage      = "https://github.com/ninja-loss/enumerative"
+
+  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          = "enumerative"
+  gem.require_paths = ["lib"]
+  gem.version       = Enumerative::VERSION
+end

data/lib/enumerative.rb

@@ -0,0 +1,8 @@
+require "enumerative/version"
+
+module Enumerative
+
+  autoload :Enumeration,    "enumerative/enumeration"
+  autoload :HasEnumeration, "enumerative/has_enumeration"
+
+end

data/lib/enumerative/enumeration.rb

@@ -0,0 +1,66 @@
+ module Enumerative
+
+   module Enumeration
+
+     def self.included( other_module )
+       other_module.module_eval do
+         valid_keys.each do |k|
+           const_set k.gsub( /\s/, '_' ).upcase, other_module.new( k )
+         end
+
+         extend ClassMethods
+
+         attr_reader :key
+       end
+     end
+
+     module ClassMethods
+
+       def to_select
+         valid_keys.sort.collect do |k|
+           [translate( k ), k]
+         end
+       end
+
+       def translate( key )
+         I18n.translate "enumerations.#{name.underscore}.#{key}", :raise => true
+       rescue I18n::MissingTranslationData
+         nil
+       end
+
+     end
+
+     def initialize( key )
+       @key = key.to_s.try( :dup ).try( :freeze )
+     end
+
+     def ==( other )
+       other.is_a?( self.class ) && (other.key == key)
+     end
+
+     def to_s
+       key
+     end
+
+     def valid?
+       key.blank? || self.class.valid_keys.include?( key )
+     end
+
+     def value
+       key.blank? ? nil : self.class.translate( key )
+     end
+
+     def blank?
+       key.blank?
+     end
+
+     # Method is required for Rails > 3.2.x due to ActiveRecord's autosave
+     # functionality.
+     #
+     def marked_for_destruction?
+       false
+     end
+
+   end
+
+ end

data/lib/enumerative/enumeration_sharedspec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+shared_examples_for 'an Enumeration' do
+
+  describe 'an instance' do
+
+    let :instance do
+      described_class.new 'foo'
+    end
+
+    it 'should have the expected #key' do
+      instance.key.should == 'foo'
+    end
+
+    it 'should have an immutable #key' do
+      instance.should_not respond_to( :key= )
+
+      expect {
+        instance.key.gsub!( /./, 'x' )
+      }.to raise_error( RuntimeError, "can't modify frozen string")
+    end
+
+    it 'should equal an equivalent instance' do
+      instance.should == described_class.new( 'foo' )
+    end
+
+    it 'should have the expected string representation' do
+      instance.to_s.should == 'foo'
+    end
+
+    describe 'that is valid' do
+
+      subject { described_class.new described_class.valid_keys.first }
+
+      it { should be_valid }
+
+      it 'should have a #value' do
+        subject.value.should_not == nil
+      end
+
+    end
+
+    describe 'that is invalid' do
+
+      subject { described_class.new "not a valid #{described_class.name} key" }
+
+      it { should_not be_valid }
+
+      it 'should not have a #value' do
+        subject.value.should == nil
+      end
+
+    end
+
+  end
+
+end

data/lib/enumerative/has_enumeration.rb

@@ -0,0 +1,37 @@
+ module Enumerative
+
+   module HasEnumeration
+
+     def self.included( other_module )
+       other_module.extend ClassMethods
+     end
+
+     module ClassMethods
+
+       def has_enumeration( *attributes )
+         options = attributes.extract_options!
+         class_name = if options[:from].try( :is_a?, Class )
+                        options[:from].name
+                      else
+                        options[:from]
+                      end
+         if class_name && !class_name.constantize.include?( Enumeration )
+           raise ArgumentError,
+                 ':from option should refer to a class that mixes in Enumeration'
+         end
+
+         attributes.each do |a|
+           composed_of a, :allow_nil => true,
+                          :class_name => class_name || a.to_s.classify,
+                          :mapping => [a, 'key'],
+                          :converter => :new
+
+           validates_associated a, :allow_blank => true
+         end
+       end
+
+     end
+
+   end
+
+ end

data/lib/enumerative/version.rb

@@ -0,0 +1,5 @@
+module Enumerative
+
+  VERSION = "1.0.0"
+
+end

data/spec/support/enumeration_sharedspec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+shared_examples_for 'an Enumeration' do
+
+  describe 'an instance' do
+
+    let :instance do
+      described_class.new 'foo'
+    end
+
+    it 'should have the expected #key' do
+      instance.key.should == 'foo'
+    end
+
+    it 'should have an immutable #key' do
+      instance.should_not respond_to( :key= )
+
+      expect {
+        instance.key.gsub!( /./, 'x' )
+      }.to raise_error( RuntimeError, "can't modify frozen string")
+    end
+
+    it 'should equal an equivalent instance' do
+      instance.should == described_class.new( 'foo' )
+    end
+
+    it 'should have the expected string representation' do
+      instance.to_s.should == 'foo'
+    end
+
+    describe 'that is valid' do
+
+      subject { described_class.new described_class.valid_keys.first }
+
+      it { should be_valid }
+
+      it 'should have a #value' do
+        subject.value.should_not == nil
+      end
+
+    end
+
+    describe 'that is invalid' do
+
+      subject { described_class.new "not a valid #{described_class.name} key" }
+
+      it { should_not be_valid }
+
+      it 'should not have a #value' do
+        subject.value.should == nil
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: enumerative
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nils Jonsson
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies: []
+description: Tools for defining and using enumerations.
+email:
+- ninja.loss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- enumerative.gemspec
+- lib/enumerative.rb
+- lib/enumerative/enumeration.rb
+- lib/enumerative/enumeration_sharedspec.rb
+- lib/enumerative/has_enumeration.rb
+- lib/enumerative/version.rb
+- spec/support/enumeration_sharedspec.rb
+homepage: https://github.com/ninja-loss/enumerative
+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: Tools for enumerations.
+test_files:
+- spec/support/enumeration_sharedspec.rb