lists_constant 0.1.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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Horner
+
+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,114 @@
+# ListsConstant
+
+ListsConstant is a module which allows you to easily define
+lists of constant values. I18n is used to translate the listed
+constants into readable values.
+
+This library is intended to make it simple to keep view-specific
+information (like the text representations of your listed values)
+out of your model classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lists-constant'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lists-constant
+
+## Usage
+
+Example:
+
+In `my_state_machine.rb`:
+```
+class MyStateMachine
+  include ListsConstant
+  lists_constant :first, :second, :third, as: :steps
+
+  attr_accessor :step
+  def initialize(step)
+    @step = step
+  end
+end
+```
+
+In `locales/en.yml`:
+```
+en:
+  my_state_machine:
+    steps:
+      first: Initialize
+      second: Validate
+      third: Save
+```
+
+In `locales/es.yml`:
+```
+es:
+  my_state_machine:
+    steps:
+      first: Inicie
+      second: Valide
+      third: Guarde
+```
+
+Using the generated constant:
+```
+MyStateMachine::STEPS
+# => [:first, :second, :third]
+```
+
+Using class-level localization:
+```
+I18n.locale = :en
+MyStateMachine.steps[:first]
+# => 'Initialize'
+
+MyStateMachine.step_options
+# => {
+    'Initialize' => :first,
+    'Validate' => :second,
+    'Save' => :third
+  }
+
+I18n.locale = :es
+MyStateMachine.steps[:first]
+# => 'Inicie'
+```
+
+Instance query methods:
+```
+msm = MyStateMachine.new(:second)
+
+msm.step_second?
+# => true
+
+msm.step_third?
+# => false
+```
+
+Using instance-level localization:
+```
+I18n.locale = :en
+msm.localized_step
+# => 'Validate'
+
+I18n.locale = :es
+msm.localized_step
+# => 'Valide'
+```
+
+## 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,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/lists_constant/version.rb

@@ -0,0 +1,3 @@
+module ListsConstant
+  VERSION = "0.1.0"
+end

data/lib/lists_constant.rb

@@ -0,0 +1,63 @@
+require_relative './lists_constant/version'
+require 'active_support/inflector'
+require 'active_support/concern'
+
+module ListsConstant
+  extend ActiveSupport::Concern
+
+  def self.namespace
+    "#{@namespace}." if @namespace
+  end
+
+  def self.namespace=(namespace)
+    @namespace = namespace
+  end
+
+  module ClassMethods
+
+    def lists_constant(*values)
+      options = values.extract_options!
+
+      field = options[:as].to_s
+      raise ArgumentError.new('A constant name must be provided using the :as option') if field.empty?
+
+      const_set(field.upcase, values.freeze)
+      add_constant_list_getters(field)
+      add_localized_lookups(field)
+      add_query_methods(field, values)
+    end
+
+
+    private
+
+    def add_constant_list_getters(field)
+      define_singleton_method field do
+        const_get(field.upcase).inject({}) do |hash, value|
+          hash[value] = I18n.t(value, scope: "#{ListsConstant.namespace}#{name.underscore}.#{field}")
+          hash
+        end
+      end
+
+      define_singleton_method "#{field.singularize}_options" do
+        send(field).invert
+      end
+    end
+
+    def add_localized_lookups(field)
+      define_method "localized_#{field.singularize}" do
+        value = send(field.singularize)
+        return nil if value.nil? || value.empty?
+
+        I18n.t(value, scope: "#{ListsConstant.namespace}#{self.class.name.underscore}.#{field}")
+      end
+    end
+
+    def add_query_methods(field, values)
+      values.each do |value|
+        define_method "#{field.singularize}_#{value}?" do
+          send(field.singularize).to_s == value.to_s
+        end
+      end
+    end
+  end
+end

data/lists_constant.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lists_constant/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Horner"]
+  gem.email         = ["andrew@tablexi.com"]
+  gem.description   = %q{Easily create localization-friendly constant lists}
+  gem.summary       = %q{
+    ListsConstant supplies a module which allows easy definition of lists of
+    constant values for a Ruby class. I18n is used to translate the listed
+    constants into readable values.
+  }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.name          = "lists_constant"
+  gem.require_paths = ["lib"]
+  gem.version       = ListsConstant::VERSION
+
+  gem.add_dependency('activesupport')
+  gem.add_dependency('i18n')
+end

data/test/lib/lists_constant/lists_constant_test.rb

@@ -0,0 +1,115 @@
+require_relative '../../test_helper'
+
+class Lister
+
+  attr_accessor :color
+
+  def initialize(color)
+    @color = color
+  end
+end
+
+describe ListsConstant do
+  before do
+    I18n.locale = :en
+    Lister.send :include, ListsConstant
+  end
+
+  it "requires a name for the constant list" do
+    assert_raises ArgumentError do
+      Lister.lists_constant :red, :blue, :yellow
+    end
+  end
+
+  describe "creating a constant list" do
+    before do
+      Lister.lists_constant :red,
+        :blue,
+        :yellow,
+        as: :colors
+    end
+
+    after do
+      Lister.send :remove_const, 'COLORS'
+    end
+
+    it "adds the constant to the includer" do
+      assert_equal Lister::COLORS, [:red, :blue, :yellow]
+    end
+
+    it "adds instance query methods for each value" do
+      listed = Lister.new(:red)
+
+      assert listed.color_red?
+      refute listed.color_yellow?
+      refute listed.color_blue?
+    end
+
+    describe "given I18n translations" do
+      before do
+        @translations = {
+          red: 'rojo',
+          blue: 'azul',
+          yellow: 'amarillo'
+        }
+
+        I18n.backend.store_translations :es, {
+          lister: {
+            colors: @translations
+          }
+        }
+
+        I18n.locale = :es
+      end
+
+      it "generates a hash of the localized names with their values" do
+        assert_equal Lister.colors, {
+          red: @translations[:red],
+          blue: @translations[:blue],
+          yellow: @translations[:yellow]
+        }
+      end
+
+      it "generates an inverted hash for option helpers" do
+        assert_equal Lister.color_options, {
+          @translations[:red] => :red,
+          @translations[:blue] => :blue,
+          @translations[:yellow] => :yellow
+        }
+      end
+
+      it "localizes the variable description" do
+        listed = Lister.new(:red)
+        assert_equal listed.localized_color, @translations[:red]
+      end
+
+      describe "with a namespace" do
+        before do
+          ListsConstant.namespace = :mistranslations
+
+          @mistranslations = {
+            red: 'sangriento',
+            blue: 'morado',
+            yellow: 'gallina'
+          }
+
+          I18n.backend.store_translations :es, {
+            mistranslations: {
+              lister: {
+                colors: @mistranslations
+              }
+            }
+          }
+        end
+
+        it "scopes within the namespace for localization" do
+          assert_equal Lister.colors, {
+            red: @mistranslations[:red],
+            blue: @mistranslations[:blue],
+            yellow: @mistranslations[:yellow]
+          }
+        end
+      end
+    end
+  end
+end

data/test/lib/lists_constant/version_test.rb

@@ -0,0 +1,8 @@
+require_relative '../../test_helper'
+
+describe ListsConstant do
+
+  it 'defines a version' do
+    ListsConstant::VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require File.expand_path('../../lib/lists_constant.rb', __FILE__)

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: lists_constant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily create localization-friendly constant lists
+email:
+- andrew@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lists_constant.rb
+- lib/lists_constant/version.rb
+- lists_constant.gemspec
+- test/lib/lists_constant/lists_constant_test.rb
+- test/lib/lists_constant/version_test.rb
+- test/test_helper.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ListsConstant supplies a module which allows easy definition of lists of
+  constant values for a Ruby class. I18n is used to translate the listed constants
+  into readable values.
+test_files:
+- test/lib/lists_constant/lists_constant_test.rb
+- test/lib/lists_constant/version_test.rb
+- test/test_helper.rb