enumerize 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'minitest', '~> 2.11.0'
+
+gem 'activerecord'
+gem 'sqlite3'

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sergey Nartimov
+
+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,49 @@
+# Enumerize
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumerize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerize
+
+## Usage
+
+Basic:
+
+```ruby
+class User
+  include Enumerize
+
+  enumerize :sex, :in => [:male, :female]
+end
+```
+
+ActiveRecord:
+
+```ruby
+class User < ActiveRecord::Base
+  include Enumerize
+
+  enumerize :sex, :in => [:male, :female]
+
+  enumerize :role, :in => [:user, :admin], :default => :user
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/enumerize.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/enumerize/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sergey Nartimov"]
+  gem.email         = "info@twinslash.com"
+  gem.description   = %q{Enumerated attributes with I18n and ActiveRecord support}
+  gem.summary       = %q{Enumerated attributes with I18n and ActiveRecord support}
+  gem.homepage      = "https://github.com/twinslash/enumerize"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "enumerize"
+  gem.require_paths = ["lib"]
+  gem.version       = Enumerize::VERSION
+
+  gem.add_dependency('activesupport', '>= 3.1.3')
+end

data/lib/enumerize.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+require 'enumerize/version'
+
+module Enumerize
+  autoload :Attribute,    'enumerize/attribute'
+  autoload :Value,        'enumerize/value'
+  autoload :Integrations, 'enumerize/integrations'
+
+  extend ActiveSupport::Concern
+
+  included do
+    if defined?(ActiveRecord::Base) && self < ActiveRecord::Base
+      include Integrations::ActiveRecord
+    else
+      include Integrations::Basic
+    end
+  end
+end

data/lib/enumerize/attribute.rb

@@ -0,0 +1,32 @@
+module Enumerize
+  class Attribute
+    attr_reader :name, :values, :default_value
+
+    def initialize(klass, name, options={})
+      raise ArgumentError, ':in option is required' unless options[:in]
+
+      @klass  = klass
+      @name   = name
+      @values = Array(options[:in]).map { |v| Value.new(self, v) }
+
+      if options[:default]
+        @default_value = options[:default] && find_value(options[:default])
+        raise ArgumentError, 'invalid default value' unless @default_value
+      end
+    end
+
+    def find_value(value)
+      return if value.nil?
+      value = value.to_s
+      values.find { |v| v == value }
+    end
+
+    def i18n_suffix
+      @klass.model_name.i18n_key if @klass.respond_to?(:model_name)
+    end
+
+    def options
+      values.map { |v| [v.text, v.to_s] }
+    end
+  end
+end

data/lib/enumerize/integrations.rb

@@ -0,0 +1,6 @@
+module Enumerize
+  module Integrations
+    autoload :Basic,        'enumerize/integrations/basic'
+    autoload :ActiveRecord, 'enumerize/integrations/active_record'
+  end
+end

data/lib/enumerize/integrations/active_record.rb

@@ -0,0 +1,27 @@
+require 'active_support/concern'
+
+module Enumerize
+  module Integrations
+    module ActiveRecord
+      extend ActiveSupport::Concern
+
+      include Integrations::Basic
+
+      module ClassMethods
+        private
+
+        def _define_enumerize_attribute(mod, attr)
+          mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attr.name}
+              self.class.#{attr.name}.find_value(super)
+            end
+
+            def #{attr.name}=(new_value)
+              super self.class.#{attr.name}.find_value(new_value).to_s
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/integrations/basic.rb

@@ -0,0 +1,55 @@
+require 'active_support/concern'
+
+module Enumerize
+  module Integrations
+    module Basic
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def enumerize(*args, &block)
+          attr = Attribute.new(self, *args)
+          singleton_class.class_eval do
+            define_method(attr.name) { attr }
+          end
+
+          mod = Module.new
+
+          mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def initialize(*, &_)
+              super
+              self.#{attr.name} = self.class.#{attr.name}.default_value if #{attr.name}.nil?
+            end
+          RUBY
+
+          _define_enumerize_attribute(mod, attr)
+
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attr.name}_text
+              #{attr.name} && #{attr.name}.text
+            end
+          RUBY
+
+          include mod
+        end
+
+        private
+
+        def _define_enumerize_attribute(mod, attr)
+          mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attr.name}
+              if defined?(@#{attr.name})
+                self.class.#{attr.name}.find_value(@#{attr.name})
+              else
+                @#{attr.name} = nil
+              end
+            end
+
+            def #{attr.name}=(new_value)
+              @#{attr.name} = self.class.#{attr.name}.find_value(new_value).to_s
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/enumerize/value.rb

@@ -0,0 +1,21 @@
+require 'i18n'
+
+module Enumerize
+  class Value < String
+    def initialize(attr, value)
+      singleton_class.class_eval do
+        define_method(:attr) { attr }
+      end
+
+      super(value.to_s)
+      freeze
+    end
+
+    def text
+      i18n_keys = ['']
+      i18n_keys.unshift "#{attr.i18n_suffix}." if attr.i18n_suffix
+      i18n_keys.map! { |k| :"enumerize.#{k}#{attr.name}.#{self}" }
+      I18n.t(i18n_keys.shift, :default => i18n_keys)
+    end
+  end
+end

data/lib/enumerize/version.rb

@@ -0,0 +1,3 @@
+module Enumerize
+  VERSION = "0.0.1"
+end

data/test/active_record/migrate/1_create_tables.rb

@@ -0,0 +1,8 @@
+class CreateTables < ActiveRecord::Migration
+  def up
+    create_table :users do |t|
+      t.string :sex
+      t.string :role
+    end
+  end
+end

data/test/active_record/models.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base
+  include Enumerize
+
+  enumerize :sex, :in => [:male, :female]
+
+  enumerize :role, :in => [:user, :admin], :default => :user
+end

data/test/active_record_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Migrator.migrate File.expand_path("../active_record/migrate", __FILE__)
+require File.expand_path('../active_record/models', __FILE__)
+
+describe Enumerize::Integrations::ActiveRecord do
+  it 'sets nil if invalid value is passed' do
+    user = User.new
+    user.sex = :invalid
+    user.sex.must_equal nil
+  end
+
+  it 'saves value' do
+    User.delete_all
+    user = User.new
+    user.sex = :female
+    user.save!
+    user.sex.must_equal 'female'
+  end
+
+  it 'loads value' do
+    User.delete_all
+    I18n.backend.store_translations(:en, :enumerize => {:sex => {:male => 'Male'}})
+    User.create!(:sex => :male)
+    user = User.first
+    user.sex.must_equal 'male'
+    user.sex_text.must_equal 'Male'
+  end
+
+  it 'has default value' do
+    User.new.role.must_equal 'user'
+  end
+end

data/test/basic_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+describe Enumerize::Integrations::Basic do
+  let(:klass) do
+    Class.new do
+      include Enumerize
+    end
+  end
+
+  let(:object) { klass.new }
+
+  it 'defines method that returns nil' do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo.must_equal nil
+  end
+
+  it 'defines setter method' do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = :a
+    object.foo.must_equal 'a'
+  end
+
+  it 'returns translation' do
+    I18n.backend.store_translations(:en, :enumerize => {:foo => {:a => 'a text'}})
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = :a
+    object.foo.text.must_equal 'a text'
+    object.foo_text.must_equal 'a text'
+  end
+
+  it 'returns nil as translation when value is nil' do
+    I18n.backend.store_translations(:en, :enumerize => {:foo => {:a => 'a text'}})
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo_text.must_equal nil
+  end
+
+  it 'scopes translation by i18 key' do
+    I18n.backend.store_translations(:en, :enumerize => {:example_class => {:foo => {:a => 'a text scoped'}}})
+    def klass.model_name
+      name = "ExampleClass"
+      def name.i18n_key
+        'example_class'
+      end
+
+      name
+    end
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = :a
+    object.foo.text.must_equal 'a text scoped'
+    object.foo_text.must_equal 'a text scoped'
+  end
+
+  it 'returns options for select' do
+    I18n.backend.store_translations(:en, :enumerize => {:foo => {:a => 'a text', :b => 'b text'}})
+    klass.enumerize(:foo, :in => [:a, :b])
+    klass.foo.options.must_equal [['a text', 'a'], ['b text', 'b']]
+  end
+
+  it 'stores value as string' do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = :a
+    object.instance_variable_get(:@foo).must_be_instance_of String
+  end
+
+  it 'handles default value' do
+    klass.enumerize(:foo, :in => [:a, :b], :default => :b)
+    object.foo.must_equal 'b'
+  end
+
+  it 'raises exception on invalid default value' do
+    proc {
+      klass.enumerize(:foo, :in => [:a, :b], :default => :c)
+    }.must_raise ArgumentError
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+$VERBOSE=true
+
+require 'enumerize'

data/test/value_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'yaml'
+
+describe Enumerize::Value do
+  let(:value) { Enumerize::Value.new(nil, 'test_value') }
+
+  it 'is a string' do
+    value.must_be_kind_of String
+  end
+
+  it 'is compared to string' do
+    value.must_be :==, 'test_value'
+  end
+
+  it 'is frozen' do
+    value.must_be :frozen?
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: enumerize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergey Nartimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &21707780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *21707780
+description: Enumerated attributes with I18n and ActiveRecord support
+email: info@twinslash.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- enumerize.gemspec
+- lib/enumerize.rb
+- lib/enumerize/attribute.rb
+- lib/enumerize/integrations.rb
+- lib/enumerize/integrations/active_record.rb
+- lib/enumerize/integrations/basic.rb
+- lib/enumerize/value.rb
+- lib/enumerize/version.rb
+- test/active_record/migrate/1_create_tables.rb
+- test/active_record/models.rb
+- test/active_record_test.rb
+- test/basic_test.rb
+- test/test_helper.rb
+- test/value_test.rb
+homepage: https://github.com/twinslash/enumerize
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2173772140920833240
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2173772140920833240
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Enumerated attributes with I18n and ActiveRecord support
+test_files:
+- test/active_record/migrate/1_create_tables.rb
+- test/active_record/models.rb
+- test/active_record_test.rb
+- test/basic_test.rb
+- test/test_helper.rb
+- test/value_test.rb