code-box 0.0.1

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+tmp
+
+### Rubymine stuff
+.idea

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in code-attr.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    code-box (0.0.1)
+      activerecord (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  code-box!
+  rake
+  sqlite3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Martin Schweizer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Code::Attr
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code-attr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code-attr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rubygems'
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+require 'rdoc/task'
+require "code-box/version"
+Rake::RDocTask.new do |rdoc|
+  version = CodeBox::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "code-box #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/code-box.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.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.version       = CodeBox::VERSION
+
+  gem.authors       = ["Martin Schweizer"]
+  gem.email         = ["contact@verticonaut.me"]
+  gem.description   = %q{Specify attributes as code and provide lookup by I18n-, cache- or associated and support for building code classes.}
+  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", "~> 3.0"
+
+  gem.add_development_dependency  "activerecord", "~> 3.0"
+  gem.add_development_dependency  "sqlite3"
+  gem.add_development_dependency  "rake"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.rdoc_options  << '--charset' << 'UTF-8' << '--line-numbers'
+end
+

data/lib/code-box/acts_as_code.rb

@@ -0,0 +1,74 @@
+
+# encoding: utf-8
+
+module CodeBox
+
+  module ActsAsCode
+    @opts = {}
+
+    def self.[](options={})
+      @opts = options
+      self
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.acts_as_code(@opts)
+    end
+
+
+    module ClassMethods
+      DefaultOptions = {
+          :code_attribute            => :code,
+          :polymorphic               => false,
+          :position_attribute        => :position,
+          :uniqueness_case_sensitive => false
+      }
+
+      def acts_as_code(options={})
+        opts           = DefaultOptions.merge(options)
+        code_attr      = opts[:code_attribute]
+        position_attr  = opts[:position_attribute]
+        case_sensitive = opts[:uniqueness_case_sensitive]
+
+        order_expression = if position_attr then
+          "coalesce(#{position_attr.to_s}, #{code_attr.to_s})"
+        else
+          code_attr.to_s
+        end
+
+        class_eval <<-CODE
+          validates_presence_of   :#{code_attr}
+          validates_uniqueness_of :#{code_attr}#{opts[:polymorphic] ? ', :scope => :type' : ' '}, :case_sensitive => #{case_sensitive}
+
+          default_scope order('#{order_expression}')
+
+          def self.initialize_cache
+            all.inject({}) {|hash, obj| hash[obj.#{code_attr}] = obj; hash }
+          end
+
+          def self.for(code)
+            code_cache[code]
+          end
+
+          def hash
+            (self.class.name + '#' + #{code_attr}).hash
+          end
+
+          def equal?(other)
+            other && is_a?(other.class) && #{code_attr} == other.#{code_attr}
+          end
+        CODE
+
+        instance_eval <<-CODE
+          class << self
+            def code_cache
+              @code_cache ||= initialize_cache
+            end
+          end
+        CODE
+      end
+    end
+  end
+end
+

data/lib/code-box/code_attribute.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module CodeBox
+
+  module CodeAttribute
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+
+    module ClassMethods
+      DefaultOptions = {
+        :foreign_code_attribute => :code,
+        :lookup                 => :i18n,
+        :code_attribute_suffix  => 'code'
+      }
+
+      def code_attribute(*code_names)
+        options                = code_names.extract_options!
+        opts                   = DefaultOptions.merge(options)
+        lookup_type            = opts.delete(:lookup)
+        code_attr_suffix       = (opts.delete(:code_attribute_suffix) || "code").to_s
+        foreign_code_attr_name = opts.delete(:foreign_code_attribute)
+
+        code_names.each do |code_name|
+          opts_copy = opts.dup
+          code_attr_name  = (opts_copy.delete(:attribute_name) || "#{code_name}_#{code_attr_suffix}").to_s
+          code_class_name = opts_copy.delete(:class_name) || "::Codes::#{code_name.to_s.camelize}"
+
+          case lookup_type
+            when :cache
+              class_eval <<-RUBY_
+                # getter
+                def #{code_name}
+                  code_class_name.constantize.for(value)
+                end
+
+                # setter
+                def #{code_name}=(code)
+                  value = code.#{foreign_code_attr_name}
+                  #{code_attr_name} = value
+                end
+              RUBY_
+            when :association
+              association_options = opts_copy.merge({
+                  :class_name  => "#{code_class_name}",
+                  :foreign_key => "#{code_attr_name}".to_sym,
+                  :primary_key => "#{foreign_code_attr_name}"
+              })
+              belongs_to "#{code_name}".to_sym, association_options
+            when :i18n
+              class_eval <<-RUBY_
+                # getter
+                def #{code_name}(locale=I18n.locale)
+                  value = self.#{code_attr_name}
+                  value_key = value.nil? ? :null_value : value
+                  I18n.t("activerecord.\#{self.class.name.underscore}.values.#{code_attr_name}.\#{value_key}", :locale => locale)
+                end
+
+                # setter
+                def #{code_name}=(code)
+                  raise "#{code_name} is a i18n code and can not be set. Use the the correct method '#{code_attr_name}='' instead."
+                end
+              RUBY_
+            else
+              raise ArgumentError, "'#{lookup_type}' is not valid. Must be one of [:code_cache, :association]"
+          end
+        end
+      end
+
+      alias :belongs_to_code :code_attribute
+    end
+  end
+end

data/lib/code-box/version.rb

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

data/lib/code-box.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require File.expand_path('code-box/code_attribute', File.dirname(__FILE__))
+require File.expand_path('code-box/acts_as_code'  , File.dirname(__FILE__))
+

data/test/code-box/test_acts_as_code.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestActsAsCode < Test::Unit::TestCase
+
+  def setup
+
+  end
+
+  def test_author_attributes_available
+    assert_equal 1,1
+  end
+end

data/test/code-box/test_code_attribute.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestCodeAttribute < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_acts_as_code_i18n_lookup
+    obj = Code::SampleClass.new(gender_code: 'f', country_iso: 'de')
+
+    assert_equal('f',      obj.gender_code)
+    assert_equal('female', obj.gender)
+
+    assert_equal('de',      obj.country_iso)
+    assert_equal('Germany', obj.country)
+
+    assert_equal('f',        obj.gender_code)
+    assert_equal('weiblich', obj.gender(:de))
+
+    assert_equal('de',          obj.country_iso)
+    assert_equal('Deutschland', obj.country(:de))
+
+    # I18n.locale = :de
+
+    # assert_equal(obj.gender_code, 'f')
+    # assert_equal(obj.gender, 'weiblich')
+
+    # assert_equal(obj.country_iso, 'de')
+    # assert_equal(obj.country, 'Deutschland')
+  end
+
+
+end

data/test/helper.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'test/unit'
+require 'fileutils'
+require 'active_record'
+require 'logger'
+
+# ------------------------------------------------------
+# Setup AR environment
+# ------------------------------------------------------
+
+# Define connection info
+ActiveRecord::Base.configurations = {
+  "test" => {
+    :adapter  => 'sqlite3',
+    :database => ':memory:'
+  }
+}
+ActiveRecord::Base.establish_connection("test")
+
+# Setup logger
+tmp = File.expand_path('../../tmp', __FILE__)
+FileUtils.mkdir_p(tmp)
+ActiveRecord::Base.logger = Logger.new("#{tmp}/debug.log")
+
+# I18n
+I18n.load_path += Dir[File.expand_path('resources/locale/*.yml', File.dirname(__FILE__))]
+I18n.default_locale = :en
+
+puts :i18n_load => I18n.load_path
+
+# ------------------------------------------------------
+# Inject audit-trascer
+#   and setup test schema
+#   and define models used in tests
+# ------------------------------------------------------
+require "code-box"
+
+require "resources/schema.rb"
+require "resources/models.rb"

data/test/resources/locale/de.yml

@@ -0,0 +1,12 @@
+# encoding: utf-8
+---
+de:
+  activerecord:
+    code/sample_class:
+      values:
+        gender_code:
+          f: weiblich
+          m: männlich
+        country_iso:
+          de: Deutschland
+          ch: Schweiz

data/test/resources/locale/en.yml

@@ -0,0 +1,12 @@
+# encoding: utf-8
+---
+en:
+  activerecord:
+    'code/sample_class':
+      values:
+        gender_code:
+          f: female
+          m: male
+        country_iso:
+          de: Germany
+          ch: Switzerland

data/test/resources/models.rb

@@ -0,0 +1,13 @@
+# ------------------------------------------------------
+# Defined the respective AR Models
+# ------------------------------------------------------
+module Code
+  class SampleClass < ActiveRecord::Base
+    self.table_name = :code_sample_class
+
+    include CodeBox::CodeAttribute
+
+    code_attribute :gender
+    code_attribute :country, :lookup => :i18n, :code_attribute_suffix => 'iso'
+  end
+end

data/test/resources/schema.rb

@@ -0,0 +1,12 @@
+# ------------------------------------------------------
+# Defined the migrations
+# ------------------------------------------------------
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :code_sample_class, :force => true do |t|
+    t.string :gender_code
+    t.string :country_iso
+  end
+
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: code-box
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Schweizer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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
+    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:
+- contact@verticonaut.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- code-box.gemspec
+- lib/code-box.rb
+- lib/code-box/acts_as_code.rb
+- lib/code-box/code_attribute.rb
+- lib/code-box/version.rb
+- test/code-box/test_acts_as_code.rb
+- test/code-box/test_code_attribute.rb
+- test/helper.rb
+- test/resources/locale/de.yml
+- test/resources/locale/en.yml
+- test/resources/models.rb
+- test/resources/schema.rb
+homepage: http://github.com/verticonaut/code-box
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset
+- UTF-8
+- --line-numbers
+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: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Specify attributes as code and provide lookup by I18n-, cache- or associated
+  and support for building code classes.
+test_files:
+- test/code-box/test_acts_as_code.rb
+- test/code-box/test_code_attribute.rb
+- test/helper.rb
+- test/resources/locale/de.yml
+- test/resources/locale/en.yml
+- test/resources/models.rb
+- test/resources/schema.rb