serialized-attributes 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gem 'rails', "~> 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.7"
+  gem "jeweler", "~> 1.5.2"
+	gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.7)
+  jeweler (~> 1.5.2)
+  rails (~> 3.0.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Emma Persky
+
+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,72 @@
+serialized_attributes
+=====================
+
+This is a very cool lib, allows to define dynamic serialized fields in your AR model, which acts as normal rails db columns.
+It give you full power of rails to your virtual columns: validations, rails forms, error messages, type casting
+(integer, date/time), type safety, :dirty? s, etc.. STI is supported! Basic associations is working too!
+
+Now updated for Rails 3
+
+Example of usage
+----------------
+
+### STI table def
+
+    create_table :documents do |t|
+      t.string :type
+      t.text :serialized_attributes     # <---  here all your dynamic fields will be saved
+      t.integer :reference_id           # <---  you can also define any sql columns for your indexes
+      t.timestamps
+    end
+
+### STI base model
+
+    class Document < ActiveRecord::Base
+      include SerializedAttributes
+    end
+
+### Other models..
+
+    class Post < Document
+      attribute :title, String
+      attribute :body,  String
+      attribute :is_published, Boolean, :default => false
+      
+      attribute :comment_ids, Array             # <--- serialized Array of ids of associated comments
+      has_references_to :comments
+      
+      validates_presence_of :title, :body
+    end
+    
+    class Comment < Document
+      attribute :body, String, :requied => true # <--- validates_presence_of :body
+      attribute :post_id, Integer
+      belongs_to :post
+    end
+    
+IRB fun
+-------
+
+    post = Post.create(:title => "First Post", :body => "Lorem ...")
+    assert !post.new_record?
+    post.comments = [Comment.create(:body => "this is a comment")]
+    post.comments << Comment.create(:body => "this is second comment")
+    assert_equal Comment.all.map(&:id), post.comment_ids
+    post.save
+    assert post.reload.comments.length == 2
+
+# Mass Assignment and Protect Attributes
+	class Widget < ActiveRecord::Base
+	  include SerializedAttributes
+	
+	  #protect other attributes from mass assignment
+	  attr_accessible :name
+
+		#specifically permit a given serialized attribute to be mass assigned
+	  accessible_attribute :creator, String
+	end
+
+
+# limitations
+- has-references-to association dont update reverse association
+- serialized-attributes column saved every time you call :save without depending on what is actually changed

data/Rakefile

@@ -0,0 +1,53 @@
+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 = "serialized-attributes"
+  gem.homepage = "http://github.com/emmapersky/serialized_attributes"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple serialization of row level attributes}
+  gem.description = %Q{Serialize model attributes to a single database column instead}
+  gem.email = "emma.persky@gmail.com"
+  gem.authors = ["Emma Persky"]
+  # 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/**/*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = '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 = "foo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/lib/has_references_to'
+require File.dirname(__FILE__) + '/lib/serialized_attributes'

data/lib/has_references_to.rb

@@ -0,0 +1,70 @@
+module ActiveRecord
+  module Associations
+
+    class HasReferencesToAssociation < HasManyAssociation
+      def ids
+        (@owner["#{@reflection.name.to_s.singularize}_ids"] ||= []).map(&:to_i)
+      end
+      
+      def ids=(array = [])
+        @owner["#{@reflection.name.to_s.singularize}_ids"] = array.map(&:to_i)
+      end
+      
+      def construct_sql
+        @finder_sql = "#{@reflection.quoted_table_name}.id IN (#{ids * ', '})"
+        @finder_sql << " AND (#{conditions})" if conditions
+        @counter_sql = @finder_sql
+      end
+      
+      def insert_record(record, force = false, validate = true)
+        load_target
+        set_belongs_to_association_for(record)
+        result = !record.new_record? || (force ? record.save! : record.save(:validate => validate))
+        self.ids = (ids + [record.id]) if result
+        result
+      end
+      
+      def delete_records(records)
+        self.ids = ids - records.map(&:id)
+      end
+      
+      def create(attrs = {})
+        if attrs.is_a?(Array)
+          attrs.collect { |attr| create(attr) }
+        else
+          create_record(attrs) do |record|
+            yield(record) if block_given?
+            self.ids = (ids << record.id) if record.save
+          end
+        end
+      end
+
+      def create!(attrs = {})
+        create_record(attrs) do |record|
+          yield(record) if block_given?
+          record.save!
+          self.ids = (ids << record.id)           
+        end
+      end      
+    end
+  
+    module ClassMethods
+      def create_has_references_to_reflection(association_id, options, &extension)
+        #options.assert_valid_keys(valid_keys_for_has_many_association)
+        options[:extend] = create_extension_modules(association_id, extension, options[:extend])
+        reflection = ActiveRecord::Reflection::AssociationReflection.new(:has_many, association_id, options, self)
+        write_inheritable_hash :reflections, name => reflection
+        reflection
+      end
+  
+      def has_references_to(association_id, options = {}, &extension)
+        reflection = create_has_references_to_reflection(association_id, options, &extension)
+        configure_dependency_for_has_many(reflection)
+        add_association_callbacks(reflection.name, reflection.options)
+
+        collection_accessor_methods(reflection, HasReferencesToAssociation)
+      end
+    end
+
+  end
+end

data/lib/serialized_attributes.rb

@@ -0,0 +1,89 @@
+module SerializedAttributes
+  def self.included(base)
+    return if base.respond_to?(:serialized_attributes_definition)
+
+    base.class_eval do
+      class_inheritable_hash :serialized_attributes_definition
+      write_inheritable_attribute(:serialized_attributes_definition, {})
+      cattr_accessor :serialized_attributes_column
+      self.serialized_attributes_column = :serialized_attributes
+      
+      serialize serialized_attributes_column, Hash
+    
+      
+      base.extend ClassMethods
+      include InstanceMethods
+    end
+  end
+
+  module ClassMethods
+    def serialized_attributes_definition
+      read_inheritable_attribute(:serialized_attributes_definition)
+    end
+    
+    def instantiate(record)
+      object = super(record)
+      object.unpack_serialized_attributes!
+      object
+    end
+
+    def accessible_attribute(name, type, opts = {})
+      attribute(name, type, opts.merge({:attr_accessible => true}))
+    end
+
+    def attribute(name, type, opts = {})
+      name = name.to_s
+      type = SerializedAttributes.type_to_sqltype(type)
+      serialized_attributes_definition[name] = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, opts[:default], type.to_s, nil)
+
+      define_method("#{name.to_s}=".to_sym) { |value| @attributes[name] = value }
+      define_method(name) { self.class.serialized_attributes_definition[name].type_cast(@attributes[name]) }
+      
+      attr_accessible name if opts[:attr_accessible]
+    end
+  end
+  
+  module InstanceMethods
+    def create_or_update
+      pack_serialized_attributes!
+      super
+    end
+  
+    def unpack_serialized_attributes!
+      if @attributes.has_key?(serialized_attributes_column.to_s) && attributes = (self[serialized_attributes_column] || {})
+        serialized_attributes_definition.each do |key, column|
+          loaded_value = attributes.has_key?(key) ? attributes[key] : column.default
+          @attributes[key] = attributes.has_key?(key) ? attributes[key] : column.default
+        end
+        attributes.slice!(*serialized_attributes_definition.keys)
+      end
+    end
+    
+    def pack_serialized_attributes!
+      if @attributes.has_key?(serialized_attributes_column.to_s)
+        attributes = self[serialized_attributes_column] ||= {}
+        serialized_attributes_definition.each do |key, column|
+          attributes[key] = self.send key
+        end 
+      end
+      attributes.slice!(*serialized_attributes_definition.keys)
+    end
+  end
+
+  def to_variable(sym)
+    "@#{sym.to_s}".to_sym
+  end
+  
+  def self.type_to_sqltype(type)
+    return type if type.is_a?(Symbol) 
+    {
+      String => :string, Boolean => :boolean,
+      Fixnum => :integer, Integer => :integer, BigDecimal => :decimal, Float => :float,
+      Date => :date, Time => :time, DateTime => :time
+    }[type] || type
+  end
+  
+  module Boolean
+  end
+
+end

data/test/simple_test.rb

@@ -0,0 +1,130 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'logger'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+require File.dirname(__FILE__) + "/../init"  # load plugin
+
+class DocumentsSchema < ActiveRecord::Migration
+  def self.up
+    create_table :documents do |t|
+      t.text :serialized_attributes     # <---  here all your dynamic fields will be saved
+      t.string :type
+      t.integer :reference_id           # <---  you can also define any sql columns for your indexes
+      t.timestamps
+    end
+    
+    create_table :widgets do |t|
+      t.string :name
+      t.boolean :active
+      t.text :serialized_attributes
+      t.timestamps
+    end
+  end
+end
+
+class Document < ActiveRecord::Base
+  include SerializedAttributes
+end
+
+class Post < Document
+  attribute :title, String
+  attribute :body,  String
+  attribute :is_published, Boolean, :default => false
+
+  attribute :comment_ids, Array     # <--- serialized Array of ids of associated comments
+  has_references_to :comments
+
+  validates_presence_of :title, :body
+
+end
+
+class Comment < Document
+  attribute :body, String
+  attribute :post_id, Integer
+  belongs_to :post
+
+  validates_presence_of :body
+
+end
+
+class ModelBefore < ActiveRecord::Base
+  set_table_name :documents
+end
+
+class ModelAfter < ActiveRecord::Base
+  set_table_name :documents
+  include SerializedAttributes
+  attribute :custom_field, String, :default => 'default value'
+end
+
+class ModelSecond < ActiveRecord::Base
+  set_table_name :documents
+  include SerializedAttributes
+  attribute :custom_field_renamed, String, :default => 'new default value'
+end
+
+class Widget < ActiveRecord::Base
+  include SerializedAttributes
+  
+  #white list the name attribute, others may not be mass assigned
+  attr_accessible :name, String
+end
+
+class Sprocket < Widget
+  #we want the attribute in_motion, but it may not be mass assigned
+  attribute :in_motion, Boolean
+  
+  #we want to allow the size attribute to be mass assigned
+  accessible_attribute :size, Integer
+end
+
+
+class SimpleTest < Test::Unit::TestCase
+  #ActiveRecord::Base.logger = Logger.new(STDOUT)
+  DocumentsSchema.suppress_messages{ DocumentsSchema.migrate(:up) }
+
+  def test_simple
+    post = Post.create(:title => "First Post", :body => "Lorem ...")
+    assert !post.new_record?
+    post.comments << Comment.new(:body => "this is a comment")
+    post.comments << Comment.create(:body => "this is second comment")
+    post.comments.create(:body => "one more")
+        
+    assert_equal Comment.all.map(&:id), post.comment_ids
+    post.save
+    
+    assert_equal 3, post.reload.comments.size
+  end
+  
+  
+  # => it should initialize attributes on objects even if they were serialized before that attribute existed
+  def test_null_serialized_attributes_column_on_already_exists_records
+    # => to test this, we create a model (ModelBefore) that has no attributes (but has an attributes column)
+    # => then we create second model (ModelAfter) which we force to use the same table as ModelBefore (set_table_name)
+    # => We create an object using ModelBefore and then try to load it using ModelAfter.
+    model_before = ModelBefore.create
+    model_after = ModelAfter.find(model_before.id)
+  
+    assert_equal model_after.custom_field, 'default value'
+  end
+  
+  # => it should not unpack custom attributes on objects if they have been removed
+  def test_removed_custom_field
+    # => to test this, we use a similar method to the prior test, but change (or remove) an attribute
+    model1 = ModelAfter.create
+    model2 = ModelSecond.find(model1.id)
+    model2.save!
+    model2.reload
+    
+    assert_equal model2.serialized_attributes.keys.include?('custom_field'), false
+  end
+  
+  # => it should create attributes as whitelisted and allow their mass assignment
+  def test_accessible_attributes_are_created
+    sprocket = Sprocket.create(:name => "Spacely's Space Sprocket", :size => 99)
+    assert sprocket.size == 99
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: serialized-attributes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Emma Persky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: rails
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  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
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: sqlite3
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: Serialize model attributes to a single database column instead
+email: emma.persky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- lib/has_references_to.rb
+- lib/serialized_attributes.rb
+- test/simple_test.rb
+has_rdoc: true
+homepage: http://github.com/emmapersky/serialized_attributes
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Simple serialization of row level attributes
+test_files: 
+- test/simple_test.rb