has_constant 0.2.0

data/.document

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

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 1.8.7
+rvm gemset use has_constant

data/Gemfile

@@ -0,0 +1,8 @@
+source :gemcutter
+
+group :test do
+  gem 'shoulda'
+  gem 'activesupport'
+  gem 'activerecord'
+  gem 'sqlite3-ruby'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mattbeedle
+
+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,17 @@
+= has_constant
+
+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) 2010 mattbeedle. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_constant"
+    gem.summary = %Q{Allows certain fields to be limited to a set of values}
+    gem.description = %Q{Allows certain fields to be limited to a set of values}
+    gem.email = "mattbeedle@gmail.com"
+    gem.homepage = "http://github.com/mattbeedle/has_constant"
+    gem.authors = ["mattbeedle"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency 'activesupport', '>= 0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_constant #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/has_constant.gemspec

@@ -0,0 +1,65 @@
+# 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{has_constant}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mattbeedle"]
+  s.date = %q{2010-07-26}
+  s.description = %q{Allows certain fields to be limited to a set of values}
+  s.email = %q{mattbeedle@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rvmrc",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "has_constant.gemspec",
+     "lib/has_constant.rb",
+     "lib/orm/active_record.rb",
+     "lib/orm/mongoid.rb",
+     "test/has_constant_test.rb",
+     "test/helper.rb",
+     "test/unit/orm/active_record_test.rb",
+     "test/unit/orm/mongoid_test.rb"
+  ]
+  s.homepage = %q{http://github.com/mattbeedle/has_constant}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Allows certain fields to be limited to a set of values}
+  s.test_files = [
+    "test/has_constant_test.rb",
+     "test/helper.rb",
+     "test/unit/orm/active_record_test.rb",
+     "test/unit/orm/mongoid_test.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<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/lib/has_constant.rb

@@ -0,0 +1,61 @@
+require 'lib/orm/mongoid'
+require 'lib/orm/active_record'
+require 'active_support/inflector'
+module HasConstant
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # HasConstant takes a Proc containing an array of possible values for a field name
+  # The field name is inferred as the singular of the has constant name. For example
+  # has_constant :titles
+  # would use the database column "title"
+  #
+  # USAGE:
+  #
+  # class User < ActiveRecord::Base
+  #   include HasConstant
+  #   has_constant :titles, lambda { %w(Mr Mrs) }
+  # end
+  #
+  # User.titles #=> ['Mr', 'Ms']
+  #
+  # @user = User.new(:title => 'Mr')
+  # @user.title #=> 'Mr'
+  # @user.attributes['title'] #=> 0
+  #
+  # @user.title_is?('Mr') #=> true
+  # @user.title_is?('Ms') #=> false
+  #
+  # User.by_constant('title', 'Mr') #=> [@user]
+  #
+  module ClassMethods
+    def has_constant(name, values, options = {})
+
+      singular = (options[:accessor] || name.to_s.singularize).to_s
+
+      (class << self; self; end).instance_eval do
+        define_method(name.to_s, values) if values.respond_to?(:call)
+        define_method(name.to_s, lambda { values }) unless values.respond_to?(:call)
+      end
+
+      define_method(singular) do
+        values[instance_variable_get("@#{singular}")]
+      end
+
+      # Add the setter method. This takes the string representation and converts it to an integer to store in the DB
+      define_method("#{singular}=") do |val|
+        if val.instance_of?(String)
+          instance_variable_set("@#{singular}", values.index(val))
+        else
+          instance_variable_set("@#{singular}", val)
+        end
+      end
+
+      define_method("#{singular}_is?") do |value|
+        eval("#{singular} == '#{value.to_s}'")
+      end
+    end
+  end
+end

data/lib/orm/active_record.rb

@@ -0,0 +1,46 @@
+module HasConstant
+  module Orm
+    module ActiveRecord
+      def self.included( base )
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def has_constant( name, values, options = {} )
+          super(name, values, options)
+
+          singular = (options[:accessor] || name.to_s.singularize).to_s
+
+          # Add the getter method. This returns the string representation of the stored value
+          define_method(singular) do
+            self.class.send(name)[read_attribute(singular).to_i] if read_attribute(singular)
+          end
+
+          define_method("#{singular}=") do |val|
+            if val.instance_of?(String)
+              write_attribute singular.to_sym, self.class.send(name.to_s).index(val)
+            else
+              write_attribute singular.to_sym, val
+            end
+          end
+
+          class_eval do
+            named_scope :by_constant, lambda { |constant,value| { :conditions =>
+              { constant.to_sym => eval("#{self.to_s}.#{constant.pluralize}.index(value)") } } }
+            named_scope "#{singular}_is".to_sym, lambda { |*values| { :conditions =>
+              { singular.to_sym => indexes_for(name, values) }
+            } }
+            named_scope "#{singular}_is_not".to_sym, lambda { |*values| { :conditions =>
+              ["#{singular} NOT IN (?)", indexes_for(name, values)]
+            } }
+          end
+        end
+
+      private
+        def indexes_for( name, values )
+          values.map { |v| self.send(name.to_sym).index(v) }
+        end
+      end
+    end
+  end
+end

data/lib/orm/mongoid.rb

@@ -0,0 +1,39 @@
+module HasConstant
+  module Orm
+    module Mongoid
+      def self.included( base )
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def has_constant( name, values, options = {} )
+          super(name, values, options)
+
+          singular = (options[:accessor] || name.to_s.singularize).to_s
+
+          # Add the getter method. This returns the string representation of the stored value
+          define_method(singular) do
+            eval("#{self.class}.#{name.to_s}[self.attributes[singular].to_i] if self.attributes[singular]")
+          end
+
+          define_method("#{singular}=") do |val|
+            if val.instance_of?(String)
+              write_attribute singular.to_sym, self.class.send(name.to_s).index(val)
+            else
+              write_attribute singular.to_sym, val
+            end
+          end
+
+          class_eval do
+            named_scope :by_constant, lambda { |constant,value| { :where =>
+              { constant.to_sym => eval("#{self.to_s}.#{constant.pluralize}.index(value)") } } }
+            named_scope "#{singular}_is".to_sym, lambda { |*values| { :where =>
+              { singular.to_sym => { '$in' =>  values.map { |v| self.send(name.to_sym).index(v) } } } } }
+            named_scope "#{singular}_is_not".to_sym, lambda { |*values| { :where =>
+              { singular.to_sym => { '$nin' => values.map { |v| self.send(name.to_sym).index(v) } } } } }
+          end
+        end
+      end
+    end
+  end
+end

data/test/has_constant_test.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class Model
+  include HasConstant
+
+  attr_accessor :salutation
+end
+
+class TestHasConstant < Test::Unit::TestCase
+  should 'default accessor to singular of the constant name' do
+    Model.has_constant :titles, ['Mr', 'Mrs']
+    assert Model.new.respond_to?(:title)
+    assert Model.new.respond_to?(:title=)
+  end
+
+  should 'be able to override accessor' do
+    Model.has_constant :titles, ['Mr', 'Mrs'], :accessor => :salutation
+    m = Model.new
+    m.salutation = 'Mr'
+    assert_equal 'Mr', m.salutation
+  end
+
+  should 'be able to use an array' do
+    Model.has_constant :titles, ['Mr', 'Mrs']
+    assert_equal ['Mr', 'Mrs'], Model.titles
+  end
+
+  should 'be able to use a proc' do
+    Model.has_constant :titles, Proc.new { ['Mr', 'Mrs'] }
+    assert_equal ['Mr', 'Mrs'], Model.titles
+  end
+
+  should 'be able to use lambda' do
+    Model.has_constant :titles, lambda { ['Mr', 'Mrs'] }
+    assert_equal ['Mr', 'Mrs'], Model.titles
+  end
+
+  should 'provide singular_is? comparison method' do
+    Model.has_constant :titles, ['Mr', 'Mrs']
+    m = Model.new
+    m.title = 'Mr'
+    assert m.title_is?('Mr')
+  end
+end

data/test/helper.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'has_constant'
+
+def setup_mongoid
+  begin
+    require 'mongoid'
+    Mongoid.database = Mongo::Connection.new('localhost', @port).db('i18n_test')
+  rescue LoadError => e
+    puts "can't use Mongoid adapter because: #{e}"
+  end
+end
+
+def setup_active_record
+  begin
+    require 'active_record'
+    ActiveRecord::Base.connection
+    true
+  rescue LoadError => e
+    puts "can't use ActiveRecord backend because: #{e.message}"
+  rescue ActiveRecord::ConnectionNotEstablished
+    connect_active_record
+    true
+  end
+end
+
+def connect_active_record
+  connect_adapter
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users, :force => true do |t|
+      t.integer :salutation
+    end
+  end
+end
+
+def connect_adapter
+  ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+end
+
+class Test::Unit::TestCase
+
+  def setup
+    Mongoid.database.collections.each do |collection|
+      begin
+        collection.drop
+      rescue
+      end
+    end if defined?(Mongoid)
+    User.delete_all if defined?(ActiveRecord)
+  end
+end

data/test/unit/orm/active_record_test.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+setup_active_record
+
+class User < ActiveRecord::Base
+  include HasConstant
+  include HasConstant::Orm::ActiveRecord
+
+  has_constant :salutations, ['Mr', 'Mrs']
+end if defined?(ActiveRecord)
+
+class ActiveRecordTest < Test::Unit::TestCase
+  should 'save values as integers' do
+    u = User.new(:salutation => 'Mr')
+    u.save!
+    assert_equal 'Mr', u.salutation
+    assert_equal 0, u.attributes['salutation']
+  end
+
+  context 'scopes' do
+    setup do
+      @man = User.create!(:salutation => 'Mr')
+      @woman = User.create!(:salutation => 'Mrs')
+    end
+
+    should 'provide by_constant scope' do
+      assert_equal 1, User.by_constant('salutation', 'Mr').count
+      assert_equal @man, User.by_constant('salutation', 'Mr').first
+    end
+
+    should 'provide singular_is scope' do
+      assert_equal 1, User.salutation_is('Mr').count
+      assert_equal @man, User.salutation_is('Mr').first
+    end
+
+    should 'provide singular_is_not scope' do
+      assert_equal 1, User.salutation_is_not('Mr').count
+      assert_equal @woman, User.salutation_is_not('Mr').first
+    end
+  end
+end if defined?(ActiveRecord)

data/test/unit/orm/mongoid_test.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+setup_mongoid
+
+class MongoUser
+  include Mongoid::Document
+  include HasConstant
+  include HasConstant::Orm::Mongoid
+
+  field :salutation, :type => Integer
+
+  has_constant :salutations, ['Mr', 'Mrs']
+end if defined?(Mongoid)
+
+class MongoidTest < Test::Unit::TestCase
+  should 'save values as integers' do
+    m = MongoUser.new(:salutation => 'Mr')
+    m.save!
+    assert_equal 'Mr', m.salutation
+    assert_equal 0, m.attributes['salutation']
+  end
+
+  context 'scopes' do
+    setup do
+      @man = MongoUser.create!(:salutation => 'Mr')
+      @woman = MongoUser.create!(:salutation => 'Mrs')
+    end
+
+    should 'provide by_constant scope' do
+      assert_equal 1, MongoUser.by_constant('salutation', 'Mr').count
+      assert_equal @man, MongoUser.by_constant('salutation', 'Mr').first
+    end
+
+    should 'provide singular_is scope' do
+      assert_equal 1, MongoUser.salutation_is('Mr').count
+      assert_equal @man, MongoUser.salutation_is('Mr').first
+    end
+
+    should 'provide singular_is_not scope' do
+      assert_equal 1, MongoUser.salutation_is_not('Mr').count
+      assert_equal @woman, MongoUser.salutation_is_not('Mr').first
+    end
+  end
+end if defined?(Mongoid)

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: has_constant
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- mattbeedle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Allows certain fields to be limited to a set of values
+email: mattbeedle@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- has_constant.gemspec
+- lib/has_constant.rb
+- lib/orm/active_record.rb
+- lib/orm/mongoid.rb
+- test/has_constant_test.rb
+- test/helper.rb
+- test/unit/orm/active_record_test.rb
+- test/unit/orm/mongoid_test.rb
+has_rdoc: true
+homepage: http://github.com/mattbeedle/has_constant
+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: Allows certain fields to be limited to a set of values
+test_files: 
+- test/has_constant_test.rb
+- test/helper.rb
+- test/unit/orm/active_record_test.rb
+- test/unit/orm/mongoid_test.rb