attr_enum_accessor 1.0.0

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,4 @@
+language: ruby
+
+rvm:
+  - 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :test do
+  watch(%r{^test/.+_test\.rb$})
+  watch('test/test_helper.rb') { "test" }
+
+  watch(%r{^app/models/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^app/validators/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Venture Media Labs Inc.
+
+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,65 @@
+# AttrEnumAccessor
+
+[![Build Status](https://travis-ci.org/gshaw/attr_enum_accessor.png?branch=master)](https://travis-ci.org/gshaw/attr_enum_accessor)
+[![Gem Version](https://badge.fury.io/rb/attr_enum_accessor.png)](http://badge.fury.io/rb/attr_enum_accessor)
+
+Store enumerated attributes in your database as integers while using type
+checked symbols in code.
+
+[RubyDoc Documentation](http://rubydoc.info/github/gshaw/attr_enum_accessor/master/frames)
+
+## Usage
+
+Create integer columsn with `_value` suffix to store enumerated attribute values.
+
+    class CreateUsers < ActiveRecord::Migration
+      def change
+        create_table :users do |t|
+          t.string :email, null: false
+          t.string :password_digest
+          t.integer :role_value, null: false, default: 0
+          t.timestamps
+        end
+      end
+    end
+
+Create a hash in your model to map symbols to enumerated attribute values.
+
+    class User < ActiveRecord::Base
+      ROLE = {
+        user:  0,
+        admin: 1,
+      }
+
+      include AttrEnumAccessor
+      attr_enum_accessor :role, with: ROLE
+    end
+
+Access your enumerated values using symbols.
+
+    u = User.new
+    u.role = :admin
+    puts u.role_value
+
+    # throws exception
+    u.role = :unknown_role
+
+    puts User.where_role(:admin).count
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attr_enum_accessor'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue LoadError
+  raise 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttrEnumAccessor'
+  rdoc.options << '--line-numbers'
+  rdoc_main = 'README.md'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/attr_enum_accessor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_enum_accessor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_enum_accessor"
+  spec.version       = AttrEnumAccessor::VERSION
+  spec.authors       = ["Gerry Shaw"]
+  spec.email         = ["gshaw@reinvent.com"]
+  spec.summary       = %q{Enumerated fields stored using integers}
+  spec.homepage      = "https://github.com/gshaw/attr_enum_accessor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9"
+
+  spec.add_dependency "activesupport", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "guard-test"
+end

data/lib/attr_enum_accessor.rb

@@ -0,0 +1,63 @@
+# Provides a method to allow models to access enumerated values
+module AttrEnumAccessor
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Provides easy accessors for enumerated fields stored as integers in database.
+    #
+    # Requires a column in the model to have :name_value (override with `:value_column` option)
+    #
+    # Example:
+    #
+    #   class User < ActiveRecord::Base
+    #     ROLE = {
+    #       user:   1,
+    #       editor: 2,
+    #       admin:  3
+    #     }
+    #
+    #     include AttrEnumAccessor
+    #     attr_enum_accessor :role, with: ROLE
+    #     attr_enum_accessor :status, with: STATUS, value_column: :status_number, exclude_scope: true
+    #
+    #   end
+    #
+    #   u = User.new
+    #   u.role = :admin
+    #   u.role # => :admin
+    #   u.role_value # => 3
+    #
+    #   User.where_role(:admin).count                 # all admins
+    #   User.where_role([:editor, :admin]).count      # all editors and admins
+    #   User.where_role(ROLE.keys - [:admin]).count   # all except admins
+    #
+    #   User.role_to_value(:admin)            # => 3
+    #   User.role_to_value([:editor, :admin]) # => [2, 3]
+    #
+    def attr_enum_accessor(enum_attribute, options = {})
+      enum_values = options[:with]
+      value_column = options[:value_column] || :"#{enum_attribute}_value"
+      raise ArgumentError.new("Required option `with` must be a Hash") unless enum_values.kind_of?(Hash)
+
+      define_singleton_method(:"#{enum_attribute}_to_value") do |value|
+        values = Array(value).flatten.map do |value|
+          enum_values[value.to_sym] or raise ArgumentError.new("Invalid #{enum_attribute} `#{value}`")
+        end
+        values.count == 1 ? values.first : values
+      end
+
+      define_singleton_method(:"where_#{enum_attribute}") do |value|
+        values = send(:"#{enum_attribute}_to_value", value)
+        where(value_column => values)
+      end unless options[:exclude_scope]
+
+      define_method(enum_attribute) do
+        enum_values.key(read_attribute(value_column))
+      end
+
+      define_method(:"#{enum_attribute}=") do |value|
+        write_attribute(value_column, self.class.send(:"#{enum_attribute}_to_value", value))
+      end
+    end
+  end
+end

data/lib/attr_enum_accessor/version.rb

@@ -0,0 +1,3 @@
+module AttrEnumAccessor
+  VERSION = "1.0.0"
+end

data/test/attr_enum_accessor_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class User < TestBaseModel
+  ROLE = {
+    user: 1,
+    admin: 2,
+  }
+
+  include AttrEnumAccessor
+  attr_enum_accessor :role, with: ROLE
+end
+
+class AttrEnumAccessorTest < ActiveSupport::TestCase
+  test "role_to_value" do
+    assert_equal 1, User.role_to_value(:user)
+    assert_equal 2, User.role_to_value(:admin)
+  end
+
+  test "accessors" do
+    u = User.new
+    u.role = :admin
+    assert_equal :admin, u.role
+    assert_equal 2, u.read_attribute(:role_value)
+
+    u.write_attribute(:role_value, 1)
+    assert_equal :user, u.role
+  end
+
+  test "raise error on invalid value" do
+    begin
+      u = User.new
+      u.role = :unknown
+      assert false, "should have thrown error"
+    rescue ArgumentError => ex
+      assert_equal "Invalid role `unknown`", ex.to_s
+    end
+  end
+
+  test "where helper" do
+    User.where_role(:admin)
+    assert_equal User.where_options, { role_value: 2 }
+
+    User.where_role([:user, :admin])
+    assert_equal User.where_options, { role_value: [1, 2] }
+  end
+end

data/test/test_base_model.rb

@@ -0,0 +1,23 @@
+class TestBaseModel
+  attr_accessor :column_values
+
+  def initialize
+    @column_values = {}
+  end
+
+  def read_attribute(column_name)
+    @column_values[column_name.to_sym]
+  end
+
+  def write_attribute(column_name, value)
+    @column_values[column_name.to_sym] = value
+  end
+
+  def self.where(options = {})
+    @@where_options = options
+  end
+
+  def self.where_options
+    @@where_options
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require 'test/unit'
+require 'active_support'
+require 'test_base_model'
+
+require 'attr_enum_accessor'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: attr_enum_accessor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerry Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gshaw@reinvent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_enum_accessor.gemspec
+- lib/attr_enum_accessor.rb
+- lib/attr_enum_accessor/version.rb
+- test/attr_enum_accessor_test.rb
+- test/test_base_model.rb
+- test/test_helper.rb
+homepage: https://github.com/gshaw/attr_enum_accessor
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1587781763028525838
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Enumerated fields stored using integers
+test_files:
+- test/attr_enum_accessor_test.rb
+- test/test_base_model.rb
+- test/test_helper.rb