static_list 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Novelys
+
+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.rdoc

@@ -0,0 +1,72 @@
+= Static List
+
+This module is very useful to handle static lists (like enumerations).
+
+== The problem:
+
+In your application you may want to handle things in your User model like sex (female, male) or other static lists.
+You want these lists to be handled using 'textual keys' in your application but stored in your database using codes in an integer column.
+You don't want to join other tables to display these information.
+You want these lists to be easily ordered, localized and translated using Rails i18n. You want view helpers to display these lists localized and validations helpers to validate the values in the 'receiving' model.
+
+Example :
+  (I want to store the hair color of the user...)
+
+(hair_color.rb)
+class HairColor
+  include StaticList::Model
+  static_list [[:white, 1], [:blond, 2], [:red, 3], [:light_brown, 4], [:brown, 5], [:black, 6], [:colored, 7], [:bald, 8]]
+end
+
+(user.rb)
+class User < ActiveRecord::Base
+  ...
+  include StaticList::Validate
+
+  validates_static_list_value :hair_color, HairColor, :allow_blank => true
+  ...
+end
+
+(application_helper.rb)
+module ApplicationHelper
+  ...
+  include StaticList::Helpers
+  ...
+end
+
+(_form.html.erb)
+...
+<%= f.select :hair_color, static_list_select_options(HairColor) %>
+...
+
+(show.html.erb)
+...
+<%= t_static_list(@user.hair_color, HairColor) %>
+...
+
+(en.yml)
+...
+hair_color:
+  white: white
+  blond: blond
+  red: red
+...
+
+(fr.yml)
+...
+hair_color:
+  white: blancs
+  blond: blonds
+  red: rouges
+...
+
+== Copyright
+
+Copyright (c) 2010-2011 Novelys[http://www.novelys.com]. See LICENSE.txt for details.
+
+== Contributors
+
+* {Yann Klis}[http://github.com/yannski]
+* {Nicolas Blanco}[http://github.com/slainer68]
+* {David Bourguignon}[http://github.com/dbourguignon]
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "static_list"
+  gem.homepage = "http://github.com/novelys/static_list"
+  gem.license = "MIT"
+  gem.summary = %q{This gem is very useful to handle static lists (like enumerations).}
+  gem.description = %q{
+    In your application you may want to handle things in your User model like sex (female, male) or other static lists.
+    You want these lists to be handled using 'textual keys' in your application but stored in your database using codes in an integer column.
+  }
+  gem.email = "yann.klis@novelys.com"
+  gem.authors = ["Yann Klis"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "static_list #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/core_ext/concern.rb

@@ -0,0 +1,30 @@
+module ActiveSupport
+  module Concern
+    def self.extended(base)
+      base.instance_variable_set("@_dependencies", [])
+    end
+
+    def append_features(base)
+      if base.instance_variable_defined?("@_dependencies")
+        base.instance_variable_get("@_dependencies") << self
+        return false
+      else
+        return false if base < self
+        @_dependencies.each { |dep| base.send(:include, dep) }
+        super
+        base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
+        base.send :include, const_get("InstanceMethods") if const_defined?("InstanceMethods")
+        base.class_eval(&@_included_block) if instance_variable_defined?("@_included_block")
+      end
+    end
+
+    def included(base = nil, &block)
+      if base.nil?
+        @_included_block = block
+      else
+        super
+      end
+    end
+  end
+end
+

data/lib/static_list.rb

@@ -0,0 +1,99 @@
+if Rails::VERSION::MAJOR < 3
+  require "core_ext/concern"
+end
+
+class Hashit
+  def initialize(hash)
+    hash.each do |k,v|
+      self.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+      self.class.send(:define_method, k, proc{self.instance_variable_get("@#{k}")})  ## create the getter that returns the instance variable
+      self.class.send(:define_method, "#{k}=", proc{|v| self.instance_variable_set("@#{k}", v)})  ## create the setter that sets the instance variable
+    end
+  end
+end
+
+module StaticList
+  module Validate
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      # Method to validate in the receiving model that the value received is included in the static list model.
+      # For example :
+      # with_options(:allow_blank => true) do |options|
+      #   options.validate_static_list_value :hair_color,          HairColor
+      #   options.validate_static_list_value :ethnicity,           Ethnicity
+      #   options.validate_static_list_value :sex,                 Sex
+      # end
+      def validates_static_list_value(attribute, model, options = {})
+        options.merge!(:in => model.static_list_codes.map { |el| el[1] })
+        validates_inclusion_of attribute, options
+      end
+    end
+  end
+  
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :static_list_codes
+    end
+    
+    module ClassMethods
+      # Returns all elements of the static list
+      def all
+        static_list_codes.map{|x| Hashit.new(Hash[*["name", I18n.t("#{self.to_s.demodulize.underscore}.#{x.first.to_s}"), "id", x.last]])}
+      end
+
+      # Method to declare the static list in the static list model.
+      def static_list(list)
+        self.static_list_codes = list
+      end
+      
+      # Returns the symbol associated with the code in parameter.
+      #
+      # For example : HairColor.static_list_code_to_sym(0) # => :white
+      #
+      def static_list_code_to_sym(code)
+        static_list_codes.find { |el| el[1] == code }[0]
+      end
+      
+      def t_symbol(code)
+        "#{self.to_s.demodulize.underscore}.#{self.static_list_code_to_sym(code)}"
+      end
+      
+      def to_code(sym)
+        static_list_codes.find { |el| el[0] == sym }[1]
+      end
+      
+      def static_codes
+        static_list_codes.map{ |e| e[0] }
+      end
+      
+      def static_keys
+        static_list_codes.map{ |e| e[1] }
+      end
+    end
+  end
+  
+  module Helpers
+    # Localizes a static code
+    # For example :
+    # t_static_list(@user.hair_color, HairColor)
+    #
+    # will read the key hair_color.white
+    #
+    def t_static_list(code, static_object)
+      return unless code
+      t "#{static_object.to_s.demodulize.underscore}.#{static_object.static_list_code_to_sym(code)}"
+    end
+
+    # Localizes all the static codes for select options helper
+    #
+    # Example :
+    # f.select :hair_color, static_list_select_options(HairColor)
+    #
+    def static_list_select_options(static_object)
+      static_object.static_list_codes.map { |code| [t_static_list(code[1], static_object), code[1]] }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'static_list'
+
+class Test::Unit::TestCase
+end

data/test/test_static_list.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestStaticList < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: static_list
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yann Klis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id004
+description: "\n    In your application you may want to handle things in your User model like sex (female, male) or other static lists.\n    You want these lists to be handled using 'textual keys' in your application but stored in your database using codes in an integer column.\n  "
+email: yann.klis@novelys.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/core_ext/concern.rb
+- lib/static_list.rb
+- test/helper.rb
+- test/test_static_list.rb
+has_rdoc: true
+homepage: http://github.com/novelys/static_list
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: This gem is very useful to handle static lists (like enumerations).
+test_files: 
+- test/helper.rb
+- test/test_static_list.rb