ChristophPetschnig-constantrecord 0.0.2

data/Manifest

@@ -0,0 +1,6 @@
+constantrecord.gemspec
+lib/constantrecord.rb
+test/constantrecord_test.rb
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc

@@ -0,0 +1,87 @@
+= ConstantRecord
+
+== Usage
+
+  class Currency < ConstantRecord::Base
+    data 'EUR', 'USD', 'CAD', 'GBP', 'CHF'
+  end
+
+or
+
+  class MoreDetailedCurrency < ConstantRecord::Base
+    columns :short, :description
+    data ['EUR', 'Euro'],
+         ['USD', 'United States dollar'],
+         ['CAD', 'Canadian dollar'],
+         ['GBP', 'British pound sterling'],
+         ['CHF', 'Swiss franc']
+  end
+
+
+Inside ActiveRecord, it works just like a "normal" ActiveRecord association:
+
+  class Invoice < ActiveRecord::Base
+    belongs_to :currency   # via currency_id database column
+
+    def print_currency
+      # Currency#name is the default attribute
+      puts self.currency.name if self.currency
+    end
+  end
+
+ConstantRecord is meant as a substitute for ActiveRecord for tables, that will
+never change in the lifespan of a mongrel process. I.e. an application might
+let the user select a state of the US. Most applications will never have a
+feature where a user/admin can edit the list of US states. They are considered
+constant.
+
+In my current application, my main/parent class has about 35 child classes,
+that use over 40 different constant classes. The use of ConstantRecord meant
+an estimated 15 to 20 per cent speed gain for my application.
+
+ConstantRecord classes don't need accociations:
+
+  class CanadianProvince < ConstantRecord::Base
+    data = 'Alberta', ...
+    has_many :people  # is not necessary, will not work
+  end
+
+If you want to fetch all people living in Alberta, use:
+
+  Person.find(:all, :conditions =>
+    {:province_id => CanadianProvince.find_by_name('Alberta').id}
+
+If you ever think, ConstantRecord lacks key features of ActiveRecord, (submit
+a patch or) create the table and derive you class from ActiveRecord instead.
+This is a key design objective for ConstantRecord.
+
+== Features
+
+  Currency.find(1)              >>  #<Currency:0x332cbf4 @id=1, @name="EUR">
+
+Just as in a database table, #id starts with 1.
+When +data+ is a simple Array, #name is the default attribute.
+
+  MoreDetailedCurrency.find(3)  >>  #<MoreDetailedCurrency:0x2c8d94c 
+                                      @description="Canadian Dollar", 
+                                      @id=3, @short="CAD">
+
+  Currency.find_by_name('CHF')  >>  #<Currency:0x2c86ef8 @id=3, @name="CHF">
+
+  MoreDetailedCurrency.find_by_short('CAD')
+                                >>  #<MoreDetailedCurrency:0x2c8d94c 
+                                      @description="Canadian Dollar", 
+                                      @id=3, @short="CAD">
+
+  Currency.count :all           >>  5
+
+
+As a matter of fact, a ConstantRecord will often be used as a select field in a
+HTML form. Therefore it comes with a special feature, that is not ActiveRecord
+compatible. In a Form you can use:
+
+  <%= f.select :currency_id, Currency.options_for_select %>
+
+or
+
+  <%= f.select :currency_id, Currency.options_for_select(:include_null => true) %>

data/Rakefile

@@ -0,0 +1,23 @@
+# Rakefile for constantrecord
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('constantrecord', '0.0.1') do |p|
+  p.description = "A tiny ActiveRecord substitute for small, never changing database tables."
+  p.url = "http://github.com/ChristophPetschnig/constantrecord"
+  p.author = "Christoph Petschnig"
+  p.email = "info@purevirtual.de"
+  p.ignore_pattern = ["tmp/*", "script/*", "rdoc/*", "pkg/*"]
+  p.development_dependencies = []
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README.rdoc|^CHANGELOG|^TODO|^MIT-LICENSE|^COPYING$/
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+
+task :default => :test
+
+require 'rake/testtask'
+
+

data/constantrecord.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{constantrecord}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Petschnig"]
+  s.date = %q{2009-03-15}
+  s.description = %q{A tiny ActiveRecord substitute for small, never changing database tables.}
+  s.email = %q{}
+  s.extra_rdoc_files = ["lib/constantrecord.rb", "README.rdoc"]
+  s.files = ["lib/constantrecord.rb", "test/constantrecord_test.rb", "Rakefile",
+    "README.rdoc", "Manifest", "constantrecord.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ChristophPetschnig/constantrecord}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Constantrecord", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{constantrecord}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A tiny ActiveRecord substitute for small, never changing database tables.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/constantrecord.rb

@@ -0,0 +1,296 @@
+#--
+# Copyright (c) 2009 Christoph Petschnig
+#
+# 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.
+#++
+
+module ConstantRecord  #:nodoc:
+  # ConstantRecord::Base is a tiny ActiveRecord substitute for small, never
+  # changing database tables.
+  #
+  # == Usage:
+  # 
+  #   class Currency < ConstantRecord::Base
+  #     data 'EUR', 'USD', 'CAD', 'GBP', 'CHF'
+  #   end
+  #
+  # or
+  #
+  #   class MoreDetailedCurrency < ConstantRecord::Base
+  #     columns :short, :description
+  #     data ['EUR', 'Euro'],
+  #          ['USD', 'US Dollar'],
+  #          ['CAD', 'Canadian Dollar'],
+  #          ['GBP', 'British Pound sterling'],
+  #          ['CHF', 'Swiss franc']
+  #   end
+  #
+  # To show all records in a HTML select field, use:
+  #
+  #   <%= f.select :currency_id, Currency.options_for_select %>
+  #
+  class Base
+
+  private
+    attr_writer :id, :name  #:nodoc:
+
+  public
+    attr_reader :id, :name  #:nodoc:
+
+    # Set the column names of the constant table.
+    # Default is one column called `name`
+    def self.columns(*args)
+      # remove the default column name
+      undef_method :name
+
+      i = 0
+      col_ar = args.collect do |column|
+        raise TypeError.new("You can only pass Symbol or String object to #{self}::columns.") unless column.kind_of?(Symbol) || column.kind_of?(String)
+
+        class_eval do
+          private
+              attr_writer column
+          public
+              attr_reader column
+        end
+
+        i += 1
+        [column.to_sym, i - 1]
+      end.flatten
+
+      @columns = Hash[*col_ar]
+    end
+
+    # Set the data. Arguments must be an Array.
+    def self.data(*args)
+      @data = args.collect{|arg| arg.kind_of?(Array) ? arg : [arg]}
+    end
+
+    # Constructor. Call with the <tt>id</tt> plus a list of the values.
+    #
+    #   MyConstantRecord.new(1, 'value of column #1', 2, 3.333)
+    #
+    def initialize(id, *values)
+      @id = id
+
+      return if values.empty?
+
+      #  set the instance variables
+      get_columns.each do |key, value|
+        instance_variable_set("@#{key}", values[value])
+      end
+    end
+
+    # Implement +find+. Warning: <tt>:conditions</tt> are only supported with <tt>:first</tt>!
+    def self.find(*args)
+      selector = args[0]
+
+      #  find might get called on constant_record_id.nil? == true
+      return nil if selector.nil?
+
+      raise TypeError.new("#{self}.find failed!\nArguments: #{args.inspect}") unless selector.kind_of?(Symbol) || selector.kind_of?(Fixnum)
+
+      if selector == :first
+        conditions = args[1][:conditions]
+
+        raise TypeError.new("#{self}.find failed!\nArguments: #{args.inspect}") unless conditions.kind_of?(Hash) && conditions.size == 1
+
+        compare_col_nr = get_columns[conditions.keys[0]]
+        raise "Unknown column :#{conditions.keys[0]}" unless compare_col_nr
+
+        @data.each_with_index do |datum, i|
+          return self.new(i, *datum) if datum[compare_col_nr] == conditions.values[0]
+        end
+
+        return nil
+      end
+
+      #  ignore conditions on :all
+      return find_all if selector == :all
+
+      #  ignore conditions if id is given as the first argument
+      return find_by_id(selector) if selector.kind_of?(Fixnum)
+
+      raise "#{self}.find failed!\nArguments: #{args.inspect}"
+    end
+
+    # Implement +count+. Warning: <tt>:conditions</tt> are not supported!
+    def self.count(*args)
+      selector = args[0] || :all
+      raise TypeError.new("#{self}.count failed!\nArguments: #{args.inspect}") unless selector.kind_of?(Symbol)
+
+      #  ignore conditions on :all
+      return @data.size if selector == :all
+
+      raise "#{self}.count failed!\nArguments: #{args.inspect}"
+    end
+
+    # A ConstantRecord will never be a new record
+    def new_record?  #:nodoc:
+      false
+    end
+
+    # A ConstantRecord should never be empty
+    def empty?  #:nodoc:
+      false
+    end
+
+    # Keep this to spot problems in integration with ActiveRecord
+    def method_missing(symbol, *args)  #:nodoc:
+      p "ConstantRecord::Base#method_missing(#{symbol})"
+      super symbol, *args
+    end
+
+    # Keep this to spot problems in integration with ActiveRecord
+    def respond_to?(symbol)  #:nodoc:
+      result = super(symbol)
+      p "ConstantRecord::Base#respond_to?(#{symbol}) => #{result}(#{self.class})" unless result
+      result
+    end
+
+    # Handle +find_by_xxx+ calls on the class
+    def self.method_missing(symbol, *args)  #:nodoc:
+      if /^find_by_([_a-zA-Z]\w*)$/ =~ (symbol.to_s)
+        return find(:first, :conditions => {$1.to_sym => args[0]})
+      end
+      p "ConstantRecord::Base::method_missing(#{symbol})"
+      super symbol, *args
+    end
+
+    # Keep this to spot problems in integration with ActiveRecord
+    def self.respond_to?(symbol)  #:nodoc:
+      result = super symbol
+      p "ConstantRecord::Base::respond_to?(#{symbol}) => #{result}(#{self.class})" unless result
+      result
+    end
+
+    # Creates options for a select box in a form. The result is basically the same as
+    # the following code with ActiveRecord:
+    # 
+    #  MyActiveRecord.find(:all).collect{|obj| [obj.name, obj.id]}
+    #
+    # === Usage
+    #
+    # With the class:
+    #
+    #  class Currency < ConstantRecord::Base
+    #    columns :short, :description
+    #    data ['EUR', 'Euro'],
+    #         ['USD', 'US Dollar']
+    #  end
+    #
+    # The following erb code:
+    #
+    #  <%= f.select :currency_id, Currency.options_for_select %>
+    #
+    # Results to:
+    #
+    #  <select id="invoice_currency_id" name="invoice[currency_id]">
+    #    <option value="1">EUR</option>
+    #    <option value="2">USD</option>
+    #  </select>
+    #
+    # While:
+    #
+    #  <%= f.select :currency_id, Currency.options_for_select(
+    #    :display => Proc.new { |obj| "#{obj.short} (#{obj.description})" },
+    #    :value => :short, :include_null => true,
+    #    :null_text => 'Please choose one', :null_value => nil ) %>
+    #
+    # Results to:
+    #
+    #  <select id="invoice_currency_id" name="invoice[currency_id]">
+    #    <option value="">Please choose one</option>
+    #    <option value="EUR">EUR (Euro)</option>
+    #    <option value="USD">USD (US Dollar)</option>
+    #  </select>
+    #
+    # === Options
+    # 
+    # [:display]
+    #   The attribute to call to display the text in the select box or a Proc object.
+    # [:value]
+    #   The value to use for the option value. Default is the id of the record.
+    # [:include_null]
+    #   Make an entry with the value 0 in the selectbox. Default is +false+.
+    # [:null_text]
+    #   The text to show with on value 0. Default is '-'.
+    # [:null_value]
+    #   The value of the null option. Default is 0.
+    def self.options_for_select(options = {})
+      display = options[:display] || get_columns.invert[0]
+      raise "#{self}.options_for_select: :display must be either Symbol or Proc." unless display.kind_of?(Symbol) ||display.kind_of?(Proc)
+
+      if display.kind_of?(Symbol)
+        display_col_nr = get_columns[display]
+        raise "Unknown column :#{display}" unless display_col_nr
+      end
+
+      value = options[:value] || :id
+
+      i = 0
+      result = @data.collect do |datum|
+        i += 1
+        obj = self.new(i, *datum)
+        option_show = display.kind_of?(Symbol) ? datum[display_col_nr] : display.call(obj)
+        option_value = value == :id ? i : obj.send(value)
+
+        [option_show, option_value]
+      end
+
+      if options[:include_null] == true
+        result.unshift [ options[:null_text] || '-', options.key?(:null_value) ? options[:null_value] : 0 ]
+      end
+
+      result
+    end
+
+    private
+
+    # Get the name of the columns or the default value
+    def self.get_columns
+      #  if columns were not set, the default value is one column
+      #  with the name of "name"
+      @columns || { :name => 0 }
+    end
+
+    def get_columns  #:nodoc:
+      self.class.get_columns
+    end
+
+    # Implementation of +find+(:all)
+    def self.find_all  #:nodoc:
+      i = 0
+      @data.collect do |datum|
+        i += 1
+        self.new(i, *datum)
+      end
+    end
+
+    # Implementation of +find+(:id)
+    def self.find_by_id(id)  #:nodoc:
+      # check for valid range of selector
+      return nil if id <= 0 || id > @data.size
+
+      self.new(id, *@data[id - 1])
+    end
+
+  end
+end

data/test/constantrecord_test.rb

@@ -0,0 +1,84 @@
+require 'constantrecord'
+require 'test/unit'
+
+class SimpleClass < ConstantRecord::Base
+  data 'Lithuania', 'Latvia', 'Estonia'
+end
+
+class SimpleClass2 < ConstantRecord::Base
+  columns :album
+  data 'Sgt. Pepper', 'Magical Mystery Tour', 'Abbey Road'
+end
+
+class MultiColumnClass < ConstantRecord::Base
+  columns :short, :description
+  data ['EUR', 'Euro'],
+       ['USD', 'US Dollar'],
+       ['CAD', 'Canadian Dollar'],
+       ['GBP', 'British Pound sterling'],
+       ['CHF', 'Swiss franc']
+end
+
+class TestConstantRecord < Test::Unit::TestCase
+  def test_simple_finder
+    assert_equal 'Estonia', SimpleClass.find(3).name
+    assert_equal 3, SimpleClass.find(3).id
+    assert_nil SimpleClass.find(4)
+    assert_nil SimpleClass.find(0)
+    assert_nil SimpleClass.find(nil)
+    assert_equal 'Estonia', SimpleClass.find_by_name('Estonia').name
+    assert_equal 3, SimpleClass.find_by_name('Estonia').id
+    assert_raise (RuntimeError) { SimpleClass.find_by_foo('bar') }
+    assert_equal [ 'Lithuania', 'Latvia', 'Estonia' ], SimpleClass.find(:all).collect{|o| o.name}
+    assert_equal [ 1, 2, 3 ], SimpleClass.find(:all).collect{|o| o.id}
+    assert_equal 3, SimpleClass.count
+  end
+  
+  def test_simple_finder_with_custom_column_name
+    assert_equal 'Abbey Road', SimpleClass2.find(3).album
+    assert_equal 3, SimpleClass2.find(3).id
+    assert_nil SimpleClass2.find(4)
+    assert_nil SimpleClass2.find(0)
+    assert_nil SimpleClass2.find(nil)
+    assert_equal 'Sgt. Pepper', SimpleClass2.find_by_album('Sgt. Pepper').album
+    assert_equal 1, SimpleClass2.find_by_album('Sgt. Pepper').id
+    assert_raise (RuntimeError) { SimpleClass2.find_by_name('Sgt. Pepper') }
+    assert_equal [ 'Sgt. Pepper', 'Magical Mystery Tour', 'Abbey Road' ], SimpleClass2.find(:all).collect{|o| o.album}
+    assert_equal [ 1, 2, 3 ], SimpleClass2.find(:all).collect{|o| o.id}
+    assert_equal 3, SimpleClass2.count
+  end
+
+  def test_multi_column_finder
+    all = MultiColumnClass.find(:all)
+    chf = all[4]
+    assert 5 == chf.id && chf.short && 'Swiss franc' == chf.description
+
+    assert_equal 'Canadian Dollar', MultiColumnClass.find_by_short('CAD').description
+    assert_equal 3, MultiColumnClass.find_by_short('CAD').id
+
+    assert_nil MultiColumnClass.find(6)
+    assert_nil MultiColumnClass.find(0)
+    assert_nil MultiColumnClass.find(nil)
+    assert_raise (RuntimeError) { MultiColumnClass.find_by_name('EUR') }
+    assert_equal [ 'EUR', 'USD', 'CAD', 'GBP', 'CHF' ], MultiColumnClass.find(:all).collect{|o| o.short}
+    assert_equal [ 1, 2, 3, 4, 5 ], MultiColumnClass.find(:all).collect{|o| o.id}
+    assert_equal 5, MultiColumnClass.count
+  end
+
+  def test_options_for_select
+    assert_equal [['Lithuania', 1], ['Latvia', 2], ['Estonia', 3]], SimpleClass.options_for_select
+    assert_equal [['n/a', 0], ['Lithuania', 1], ['Latvia', 2], ['Estonia', 3]],
+      SimpleClass.options_for_select(:include_null => true, :null_text => 'n/a')
+    assert_equal [['-', nil], ['Lithuania', 1], ['Latvia', 2], ['Estonia', 3]],
+      SimpleClass.options_for_select(:include_null => true, :null_value => nil)
+    assert_equal [['Euro', 1], ['US Dollar', 2], ['Canadian Dollar', 3],
+      ['British Pound sterling', 4], ['Swiss franc', 5]],
+      MultiColumnClass.options_for_select(:display => :description)
+    assert_equal [['-', "nothn'"], ['Euro', 'EUR'], ['US Dollar', 'USD'],
+      ['Canadian Dollar', 'CAD'], ['British Pound sterling', 'GBP'], ['Swiss franc', 'CHF']],
+      MultiColumnClass.options_for_select(:display => :description, :value => :short,
+        :include_null => true, :null_value => "nothn'")
+    assert_equal [['*Sgt. Pepper*', 1], ['*Magical Mystery Tour*', 2], ['*Abbey Road*', 3]],
+      SimpleClass2.options_for_select(:display => Proc.new{|obj| "*#{obj.album}*"})
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: ChristophPetschnig-constantrecord
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Christoph Petschnig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-15 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A tiny ActiveRecord substitute for small, never changing database tables.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/constantrecord.rb
+- README.rdoc
+files: 
+- lib/constantrecord.rb
+- test/constantrecord_test.rb
+- Rakefile
+- README.rdoc
+- Manifest
+- constantrecord.gemspec
+has_rdoc: true
+homepage: http://github.com/ChristophPetschnig/constantrecord
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Constantrecord
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: constantrecord
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A tiny ActiveRecord substitute for small, never changing database tables.
+test_files: []
+