railsgarden-has_meta_data 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+* [0.1.0] Initial Version

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,16 @@
+CHANGELOG
+has_meta_data_plugin.sqlite3
+init.rb
+install.rb
+lib/has_meta_data.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+tasks/has_meta_data_tasks.rake
+test/config/database.yml
+test/has_meta_data_test.rb
+test/models/article.rb
+test/schema.rb
+test/test_helper.rb
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,82 @@
+== Has Meta Data
+
+This plugin allows you to extend one of your models with additional supplementary data stored in another table through a has_one relationship.  The benefit of this plugin over a simple has_one is that the meta model class is dynamically defined (though extendable via the has_meta_data declaration) and fields on the meta model are automatically delegated to from the main model, allowing you to work solely with your primary model and not worry about the storage of the data in a separate meta table.  This plugin also automatically handles creation of the meta model if you set a field on your model that exists in the meta model table.  
+
+Common use cases for this are database efficiency if only a small number of your records have a certain set of data or in conjunction with STI to accomplish something akin to Class Table Inheritance (CTI).
+
+In short, it's a transparent way of splitting up data into two tables while still treating them as one model.  
+
+== Installation
+  
+  # In environment.rb:
+  config.gem 'railsgarden-has_meta_data', :lib => 'has_meta_data', :source => 'http://gems.github.com'
+
+== Basic Example
+
+  ## Database Schema
+  create_table :articles, :force => true do |t|
+    t.string :title
+    t.text :body
+  end
+  
+  create_table :article_meta, :force => true do |t|
+    t.references :article
+    t.string :reference_link
+    t.text :reference_note
+  end
+  
+  ## Model
+  class Article < ActiveRecord::Base
+    has_meta_data
+  end
+  
+  ## Exposed Class Methods & Scopes:
+  Article.meta_data_class
+  => Article::Meta
+  Article.with_meta_data.all
+  => (Articles that have associated meta data)
+  Article.without_meta_data.all
+  => (Articles with no associated meta data)
+  
+  ## Usage Examples:
+  
+  article = Article.create(:title => 'Title', :body => 'Body')
+  article.has_meta_data?  # => false
+  
+  article.reference_link = 'http://benhughes.name/'
+  article.has_meta_data?  # => true
+  article.meta
+  # => #<Article::Meta reference_link: "http://benhughes.name/", reference_note: nil>
+  
+  article = Article.create(:title => 'Title', :body => 'Body', :reference_link => 'http://benhughes.name/')
+  article.has_meta_data?  # => true
+  article.reference_link  # => "http://benhughes.name/"
+
+== Changing the Defaults
+
+You can control the name of the meta class, foreign key, and table name not unlike ActiveRecord associations:
+
+  class Article < ActiveRecord::Base
+    has_meta_data :class_name => 'AdditionalData', 
+                  :foreign_key => 'news_article_id',
+                  :table_name => 'news_article_additional_data'
+  end
+
+
+== Extending the Meta Data Class
+
+Because you don't directly define the meta data class, you can specify a block of code to be run in its
+context by passing a block to has_draft:
+  
+  class Article < ActiveRecord::Base
+    belongs_to :user
+    
+    has_meta_data do
+      belongs_to :some_author
+      
+      def do_something
+        # Something
+      end
+    end
+    
+  end

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'echoe'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_meta_data plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_meta_data plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasMetaData'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Echoe.new('has_meta_data', '0.1.0') do |p|
+  p.description    = "Create one model backed by a primary table and a supplementary 'meta' table."
+  p.url            = "http://github.com/railsgarden/has_meta_data"
+  p.author         = "Ben Hughes"
+  p.email          = "ben@railsgarden.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+

data/has_meta_data.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_meta_data}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Hughes"]
+  s.date = %q{2009-01-16}
+  s.description = %q{Create one model backed by a primary table and a supplementary 'meta' table.}
+  s.email = %q{ben@railsgarden.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/has_meta_data.rb", "README.rdoc", "tasks/has_meta_data_tasks.rake"]
+  s.files = ["CHANGELOG", "has_meta_data.gemspec", "init.rb", "install.rb", "lib/has_meta_data.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/has_meta_data_tasks.rake", "test/config/database.yml", "test/has_meta_data_test.rb", "test/models/article.rb", "test/schema.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/railsgarden/has_meta_data}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Has_meta_data", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{has_meta_data}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Create one model backed by a primary table and a supplementary 'meta' table.}
+  s.test_files = ["test/has_meta_data_test.rb", "test/test_helper.rb"]
+
+  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/init.rb

@@ -0,0 +1,3 @@
+require 'has_meta_data'
+
+ActiveRecord::Base.send(:include, Rubiety::HasMetaData)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/has_meta_data.rb

@@ -0,0 +1,69 @@
+module Rubiety
+  module HasMetaData
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def has_meta_data(options = {}, &block)
+        return if self.included_modules.include?(HasMetaData::InstanceMethods)
+        include HasMetaData::InstanceMethods
+        
+        cattr_accessor :meta_data_class_name, :meta_data_foreign_key, :meta_data_table_name, :meta_data_columns
+        
+        self.meta_data_class_name = options[:class_name]  || 'Meta'
+        self.meta_data_foreign_key = options[:foreign_key] || self.to_s.foreign_key
+        self.meta_data_table_name = options[:table_name]  || "#{table_name_prefix}#{self.name.demodulize.underscore}_meta#{table_name_suffix}"
+        
+        
+        # Create Relationship to Meta Data
+        class_eval do
+          has_one :meta, 
+            :class_name => "#{self.to_s}::#{meta_data_class_name}",
+            :foreign_key => meta_data_foreign_key,
+            :dependent => :destroy
+          
+          named_scope :with_meta, :include => [:meta], :conditions => "#{meta_data_table_name}.id IS NOT NULL"
+          named_scope :without_meta, :include => [:meta], :conditions => "#{meta_data_table_name}.id IS NULL"
+        end
+        
+        # Dynamically Create Model::Meta Class
+        const_set(meta_data_class_name, Class.new(ActiveRecord::Base))
+        
+        meta_data_class.cattr_accessor :original_class
+        meta_data_class.original_class = self
+        meta_data_class.set_table_name(meta_data_table_name)
+        
+        # Draft Parent Association
+        meta_data_class.belongs_to self.to_s.demodulize.underscore.to_sym, :class_name => "::#{self.to_s}", :foreign_key => meta_data_foreign_key
+        
+        # Block extension
+        meta_data_class.class_eval(&block) if block_given?
+        
+        # Finally setup attribute delegation to the meta fields
+        self.meta_data_columns = meta_data_class.content_columns.map(&:name)
+        
+        meta_data_columns.each do |field|
+          define_method(field.to_sym) do
+            meta.send(field.to_sym) if has_meta_data?
+          end
+          
+          define_method("#{field}=".to_sym) do |value|
+            self.build_meta unless has_meta_data?
+            meta.send("#{field}=".to_sym, value)
+          end
+        end
+      end
+      
+      def meta_data_class
+        const_get(meta_data_class_name)
+      end
+    end
+    
+    module InstanceMethods
+      def has_meta_data?
+        !self.meta.nil?
+      end
+    end
+  end
+end

data/tasks/has_meta_data_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_meta_data do
+#   # Task goes here
+# end

data/test/config/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: has_meta_data_plugin.sqlite
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: has_meta_data_plugin.sqlite3
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: has_meta_data_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: has_meta_data_plugin_test

data/test/has_meta_data_test.rb

@@ -0,0 +1,93 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), 'models/article')
+
+class ArticleTest < Test::Unit::TestCase
+  
+  context "Article model" do
+    should_have_one :meta
+    should_have_named_scope :with_meta
+    should_have_named_scope :without_meta
+    
+    should_have_class_methods :meta_data_class_name, :meta_data_foreign_key, :meta_data_table_name
+    
+    should "default class name to Meta" do
+      assert_equal "Meta", Article.meta_data_class_name
+    end
+    
+    should "expose meta class constant" do
+      assert_equal Article::Meta, Article.meta_data_class
+    end
+    
+    should "default foreign key to article_id" do
+      assert_equal "article_id", Article.meta_data_foreign_key
+    end
+    
+    should "default table name to article_meta" do
+      assert_equal "article_meta", Article.meta_data_table_name
+    end
+    
+    should "detect correct meta data columns" do
+      assert_equal ['reference_link', 'reference_note'], Article.meta_data_columns
+    end
+    
+    context "Meta model" do
+      should "have a be defined under Article" do
+        assert Article.constants.include?('Meta')
+      end
+      
+      should "load" do
+        assert_nothing_raised do
+          Article::Meta
+        end
+      end
+      
+      should "expose original class name of Article" do
+        assert_equal Article, Article::Meta.original_class
+      end
+    end
+  end
+  
+  context "an new article without meta data" do
+    setup { @article = Article.new(:title => 'Title', :body => 'Body') }
+    
+    should "not have meta data" do
+      assert !@article.has_meta_data?
+    end
+    
+    should "return nil for meta data fields" do
+      assert_nil @article.reference_link
+      assert_nil @article.reference_note
+    end
+  end
+  
+  context "a new article with meta data" do
+    setup { @article = Article.new(:title => 'Title', :body => 'Body', :reference_link => 'http://benhughes.name/') }
+    
+    should "have meta data" do
+      assert @article.has_meta_data?
+    end
+    
+    should "return values for meta data fields" do
+      assert_equal 'http://benhughes.name/', @article.reference_link
+      assert_nil @article.reference_note
+    end
+  end
+  
+  context "a new article after setting meta data fields through mutators" do
+    setup do
+      @article = Article.new(:title => 'Title', :body => 'Body')
+      @article.reference_link = 'http://benhughes.name/'
+      @article.reference_note = 'Ben Hughes Author'
+    end
+    
+    should "have meta data" do
+      assert @article.has_meta_data?
+    end
+    
+    should "return values for meta data fields" do
+      assert_equal 'http://benhughes.name/', @article.reference_link
+      assert_equal 'Ben Hughes Author', @article.reference_note
+    end
+  end
+  
+end

data/test/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  has_meta_data
+end

data/test/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+  
+  create_table :articles, :force => true do |t|
+    t.string :title
+    t.text :body
+  end
+  
+  create_table :article_meta, :force => true do |t|
+    t.references :article
+    t.string :reference_link
+    t.text :reference_note
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda/rails'
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/has_meta_data'))
+
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'config', '/database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$:.unshift(Test::Unit::TestCase.fixture_path)
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+class Test::Unit::TestCase
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+end
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../init'))

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: railsgarden-has_meta_data
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Create one model backed by a primary table and a supplementary 'meta' table.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/has_meta_data.rb
+- README.rdoc
+- tasks/has_meta_data_tasks.rake
+files: 
+- CHANGELOG
+- has_meta_data.gemspec
+- init.rb
+- install.rb
+- lib/has_meta_data.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/has_meta_data_tasks.rake
+- test/config/database.yml
+- test/has_meta_data_test.rb
+- test/models/article.rb
+- test/schema.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/railsgarden/has_meta_data
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Has_meta_data
+- --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: has_meta_data
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Create one model backed by a primary table and a supplementary 'meta' table.
+test_files: 
+- test/has_meta_data_test.rb
+- test/test_helper.rb