dynamic_attributes 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Reinier de Lange
+
+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,75 @@
+= dynamic_attributes
+
+dynamic_attributes is a gem that lets you dynamically specify attributes on ActiveRecord models, which will be serialized and
+deserialized to a given text column.
+
+== Requirements
+
+* Rails 2.x
+
+== Installation
+
+* config.gem 'dynamic_attributes', sudo rake gems:install
+* gem install dynamic_attributes
+
+== Usage
+
+To add dynamic_attributes to an AR model, take the following steps:
+
+* Create a migration to add a column to serialize the dynamic attributes to:
+
+    class AddDynamicAttributesToDynamicModels < ActiveRecord::Migration
+      def self.up
+        add_column :dynamic_models, :dynamic_attributes, :text
+      end
+
+      def self.down
+        remove_column :dynamic_models, :dynamic_attributes
+      end
+    end
+  
+* Add dynamic_attributes to your AR model:
+
+    class DynamicModel < ActiveRecord::Base
+      has_dynamic_attributes
+    end  
+  
+* Now you can add dynamic attributes in several ways. Examples:
+
+  - New: DynamicModel.new(:title => 'Hello', :field_summary => 'This is a dynamic attribute')
+  - Create: DynamicModel.create(:title => 'Hello', :field_summary => 'This is a dynamic attribute')
+  - Update: 
+    * dynamic_model.update_atribute(:field_summary, 'This is a dynamic attribute')
+    * dynamic_model.update_atributes(:field_summary => 'This is a dynamic attribute', :description => 'Testing')
+  - Set manually: dynamic_model.field_summary = 'This is a dynamic attribute'
+  
+== Options
+
+The has_dynamic_attribute call takes three different options:
+
+* :dynamic_attribute_field
+  - Defines the database column to serialize to.
+* :dynamic_attribute_prefix
+  - Defines the prefix that a dynamic attribute should have. All attribute assignments that start with this prefix will become dynamic attributes. Note that it's not recommended to set this prefix to the empty string; as every method call that falls through to method_missing will become a dynamic attribute.
+* :destroy_dynamic_attribute_for_nil
+  - When set to true, the module will remove a dynamic attribute when its value is set to nil. Defaults to false, causing the module to store a dynamic attribute even if its value is nil.
+
+By default, the has_dynamic_attributes call without options equals to calling: 
+
+has_dynamic_attributes :dynamic_attribute_field => :dynamic_attributes, :dynamic_attribute_prefix => 'field_', :destroy_dynamic_attribute_for_nil => false
+  
+Take a look at the code Rdoc for more information!
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Reinier de Lange. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dynamic_attributes"
+    gem.summary = %Q{Dynamic attributes is a gem that lets you dynamically specify attributes on ActiveRecord models, which will be serialized and
+deserialized to a given text column.}
+    gem.description = %Q{Dynamic attributes is a gem that lets you dynamically specify attributes on ActiveRecord models, which will be serialized and
+deserialized to a given text column. Dynamic attributes can be defined by simply setting an attribute or by passing them on create or update.}
+    gem.email = "r.j.delange@nedforce.nl"
+    gem.homepage = "http://github.com/moiristo/dynamic_attributes"
+    gem.authors = ["Reinier de Lange"]
+    gem.files = [
+      "init.rb",
+      ".document",
+      ".gitignore",
+      "LICENSE",
+      "README.rdoc",
+      "Rakefile",
+      "VERSION",
+      "lib/dynamic_attributes.rb"
+    ]
+    gem.test_files = [
+      "test/helper.rb",
+      "test/test_dynamic_attributes.rb",
+      "test/database.yml",
+      "test/schema.rb"      
+    ]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+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
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dynamic_attributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require 'dynamic_attributes'

data/lib/dynamic_attributes.rb

@@ -0,0 +1,118 @@
+
+# Adds the has_dynamic_attributes method in ActiveRecord::Base, which can be used to configure the module.
+class << ActiveRecord::Base  
+  
+  # Method to call in AR classes in order to be able to define dynamic attributes. The following options can be defined:
+  #
+  # * :dynamic_attribute_field - Defines the attribute to which all dynamic attributes will be serialized. Default: :dynamic_attributes.
+  # * :dynamic_attribute_prefix - Defines the prefix that a dynamic attribute should have. All assignments that start with this prefix will become
+  # dynamic attributes. Note that it's not recommended to set this prefix to the empty string; as every method call that falls through to method_missing 
+  # will become a dynamic attribute. Default: 'field_'
+  # * :destroy_dynamic_attribute_for_nil - When set to true, the module will remove a dynamic attribute when its value is set to nil. Defaults to false, causing
+  # the module to store a dynamic attribute even if its value is nil.
+  #
+  def has_dynamic_attributes(options = { :dynamic_attribute_field => :dynamic_attributes, :dynamic_attribute_prefix => 'field_', :destroy_dynamic_attribute_for_nil => false})
+    cattr_accessor :dynamic_attribute_field  
+    self.dynamic_attribute_field = options[:dynamic_attribute_field] || :dynamic_attributes
+    cattr_accessor :dynamic_attribute_prefix
+    self.dynamic_attribute_prefix = options[:dynamic_attribute_prefix] || 'field_'
+    cattr_accessor :destroy_dynamic_attribute_for_nil
+    self.destroy_dynamic_attribute_for_nil = options[:destroy_dynamic_attribute_for_nil] || false    
+    
+    include DynamicAttributes    
+  end
+end
+
+# The DynamicAttributes module handles all dynamic attributes.
+module DynamicAttributes
+  
+    # On saving an AR record, the attributes to be persisted are re-evaluated and written to the serialization field. 
+    def before_save
+      new_dynamic_attributes = {}
+      self.persisting_dynamic_attributes.uniq.each do |dynamic_attribute| 
+        value = send(dynamic_attribute)
+        if value.nil? and destroy_dynamic_attribute_for_nil
+          self.persisting_dynamic_attributes.delete(dynamic_attribute)
+          singleton_class.send(:remove_method, dynamic_attribute + '=')
+        else
+          new_dynamic_attributes[dynamic_attribute] = value
+        end
+      end
+      write_attribute(self.dynamic_attribute_field, new_dynamic_attributes)
+    end
+
+    # After find, populate the dynamic attributes and create accessors
+    def after_find
+      (read_attribute(self.dynamic_attribute_field) || {}).each {|att, value| set_dynamic_attribute(att, value); self.destroy_dynamic_attribute_for_nil = false if value.nil? }
+    end
+
+    # Creates an accessor when a non-existing setter with the configured dynamic attribute prefix is detected. Calls super otherwise.
+    def method_missing(method, *arguments, &block) 
+      (method.to_s =~ /#{self.dynamic_attribute_prefix}(.+)=/) ? set_dynamic_attribute(self.dynamic_attribute_prefix + $1, *arguments.first) : super
+    end 
+    
+    # Overrides the initializer to take dynamic attributes into account
+    def initialize(attributes = nil)
+      dynamic_attributes = {}
+      attributes.each{|att,value| dynamic_attributes[att] = value if att.to_s.starts_with?(self.dynamic_attribute_prefix) }
+      super(attributes.except(*dynamic_attributes.keys))   
+      set_dynamic_attributes(dynamic_attributes)    
+    end
+
+    # Overrides update_attributes to take dynamic attributes into account
+    def update_attributes(attributes)  
+      set_dynamic_attributes(attributes)  
+      super(attributes)
+    end
+    
+    # Returns the dynamic attributes that will be persisted to the serialization column. This array can
+    # be altered to force dynamic attributes to not be saved in the database or to persist other attributes, but
+    # it is recommended to not change it at all.
+    def persisting_dynamic_attributes
+      @persisting_dynamic_attributes ||= []
+    end
+    
+    # Ensures the configured dynamic attribute field is serialized by AR.
+    def self.included object
+      object.serialize object.dynamic_attribute_field
+    end
+
+  private
+
+    # Method that is called when a dynamic attribute is added to this model. It adds this attribute to the list
+    # of attributes that will be persisited, creates an accessor and sets the attribute value. To reflect that the
+    # attribute has been added, the serialization attribute will also be updated. 
+    def set_dynamic_attribute(att, value)
+      att = att.to_s
+      persisting_dynamic_attributes << att
+      singleton_class.send(:attr_accessor, att)
+      send(att + '=', value)
+      update_dynamic_attribute(att, value)
+    end
+    
+    # Called on object initialization or when calling update_attributes to convert passed dynamic attributes
+    # into attributes that will be persisted by calling set_dynamic_attribute if it does not exist already. 
+    # The serialization column will also be updated and the detected dynamic attributes are removed from the passed
+    # attributes hash.
+    def set_dynamic_attributes(attributes)
+      return if attributes.nil?
+      
+      attributes.each do |att, value| 
+        if att.to_s.starts_with?(self.dynamic_attribute_prefix)
+          attributes.delete(att)          
+          unless respond_to?(att.to_s + '=')
+            set_dynamic_attribute(att, value)           
+          else
+            send(att.to_s + '=', value); 
+            update_dynamic_attribute(att, value)
+          end
+        end    
+      end      
+    end
+    
+    # Updates the serialization column with a new attribute and value.
+    def update_dynamic_attribute(attribute, value)
+      write_attribute(self.dynamic_attribute_field.to_s, (read_attribute(self.dynamic_attribute_field.to_s) || {}).merge(attribute.to_s => value))                
+    end 
+    
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+sqlite: 
+  adapter: sqlite 
+  database: ":memory:"
+sqlite3: 
+  adapter: sqlite3 
+  database: ":memory:"

data/test/helper.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+gem "activerecord"
+require 'active_record'
+require 'dynamic_attributes'
+require 'pp'
+
+class DynamicModel < ActiveRecord::Base
+  has_dynamic_attributes :dynamic_attribute_field => :dynamic_attributes, :dynamic_attribute_prefix => 'field_', :destroy_dynamic_attribute_for_nil => false  
+end
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+  db_adapter = ENV['DB']
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||= begin
+    require 'rubygems'
+    require 'sqlite'
+    'sqlite'
+  rescue MissingSourceFile
+    begin
+      require 'sqlite3'
+      'sqlite3'
+    rescue MissingSourceFile
+    end
+  end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../init.rb'
+end  

data/test/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 0) do   
+  create_table :dynamic_models, :force => true do |t|
+    t.string :title
+    t.text :dynamic_attributes
+    t.text :extra    
+  end  
+end

data/test/test_dynamic_attributes.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class TestDynamicAttributes < Test::Unit::TestCase
+  load_schema
+  
+  def setup
+    DynamicModel.dynamic_attribute_field = :dynamic_attributes
+    DynamicModel.dynamic_attribute_prefix = 'field_'
+    DynamicModel.destroy_dynamic_attribute_for_nil = false  
+        
+    @dynamic_model = DynamicModel.create(:title => "A dynamic model")  
+  end
+  
+  def test_should_persist_nothing_by_default
+    assert_equal [], @dynamic_model.persisting_dynamic_attributes
+  end
+  
+  def test_should_create_manual_dynamic_attribute
+    @dynamic_model.field_test = 'hello'
+    assert_equal 'hello', @dynamic_model.field_test
+    assert @dynamic_model.persisting_dynamic_attributes.include?('field_test')
+    assert @dynamic_model.dynamic_attributes.keys.include?('field_test')
+  end
+  
+  def test_should_create_dynamic_attributes_for_hash
+    assert dynamic_model = DynamicModel.create(:title => 'Title', :field_test1 => 'Hello', :field_test2 => 'World')
+    assert dynamic_model.persisting_dynamic_attributes.include?('field_test1')
+    assert dynamic_model.persisting_dynamic_attributes.include?('field_test2')    
+    assert_equal 'Hello', dynamic_model.field_test1
+    assert_equal 'World', dynamic_model.field_test2    
+  end
+  
+  def test_should_update_attributes
+    @dynamic_model.update_attributes(:title => 'Title', :field_test1 => 'Hello', :field_test2 => 'World')
+    assert @dynamic_model.persisting_dynamic_attributes.include?('field_test1')
+    assert @dynamic_model.persisting_dynamic_attributes.include?('field_test2')    
+    assert_equal 'Hello', @dynamic_model.field_test1
+    assert_equal 'World', @dynamic_model.field_test2
+    
+    @dynamic_model.reload
+    assert_equal 'Hello', @dynamic_model.field_test1
+    assert_equal 'World', @dynamic_model.field_test2        
+  end
+  
+  def test_should_load_dynamic_attributes_after_find
+    DynamicModel.update_all("dynamic_attributes = '---\nfield_test: Hi!\n'", :id => @dynamic_model.id)    
+    dynamic_model = DynamicModel.find(@dynamic_model.id)
+    assert_equal 'Hi!', dynamic_model.field_test
+  end
+  
+  def test_should_set_dynamic_attribute_to_nil_if_configured
+    assert @dynamic_model.update_attribute(:field_test,nil)
+    assert_nil @dynamic_model.field_test
+    assert @dynamic_model.persisting_dynamic_attributes.include?('field_test')    
+    assert @dynamic_model.dynamic_attributes.include?('field_test')
+    
+    DynamicModel.destroy_dynamic_attribute_for_nil = true
+    assert @dynamic_model.update_attribute(:field_test,nil)
+    assert !@dynamic_model.persisting_dynamic_attributes.include?('field_test')  
+    assert !@dynamic_model.dynamic_attributes.include?('field_test')    
+    assert !@dynamic_model.respond_to?('field_test=')
+  end
+  
+  def test_should_allow_different_prefix
+    DynamicModel.dynamic_attribute_prefix = 'what_'
+    
+    @dynamic_model.what_test = 'hello'
+    assert_equal 'hello', @dynamic_model.what_test
+    assert @dynamic_model.persisting_dynamic_attributes.include?('what_test')
+    assert @dynamic_model.dynamic_attributes.keys.include?('what_test')
+        
+    assert_raises NoMethodError do
+      @dynamic_model.field_test = 'Fail'
+    end
+  end
+  
+  def test_should_allow_different_serialization_field
+    DynamicModel.dynamic_attribute_field = 'extra'
+    @dynamic_model.update_attributes(:title => 'Title', :field_test1 => 'Hello', :field_test2 => 'World')
+    assert_equal({}, @dynamic_model.dynamic_attributes)
+    assert_equal({"field_test1"=>"Hello", "field_test2"=>"World"}, @dynamic_model.extra)
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: dynamic_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Reinier de Lange
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-29 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Dynamic attributes is a gem that lets you dynamically specify attributes on ActiveRecord models, which will be serialized and
+  deserialized to a given text column. Dynamic attributes can be defined by simply setting an attribute or by passing them on create or update.
+email: r.j.delange@nedforce.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/dynamic_attributes.rb
+has_rdoc: true
+homepage: http://github.com/moiristo/dynamic_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Dynamic attributes is a gem that lets you dynamically specify attributes on ActiveRecord models, which will be serialized and deserialized to a given text column.
+test_files: 
+- test/helper.rb
+- test/test_dynamic_attributes.rb
+- test/database.yml
+- test/schema.rb