classy_enum 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Peter Brown
+
+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.rdoc

@@ -0,0 +1,7 @@
+= classy_enum
+
+More Description love in the works
+
+== Copyright
+
+Copyright (c) 2010 Peter Brown. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "classy_enum"
+    gem.summary = %Q{A class based enumerator utility for Ruby on Rails}
+    gem.description = %Q{A utility that adds class based enum functionaltiy to ActiveRecord attributes}
+    gem.email = "github@lette.us"
+    gem.homepage = "http://github.com/beerlington/classy_enum"
+    gem.authors = ["Peter Brown"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "activerecord", "~> 2.3"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "classy_enum #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/classy_enum.gemspec

@@ -0,0 +1,59 @@
+# 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{classy_enum}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Brown"]
+  s.date = %q{2010-09-21}
+  s.description = %q{A utility that adds class based enum functionaltiy to ActiveRecord attributes}
+  s.email = %q{github@lette.us}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "classy_enum.gemspec",
+     "init.rb",
+     "lib/classy_enum.rb",
+     "spec/classy_enum_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/beerlington/classy_enum}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A class based enumerator utility for Ruby on Rails}
+  s.test_files = [
+    "spec/classy_enum_spec.rb",
+     "spec/spec_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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 2.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+# Adds active_set_helper method to all active record classes
+require 'classy_enum'

data/lib/classy_enum.rb

@@ -0,0 +1,105 @@
+class ClassyEnumValue < Object 
+ 
+  attr_reader :to_s, :index
+
+  def initialize(option, index)
+    @to_s = option.to_s.downcase
+    @index = index + 1
+  end
+  
+  def name
+    to_s.titleize
+  end
+  
+  def <=> other
+    @index <=> other.index
+  end
+
+end
+
+module ClassyEnum
+    
+  module ClassMethods
+      
+    def new(option)
+      self::OPTION_HASH[option] || TypeError.new("Valid #{self} options are #{self.valid_options}")
+    end
+    
+    def all
+      self::OPTIONS.map {|e| self.new(e) }
+    end
+    
+    # Uses the name field for select options
+    def all_with_name
+      self.all.map {|e| [e.name, e.to_s] }
+    end
+    
+    def valid_options
+      self::OPTIONS.map(&:to_s).join(', ')
+    end
+    
+    # Alias of new
+    def find(option)
+      new(option)
+    end
+  
+  end
+  
+  def self.included(other)
+    other.extend ClassMethods
+    
+    other.const_set("OPTION_HASH", Hash.new)
+
+    other::OPTIONS.each do |option|
+      klass = Class.new(ClassyEnumValue) {
+        include other::Defaults if other.const_defined?("Defaults")
+      }
+
+      Object.const_set("#{other}#{option.to_s.camelize}", klass)
+    
+      instance = klass.new(option, other::OPTIONS.index(option))
+      
+      other::OPTION_HASH[option] = other::OPTION_HASH[option.to_s.downcase] = instance
+      
+      ClassyEnum.const_set(option.to_s.upcase, instance)
+    end
+
+  end
+  
+end
+
+module ClassyEnumAttributes
+  module ClassMethods
+    def classy_enum_attr(klass, method=nil)
+      
+      method ||= klass
+      
+      klass = klass.to_s.camelize.constantize
+      
+      # Add ActiveRecord validation to ensure it won't be saved unless it's an option
+      self.send(:validates_inclusion_of, method, :in => klass.all)
+      
+      self.instance_eval do
+        
+        # Define getter method
+        define_method method do
+          klass.new(super)
+        end
+        
+        # Define setter method
+        define_method "#{method}=" do |value|
+          super value.to_s
+        end
+        
+      end
+      
+    end
+  end
+  
+  def self.included(other)
+    other.extend ClassMethods
+  end
+  
+end
+
+ActiveRecord::Base.send :include, ClassyEnumAttributes

data/spec/classy_enum_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module TestEnum 
+  OPTIONS = [:one, :two, :three]
+  
+  module Defaults
+    def do_something?
+      false
+    end
+  end
+
+  include ClassyEnum
+end
+
+class TestEnumTwo
+  def do_something?
+    true
+  end
+end
+
+describe ClassyEnum do
+
+  TestEnum::OPTIONS.each do |option|
+   it "should define a TestEnum#{option.to_s.capitalize} class" do
+     Object.const_defined?("TestEnum#{option.to_s.capitalize}").should be_true
+   end
+  end
+  
+  it "should return an array of enums" do
+    TestEnum.all.should == TestEnum::OPTIONS.map {|o| TestEnum.new(o) }
+  end
+  
+  it "should return an array of enums for a select tag" do
+    TestEnum.all_with_name.should == TestEnum::OPTIONS.map {|o| [TestEnum.new(o).name, TestEnum.new(o).to_s] }
+  end
+  
+  it "should return a type error when adding an invalid option" do
+    TestEnum.new(:invalid_option).class.should == TypeError
+  end
+  
+  context "with a collection of enums" do
+    before(:each) do
+      @one = TestEnum.new(:one)
+      @two = TestEnum.new(:two)
+      @three = TestEnum.new(:three)
+
+      @unordered = [@one, @three, @two]
+    end
+    
+    it "should sort the enums" do
+      @unordered.sort.should == [@one, @two, @three]
+    end
+
+    it "should find the max enum based on its order" do
+      @unordered.max.should == @three
+    end
+  end
+  
+  it "should find an enum by symbol" do
+    TestEnum.find(:one).class.should == TestEnumOne
+  end
+  
+  it "should find an enum by string" do
+    TestEnum.find("one").class.should == TestEnumOne
+  end
+  
+end
+
+describe "An ClassyEnumValue" do
+  before(:each) { @enum = TestEnum.new(:one) }
+  
+  it "should have a name" do
+    @enum.name.should == "One"
+  end
+  
+  it "should inherit the Default methods" do
+    @enum.do_something?.should be_false
+  end
+  
+  it "should create the same instance with a string or symbol" do
+    @enum_string = TestEnum.new("one")
+    
+    @enum.should == @enum_string
+  end
+end
+
+describe "An ClassyEnumValue" do
+  before(:each) { @enum = TestEnum.new(:two) }
+  
+  it "should override the Default methods" do
+    @enum.do_something?.should be_true
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'active_record'
+require 'classy_enum'
+require 'spec'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: classy_enum
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+description: A utility that adds class based enum functionaltiy to ActiveRecord attributes
+email: github@lette.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- classy_enum.gemspec
+- init.rb
+- lib/classy_enum.rb
+- spec/classy_enum_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/beerlington/classy_enum
+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 
+      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.3.7
+signing_key: 
+specification_version: 3
+summary: A class based enumerator utility for Ruby on Rails
+test_files: 
+- spec/classy_enum_spec.rb
+- spec/spec_helper.rb