code-box 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code-box (0.0.1)
+    code-box (0.0.2)
       activerecord (~> 3.0)
 
 GEM

data/README.md

@@ -1,6 +1,9 @@
-# Code::Attr
+# CodeBox::CodeAttribute
+
+Lets you define attributes as codes, instead keys (ids). For simple option storage saving a string code is often more simple an conveniant the storing an artificial id-key referencing a special code object.
+CodeBox lets you access define codes as strings and access the associated code objects in various ways.
+
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -16,7 +19,9 @@ Or install it yourself as:
 
     $ gem install code-box
 
-## Usage
+
+
+## Sample Usages
 
 ### Specifying attributes as codes
 
@@ -24,9 +29,10 @@ There are cases you want to store 'named codes' instead artificial keys.
 Codes make sense for stable references and better readability of the raw data.
 
 There are several options to specify an attribute as a code:
-  1. Attribute is a code. There is no associated object involved, but simple I18n translation of the code
-  1. Attribute is a code. There exists a code object that is looked up on access.
-  1. Attribute is a code. There exists an AR code object that is looked up through AR association.
+  1. The code value is used for I18n translation (e.g. nationality_code: 'SUI' -> nationality: 'Switzerland' (when locale is 'en')).
+  1. The code value is used to lookup a specific code object that implements `.for_code`.
+  1. The code value is a foreign key on a specific ActiveRecord code object.
+
 
 #### Lookup through I18n
 
@@ -35,13 +41,14 @@ Example
     class Person
       iclude CodeBox::CodeAttribute
 
-      attr_accessor :nationality_code
-    end
+      attr_accessor  :nationality_code
 
-The include will create the following methods in Person:
+      code_attribute :nationality
+    end
 
-  #nationality Will return the nationality looked up through I18n on key: 'activerecord.values.person.nationality_code.de: Germany', where de would 'de' the nationality code.
+The include will create the following method in Person:
 
+  `#nationality` Will return the nationality text for the value stored in `nationality_code`. For the code 'SUI' the I18n key would look like: `activerecord.values.person.nationality_code.SUI` (Note: The key is build like the standard I18n keys for activerecord classes or attribute by default. Since I dislike the `activerecord` naming and prefer `model` I made this configurable - see below).
 
 
 #### Lookup through code object
@@ -51,29 +58,67 @@ Example
     class Person
       iclude CodeBox::CodeAttribute
 
-      attr_accessor :nationality_code, :lookup_type => :lookup
+      attr_accessor :nationality_code
+
+      code_attribute :nationality, :lookup_type => :lookup
     end
 
     class Code::Nationality
       attr_accessor :code, :name
 
-      def lookup(code)
-        return the correct Code::Nationality for the passed code
+      def self.for_code(code)
+        # return the correct Code::Nationality for the passed code
       end
     end
 
-The include will create the following methods in Person:
 
-  #nationality Will return the nationality looked through lookup on the associated code object.
+The include will create the following method in Person:
+
+  `#nationality` Will return the nationality object looked up using the method '.for_code' on the code class.
+  Translation then can be done within this class with the first method described above.
+
 
 
 #### Lookup through associated AR Code Object
-to be completed ...
+
+The code value is interpreted as a foreign key on an associated AR Code object.
+
+    class Person < ActiveRecord::Base
+      iclude CodeBox::CodeAttribute
+
+      code_attribute :nationality, :lookup_type => :activerecord
+    end
+
+    class Code::Nationality < ActiveRecord::Base
+      # has attribute 'code' of type string
+    end
+
+The include and code specification will create the following methods in Person:
+
+  `#nationality` - will return the nationality looked up through AR association on the associated code object - implemented through below AR association:
+
+      belongs_to :nationality,
+        :class_name  => 'Codes::Nationality',
+        :foreign_key => :nationality_code,
+        :primary_key => :code
+
+
+## Configuration details
+
+### Lookup through I18n
+... to be completed
+
+### Lookup through code object
+... to be completed
+
+### Lookup through associated AR Code Object
+... to be completed
+
 
 
 ## Contributing
 
-1. Fork it
+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`)

data/lib/code-box/acts_as_code.rb

@@ -59,7 +59,7 @@ module CodeBox
                 all.inject({}) {|hash, obj| hash[obj.#{code_attr}] = obj; hash }
               end
 
-              def self.lookup(code)
+              def self.for_code(code)
                 code_cache[code]
               end
 
@@ -92,7 +92,7 @@ module CodeBox
                 all.inject({}) {|hash, obj| hash[obj.#{code_attr}] = obj; hash }
               end
 
-              def self.lookup(code)
+              def self.for_code(code)
                 code_cache[code]
               end
 

data/lib/code-box/code_attribute.rb

@@ -3,9 +3,49 @@
 module CodeBox
 
   module CodeAttribute
+    Config = { :i18n_model_segment => :activerecord }
+
+    def i18n_model_segment=(segment)
+      Config[:i18n_model_segment] = segment
+    end
+    def i18n_model_segment
+      Config[:i18n_model_segment]
+    end
+    module_function :i18n_model_segment=, :i18n_model_segment
+
+
+    def self.[](*options)
+      instance_eval <<-RUBY_
+        class << self
+          def _code_box_i18n_model_segment
+            "#{options.extract_options![:i18n_model_segment]}"
+          end
+        end
+      RUBY_
+      self
+    end
 
     def self.included(base)
+      unless (class << self; self; end).method_defined?(:_code_box_i18n_model_segment)
+        instance_eval <<-RUBY_
+          class << self
+            def _code_box_i18n_model_segment
+              nil
+            end
+          end
+        RUBY_
+      end
+
       base.extend(ClassMethods)
+
+      instance_eval <<-RUBY_
+        class << base
+          def _code_box_i18n_model_segment
+            return CodeBox::CodeAttribute.i18n_model_segment if "#{self._code_box_i18n_model_segment}".empty?
+            "#{self._code_box_i18n_model_segment}"
+          end
+        end
+      RUBY_
     end
 
 
@@ -34,7 +74,7 @@ module CodeBox
               class_eval <<-RUBY_
                 # getter
                 def #{code_name}
-                  #{code_class_name}.lookup(#{code_attr_name})
+                  #{code_class_name}.for_code(#{code_attr_name})
                 end
 
                 # setter
@@ -57,7 +97,7 @@ module CodeBox
                 # getter
                 def #{code_name}(locale=I18n.locale)
                   code = self.#{code_attr_name}
-                  self.class.translate_#{code_attr_name}(code, locale)
+                  self.class.translate_#{code_attr_name}(code, :locale => locale)
                 end
 
                 # setter
@@ -67,13 +107,23 @@ module CodeBox
 
                 # translator
                 class << self
-                  def translate_#{code_attr_name}(code, locale=I18n.locale)
-                    codes = Array(code)
-                    tranlsated_codes = codes.map { |code|
+                  def translate_#{code_attr_name}(*code)
+                    options           = code.extract_options!
+                    locale            = options[:locale] || I18n.locale
+                    codes             = code.first
+                    is_paramter_array = codes.kind_of? Array
+
+                    codes = Array(codes)
+                    translated_codes = codes.map { |code|
                       code_key = code.nil? ? :null_value : code
-                      I18n.t("activerecord.\#{self.name.underscore}.values.#{code_attr_name}.\#{code_key}", :locale => locale)
+                      I18n.t("\#{self._code_box_i18n_model_segment}.\#{self.name.underscore}.values.#{code_attr_name}.\#{code_key}", :locale => locale)
                     }
-                    tranlsated_codes.size == 1 ? tranlsated_codes.first : tranlsated_codes
+
+                    if options[:build] == :zip
+                      translated_codes.zip(codes)
+                    else
+                      is_paramter_array ? translated_codes : translated_codes.first
+                    end
                   end
                 end
               RUBY_

data/lib/code-box/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module CodeBox
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/code-box/test_acts_as_code.rb

@@ -12,8 +12,8 @@ class TestActsAsCode < Test::Unit::TestCase
   def test_constants
     assert_equal 2, Codes::CivilStatus::all.size
 
-    assert_equal Codes::CivilStatus.lookup('single'),  Codes::CivilStatus::all.first
-    assert_equal Codes::CivilStatus.lookup('married'), Codes::CivilStatus::all.last
+    assert_equal Codes::CivilStatus.for_code('single'),  Codes::CivilStatus::all.first
+    assert_equal Codes::CivilStatus.for_code('married'), Codes::CivilStatus::all.last
   end
 
 
@@ -29,7 +29,7 @@ class TestActsAsCode < Test::Unit::TestCase
     code_1 = Codes::ArCode.create(:code => 'code_1', :name => "Code_1_name")
     code_2 = Codes::ArCode.create(:code => 'code_2', :name => "Code_2_name")
 
-    assert_equal code_2, Codes::ArCode.lookup('code_2')
+    assert_equal code_2, Codes::ArCode.for_code('code_2')
   end
 
 

data/test/code-box/test_code_attribute.rb

@@ -23,7 +23,15 @@ class TestCodeAttribute < Test::Unit::TestCase
 
     assert_equal('de',          obj.country_iso)
     assert_equal('Deutschland', obj.country(:de))
+  end
+
+  def test_code_attribute_i18n_lookup_w_segment
+    obj = Codes::SegmentModel.new
+    obj.gender_code = 'f'
+    I18n.locale =:en
 
+    assert_equal('f',      obj.gender_code)
+    assert_equal('female', obj.gender)
   end
 
   def test_code_attribute_i18n_translator_with_single_code
@@ -31,7 +39,7 @@ class TestCodeAttribute < Test::Unit::TestCase
     translation = Codes::SampleClass.translate_gender_code('f')
     assert_equal('weiblich', translation)
 
-    translation = Codes::SampleClass.translate_gender_code('f', :en)
+    translation = Codes::SampleClass.translate_gender_code('f', :locale => :en)
     assert_equal('female', translation)
   end
 
@@ -43,18 +51,33 @@ class TestCodeAttribute < Test::Unit::TestCase
     assert_equal('weiblich', translation.first)
     assert_equal('männlich', translation.last)
 
-    translation = Codes::SampleClass.translate_gender_code(['f', 'm'], :en)
+    translation = Codes::SampleClass.translate_gender_code(['f', 'm'], :locale => :en)
 
     assert translation.kind_of? Array
     assert_equal('female', translation.first)
     assert_equal('male', translation.last)
   end
 
+  def test_code_attribute_i18n_translator_with_multiple_codes_zipped
+    I18n.locale = :de
+    translation = Codes::SampleClass.translate_gender_code(['f', 'm'], :build => :zip)
+
+    assert translation.kind_of? Array
+    assert_equal(['weiblich', 'f'], translation.first)
+    assert_equal(['männlich', 'm'], translation.last)
+
+    translation = Codes::SampleClass.translate_gender_code(['f', 'm'], :locale => :en, :build => :zip)
+
+    assert translation.kind_of? Array
+    assert_equal(['female', 'f'], translation.first)
+    assert_equal(['male', 'm'],   translation.last)
+  end
+
 
   # :type => :lookup -------------------------------------------------------------------
   def test_code_attribute_lookup_default
-    code_single  = Codes::CivilStatus.lookup('single')
-    code_married = Codes::CivilStatus.lookup('married')
+    code_single  = Codes::CivilStatus.for_code('single')
+    code_married = Codes::CivilStatus.for_code('married')
 
     code_client  = Codes::SampleClass.new(:civil_status_code => 'single')
 

data/test/resources/locale/de.yml

@@ -9,4 +9,10 @@ de:
           m: männlich
         country_iso:
           de: Deutschland
-          ch: Schweiz
+          ch: Schweiz
+  model:
+    codes/segment_model:
+      values:
+        gender_code:
+          f: weiblich
+          m: männlich

data/test/resources/locale/en.yml

@@ -9,4 +9,10 @@ en:
           m: male
         country_iso:
           de: Germany
-          ch: Switzerland
+          ch: Switzerland
+  model:
+    codes/segment_model:
+      values:
+        gender_code:
+          f: female
+          m: male

data/test/resources/models.rb

@@ -49,7 +49,7 @@ module Codes
       @@code_cache[code_obj.code_id] = code_obj
     end
 
-    def self.lookup(code)
+    def self.for_code(code)
       @@code_cache[code]
     end
   end
@@ -64,4 +64,13 @@ module Codes
     self.table_name = :codes_ar_code
   end
 
+  class SegmentModel
+    include CodeBox::CodeAttribute[:i18n_model_segment => :model]
+
+    attr_accessor :gender_code
+
+    # i18n codes
+    code_attribute :gender
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code-box
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord