act_with_bag 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README

@@ -0,0 +1,51 @@
+ActWithBag
+==========
+
+In Gemfile:
+  gem 'act_with_bag'
+
+Bag helps when fields in a table are not yet settled down
+or when many fields without business logic are required.
+
+Install one bag in a table to collect many fields.
+Additional fields or removal of them are easy.
+No migration is required for new fields.
+
+Keep in mind that the collection is kept in a YAML bag, i.e.
+SQL commands can't access the fields.
+
+Boolean and Date fields require explicit typing, others are
+treated as string.
+
+Technical background: getters and putters are injected into models.
+If baggies of type :date are being used then
+params must be corrected before an update_attributes.
+Warning: :date fields are not well integrated; avoid them.
+
+
+Example
+=======
+
+In model:
+  class Order < ActiveRecord::Base
+    add_to_bag :name, :color, :description,
+	{:active => :boolean},
+	{:paused_at => :date}
+
+In controller:
+  class OrdersController < ApplicationController
+    def create
+      params = Order.merge({}, self.params)   # only if type :date is being used
+      @order = Order.new(params[:order])
+
+    def update
+      @order = Order.find(params[:id])
+      params = Order.merge(@order.bag, self.params) # only if type :date is being used
+
+Test
+====
+
+rake
+
+
+Copyright (c) 2009-2011 [Dittmar Krall], released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the act_with_bag plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the act_with_bag plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'act_with_bag'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/act_with_bag.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "act_with_bag/version"
+
+Gem::Specification.new do |s|
+  s.name        = "act_with_bag"
+  s.version     = ActWithBag::VERSION
+  s.authors     = ["matique"]
+  s.email       = ["dittmar.krall@matique.de"]
+  s.homepage    = "http://www.matique.de"
+  s.summary     = %q{act_with_bag (baggies) gem}
+  s.description = %q{Add a bag to a Rails model}
+
+  s.rubyforge_project = "act_with_bag"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_development_dependency "sqlite3"
+end

data/lib/act_with_bag/version.rb

@@ -0,0 +1,3 @@
+module ActWithBag
+  VERSION = "0.2.0"
+end

data/lib/act_with_bag.rb

@@ -0,0 +1,113 @@
+class << ActiveRecord::Base
+
+  def add_to_bag(*baglets)
+#p "baglets #{baglets.inspect}"
+    serialize :bag, Hash
+
+    self.class_eval %{
+      def bag=(x)
+	#bag changes disabled as it must be handled by Bag himself
+      end
+    }
+    model = model_sym
+    @baggies ||= {}
+    @baggies[model] ||= {}
+    baglets.each {|b|
+      if b.is_a?(Hash)
+	b.each {|baggie, type|
+	  @baggies[model].merge!(baggie => type)
+	  add_accessor(baggie)
+	}
+      else
+	@baggies[model].merge!(b => :string)
+	add_accessor(b)
+      end
+    }
+  end
+
+  def baggies
+    @baggies ||= {}
+    @baggies[model_sym] || {}
+  end
+
+  def merge(bag, params)
+    model = model_sym
+    return params unless params[model]
+
+    baggies.each {|baggie, type|
+      if type == :date
+	res, found, stopped = [], false, false
+	(1..3).each {|i|
+	  p = params[model].delete("#{baggie}(#{i}i)")
+	  break if p.nil?
+	  found = true
+	  stopped = true if p.empty?
+	  res << p.to_i unless stopped
+	}
+	next unless found
+  ## weird Timestamp, Hash and YAML problem
+	res = [0]  if res == []
+	res[0] = 0  unless res[0] >= 0
+
+	value = Date.new(*res) rescue value = nil
+	params[model][baggie] = value
+      end
+    }
+    params
+  end
+
+ private
+  def model_sym
+    self.to_s.underscore.to_sym
+  end
+
+  def free_accessor(str)
+    accessor = str.to_sym
+    return accessor unless self.method_defined?(accessor)
+    logger.info "** Already defined #{self.to_s}.#{accessor}"
+#p "** Bag: untouched accessor '#{self.to_s}.#{accessor}'"
+    nil
+  end
+
+  def add_accessor(baggie)
+#p "add_accessor #{self.to_s} #{baggie.inspect}"
+    accessor = free_accessor("#{baggie.to_s}")
+    if accessor
+      self.class_eval %{
+	def #{accessor}
+	  res = bag && bag[:#{baggie}]
+	  if #{self.to_s}.baggies[:#{baggie}] == :boolean
+	    return res if res.class == FalseClass
+	    return res if res.class == TrueClass
+	    return res.to_i != 0
+	  end
+	  res
+	end
+      }
+    end
+
+    accessor = free_accessor("#{baggie.to_s}=")
+    if accessor
+      self.class_eval %{
+	def #{accessor}(value)
+	  @attributes['bag'] = {}  unless bag.is_a?(Hash)
+	  self.bag.merge!(:#{baggie} => value)
+	end
+      }
+    end
+
+    return  unless baggies["#{baggie}".to_sym] == :boolean
+    accessor = free_accessor("#{baggie.to_s}?")
+    if accessor
+      self.class_eval %{
+	def #{accessor}
+	  res = bag && bag[:#{baggie}]
+	  return res if res.class == FalseClass
+	  return res if res.class == TrueClass
+	  res.to_i != 0
+	end
+      }
+    end
+  end
+
+end

data/test/bag_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+
+class Order < ActiveRecord::Base
+  add_to_bag :field, :flag => :boolean, :at => :date
+end
+
+
+class BagTest < ActiveSupport::TestCase
+
+  def setup
+    @order = Order.new
+  end
+
+  test "has a bag" do
+    assert @order.respond_to?(:bag)
+  end
+
+  test "has setters and getters" do
+    assert @order.respond_to?(:field)
+    assert @order.respond_to?(:flag)
+    assert @order.respond_to?(:at)
+
+    assert @order.respond_to?('field=')
+    assert @order.respond_to?('flag=')
+    assert @order.respond_to?('flag?')
+    assert @order.respond_to?('at=')
+  end
+
+  test "string access to field" do
+    value = 'abc'
+    @order.field = value
+    assert_equal value, @order.field
+    assert_not_equal 'def', @order.field
+  end
+
+  test "date access to at" do
+    value = DateTime.now
+    @order.at = value
+    assert_equal value, @order.at
+    assert_not_equal 'def', @order.at
+  end
+
+  test "boolean access to flag" do
+    value = true
+    @order.flag = value
+    assert_equal value, @order.flag
+    assert @order.flag?
+    assert_not_equal false, @order.flag
+
+    value = false
+    @order.flag = value
+    assert_equal value, @order.flag
+    assert !@order.flag?
+    assert_not_equal true, @order.flag
+  end
+
+  test "bag is hidden" do
+    value = 'abc'
+    @order.field = value
+    @order.bag = 'bad thing'
+    assert_equal value, @order.field
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'sqlite3',
+  :database => 'docu_test'
+})
+
+ActiveRecord::Schema.define do
+  create_table 'orders', :force => true do |t|
+    t.column 'bag', :text
+  end
+end
+
+require File.dirname(__FILE__) + '/../lib/act_with_bag.rb'

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: act_with_bag
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- matique
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70820700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70820700
+description: Add a bag to a Rails model
+email:
+- dittmar.krall@matique.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- act_with_bag.gemspec
+- lib/act_with_bag.rb
+- lib/act_with_bag/version.rb
+- test/bag_test.rb
+- test/test_helper.rb
+homepage: http://www.matique.de
+licenses: []
+post_install_message: 
+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: act_with_bag
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: act_with_bag (baggies) gem
+test_files:
+- test/bag_test.rb
+- test/test_helper.rb