code-box 0.6.0 → 1.0.0

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3-p125
+ruby-1.9.3-p362

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/ar3_0.gemfile
+  - gemfiles/ar4_0.gemfile

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    code-box (0.5.0)
-      activerecord (~> 4.0)
+    code-box (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,18 +24,11 @@ GEM
     arel (4.0.0)
     atomic (1.1.14)
     builder (3.1.4)
-    coderay (1.0.5)
     i18n (0.6.5)
-    method_source (0.8.2)
     minitest (4.7.5)
     multi_json (1.8.0)
-    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)
+    rake (10.1.0)
+    sqlite3 (1.3.8)
     thread_safe (0.1.3)
       atomic
     tzinfo (0.3.37)
@@ -47,6 +39,5 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 4.0)
   code-box!
-  pry
   rake
   sqlite3

data/README.md

@@ -1,3 +1,11 @@
+[![Build Status](https://travis-ci.org/verticonaut/code-box.png)](https://travis-ci.org/verticonaut/code-box)
+[![Code Climate](https://codeclimate.com/github/verticonaut/code-box.png)](https://codeclimate.com/github/verticonaut/code-box)
+
+# 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.
@@ -166,6 +174,34 @@ __IMPORTANT__ Code object constants will only be created when the code object is
     end
 
 
+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)`  
@@ -179,7 +215,29 @@ In addition `acts_as_code` defines the following methods:
     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.
+
+    ``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.
@@ -247,6 +305,14 @@ Assuming we have an ActiveRecod code class with `code_attribute :code` we can de
 
 ## 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.

data/code-box.gemspec

@@ -12,12 +12,9 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Specify attributes as code and provide lookup by I18n-, cache- or associated and support for building code classes.}
   gem.homepage      = %q{http://github.com/verticonaut/code-box}
 
-  gem.add_dependency              "activerecord", "~> 4.0"
-
   gem.add_development_dependency  "activerecord", "~> 4.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/gemfiles/ar3_0.gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 3.0'
+
+group :test do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'sqlite3'
+end

data/gemfiles/ar4_0.gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 4.0'
+
+group :test do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'sqlite3'
+end

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
@@ -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.6.0"
+  VERSION = "1.0.0"
 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

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 require 'helper'
-require 'pry'
 
 class TestActsAsCode < Test::Unit::TestCase
 
@@ -57,15 +56,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 +78,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,32 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: code-box
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Martin Schweizer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,43 +30,33 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    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
@@ -90,12 +69,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .ruby-version
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - code-box.gemspec
+- gemfiles/ar3_0.gemfile
+- gemfiles/ar4_0.gemfile
 - lib/code-box.rb
 - lib/code-box/acts_as_code.rb
 - lib/code-box/code_attribute.rb
@@ -109,7 +91,6 @@ files:
 - test/resources/schema.rb
 homepage: http://github.com/verticonaut/code-box
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset
@@ -118,20 +99,22 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Specify attributes as code and provide lookup by I18n-, cache- or associated
   and support for building code classes.
 test_files:
@@ -142,3 +125,4 @@ test_files:
 - test/resources/locale/en.yml
 - test/resources/models.rb
 - test/resources/schema.rb
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: c8571a319760fdeab49de5c25b646af2c9796496
-  data.tar.gz: 70066a95056dda5b85a66eefd45b504ba359eb63
-SHA512:
-  metadata.gz: 91c1d2f6117c5e1b5b077d7a3d1311370963243198aa569e95c5f4a18f1a3a09a4bbe9f814794ccafe5a997cef9a6ca5fd8ef674b0bd6b31f59750083923ec2c
-  data.tar.gz: f62c03744f239e18854bdc98cb88ccf9ad597ecfcc2f96ca908e76daa6fcbd684696ab986a10694ac55d70d116023021d22ab71720a8699fa5c5a126d195528a