has_meta_data 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+== 1.0.0 Updated to Rails 3, RSpec
+
+* Converted tests to RSpec
+* Added support for Rails 3.0
+
+== 0.1.0 Initial Version

data/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/README.rdoc

@@ -0,0 +1,85 @@
+== 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
+  
+This gem works with Rails 3 only.
+
+In your Gemfile:
+  
+  gem "has_meta_data"
+  
+== 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,14 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+
+desc "Generate documentation for the plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "has_meta_data"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,3 @@
+require "has_meta_data"
+
+HasMetaData::Railtie.insert

data/lib/has_meta_data.rb

@@ -0,0 +1,69 @@
+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
+
+require "has_meta_data/railtie"

data/lib/has_meta_data/railtie.rb

@@ -0,0 +1,19 @@
+module HasMetaData
+  if defined?(Rails::Railtie)
+    require "rails"
+    
+    class Railtie < Rails::Railtie
+      initializer "has_draft.extend_active_record" do
+        ActiveSupport.on_load(:active_record) do
+          HasMetaData::Railtie.insert
+        end
+      end
+    end
+  end
+  
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, HasMetaData)
+    end
+  end
+end

data/lib/has_meta_data/version.rb

@@ -0,0 +1,3 @@
+module HasMetaData
+  VERSION = "1.0.0"
+end

data/spec/db/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  adapter: sqlite
+  database: spec/db/test.sqlite
+
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.sqlite3
+
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: has_draft_plugin_test
+  min_messages: ERROR
+
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: has_draft_plugin_test

data/spec/db/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/spec/factories/article.rb

@@ -0,0 +1,16 @@
+require "factory_girl"
+
+Factory.define(:article) do |f|
+  f.title { Faker::Lorem.sentence }
+  f.body { Faker::Lorem.paragraphs.join("\n\n") }
+end
+
+Factory.define(:article_meta, :class => Article::Meta) do |f|
+  f.association(:article)
+  f.reference_link { "http://" + Faker::Internet.domain_name }
+  f.reference_note { Faker::Lorem.paragraph }
+end
+
+Factory.define(:article_with_meta_data, :parent => :article) do |f|
+  f.association(:meta, :factory => :article_meta)
+end

data/spec/has_meta_data_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe HasMetaData do
+  context "Article model" do
+    it "should expose #meta_data_class_name as Meta" do
+      Article.meta_data_class_name.should == "Meta"
+    end
+    
+    it "should expose #meta_data_class as Article::Meta" do
+      Article.meta_data_class.should == Article::Meta
+    end
+    
+    it "should default #meta_data_foreign_key to article_id" do
+      Article.meta_data_foreign_key.should == "article_id"
+    end
+    
+    it "should find #meta_data_columns" do
+      Article.meta_data_columns.should == ["reference_link", "reference_note"]
+    end
+    
+    context "Meta model" do
+      it "should be defined under the Article namespace" do
+        Article.constants.should include('Meta')
+      end
+      
+      it "should expose #original_class as Article" do
+        Article::Meta.original_class.should == Article
+      end
+    end
+  end
+  
+  context "with an article without meta data" do
+    before { @article = Factory.create(:article) }
+    
+    it "should not have meta data" do
+      @article.should_not have_meta_data
+    end
+    
+    it "should return nil for meta data fields" do
+      @article.reference_link.should be_nil
+      @article.reference_note.should be_nil
+    end
+  end
+  
+  context "with an article with meta data" do
+    before { @article = Factory.create(:article_with_meta_data) }
+    
+    it "should have meta data" do
+      @article.should have_meta_data
+    end
+    
+    it "should return values for meta data fields" do
+      @article.reference_link.should_not be_nil
+      @article.reference_note.should_not be_nil
+    end
+  end
+  
+  context "with an article after setting meta data fields through mutators" do
+    before do
+      @article = Factory.create(:article)
+      @article.reference_link = "http://railsgarden.com/"
+      @article.reference_note = "Notes"
+    end
+    
+    it "should have meta data" do
+      @article.should have_meta_data
+    end
+    
+    it "should return values for meta data fields" do
+      @article.reference_link.should == "http://railsgarden.com/"
+      @article.reference_note.should == "Notes"
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "rspec"
+require "factory_girl"
+require "faker"
+require "rails"
+require "active_record"
+require "active_support"
+
+# Establish DB Connection
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+require File.dirname(__FILE__) + '/../init'
+
+# Example has_meta_data Model:
+class Article < ActiveRecord::Base
+  has_meta_data
+end
+
+# Load Factories:
+Dir[File.join(File.dirname(__FILE__), "factories/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: has_meta_data
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Hughes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Create one model backed by a primary table and a supplementary 'meta' table.
+email: ben@railsgarden.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/has_meta_data/railtie.rb
+- lib/has_meta_data/version.rb
+- lib/has_meta_data.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/factories/article.rb
+- spec/has_meta_data_spec.rb
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/rubiety/has_meta_data
+licenses: []
+
+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: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: has_meta_data
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extended attributes in an attached meta table.
+test_files: []
+