code-box 0.3.1 → 0.4.0

data/README.md

@@ -1,7 +1,13 @@
 # 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.
+
+CodeBox:
+
+* lets you define code attributes
+* provides translation of this codes __or__
+* provides access to associated code objects (see below) in various ways
+* __and__ furthermore enables an easy way to define code objects
 
 
 
@@ -67,7 +73,7 @@ Example
       code_attribute :nationality, :lookup_type => :lookup
     end
 
-    # Note: Below class is a plain sample implementation. Code objects can be built easier with
+    # Note: Below class is a plain sample implementation. Code objects can be built easier with
     #       'ActsAsCode' include (see below)
     class Code::Nationality
       attr_accessor :code, :name
@@ -120,44 +126,47 @@ As describe above code_attributes can reference code objects if the `code_attrib
 
 Making an code object `acts_as_code` provides the following features:
 
-  * `#translated_code(locale=I18n.locale, *other_locale_options)
-    Translates the code stored in `code`
+  * `#translated_code(locale=I18n.locale, *other_locale_options)`
+    <br/>Translates the code stored in `code`
 
-  * `&#35;translated_code(locale=I18n.locale, *other_locale_options)`
-    Translates the code stored in `code`
+  * `#translated_code(locale=I18n.locale, *other_locale_options)`
+    <br/>Translates the code stored in `code`
 
   * `.translate_code(code, *options)`
-    Translates a single code if `code` is a code, an array of codes of `code` is an array.
+    <br/>Translates a single code if `code` is a code, an array of codes of `code` is an array.
     If code is an array the option :build => :zip can be used to build a select option capable array (e.g `[['Switzerland', 'SUI'],['Germany', 'GER'],['Denmark', 'DEN']]`)
 
-  * `.for_code(code)
-    Answers the code object for the given code (fetched from cache)
+  * `.for_code(code)`:
+    <br/>Answers the code object for the given code (fetched from cache)
 
   * `.clear_code_cache`
-    Clears the cache so its build up on need from all codes from scratch
+    <br/>Clears the cache so its build up on need from all codes from scratch
 
 
   __Note:__ The code name can be configures using the `:code_attribute` option.
-  `:code_attribute => :iso_code` leads to methods like #translate_iso_code etc.
+  `:code_attribute => :iso_code` leads to methods like `#translate_iso_code` etc.
 
 
 #### Plain old ruby object codes (:poro)
 
-Assuming we have a simple ruby class with default code attribute 'code' we can defined such a class like
+Assuming we have a simple ruby class with default code attribute 'code' we can defined such a class like:
 
     class Codes::MySpecificCode
-      include CodeBox::ActsAsCode
+      include CodeBox::ActsAsCode[]
+      # Above is actually a shortcut for:
+      #   include CodeBox::ActsAsCode
+      #   acts_as_code
 
-      # Above include cretes the following:
+      # Above include creates the following:
       #
       # attr_accessor :code
       #
-      # def initialize(code)
-      #  @code = code
+      # def initialize(code)
+      #  @code = code
       # end
-      #
+      #
       # def self.all
-      #   raise "Sublass responsibility. You should implement '.all' returning all codes"
+      #   raise "Sublass responsibility. You should implement '.all' returning all codes"
       # end
 
       # @return [Array] List if all code objects (instances of this)
@@ -180,8 +189,11 @@ Assuming we have an ActiveRecod code class with `code_attribute :code` we can de
 
     class Codes::MySpecificCode < ActiveRecord::Base
       include CodeBox::ActsAsCode[:type => :active_record]
+      # Above is actually a shortcut for:
+      #   include CodeBox::ActsAsCode
+      #   acts_as_code(:type => :active_record)
 
-      # Above include cretes the following:
+      # Above include creates the following:
       #
       # validates_presence_of   :code
       # validates_uniqueness_of :code

data/lib/code-box/acts_as_code.rb

@@ -48,7 +48,7 @@ module CodeBox
     module ClassMethods
       DefaultOptions = {
           :type                      => :poro,
-          :code_attribute            => :code,
+          :code_attribute            => 'code',
           :polymorphic               => false,
           :uniqueness_case_sensitive => true,
           :position_attr             => :position,
@@ -58,14 +58,28 @@ module CodeBox
         options        = codes_and_or_options.extract_options!
         codes          = codes_and_or_options
         opts           = DefaultOptions.merge(options)
-        code_attr      = opts[:code_attribute]
+        code_attr      = opts[:code_attribute].to_s
         position_attr  = opts[:position_attribute]
         case_sensitive = opts[:uniqueness_case_sensitive]
         model_type     = opts.delete(:type)
 
         # Create a constant for each code
-        codes.each do |code|
-          const_set("Code#{code.to_s.camelize}", code)
+        if !codes.empty?
+          code_constants = {}
+          codes.each do |code|
+            constant_name = "#{(code_attr+'_'+code.to_s).to_s.camelize}"
+            constant      = const_set(constant_name, code.to_s) unless const_defined?(constant_name)
+            code_constants[constant_name] = constant
+          end
+          raise "Could not define all code constants. Only defined for #{code_constants.values.compact.inspect}" unless code_constants.values.compact.size == codes.size
+
+          pl_code_attr  = code_attr.pluralize.camelize
+          constant_name = "All#{pl_code_attr}"
+          if const_defined?(constant_name)
+            raise "Could not define constant '#{const_name}' for all codes."
+          else
+            const_set(constant_name, code_constants.values.compact)
+          end
         end
 
         class_eval <<-RUBY_
@@ -103,11 +117,18 @@ module CodeBox
           def self.initialize_cache
             Hash[all.map{ |code| [code.#{code_attr}, code] }]
           end
-
         RUBY_
 
         instance_eval <<-CODE
           class << self
+            def code_box_model_type
+              '#{model_type.to_sym}'
+            end
+
+            def code_box_code_attr_name
+              '#{code_attr}'
+            end
+
             def code_cache
               @code_cache ||= initialize_cache
             end
@@ -155,17 +176,91 @@ module CodeBox
               def ==(other)
                 self.equal? other
               end
+            CODE
 
-              def self.all
-                raise "Sublass responsibility. You should implement '.all' returning all codes"
+            if codes.empty?
+              class_eval <<-CODE
+                def self.all
+                  raise 'Class responsibility'
+                end
+              CODE
+            else
+              code_constants = {}
+              codes.each do |code|
+                constant_name = "#{code.to_s.camelize}"
+                constant      = const_set(constant_name, self.new(code.to_s)) unless const_defined?(constant_name)
+                code_constants[constant_name] = constant
               end
-            CODE
+              raise "Could not define all code instance constants. Only defined for #{code_constants.values.compact.inspect}" unless code_constants.values.compact.size == codes.size
+
+              pl_code_attr = code_attr.pluralize.camelize
+              constant_name   = 'All'
+              if const_defined?(constant_name)
+                raise "Could not define constant '#{const_name}' for all codes."
+              else
+                const_set(constant_name, code_constants.values.compact)
+              end
+
+              class_eval <<-CODE
+                def self.all
+                  All
+                end
+              CODE
+            end
 
           else
             raise ArgumentError, "'#{model_type}' is not a valid type. Use :active_record or :poro(default) instead"
         end
+      end
+
+      def define_codes(*codes)
+        code_attr      = self.code_box_code_attr_name
+        model_type     = self.code_box_model_type
+
+        return if codes.empty?
+
+        # Create a constant for each code
+        code_constants = {}
+        codes.each do |code|
+          constant_name = "#{(code_attr+'_'+code.to_s).to_s.camelize}"
+          constant      = const_set(constant_name, code.to_s) unless const_defined?(constant_name)
+          code_constants[constant_name] = constant
+        end
+        raise "Could not define all code constants. Only defined for #{code_constants.values.compact.inspect}" unless code_constants.values.compact.size == codes.size
+
+        pl_code_attr  = code_attr.pluralize.camelize
+        constant_name = "All#{pl_code_attr}"
+        if const_defined?(constant_name)
+          raise "Could not define constant '#{const_name}' for all codes."
+        else
+          const_set(constant_name, code_constants.values.compact)
+        end
+
+        return if self.code_box_model_type == :active_record
+        
+        code_constants = {}
+        codes.each do |code|
+          constant_name = "#{code.to_s.camelize}"
+          constant      = const_set(constant_name, self.new(code.to_s)) unless const_defined?(constant_name)
+          code_constants[constant_name] = constant
+        end
+        raise "Could not define all code instance constants. Only defined for #{code_constants.values.compact.inspect}" unless code_constants.values.compact.size == codes.size
+
+        pl_code_attr = code_attr.pluralize.camelize
+        constant_name   = 'All'
+        if const_defined?(constant_name)
+          raise "Could not define constant '#{const_name}' for all codes."
+        else
+          const_set(constant_name, code_constants.values.compact)
+        end
 
+        class_eval <<-CODE
+          def self.all
+            All
+          end
+        CODE
       end
+
     end
   end
 end

data/lib/code-box/version.rb

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

data/test/code-box/test_acts_as_code.rb

@@ -4,12 +4,8 @@ require 'helper'
 
 class TestActsAsCode < Test::Unit::TestCase
 
-  def test_constants
-    assert_equal 'single', Codes::CivilStatus::CodeSingle
-  end
-
-  def test_constants
-    assert_equal 2, Codes::CivilStatus::all.size
+  def test_all_methods
+    assert_equal 2, Codes::CivilStatus.all.size
 
     assert_equal Codes::CivilStatus.for_code('single'),  Codes::CivilStatus::all.first
     assert_equal Codes::CivilStatus.for_code('married'), Codes::CivilStatus::all.last
@@ -32,14 +28,44 @@ class TestActsAsCode < Test::Unit::TestCase
     assert_equal code_2, Codes::ArCode.for_code('code_2')
   end
 
-  def test_constant_definition
+  def test_code_constant_definitiones
+    # Constants
     assert Codes::CivilStatus.const_defined?('CodeSingle')
     assert Codes::CivilStatus.const_defined?('CodeMarried')
+    assert Codes::CivilStatus.const_defined?('AllCodes')
 
+    # Constants-Values
+    assert_equal [Codes::CivilStatus::CodeSingle, Codes::CivilStatus::CodeMarried], Codes::CivilStatus::AllCodes
     assert_equal Codes::CivilStatus::CodeMarried, 'married'
     assert_equal Codes::CivilStatus::CodeSingle,  'single'
   end
 
+  def test_code_instance_constant_definitions
+    # Constants
+    assert Codes::CivilStatus.const_defined?('Single')
+    assert Codes::CivilStatus.const_defined?('Married')
+    assert Codes::CivilStatus.const_defined?('All')
+
+    # Constants-Values
+    assert_equal [Codes::CivilStatus::Single, Codes::CivilStatus::Married], Codes::CivilStatus::All
+    assert_equal [Codes::CivilStatus::Single, Codes::CivilStatus::Married], Codes::CivilStatus.all
+    assert_equal Codes::CivilStatus::Single.code,  'single'
+    assert_equal Codes::CivilStatus::Married.code, 'married'
+  end
+
+  def test_code_instance_constant_definitions_w_define_code
+    # Constants
+    assert Codes::CivilStatusUseDefine.const_defined?('Single')
+    assert Codes::CivilStatusUseDefine.const_defined?('Married')
+    assert Codes::CivilStatusUseDefine.const_defined?('All')
+
+    # Constants-Values
+    assert_equal [Codes::CivilStatusUseDefine::Single, Codes::CivilStatusUseDefine::Married], Codes::CivilStatusUseDefine::All
+    assert_equal [Codes::CivilStatusUseDefine::Single, Codes::CivilStatusUseDefine::Married], Codes::CivilStatusUseDefine.all
+    assert_equal Codes::CivilStatusUseDefine::Single.code,  'single'
+    assert_equal Codes::CivilStatusUseDefine::Married.code, 'married'
+  end
+
   def test_code_translation
     code = Codes::CivilStatus.new('married')
 

data/test/resources/models.rb

@@ -21,19 +21,12 @@ module Codes
 
   class CivilStatus
     include CodeBox::ActsAsCode['single', 'married', :type => :poro]
+  end
 
-    attr_accessor :code
+  class CivilStatusUseDefine
+    include CodeBox::ActsAsCode[:type => :poro]
 
-    def initialize(code)
-      @code = code
-    end
-
-    def self.all
-      [
-        Codes::CivilStatus.new('single'),
-        Codes::CivilStatus.new('married'),
-      ]
-    end
+    define_codes(:single, :married)
   end
 
   class AgerType

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code-box
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2013-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -117,18 +117,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -268048192927979465
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -268048192927979465
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21
@@ -144,3 +138,4 @@ test_files:
 - test/resources/locale/en.yml
 - test/resources/models.rb
 - test/resources/schema.rb
+has_rdoc: