lists_constant 0.1.1 → 0.2.0

data/README.md

@@ -12,7 +12,7 @@ out of your model classes.
 
 Add this line to your application's Gemfile:
 
-    gem 'lists-constant'
+    gem 'lists_constant'
 
 And then execute:
 
@@ -20,7 +20,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install lists-constant
+    $ gem install lists_constant
 
 ## Usage
 
@@ -69,7 +69,7 @@ MyStateMachine::STEPS
 # => [:first, :second, :third]
 ```
 
-Using class-level localization:
+Class-level localization:
 
 ``` ruby
 I18n.locale = :en
@@ -78,29 +78,30 @@ MyStateMachine.steps[:first]
 
 MyStateMachine.step_options
 # => {
-    'Initialize' => :first,
-    'Validate' => :second,
-    'Save' => :third
-  }
+#   'Initialize' => :first,
+#   'Validate' => :second,
+#   'Save' => :third
+# }
 
 I18n.locale = :es
 MyStateMachine.steps[:first]
 # => 'Inicie'
 ```
 
-Instance query methods:
+Class query method:
 
 ``` ruby
-msm = MyStateMachine.new(:second)
+MyStateMachine.includes_step? :first
+# => true
 
-msm.step_second?
+MyStateMachine.includes_step? 'second'
 # => true
 
-msm.step_third?
+MyStateMachine.includes_step? 'profit!'
 # => false
 ```
 
-Using instance-level localization:
+Instance-level localization:
 
 ``` ruby
 I18n.locale = :en
@@ -112,6 +113,18 @@ msm.localized_step
 # => 'Valide'
 ```
 
+Instance query methods:
+
+``` ruby
+msm = MyStateMachine.new(:second)
+
+msm.step_second?
+# => true
+
+msm.step_third?
+# => false
+```
+
 Localization lookups may be scoped by assigning a namespace to
 the `ListsConstant` module:
 

data/lib/lists_constant/class_methods.rb

@@ -0,0 +1,15 @@
+module ListsConstant
+
+  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
+      extend ListsConstant::Lookups::Class.new(field, values)
+      include ListsConstant::Lookups::Instance.new(field, values)
+    end
+  end
+end

data/lib/lists_constant/lookup.rb

@@ -0,0 +1,14 @@
+module ListsConstant
+
+  class Lookup
+
+    def initialize base, field
+      @base = base
+      @field = field
+    end
+
+    def lookup value
+      I18n.t(value, scope: "#{ListsConstant.namespace}#{@base.name.underscore}.#{@field}")
+    end
+  end
+end

data/lib/lists_constant/lookups/class.rb

@@ -0,0 +1,51 @@
+module ListsConstant
+
+  module Lookups
+
+    class Class < Module
+
+      def initialize field, values
+        @field = field
+        @values = values
+
+        super()
+      end
+
+      def extended base
+        add_lookup_query_method base
+        add_localized_hash_method base
+        add_inverted_hash_method base
+      end
+
+
+      private
+
+      def add_lookup_query_method base
+        field = @field
+
+        base.define_singleton_method "includes_#{field.singularize}?" do |value|
+          const_get(field.upcase).any? { |item| item.to_s == value.to_s }
+        end
+      end
+
+      def add_localized_hash_method base
+        field = @field
+
+        base.define_singleton_method field do
+          const_get(field.upcase).inject({}) do |hash, value|
+            hash[value] = ListsConstant::Lookup.new(self, field).lookup(value)
+            hash
+          end
+        end
+      end
+
+      def add_inverted_hash_method base
+        field = @field
+
+        base.define_singleton_method "#{field.singularize}_options" do
+          send(field).invert
+        end
+      end
+    end
+  end
+end

data/lib/lists_constant/lookups/instance.rb

@@ -0,0 +1,44 @@
+module ListsConstant
+
+  module Lookups
+
+    class Instance < Module
+
+      def initialize field, values
+        @field = field
+        @values = values
+
+        super()
+      end
+
+      def included base
+        add_localized_lookups base
+        add_query_methods base
+      end
+
+
+      private
+
+      def add_localized_lookups base
+        field = @field
+
+        base.send :define_method, "localized_#{field.singularize}" do
+          value = send(field.singularize)
+          return nil if value.nil? || value.empty?
+
+          ListsConstant::Lookup.new(self.class, field).lookup(value)
+        end
+      end
+
+      def add_query_methods base
+        field = @field
+
+        @values.each do |value|
+          base.send :define_method, "#{field.singularize}_#{value}?" do
+            send(field.singularize).to_s == value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lists_constant/lookups.rb

@@ -0,0 +1,6 @@
+require 'lists_constant/lookup'
+require 'lists_constant/lookups/class'
+require 'lists_constant/lookups/instance'
+
+module ListsConstant::Lookups
+end

data/lib/lists_constant/version.rb

@@ -1,3 +1,3 @@
 module ListsConstant
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/lists_constant.rb

@@ -1,63 +1,20 @@
-require_relative './lists_constant/version'
 require 'active_support/inflector'
-require 'active_support/concern'
+
+require 'lists_constant/version'
+require 'lists_constant/lookups'
+require 'lists_constant/class_methods'
 
 module ListsConstant
-  extend ActiveSupport::Concern
 
   def self.namespace
     "#{@namespace}." if @namespace
   end
 
-  def self.namespace=(namespace)
+  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
+  def self.included base
+    base.extend ClassMethods
   end
 end

data/test/fixtures/lister.rb

@@ -0,0 +1,8 @@
+class Lister
+
+  attr_accessor :color
+
+  def initialize(color)
+    @color = color
+  end
+end

data/test/lib/lists_constant/class_methods_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../test_helper'
+
+describe ListsConstant::ClassMethods do
+  before do
+    Lister.send :extend, ListsConstant::ClassMethods
+  end
+
+  it "requires a name for a list constant" 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
+  end
+end

data/test/lib/lists_constant/lookup_test.rb

@@ -0,0 +1,63 @@
+require_relative '../../test_helper'
+
+describe ListsConstant::Lookup do
+  before do
+    @lookup = ListsConstant::Lookup.new(Lister, 'colors')
+  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 @lookup.lookup(:red), @translations[:red]
+      assert_equal @lookup.lookup(:blue), @translations[:blue]
+      assert_equal @lookup.lookup(:yellow), @translations[:yellow]
+    end
+  end
+
+  describe "with a specified namespace" do
+    before do
+      ListsConstant.namespace = :mistranslations
+
+      @mistranslations = {
+        red: 'sangriento',
+        blue: 'morado',
+        yellow: 'gallina'
+      }
+
+      I18n.backend.store_translations :es, {
+        mistranslations: {
+          lister: {
+            colors: @mistranslations
+          }
+        }
+      }
+    end
+
+    after do
+      ListsConstant.namespace = nil
+    end
+
+    it "scopes within the lookup for localization" do
+      assert_equal @lookup.lookup(:red), @mistranslations[:red]
+      assert_equal @lookup.lookup(:blue), @mistranslations[:blue]
+      assert_equal @lookup.lookup(:yellow), @mistranslations[:yellow]
+    end
+  end
+
+
+end

data/test/lib/lists_constant/lookups/class_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../test_helper'
+
+describe ListsConstant::Lookups::Class do
+  before do
+    I18n.locale = :en
+
+    @colors = [:red, :blue, :yellow]
+    Lister.const_set 'COLORS', @colors
+    Lister.extend ListsConstant::Lookups::Class.new('colors', @colors)
+  end
+
+  after do
+    Lister.send :remove_const, 'COLORS'
+  end
+
+  it "determines if a passed value is available" do
+    assert Lister.includes_color?(:red)
+    assert Lister.includes_color?('blue')
+    refute Lister.includes_color?(:magenta)
+  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
+  end
+end

data/test/lib/lists_constant/lookups/instance_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../../test_helper'
+
+describe ListsConstant::Lookups::Instance do
+  before do
+    I18n.locale = :en
+
+    @colors = [:red, :blue, :yellow]
+    Lister.send :include, ListsConstant::Lookups::Instance.new('colors', @colors)
+  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 "localizes the variable description" do
+      listed = Lister.new(:red)
+      assert_equal listed.localized_color, @translations[:red]
+    end
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lists_constant
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,9 +56,18 @@ files:
 - README.md
 - Rakefile
 - lib/lists_constant.rb
+- lib/lists_constant/class_methods.rb
+- lib/lists_constant/lookup.rb
+- lib/lists_constant/lookups.rb
+- lib/lists_constant/lookups/class.rb
+- lib/lists_constant/lookups/instance.rb
 - lib/lists_constant/version.rb
 - lists_constant.gemspec
-- test/lib/lists_constant/lists_constant_test.rb
+- test/fixtures/lister.rb
+- test/lib/lists_constant/class_methods_test.rb
+- test/lib/lists_constant/lookup_test.rb
+- test/lib/lists_constant/lookups/class_test.rb
+- test/lib/lists_constant/lookups/instance_test.rb
 - test/lib/lists_constant/version_test.rb
 - test/test_helper.rb
 homepage: https://github.com/ahorner/lists-constant
@@ -89,6 +98,10 @@ summary: ListsConstant is a module which allows you to easily define lists of co
   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.
 test_files:
-- test/lib/lists_constant/lists_constant_test.rb
+- test/fixtures/lister.rb
+- test/lib/lists_constant/class_methods_test.rb
+- test/lib/lists_constant/lookup_test.rb
+- test/lib/lists_constant/lookups/class_test.rb
+- test/lib/lists_constant/lookups/instance_test.rb
 - test/lib/lists_constant/version_test.rb
 - test/test_helper.rb

data/test/lib/lists_constant/lists_constant_test.rb

@@ -1,115 +0,0 @@
-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