enumlogic 1.0.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 binarylogic
+
+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,18 @@
+= enumlogic
+
+Description goes here.
+
+== 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 binarylogic. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "enumlogic"
+    gem.summary = "Adds enumerations to your models"
+    gem.description = "Adds enumerations to your models"
+    gem.email = "bjohnson@binarylogic.com"
+    gem.homepage = "http://github.com/binarylogic/enumlogic"
+    gem.authors = ["binarylogic"]
+    gem.rubyforge_project = "enumlogic"
+    gem.add_development_dependency "rspec"
+  end
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/enumlogic.rb

@@ -0,0 +1,61 @@
+require "activerecord"
+
+# See the enum class level method for more info.
+module Enumlogic
+  # Allows you to easily specify enumerations for your models. Specify enumerations like:
+  #
+  #   class Computer < ActiveRecord::Base
+  #     enum :kind, ["apple", "dell", "hp"]
+  #     enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}
+  #   end
+  #
+  # You can now do the following:
+  #
+  #   Computer::KINDS # passes back exactly what you specified, Array or Hash
+  #   Computer.kind_options # gives you a friendly hash that you can easily pass into the select helper for forms
+  #   Computer.new(:kind => "unknown").valid? # false, automatically validates inclusion of the enum field
+  #   
+  #   c = Computer.new(:kind => "apple")
+  #   c.apple? # true
+  #   c.apple_key # :apple
+  #   c.apple_text # "apple" or "Apple" if you gave a hash with a user friendly text value
+  def enum(field, values, options = {})
+    values_hash = if values.is_a?(Array)
+      hash = {}
+      values.each { |value| hash[value] = value }
+      hash
+    else
+      values
+    end
+    
+    values_array = values.is_a?(Hash) ? values.keys : values
+    
+    message = options[:message] || "#{field} is not included in the list"
+    constant_name = options[:constant] || field.to_s.pluralize.upcase
+    const_set constant_name, values_array unless const_defined?(constant_name)
+    
+    new_hash = {}
+    values_hash.each { |key, text| new_hash[text] = key }
+    (class << self; self; end).send(:define_method, "#{field}_options") { new_hash }
+    
+    define_method("#{field}_key") do
+      send(field).to_s.gsub(/[-\s]/, '_').downcase.to_sym
+    end
+    
+    define_method("#{field}_text") do
+      values_hash.find { |key, text| key == send(field) }.last
+    end
+    
+    values_array.each do |value|
+      method_name = value.downcase.gsub(/[-\s]/, '_')
+      method_name = "#{method_name}_#{field}" if options[:namespace]
+      define_method("#{method_name}?") do
+        self.send(field) == value
+      end
+    end
+
+    validates_inclusion_of field, :in => values_array, :message => message
+  end
+end
+
+ActiveRecord::Base.extend Enumlogic

data/spec/enumlogic_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Enumlogic" do
+  it "should have a constant" do
+    Computer.enum :kind, ["apple", "dell", "hp"], :namespace => true
+    Computer::KINDS.should == ["apple", "dell", "hp"]
+  end
+  
+  it "constant should always return an array" do
+    hash = ActiveSupport::OrderedHash.new
+    hash["apple"] = "Apple"
+    hash["dell"] = "Dell"
+    hash["hp"] = "HP"
+    
+    Computer.enum :kind, hash, :namespace => true
+    Computer::KINDS.should == ["apple", "dell", "hp"]
+  end
+  
+  it "should create a class level options method" do
+    Computer.enum :kind, ["apple", "dell", "hp"]
+    Computer.kind_options.should == {"apple" => "apple", "dell" => "dell", "hp" => "hp"}
+  end
+  
+  it "should create a class level options method for hashes" do
+    Computer.enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}
+    Computer.kind_options.should == {"Apple" => "apple", "Dell" => "dell", "HP" => "hp"}
+  end
+  
+  it "should create key methods" do
+    Computer.enum :kind, ["apple", "dell", "hp"]
+    c = Computer.new(:kind => "apple")
+    c.kind_key.should == :apple
+  end
+  
+  it "should create key methods for hashes" do
+    Computer.enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}
+    c = Computer.new(:kind => "apple")
+    c.kind_key.should == :apple
+  end
+  
+  it "should create text methods" do
+    Computer.enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}
+    c = Computer.new(:kind => "hp")
+    c.kind_text.should == "HP"
+  end
+  
+  it "should create text methods for hashes" do
+    Computer.enum :kind, {"apple" => "Apple", "dell" => "Dell", "hp" => "HP"}
+    c = Computer.new(:kind => "hp")
+    c.kind_text.should == "HP"
+  end
+  
+  it "should create boolean methods" do
+    Computer.enum :kind, ["apple", "dell", "hp"]
+    c = Computer.new(:kind => "apple")
+    c.should be_apple
+  end
+  
+  it "should namespace boolean methods" do
+    Computer.enum :kind, ["apple", "dell", "hp"], :namespace => true
+    c = Computer.new(:kind => "apple")
+    c.should be_apple_kind
+  end
+  
+  it "should validate inclusion" do
+    Computer.enum :kind, ["apple", "dell", "hp"]
+    c = Computer.new
+    c.kind = "blah"
+    c.should_not be_valid
+    c.errors[:kind].should include("kind is not included in the list")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'enumlogic'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ActiveRecord::Base.configurations = true
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :computers do |t|
+    t.string :kind
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    class Computer < ActiveRecord::Base
+    end
+  end
+  
+  config.after(:each) do
+    Object.send(:remove_const, :Computer)
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: enumlogic
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- binarylogic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Adds enumerations to your models
+email: bjohnson@binarylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/enumlogic.rb
+- spec/enumlogic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/binarylogic/enumlogic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: enumlogic
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds enumerations to your models
+test_files: 
+- spec/enumlogic_spec.rb
+- spec/spec_helper.rb