enumerate 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0db9d3a63909d2f1e942fc7c9d72ee6df9129de4
+  data.tar.gz: bac591dc7038aa835d7244bde5573f1e328fdcbd
+SHA512:
+  metadata.gz: 781cedc5ede92afbdb33ba49cc4b659f7d61d0627c15ac76bf46e8c3bb2f0d26b27b3b955506b1ce540fca604d1d191c0f2d2abc4fd94fd85ef8857918b308ff
+  data.tar.gz: cdb2002e9c61cc372c8093e7c00b9de5fdc2f77787c8bb150218232404c5aa99399631213e190de45bd089036fca5a31da80cd667bb6c06fb17f7eb97acb3ff9

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/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails31.gemfile
+  - gemfiles/rails32.gemfile
+  - gemfiles/rails40.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails40.gemfile

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Dale Stevens
+
+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,80 @@
+# Enumerate [![Build Status](https://secure.travis-ci.org/TwilightCoders/enumerate.png)](http://travis-ci.org/TwilightCoders/enumerate)
+# Enumerate [![Gem Version](https://badge.fury.io/rb/enumerate.png)](http://badge.fury.io/rb/enumerate)
+
+Enumerate adds an enum command to all ActiveRecord models which enables you to work with integer and string attributes as if they were enums
+
+## Installing
+
+Just add the enumerate gem to your GemFile
+
+```ruby
+gem 'enumerate'
+```
+
+## How to use
+
+Just call the enum function in any ActiveRecord object, the function accepts the field name as the first variable and the possible values as an array
+
+```ruby
+class Event < ActiveRecord::Base
+    enum :status, [:available, :canceled, :completed]
+end
+```
+
+If your status column is of type integer, Enumerate will assign the indices of the array as the values stored in the database.
+
+:available will be 0
+:canceled will be 1
+:completed will be 2
+
+If you wish to specify yourself, simply use a hash
+
+```ruby
+class Event < ActiveRecord::Base
+    enum :status, {:available => 0, :canceled => 2, :completed => 5}
+end
+```
+
+After that you get several autogenerated commands to use with the enum
+
+```ruby
+# Access through field name
+
+event.status                # returns the enum's current value as a symbol
+event.status = :canceled    # sets the enum's value to canceled (can also get a string)
+
+
+# Shorthand methods, access through the possible values
+
+event.available?            # returns true if enum's current status is available
+event.canceled!             # changes the enum's value to canceled
+
+# Get all the possible values
+
+Event::STATUSES             # returns all available status of the enum
+```
+
+## Options
+#### :allow_nil
+By default the enum field does not support a nil value. In order to allow nil values add the `allow_nil` option (similar to the Rails validation option).
+
+```ruby
+class Event < ActiveRecord::Base
+    enum :status, [:available, :canceled, :completed], :allow_nil => true
+end
+
+Event.create! # Is valid and does not throw an exception.
+```
+
+## Scopes
+One last thing that the enumerate gem does is created scope (formerly nested_scopes) so you can easly query by the enum
+
+For example if you want to count all the events that are canceled you can just run
+
+```ruby
+Event.canceled.count
+```
+
+---
+
+Copyright (c) 2013 Dale Stevens, released under the MIT license

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'appraisal'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/appraisal

@@ -0,0 +1,11 @@
+appraise "rails31" do
+  gem "activerecord", "~> 3.1.12"
+end
+
+appraise "rails32" do
+  gem "activerecord", "~> 3.2.14"
+end
+
+appraise "rails40" do
+  gem "activerecord", "~> 4.0.0"
+end

data/enumerate.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "enumerate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "enumerate"
+  s.version     = Enumerate::VERSION
+  s.authors     = ["Dale"]
+  s.email       = ["dale@twilightcoders.net"]
+  s.homepage    = "http://github.com/twilightcoders/enumerate"
+  s.summary     = %q{Enumerate adds an `enumerate` command to all ActiveRecord models, enabling you to work with string or integer columns as if they were enums.}
+  s.description =  <<-END
+    Enumerate adds an `enumerate` command to all ActiveRecord models, enabling you to work with string or integer columns as if they were enums.
+
+    The following features are added to your model:
+      Validation - ensures that the field only receives accepted values
+      Predicate Methods - adds ? and ! functions for each enum value
+      Scopes - you can easily query for values of the enum
+  END
+  s.license     = 'MIT'
+
+
+#  s.rubyforge_project = "enumerate"
+
+  s.files         = `git ls-files`.split("\n") - ["Gemfile.lock"]
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activerecord", '>= 3.0'
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'appraisal', '>= 0.3.8'
+end

data/gemfiles/rails31.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.1.12"
+
+gemspec :path=>"../"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 3.2.14"
+
+gemspec :path=>"../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path=>"../"

data/lib/enumerate.rb

@@ -0,0 +1,3 @@
+require "enumerate/version"
+require "enumerate/model"
+require "enumerate/railtie" if defined? Rails

data/lib/enumerate/model.rb

@@ -0,0 +1,74 @@
+module Enumerate
+  module Model
+    def enumerate(attribute, vals={}, opts={})
+
+      validates_inclusion_of attribute, :in => vals, :allow_nil => !!opts[:allow_nil]
+      
+      # Get the column type of the attribute. We support int and string
+      col_type = self.columns_hash[attribute.to_s].type
+      
+      const_hash_name = attribute.to_s.pluralize.upcase
+    
+      if col_type == :string
+        vals = Hash[vals.zip vals.map{ |s| s.to_s }] if vals.kind_of?(Array)
+      elsif col_type == :integer
+        # Converts an array into a hash of values with indicies as the "values"
+        vals = Hash[vals.zip (0...vals.size)] if vals.kind_of?(Array)
+      else
+        raise "Unsupported column type for enumeration :#{attribute} in #{self.class}!"
+      end
+      
+      # Ensure that only arrays and hashes are appropriate datatypes.
+      raise "Unsupported values datatype for enumeration :#{attribute} in #{self.class}!" if !vals.kind_of?(Hash)
+      
+      # Sets a class costant with the enumerated values
+      const_set(const_hash_name, vals)
+      
+      setup_accessors(const_hash_name, attribute)
+
+      setup_predicates(vals, attribute)
+
+    end
+
+    private
+    
+      def setup_accessors(const_hash_name, attribute)
+        unless methods.include?(attribute.to_s)
+          self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attribute.to_s}
+              #{const_hash_name}.key(read_attribute(:#{attribute}))
+            end
+          RUBY
+        end
+      
+        unless methods.include?("#{attribute.to_s}=")
+          self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attribute.to_s}=(s)
+              write_attribute(:#{attribute}, #{const_hash_name}[s.to_sym])
+            end
+          RUBY
+        end
+      end
+
+      def setup_predicates(vals, attribute)
+          vals.each do |key, val|
+              raise "Collision in enumeration predicate method(s) #{key}" if respond_to?("#{key.to_s}?") or respond_to?("#{key.to_s}!") or respond_to?("#{key.to_s}")
+              
+              define_method "#{key.to_s}?" do
+                send("#{attribute.to_s}") == key
+              end
+              
+              define_method "#{key.to_s}!" do
+                send("#{attribute.to_s}=", key)
+              end
+              
+              # Define helper scopes
+              self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+                scope :#{key}, lambda { where(:#{attribute} => #{val}) }
+              RUBY
+          end
+      end
+
+  end
+
+end

data/lib/enumerate/railtie.rb

@@ -0,0 +1,9 @@
+module UrlFormatter
+  class Railtie < Rails::Railtie
+    initializer 'enumerate.model' do
+      ActiveSupport.on_load :active_record do
+        extend Enumerate::Model
+      end
+    end
+  end
+end

data/lib/enumerate/version.rb

@@ -0,0 +1,3 @@
+module Enumerate
+  VERSION = '0.0.4'
+end

data/spec/enumerate/enum_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+class Model < ActiveRecord::Base
+  extend Enumerate::Model
+
+  enumerate :status, [:available, :canceled, :completed]
+end
+
+class OtherModel < ActiveRecord::Base
+  extend Enumerate::Model
+
+  belongs_to :model
+
+  enumerate :status, [:active, :expired, :not_expired]
+end
+
+class ModelAllowingNil < ActiveRecord::Base
+  self.table_name = 'models'
+
+  extend Enumerate::Model
+
+  belongs_to :model
+
+  enumerate :status, [:active, :expired, :not_expired], :allow_nil => true
+end
+
+
+describe :Enumerate do
+
+  before(:each) do
+    Model.delete_all
+    OtherModel.delete_all
+
+    @obj = Model.create!(:status => :available)
+    @canceled_obj = Model.create!(:status => :canceled)
+    @completed_obj = Model.create!(:status => :completed)
+
+    @active_obj = OtherModel.create!(:status => :active, :model => @obj)
+    @expired_obj = OtherModel.create!(:status => :expired, :model => @canceled_obj)
+    @not_expired_obj = OtherModel.create!(:status => :not_expired, :model => @canceled_obj)
+  end
+
+  describe "allow nil" do
+
+    before(:each) do
+      @obj_not_allowing_nil = Model.create
+      @obj_allowing_nil = ModelAllowingNil.create
+    end
+
+    describe "model allowing enum value to be nil" do
+      it "should be valid" do
+        @obj_allowing_nil.should be_valid
+      end
+
+    end
+
+    describe "model not allowing enum value to be nil" do
+      it "should be invalid" do
+        @obj_not_allowing_nil.should be_invalid
+      end
+    end
+
+  end
+
+  describe "short hand methods" do
+    describe "question mark (?)" do
+      it "should return true if value of enum equals a value" do
+        @obj.available?.should be_true
+      end
+
+      it "should return false if value of enum is different " do
+        @obj.canceled?.should be_false
+      end
+
+    end
+
+    describe "exclemation mark (!)" do
+      it "should change the value of the enum to the methods value" do
+        @obj.canceled!
+        @obj.status.should == :canceled
+      end
+    end
+
+    it "should have two shorthand methods for each possible value" do
+      Model::STATUSES.each do |key, val|
+        @obj.respond_to?("#{key}?").should be_true
+        @obj.respond_to?("#{key}!").should be_true
+      end
+    end
+  end
+
+  describe "getting value" do
+    it "should always return the enums value as a symbol" do
+      @obj.status.should == :available
+      @obj.status = "canceled"
+      @obj.status.should == :canceled
+    end
+
+  end
+
+  describe "setting value" do
+    it "should except values as symbol" do
+      @obj.status = :canceled
+      @obj.canceled?.should be_true
+    end
+
+    it "should except values as string" do
+      @obj.status = "canceled"
+      @obj.canceled?.should be_true
+    end
+  end
+
+  describe "validations" do
+    it "should not except a value outside the given list" do
+      @obj = Model.new(:status => :available)
+      @obj.status = :foobar
+      @obj.should_not be_valid
+    end
+
+    it "should except value in the list" do
+      @obj = Model.new(:status => :available)
+      @obj.status = :canceled
+      @obj.should be_valid
+    end
+  end
+
+  describe "scopes" do
+    it "should return objects with given value" do
+      Model.available.should == [@obj]
+      Model.canceled.should == [@canceled_obj]
+    end
+
+    it "should return objects with given value when joined with models who have the same enum field" do
+      OtherModel.joins(:model).active.should == [@active_obj]
+    end
+
+  end
+
+
+  it "class should have a CONST that holds all the available options of the enum" do
+    Model::STATUSES.should include(:available, :canceled, :completed)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'enumerate'
+require 'active_record'
+
+def set_database
+  db_config = {:adapter => "sqlite3", :database => ":memory:"}
+  ActiveRecord::Base.establish_connection(db_config)
+  connection = ActiveRecord::Base.connection
+
+  connection.create_table :models do |t|
+    t.integer :status
+  end
+
+  connection.create_table :other_models do |t|
+    t.integer :status
+    t.references :model
+  end
+end
+
+set_database

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: enumerate
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Dale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+description: |2
+      Enumerate adds an `enumerate` command to all ActiveRecord models, enabling you to work with string or integer columns as if they were enums.
+
+      The following features are added to your model:
+        Validation - ensures that the field only receives accepted values
+        Predicate Methods - adds ? and ! functions for each enum value
+        Scopes - you can easily query for values of the enum
+email:
+- dale@twilightcoders.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- appraisal
+- enumerate.gemspec
+- gemfiles/rails31.gemfile
+- gemfiles/rails32.gemfile
+- gemfiles/rails40.gemfile
+- lib/enumerate.rb
+- lib/enumerate/model.rb
+- lib/enumerate/railtie.rb
+- lib/enumerate/version.rb
+- spec/enumerate/enum_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/twilightcoders/enumerate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Enumerate adds an `enumerate` command to all ActiveRecord models, enabling
+  you to work with string or integer columns as if they were enums.
+test_files:
+- spec/enumerate/enum_spec.rb
+- spec/spec_helper.rb