metabolical 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in metabolical.gemspec
+gemspec
+group :test do
+  gem 'activerecord'
+  gem 'sqlite3'
+  gem 'shoulda'
+end

data/README.rdoc

@@ -0,0 +1,30 @@
+= Metabolical
+
+Metabolical is an ActiveRecord Model & mixin that adds metadata to your AR classes.
+Whenever you feel like adding a column to a table ask yourself if what you really want is just some metadata.
+
+== Install
+
+  gem install metabolical
+
+== Usage
+
+  class User < ActiveRecord::Base
+    metabolize!
+  end
+  
+  user = User.new
+  user.metas['active'] = true
+  user.metas['active'].data #=> true
+  
+== Notes
+
+Metabolical will need you to run the following migration
+
+  create_table :meta_data, :force => true do |t|
+    t.integer :metabolized_id
+    t.string  :metabolized_type
+    t.string  :key
+    t.text    :data
+    t.timestamps
+  end

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+
+
+task :default => :test
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+# ROOT       = File.expand_path(File.dirname(__FILE__))
+# TEST_ROOT = ROOT + "/test"
+# MODELS_ROOT     = TEST_ROOT + "/models"
+# FIXTURES_ROOT   = TEST_ROOT + "/fixtures"
+# MIGRATIONS_ROOT = TEST_ROOT + "/migrations"
+# SCHEMA_ROOT     = TEST_ROOT + "/schema"
+# 
+# ActiveRecord::Base.establish_connection(
+#   :adapter => "sqlite3",
+#   :database  => "db/test.sqlite3"
+# )
+# load SCHEMA_ROOT + "/schema.rb"

data/lib/metabolical.rb

@@ -0,0 +1,29 @@
+require 'metabolical/meta_datum'
+require 'metabolical/scopes'
+
+module Metabolical
+  def self.included(klass)
+    klass.extend ClassMethods    
+  end  
+  
+  module ClassMethods
+    def metabolize!
+      include Metabolical::Scopes
+      
+      class_eval do
+        has_many :metas, :as => :metabolized, :class_name => 'Metabolical::MetaDatum' do
+          def [](key)
+            find_by_key(key) || self.proxy_owner.metas.detect{|m| m.key == key}
+          end
+          
+          def []=(key, data)
+            meta = self[key] || self.proxy_owner.metas.build(:key => key)
+            meta.data = data
+            meta
+          end
+        end
+      end
+    end
+  end
+    
+end

data/lib/metabolical/meta_datum.rb

@@ -0,0 +1,6 @@
+module Metabolical
+  class MetaDatum < ActiveRecord::Base
+    belongs_to :metabolized, :polymorphic => true
+    serialize :data
+  end
+end

data/lib/metabolical/scopes.rb

@@ -0,0 +1,26 @@
+module Metabolical
+  module Scopes
+    def self.included(klass)
+        method = klass.respond_to?(:named_scope) ? :named_scope : :scope
+        klass.send method, :with_meta, lambda{|k| {:joins => [:metas], :conditions => {"meta_data.key" => k}}}
+        klass.send method, :with_metas, :includes => [:metas]
+        klass.send method, :with_meta_data, lambda{|k, v| {:joins => [:metas], :conditions => {"meta_data.key" => k, "meta_data.data" => v.to_yaml}}}
+        klass.send method, :without_meta, lambda{|k| 
+          {:joins => [:metas], 
+           :conditions => ["meta_data.metabolized_id not in (?)", 
+           klass.send(:with_meta, k).all(:select => 'distinct(metabolized_id)').map(&:metabolized_id)]}
+        }        
+    end
+    
+    module AR3Scopes
+      def self.included(klass)
+        class_eval do
+          scope :with_meta, lambda{|k| joins([:meta]).where({"meta_data.key" => k}) }
+          scope :with_metas, includes(:meta)
+          scope :with_meta_data, lambda{|k, v| joins(:meta).where("meta_data.key" => k, "meta_data.data" => v.to_yaml)}
+        end
+      end
+    end
+    
+  end
+end

data/lib/metabolical/version.rb

@@ -0,0 +1,3 @@
+module Metabolical
+  VERSION = "0.0.1"
+end

data/metabolical.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "metabolical/version"
+
+Gem::Specification.new do |s|
+  s.name        = "metabolical"
+  s.version     = Metabolical::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Diego Scataglini"]
+  s.email       = ["diego@junivi.com"]
+  s.homepage    = ""
+  s.summary     = %q{This is an ActiveRecord Model & mixin to add meta data to any AR object}
+  s.description = %q{This is an ActiveRecord Model & mixin to add meta data to any AR object}
+  
+  s.required_ruby_version = '>= 1.8.7'
+  
+  s.rubyforge_project = "metabolical"
+
+  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"]
+
+  s.add_dependency('activerecord',  '>= 2.1.2')
+  s.add_dependency('activesupport', '>= 2.1.2')
+  s.add_dependency('activemodel',   '>= 2.1.2')
+  s.add_dependency('arel',          '~> 2.0.10')
+  s.add_dependency('tzinfo',        '~> 0.3.23')
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+require 'test/unit'
+require 'shoulda'
+
+TEST_ROOT       = File.expand_path(File.dirname(__FILE__))
+MODELS_ROOT     = TEST_ROOT + "/models"
+FIXTURES_ROOT   = TEST_ROOT + "/fixtures"
+MIGRATIONS_ROOT = TEST_ROOT + "/migrations"
+SCHEMA_ROOT     = TEST_ROOT + "/schema"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => "db/test.sqlite3"
+)
+
+load SCHEMA_ROOT + "/schema.rb"

data/test/metabolical_test.rb

@@ -0,0 +1,96 @@
+require 'helper'
+require 'models/user'
+
+class MetabolicalTest < Test::Unit::TestCase
+  context "an ActiveRecord Object" do
+
+    context "new record" do
+      setup do
+        @user = User.new
+      end
+      
+      teardown do
+        @user.destroy
+      end
+      
+      should "be able to assign a single meta before saving and retrieving it after save" do
+        @user.metas['foo'] = 'bar'
+        @user.save
+        assert_equal 'bar', @user.metas['foo'].data
+      end
+      
+      should "be able to assign a single meta before saving and retrieving it before save" do
+        @user.metas['foo'] = 'bar'
+        assert_equal 'bar', @user.metas['foo'].data
+      end
+    end
+    
+    context "saved record" do
+      setup do
+        @user = User.new
+        @user.save
+      end
+      
+      teardown do
+        @user.destroy
+      end
+      
+      should "be able to assign a single meta before re saving and retrieving it after save" do
+        @user.metas['foo'] = 'bar'
+        @user.save
+        assert_equal 'bar', @user.metas['foo'].data
+      end
+      
+      should "be able to assign a single meta before re saving and retrieving it before save" do
+        @user.metas['foo'] = 'baz'
+        assert_equal 'baz', @user.metas['foo'].data
+      end
+      
+      should "be able to retrieve after saving" do
+        @user.metas['foo'] = 'faz'
+        @user.save
+        user = User.find @user.id
+        assert_equal 'faz', user.metas['foo'].data
+      end
+      
+    end
+    
+    context "named scopes" do
+      setup do
+        @foo_user = User.create(:name => 'foo_user', :metas => [Metabolical::MetaDatum.new(:key => "foo", :data => "bar")])
+        @bar_user = User.create(:name => 'bar_user', :metas => [Metabolical::MetaDatum.new(:key => "bar", :data => "baz"),
+                                          Metabolical::MetaDatum.new(:key => "fuu", :data => "bar")])
+        @true_user = User.create(:name => 'true_user', :metas => [Metabolical::MetaDatum.new(:key => "bar", :data => true)])
+      end
+      
+      teardown do
+        User.delete_all
+      end
+      
+      should "have with_meta scopes" do
+        assert_equal [@foo_user], User.with_meta("foo")
+        assert_equal [@bar_user, @true_user], User.with_meta("bar")
+      end
+      
+      should "have with_meta scopes that check for data" do
+        assert_equal [], User.with_meta_data("foo", "foo")
+        assert_equal [@foo_user], User.with_meta_data("foo", "bar"), "Should have brought back foo user"
+        assert_equal [@true_user], User.with_meta_data("bar", true), "Should have brought back true user"
+      end
+      
+      should "have with_metas scope that includes all metas" do
+        assert User.respond_to?(:with_metas)
+      end
+      
+      should "bring back objects without a certain meta" do
+        assert_equal [@foo_user], User.without_meta("bar")
+      end
+      
+      
+
+    end
+    
+
+  end
+  
+end

data/test/models/user.rb

@@ -0,0 +1,5 @@
+require 'metabolical'
+class User < ActiveRecord::Base
+  include Metabolical
+  metabolize!
+end

data/test/schema/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define do
+
+  create_table :users, :force => true do |t|
+    t.string  :name
+    t.timestamps
+  end
+  
+  create_table :meta_data, :force => true do |t|
+    t.integer :metabolized_id
+    t.string  :metabolized_type
+    t.string  :key
+    t.text    :data
+    t.timestamps
+  end
+  
+  add_index :meta_data, [:metabolized_id, :metabolized_type, :key]
+  
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: metabolical
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Diego Scataglini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 0
+        - 10
+        version: 2.0.10
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 3
+        - 23
+        version: 0.3.23
+  type: :runtime
+  version_requirements: *id005
+description: This is an ActiveRecord Model & mixin to add meta data to any AR object
+email: 
+- diego@junivi.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/metabolical.rb
+- lib/metabolical/meta_datum.rb
+- lib/metabolical/scopes.rb
+- lib/metabolical/version.rb
+- metabolical.gemspec
+- test/helper.rb
+- test/metabolical_test.rb
+- test/models/user.rb
+- test/schema/schema.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: metabolical
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is an ActiveRecord Model & mixin to add meta data to any AR object
+test_files: 
+- test/helper.rb
+- test/metabolical_test.rb
+- test/models/user.rb
+- test/schema/schema.rb