code-box 0.4.1 → 0.5.0

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p125

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code-box (0.4.0)
+    code-box (0.5.0)
       activerecord (~> 3.0)
 
 GEM
@@ -20,9 +20,16 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.2)
     builder (3.0.0)
+    coderay (1.0.5)
     i18n (0.6.0)
+    method_source (0.8.2)
     multi_json (1.3.6)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (0.9.2.2)
+    slop (3.4.6)
     sqlite3 (1.3.6)
     tzinfo (0.3.33)
 
@@ -32,5 +39,6 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 3.0)
   code-box!
+  pry
   rake
   sqlite3

data/README.md

@@ -122,26 +122,73 @@ The include and code specification will create the following methods in Person:
 
 ### Defining code classes (acts_as_code)
 
-As describe above code_attributes can reference code objects if the `code_attribute` is of type `:associated` or `:lookup`.
+Above described code_attributes can reference code objects. Code objects can be defined using 
 
-Making an code object `acts_as_code` provides the following features:
+    acts_as_code(*codes, options)
 
-  * `#translated_code(locale=I18n.locale, *other_locale_options)`
-    <br/>Translates the code stored in `code`
+Options are:
 
-  * `#translated_code(locale=I18n.locale, *other_locale_options)`
-    <br/>Translates the code stored in `code`
+  * `:code_attribute => :code`  
+     Name of the attribute holding the code (default 'code').
+  * `:sti => false` 
+    If `true` the uniqueness validation is scoped by the attribute `type` (default false).
+  * `:uniqueness_case_sensitive => true`  
+    If `true` the the uniqueness validation is case sensitive (default true).
+  * `:position_attr => :position  
+    If present, the order when fetching the codes is done with this expression (default scope - means - if you want to omit the order used `unscoped` on any AR operation).
 
-  * `.translate_code(code, *options)`
+  All options except `:code_attribute` are used only for ActiveRecord models.
+
+If `*codes` are provided the following code constants will be defined when calling `acts_as_code('male', 'female', code_attribute: 'code')`  
+
+__IMPORTANT__ Code object constants will only be created when the code object is not an ActiveRecord model!
+
+    class Gender
+      include CodeBox::ActsAsCode['male', 'female'] # Code attribute name will be 'code'
+      # Above is a shortcut for...
+      # include CodeBox::ActsAsCode
+      # acts_as_code('male', 'female') # Code attribute name will be 'code'
+
+
+      # Given codes 'male' an 'female' the following constants will be defined:
+      #
+      # module Codes
+      #   Male   = 'male'
+      #   Female = 'female'
+      #   All    = [Male, Female]
+      # end
+      #
+      # Below constants pnly is is not ActiveRecod model!
+      # Male   = Gender.new('male')
+      # Female = Gender.new('female')
+      # All    = [Male, Female]
+      #
+    end
+
+
+Furthermote àcts_as_code` defines the following methods:
+
+  * `.for_code(code)`  
+    Answers the code object for the given code (fetched from cache)
+
+  * `#translated_code(locale=I18n.locale, *other_locale_options)`  
+    Translates the code stored in `code`
+
+  * `#translated_code(locale=I18n.locale, *other_locale_options)`  
+    Translates the code stored in `code`
+
+  * `.translate_code(codes_and_options)`
     <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)`:
-    <br/>Answers the code object for the given code (fetched from cache)
+  * `.build_select_options(codes_and_options)`  
+    Build an options array from the passed codes (all codes if no codes are passed). Add an empty option at the beginning if the option `:include_nil` is passed. The localization key is defined in CodeBox (CodeBox.i18n_empty_options_key). If you want the change the default key `shared.options.pls_select` you can do so in an initializer by calling `CodeBox.i18n_empty_options_key='your.key'`.
 
   * `.clear_code_cache`
     <br/>Clears the cache so its build up on need from all codes from scratch
 
+  * Passing 
+
 
   __Note:__ The code name can be configures using the `:code_attribute` option.
   `:code_attribute => :iso_code` leads to methods like `#translate_iso_code` etc.

data/code-box.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency  "activerecord", "~> 3.0"
   gem.add_development_dependency  "sqlite3"
   gem.add_development_dependency  "rake"
+  gem.add_development_dependency  "pry"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/code-box/acts_as_code.rb

@@ -47,9 +47,8 @@ module CodeBox
 
     module ClassMethods
       DefaultOptions = {
-          :type                      => :poro,
           :code_attribute            => 'code',
-          :polymorphic               => false,
+          :sti                       => false,
           :uniqueness_case_sensitive => true,
           :position_attr             => :position,
       }
@@ -61,26 +60,8 @@ module CodeBox
         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
-        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
+        model_type     = self.ancestors.include?('ActiveRecord::Base'.constantize) ? :active_record : :poro
 
         class_eval <<-RUBY_
           def translated_#{code_attr}(locale = I18n.locale, *options)
@@ -93,9 +74,9 @@ module CodeBox
           class << self
             attr_accessor :code_box_i18n_options_select_key
 
-            def translate_#{code_attr}(*code)
-              options            = code.extract_options!
-              codes              = code.first
+            def translate_#{code_attr}(*codes_and_options)
+              options            = codes_and_options.extract_options!
+              codes              = codes_and_options.first
               is_parameter_array = codes.kind_of? Array
 
               codes = Array(codes)
@@ -116,13 +97,13 @@ module CodeBox
             code_cache[code]
           end
 
-          def self.build_options(*args)
+          def self.build_select_options(*args)
             options     = args.extract_options!
-            codes       = args.empty? ? All#{code_attr.pluralize.camelize} : args
+            codes       = args.empty? ? #{code_attr.pluralize.camelize}::All : args
             include_nil = !!options[:include_nil]
 
             options = translate_#{code_attr}(codes, build: :zip)
-            options << [I18n.t(CodeBox.i18n_empty_options_key), nil] if include_nil
+            options.unshift [I18n.t(CodeBox.i18n_empty_options_key), nil] if include_nil
 
             options
           end
@@ -134,12 +115,8 @@ module CodeBox
 
         instance_eval <<-CODE
           class << self
-            def code_box_model_type
-              '#{model_type.to_sym}'
-            end
-
-            def code_box_code_attr_name
-              '#{code_attr}'
+            def _code_box_code_attr_name
+              '#{code_attr.to_s}'
             end
 
             def code_cache
@@ -163,7 +140,7 @@ module CodeBox
 
             class_eval <<-CODE
               validates_presence_of   :#{code_attr}
-              validates_uniqueness_of :#{code_attr}#{opts[:polymorphic] ? ', :scope => :type' : ' '}, :case_sensitive => #{case_sensitive}
+              validates_uniqueness_of :#{code_attr}#{opts[:sti] ? ', :scope => :type' : ' '}, :case_sensitive => #{case_sensitive}
 
               default_scope order('#{order_expression}')
             CODE
@@ -178,6 +155,10 @@ module CodeBox
                 self.#{code_attr} = #{code_attr}
               end
 
+              def self.all
+                raise 'Class responsibility'
+              end
+
               def hash
                 (self.class.name + '#' + #{code_attr}).hash
               end
@@ -190,81 +171,56 @@ module CodeBox
                 self.equal? other
               end
             CODE
-
-            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
-              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
+
+        define_codes(*codes)
       end
 
       def define_codes(*codes)
-        code_attr      = self.code_box_code_attr_name
-        model_type     = self.code_box_model_type
-
         return if codes.empty?
 
+        # --- Define the code constants...
+
+        code_attr   = self._code_box_code_attr_name
+        model_type  = self.ancestors.include?('ActiveRecord::Base'.constantize) ? :active_record : :poro
+
+        module_name  = code_attr.pluralize.camelize
+        codes_module = const_set(module_name, Module.new) 
+
         # Create a constant for each code
-        code_constants = {}
+        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
+          constant_name            = code.to_s.camelize
+          constant                 = codes_module.const_set(constant_name, code.to_s) unless codes_module.const_defined?(constant_name)
+          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
+        raise "Could not define all code constants. Only defined for #{constants.values.compact.inspect}" unless 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."
+        if const_defined?('All')
+          raise "Could not define constant 'All' for all codes."
         else
-          const_set(constant_name, code_constants.values.compact)
+          codes_module.const_set('All', constants.values.compact)
         end
 
-        return if self.code_box_model_type == :active_record
+        return if model_type == :active_record
+
+        # --- Define the code instance constants...
 
-        code_constants = {}
+        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
+          constant_name            = "#{code.to_s.camelize}"
+          constant                 = const_set(constant_name, self.new(code.to_s)) unless const_defined?(constant_name)
+          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
+        raise "Could not define all code instance constants. Only defined for #{constants.values.compact.inspect}" unless constants.values.compact.size == codes.size
 
-        pl_code_attr = code_attr.pluralize.camelize
-        constant_name   = 'All'
+        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)
+          const_set(constant_name, constants.values.compact)
         end
 
         class_eval <<-CODE

data/lib/code-box/version.rb

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

data/test/code-box/test_acts_as_code.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'helper'
+require 'pry'
 
 class TestActsAsCode < Test::Unit::TestCase
 
@@ -30,14 +31,15 @@ class TestActsAsCode < Test::Unit::TestCase
 
   def test_code_constant_definitiones
     # Constants
-    assert Codes::CivilStatus.const_defined?('CodeSingle')
-    assert Codes::CivilStatus.const_defined?('CodeMarried')
-    assert Codes::CivilStatus.const_defined?('AllCodes')
+    assert Codes::CivilStatus.const_defined?('Codes')
+    assert Codes::CivilStatus::Codes.const_defined?('Single')
+    assert Codes::CivilStatus::Codes.const_defined?('Married')
+    assert Codes::CivilStatus::Codes.const_defined?('All')
 
     # 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'
+    assert_equal [Codes::CivilStatus::Codes::Single, Codes::CivilStatus::Codes::Married], Codes::CivilStatus::Codes::All
+    assert_equal Codes::CivilStatus::Codes::Married, 'married'
+    assert_equal Codes::CivilStatus::Codes::Single,  'single'
   end
 
   def test_code_instance_constant_definitions
@@ -74,12 +76,12 @@ class TestActsAsCode < Test::Unit::TestCase
   end
 
   def test_options_building
-    options_array = Codes::CivilStatus.build_options
+    options_array = Codes::CivilStatus.build_select_options
     assert_equal options_array.size, 2
 
-    options_array = Codes::CivilStatus.build_options(include_nil: true)
-    puts arrrr: options_array
+    options_array = Codes::CivilStatus.build_select_options(include_nil: true)
     assert_equal options_array.size, 3
+    puts options_array: options_array
   end
 
 end

data/test/resources/locale/de.yml

@@ -13,7 +13,7 @@ de:
       codes/civil_status:
         code:
           married: verheiratet
-          single: ledig
+          single:  ledig
   model:
     values:
       codes/segment_model:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code-box
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Specify attributes as code and provide lookup by I18n-, cache- or associated
   and support for building code classes.
 email:
@@ -84,7 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-version
 - Gemfile
 - Gemfile.lock
 - LICENSE

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3-p125