code-box 0.5.0 → 0.5.1

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    code-box (0.5.0)
+    code-box (0.5.1)
       activerecord (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
       builder (~> 3.0.0)
-    activerecord (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.6)
+    activesupport (3.2.7)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)

data/README.md

@@ -1,3 +1,8 @@
+# Notes
+
+If you re using ActiveRecord ~> 4.0.0 use the version ~> 0.6  
+If you re using ActiveRecord ~> 3.0 use the version ~> 0.5.0
+
 # 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.
@@ -134,12 +139,12 @@ Options are:
     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  
+  * `: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).
 
-  All options except `:code_attribute` are used only for ActiveRecord models.
+  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')`  
+If `*codes` are provided the following code constants will be defined as shown in the example below.  
 
 __IMPORTANT__ Code object constants will only be created when the code object is not an ActiveRecord model!
 
@@ -150,7 +155,7 @@ __IMPORTANT__ Code object constants will only be created when the code object is
       # acts_as_code('male', 'female') # Code attribute name will be 'code'
 
 
-      # Given codes 'male' an 'female' the following constants will be defined:
+      # Given codes 'male' and 'female' the following constants will be defined:
       #
       # module Codes
       #   Male   = 'male'
@@ -158,7 +163,7 @@ __IMPORTANT__ Code object constants will only be created when the code object is
       #   All    = [Male, Female]
       # end
       #
-      # Below constants pnly is is not ActiveRecod model!
+      # Below constants are only currently only defined if the hosting class not an ActiveRecod model (as in this sample).
       # Male   = Gender.new('male')
       # Female = Gender.new('female')
       # All    = [Male, Female]
@@ -166,7 +171,35 @@ __IMPORTANT__ Code object constants will only be created when the code object is
     end
 
 
-Furthermote àcts_as_code` defines the following methods:
+If `*codes` are provided - in addition the following test_methods are defined:
+
+    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' and 'female' the following constants will be defined:
+      # ... al the stuff above
+      # 
+      # def male?
+      #   code == Codes::Male
+      # end
+      # 
+      # def female?
+      #   code == Codes::Female
+      # end
+      # 
+    end
+
+  Pass the option `define_test_methods: false` if you don't want to have test-methods generated.
+  If you prefer the all test-methods prefixed with e.g. `is_` so the methods above look like `is_male?` then you can configure this 
+  globaly by defining `CodeBox.test_method_prefix='is_'`. 
+
+
+
+In addition `acts_as_code` defines the following methods:
 
   * `.for_code(code)`  
     Answers the code object for the given code (fetched from cache)
@@ -174,18 +207,37 @@ Furthermote àcts_as_code` defines the following methods:
   * `#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.
+  * `.translate_code(codes_and_options)`  
+    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']]`)
 
   * `.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'`.
+    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_empty` is passed. If `:include_empty` is…
+
+    * `true`, then options label is derived from the I18n tranlsation of the key defined in CodeBox.i18n_empty_options_key (default is `shared.options.pls_select` - you can change this default). The value of the option is `nil` by default.
+    * `false` then no empty option is defined (default)
+    * a String then the string is used as label. The value of the option is `nil` by default.
+    * a String starting with `i18n.` the the string is considered as a tranlation key (without the `i18n.` part). Value is nil by default.
+    * is a Hash then the value is take from the Hashs value for key `:value` (nil if not present), and the label is taken from the value of key `:label` (default CodeBox.i18n_empty_option_key). If a String is present it is interpreted as a plain label or I18n key as described above.
 
-  * `.clear_code_cache`
-    <br/>Clears the cache so its build up on need from all codes from scratch
+    ``Examples
+
+    .build_select_options(include_empty: true)
+
+    is same as …
+
+    .build_select_options(include_empty: {})    
+
+    is same as …
+
+    .build_select_options(include_empty: {label: nil, value: nil})    
+
+    is same as …
+
+    .build_select_options(include_empty: {label: '<your default key in CodeBox.i18n_empty_options_key>', value: nil})    
+
+  * `.clear_code_cache`  
+    Clears the cache so its build up again lazy when needed form all codes.
 
   * Passing 
 
@@ -216,29 +268,23 @@ Assuming we have a simple ruby class with default code attribute 'code' we can d
       #   raise "Sublass responsibility. You should implement '.all' returning all codes"
       # end
 
-      # @return [Array] List if all code objects (instances of this)
+      # @return [Array] List if all code objects (instances of this) - is implemented when codes are defined.
       def self.all
-        # you need to implement this
+        raise 'Class responsibility - implement method .all returning all code models.'
       end
 
     end
 
-Configuration options are:
-
-    :type           => :poro #(default, other :active_record)
-    :code_attribute => :code #(default) or any other name as symbol
-
-
 
 #### ActiveRecod code objects (:active_record)
 
 Assuming we have an ActiveRecod code class with `code_attribute :code` we can defined such a class like
 
     class Codes::MySpecificCode < ActiveRecord::Base
-      include CodeBox::ActsAsCode[:type => :active_record]
+      include CodeBox::ActsAsCode[]
       # Above is actually a shortcut for:
       #   include CodeBox::ActsAsCode
-      #   acts_as_code(:type => :active_record)
+      #   acts_as_code
 
       # Above include creates the following:
       #
@@ -249,19 +295,31 @@ Assuming we have an ActiveRecod code class with `code_attribute :code` we can de
 
     end
 
-Configuration options are:
-
-    :type                      => :active_record # other :poro(default)
-    :code_attribute            => :code          # (default) or any other name as symbol
-    :polymorphic               => false          # (default). If `true` the uniqueness validation is scope by the attribute `type`
-    :uniqueness_case_sensitive => true           # (default). If `false` the the uniqueness validation is case insensitive
-    :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).
-
 
 
 ### Examples
   TO BE DONE…
 
+## Changelog
+
+### Version 0.5.1
+* Adding testing methods for codes objects. E.g. Code-Object with code 'my_code' get method `#codeObjectInstance.my_code?` defined.
+* Method `.build_select_options` has been changed so you can pass in more flexible empty option configuration (see Readme).
+* Ugrade of Rails 4 Version pending…
+
+### Version 0.6.0
+* Moving to activerecord 4.0.
+
+### Version 0.5.0
+* Change constant definition. Create code constants in a Codes module so the can be included in other places - an document it.
+* Remove option `:model_type. The option is obsolte and can be derived from the including module.
+
+### Version 0.4.*
+* Define constant whens defining codes.
+
+### Version 0.3.*
+* Need to scan the logs…
+
 ## Contributing
 
 1. Fork it!

data/code-box.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 require File.expand_path('../lib/code-box/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "code-box"
+  gem.name          = 'code-box'
   gem.version       = CodeBox::VERSION
 
   gem.authors       = ["Martin Schweizer"]

data/lib/code-box/acts_as_code.rb

@@ -47,21 +47,23 @@ module CodeBox
 
     module ClassMethods
       DefaultOptions = {
-          :code_attribute            => 'code',
-          :sti                       => false,
-          :uniqueness_case_sensitive => true,
-          :position_attr             => :position,
+          code_attribute:            'code',
+          sti:                       false,
+          uniqueness_case_sensitive: true,
+          position_attr:             :position,
+          define_test_methods:       true,
       }
 
       def acts_as_code(*codes_and_or_options)
-        options        = codes_and_or_options.extract_options!
-        codes          = codes_and_or_options
-        opts           = DefaultOptions.merge(options)
-        code_attr      = opts[:code_attribute].to_s
-        position_attr  = opts[:position_attribute]
-        case_sensitive = opts[:uniqueness_case_sensitive]
+        options               = codes_and_or_options.extract_options!
+        codes                 = codes_and_or_options
+        opts                  = DefaultOptions.merge(options)
+        code_attr             = opts[:code_attribute].to_s
+        position_attr         = opts[:position_attribute]
+        case_sensitive        = opts[:uniqueness_case_sensitive]
+        define_test_methods   = opts[:define_test_methods]
 
-        model_type     = self.ancestors.include?('ActiveRecord::Base'.constantize) ? :active_record : :poro
+        model_type = self.ancestors.include?('ActiveRecord::Base'.constantize) ? :active_record : :poro
 
         class_eval <<-RUBY_
           def translated_#{code_attr}(locale = I18n.locale, *options)
@@ -98,12 +100,32 @@ module CodeBox
           end
 
           def self.build_select_options(*args)
-            options     = args.extract_options!
-            codes       = args.empty? ? #{code_attr.pluralize.camelize}::All : args
-            include_nil = !!options[:include_nil]
+            options       = args.extract_options!
+            codes         = args.empty? ? #{code_attr.pluralize.camelize}::All : args
+            include_empty = options[:include_empty] || false
+            locale        = options.fetch(:locale, I18n.locale)
+
+            label, value = case include_empty
+              when Hash
+                [
+                  include_empty.fetch(:label, "i18n.#{CodeBox.i18n_empty_options_key}"),
+                  include_empty.fetch(:value, nil)
+                ]
+              when TrueClass
+                [ "i18n.#{CodeBox.i18n_empty_options_key}", nil ]
+              when String
+                [ include_empty, nil ]
+              else # is something falsish
+                []
+            end
+
 
+            # If starts with 'i18n.' it is considered an I18n key, else the label itself
             options = translate_#{code_attr}(codes, build: :zip)
-            options.unshift [I18n.t(CodeBox.i18n_empty_options_key), nil] if include_nil
+            if include_empty
+              label = I18n.t(label[5..-1], locale: locale) if label.starts_with?('i18n.')
+              options.unshift [label, value]
+            end
 
             options
           end
@@ -142,7 +164,7 @@ module CodeBox
               validates_presence_of   :#{code_attr}
               validates_uniqueness_of :#{code_attr}#{opts[:sti] ? ', :scope => :type' : ' '}, :case_sensitive => #{case_sensitive}
 
-              default_scope order('#{order_expression}')
+              default_scope -> { order('#{order_expression}') }
             CODE
 
           when :poro
@@ -156,7 +178,7 @@ module CodeBox
               end
 
               def self.all
-                raise 'Class responsibility'
+                raise 'Class responsibility - implement method .all returning all code models.'
               end
 
               def hash
@@ -175,14 +197,11 @@ module CodeBox
             raise ArgumentError, "'#{model_type}' is not a valid type. Use :active_record or :poro(default) instead"
         end
 
-        define_codes(*codes)
+        define_codes(*codes, define_test_methods) unless codes.empty?
       end
 
-      def define_codes(*codes)
-        return if codes.empty?
-
+      def define_codes(*codes, define_test_methods)
         # --- Define the code constants...
-
         code_attr   = self._code_box_code_attr_name
         model_type  = self.ancestors.include?('ActiveRecord::Base'.constantize) ? :active_record : :poro
 
@@ -204,8 +223,27 @@ module CodeBox
           codes_module.const_set('All', constants.values.compact)
         end
 
+
+        # Define test methods for each code like e.g.
+        # def married?
+        #   code == Codes::Married
+        # end
+        if define_test_methods
+          method_prefix = CodeBox.test_method_prefix
+
+          codes.each do |code|
+            method_name = "#{method_prefix}#{code.to_s}"
+            class_eval <<-CODE
+              def #{method_name}?
+                #{code_attr} == #{module_name}::#{code.to_s.camelize}
+              end
+            CODE
+          end
+        end
+
         return if model_type == :active_record
 
+
         # --- Define the code instance constants...
 
         constants = {}

data/lib/code-box/version.rb

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

data/lib/code-box.rb

@@ -5,8 +5,9 @@ require 'code-box/acts_as_code'
 
 module CodeBox
   Config = {
-  	:i18n_model_segment     => :activerecord,
-  	:i18n_empty_options_key => 'shared.options.pls_select',
+  	i18n_model_segment:     :activerecord,
+    i18n_empty_options_key: 'shared.options.pls_select',
+  	test_method_prefix:     '',
   }
 
   def i18n_model_segment=(segment)
@@ -25,5 +26,15 @@ module CodeBox
     Config[:i18n_empty_options_key]
   end
 
-  module_function :i18n_model_segment, :i18n_model_segment=, :i18n_empty_options_key, :i18n_empty_options_key=
+  def test_method_prefix=(prefix)
+    Config[:test_method_prefix] = (prefix.nil? ? '' : prefix.strip)
+  end
+
+  def test_method_prefix
+    Config[:test_method_prefix]
+  end
+
+  module_function :i18n_model_segment,     :i18n_model_segment=,
+                  :i18n_empty_options_key, :i18n_empty_options_key=,
+                  :test_method_prefix,     :test_method_prefix=
 end

data/test/code-box/test_acts_as_code.rb

@@ -57,15 +57,15 @@ class TestActsAsCode < Test::Unit::TestCase
 
   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')
+    assert Codes::CivilStatus.const_defined?('Single')
+    assert Codes::CivilStatus.const_defined?('Married')
+    assert Codes::CivilStatus.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'
+    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_translation
@@ -79,9 +79,29 @@ class TestActsAsCode < Test::Unit::TestCase
     options_array = Codes::CivilStatus.build_select_options
     assert_equal options_array.size, 2
 
-    options_array = Codes::CivilStatus.build_select_options(include_nil: true)
+    options_array = Codes::CivilStatus.build_select_options(include_empty: true)
+    assert_equal options_array.size, 3
+    assert_equal options_array.first[1], nil 
+  end
+
+  def test_options_building_with_text_label
+    options_array = Codes::CivilStatus.build_select_options(include_empty: { label: 'MyLabel' })
+    assert_equal options_array.size, 3
+    assert_equal options_array.first[0], 'MyLabel' 
+    assert_equal options_array.first[1], nil 
+  end
+
+  def test_options_building_with_custom_value
+    options_array = Codes::CivilStatus.build_select_options(include_empty: { value: 'all' })
+    assert_equal options_array.size, 3
+    assert_equal options_array.first[1], 'all' 
+  end
+
+  def test_options_building_with_custom_label_and_value
+    options_array = Codes::CivilStatus.build_select_options(include_empty: { label: 'Yaiii', value: 'all' })
     assert_equal options_array.size, 3
-    puts options_array: options_array
+    assert_equal options_array.first[0], 'Yaiii' 
+    assert_equal options_array.first[1], 'all' 
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code-box
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord