has_custom_fields 0.0.1

data/spec/fixtures/document.rb

@@ -0,0 +1,7 @@
+class Document < ActiveRecord::Base
+  has_custom_field_behavior
+
+  def is_custom_field_attribute?(attr_name, model)
+    attr_name =~ /attr$/
+  end
+end

data/spec/fixtures/people.yml

@@ -0,0 +1,4 @@
+marcus:
+  id: 1
+  name: Marcus Wyatt
+  email: marcus@example.com

data/spec/fixtures/person.rb

@@ -0,0 +1,13 @@
+class Person < ActiveRecord::Base
+  
+  has_custom_field_behavior :class_name => 'Preference', 
+                   :name_field => :key
+                   
+  has_custom_field_behavior :class_name => 'PersonContactInfo', 
+                   :foreign_key => :contact_id, 
+                   :fields => %w(phone aim icq)
+
+  def custom_field_attributes(model)
+    model == Preference ? %w(project_search project_order) : nil
+  end
+end

data/spec/fixtures/person_contact_infos.yml

@@ -0,0 +1,10 @@
+marcus_aim:
+  id: 1
+  contact_id: 1
+  name: aim
+  value: marcus.wyatt
+marcus_phone:
+  id: 2
+  contact_id: 1
+  name: phone
+  value: 021 356 0986

data/spec/fixtures/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+  
+  has_custom_field_behavior
+  
+  validates_presence_of :intro, :message => "can't be blank", :on => :create
+end

data/spec/fixtures/post_attributes.yml

@@ -0,0 +1,15 @@
+post_one_comment:
+  id: 1
+  post_id: 1
+  name: comment
+  value: Foo Bar Industries gets two thumbs up
+post_one_intro:
+  id: 2
+  post_id: 1
+  name: intro
+  value: We deliver quality foobars to consumers nationwide and around the globe
+post_one_teaser:
+  id: 3
+  post_id: 1
+  name: teaser
+  value: Coming October 7, the foobarantator

data/spec/fixtures/posts.yml

@@ -0,0 +1,9 @@
+one:
+  id: 1
+  title: Hello World
+  body: This is my first blog post. Great!
+  
+two:
+  id: 2
+  title: Following up from my first post.
+  body: I'm working on my first plugin today.

data/spec/fixtures/preference.rb

@@ -0,0 +1,5 @@
+class Preference < ActiveRecord::Base
+  def to_s
+    "#{key}: #{value}"
+  end
+end

data/spec/fixtures/preferences.yml

@@ -0,0 +1,10 @@
+marcus_project_search:
+  id: 1
+  person_id: 1
+  key: project_search
+  value: project.owner LIKE '%anderson%'
+marcus_project_order:
+  id: 2
+  person_id: 1
+  key: project_order
+  value: name

data/spec/models/eav_model_with_no_arguments_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "ActiveRecord Model annotated with 'has_custom_field_behavior' with no options in declaration" do
+  fixtures :posts, :post_attributes
+
+  it "should have many attributes" do
+    post_attr = Post.find_by_title("Hello World").post_attributes
+    post_attr[0].should be_instance_of(PostAttribute)
+    post_attr.size.should == 3
+  end
+  
+  it "should create new attribute on save" do
+    blog_post = Post.find_by_title("Following up from my first post.")
+    blog_post.send :write_attribute, 'new_attribute', 'new_value'
+
+    new_attribute = blog_post.post_attributes.to_a.find do |attribute|
+      attribute.name == 'new_attribute'
+    end
+    new_attribute.should_not be_nil
+
+    blog_post.send(:read_attribute, 'new_attribute').should == 'new_value'
+    PostAttribute.find_by_name_and_post_id('new_attribute', 2).should be_nil
+    blog_post.save!
+
+    PostAttribute.find_by_name_and_post_id('new_attribute', 2).value.should == 'new_value'
+    blog_post.send(:read_attribute, 'new_attribute').should == 'new_value'
+
+  end
+
+  it "should delete attribute" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:write_attribute, 'comment', nil)
+
+    comment = blog_post.post_attributes.find_by_name('comment')
+    comment.should_not be_nil
+
+    blog_post.send(:read_attribute, 'comment').should be_nil
+    blog_post.save!
+
+    blog_post.send(:read_attribute, 'comment').should be_nil
+
+    comment = blog_post.post_attributes.find_by_name('comment')
+    blog_post.send(:read_attribute, 'comment').should be_nil
+    PostAttribute.find_by_id(1).should be_nil
+  end
+  
+  it "should write eav attributes to attributes table" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:write_attribute, 'intro', 'Blah Blah Blah')
+    blog_post.send(:read_attribute, 'intro').should == 'Blah Blah Blah'
+    PostAttribute.find(2).value.should_not == 'Blah Blah Blah'
+    blog_post.save!
+    PostAttribute.find(2).value.should == 'Blah Blah Blah'
+  end
+  
+  it "should return nil when attribute does not exist" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:read_attribute, 'not_exist').should be_nil
+  end
+  
+  it "should use method missing to make attribute seem as native property" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.comment.should == 'Foo Bar Industries gets two thumbs up'
+    blog_post.intro.should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post.teaser.should == 'Coming October 7, the foobarantator'
+  end
+  
+  it "should read attributes using subscript notation" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post['comment'].should == 'Foo Bar Industries gets two thumbs up'
+    blog_post['intro'].should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post['teaser'].should == 'Coming October 7, the foobarantator'
+  end
+  
+  it "should read the attribute when invoking 'read_attribute'" do
+    blog_post = Post.find_by_title("Hello World")
+    blog_post.send(:read_attribute, 'comment').should == 'Foo Bar Industries gets two thumbs up'
+    blog_post.send(:read_attribute, 'intro').should == 'We deliver quality foobars to consumers nationwide and around the globe'
+    blog_post.send(:read_attribute, 'teaser').should == 'Coming October 7, the foobarantator'
+  end
+  
+end

data/spec/models/eav_model_with_options_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "ActiveRecord Model annotated with 'has_custom_field_behavior' with options in declaration" do
+  fixtures :people, :preferences, :person_contact_infos
+
+  it "should be 'has_many' association on both sides" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+
+    prefs = marcus.preferences
+    prefs[0].should be_instance_of(Preference)
+    prefs.size.should == 2
+
+    contact_info = marcus.person_contact_infos
+    contact_info[0].should be_instance_of(PersonContactInfo)
+    contact_info.size.should == 2
+  end
+
+  it "should only allow restricted fields when specified (:fields => %w(phone aim icq))" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+    marcus.aim.should == 'marcus.wyatt'
+    lambda { marcus.doesnt_exist }.should raise_error(NoMethodError)
+  end
+
+  it "should raise 'NoMethodError' when attribute not in 'custom_field_attributes' method array" do
+    marcus = Person.find_by_name('Marcus Wyatt')
+
+    marcus.project_order.should == 'name'
+    lambda { marcus.project_blah }.should raise_error(NoMethodError)
+  end
+
+  it "should raise 'NoMethodError' when attribute does not satisfy 'is_custom_field_attribute?' method" do
+    doc = Document.new
+
+    doc.copyright_attr.should be_nil
+    lambda { doc.no_exist }.should raise_error(NoMethodError)
+
+  end
+end

data/spec/models/eav_validation_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Validations on ActiveRecord Model annotated with 'has_custom_field_behavior'" do
+  
+  fixtures :posts, :post_attributes
+  
+  it "should execute as normal (validates_presence_of)" do
+    post = Post.create :comment => 'No Intro', :teaser => 'This should fail'
+    post.errors[:intro].should == "can't be blank"   
+  end
+  
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+-x gems,spec

data/spec/schema.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), 'fixtures/document')
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "people", :force => true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "person_contact_infos", :force => true do |t|
+    t.integer "contact_id", :null => false
+    t.string  "name",       :null => false
+    t.string  "value",      :null => false
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.text     "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "post_attributes", :force => true do |t|
+    t.integer "post_id", :null => false
+    t.string "name", :null => false
+    t.string "value", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "preferences", :force => true do |t|
+    t.integer "person_id", :null => false
+    t.string  "key",       :null => false
+    t.string  "value",     :null => false
+  end
+  
+  create_table "documents", :force => true do |t|
+    t.string "name", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+  create_table "document_attributes", :force => true do |t|
+    t.integer "document_id", :null => false
+    t.string "name", :null => false
+    t.string "value", :null => false
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+ENV["RAILS_ENV"] ||= "test"
+
+require "rubygems"
+require 'spec'
+require File.expand_path(File.join(File.dirname(__FILE__), "../../../../config/environment"))
+require 'spec/rails'
+require 'active_record/fixtures'
+
+begin
+  require 'ruby-debug'
+  Debugger.start
+rescue LoadError
+end
+
+require "acts_as_custom_fields"
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'mysql'])
+
+plugin_fixture_path = File.expand_path(File.dirname(__FILE__) + "/fixtures/")
+$LOAD_PATH.unshift(plugin_fixture_path)
+
+Spec::Runner.configure do |config|
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+  config.fixture_path = plugin_fixture_path
+end
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+alias :doing :lambda

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: has_custom_fields
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- kylejginavan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Uses a vertical schema to add custom fields.
+email: kylejginavan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- SPECDOC
+- VERSION
+- has_custom_fields.tmproj
+- lib/custom_fields/custom_field_base.rb
+- lib/has_custom_fields.rb
+- spec/database.yml
+- spec/debug.log
+- spec/fixtures/document.rb
+- spec/fixtures/people.yml
+- spec/fixtures/person.rb
+- spec/fixtures/person_contact_infos.yml
+- spec/fixtures/post.rb
+- spec/fixtures/post_attributes.yml
+- spec/fixtures/posts.yml
+- spec/fixtures/preference.rb
+- spec/fixtures/preferences.yml
+- spec/models/eav_model_with_no_arguments_spec.rb
+- spec/models/eav_model_with_options_spec.rb
+- spec/models/eav_validation_spec.rb
+- spec/rcov.opts
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/kylejginavan/has_custom_fields
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: The easy way to add custom fields to any Rails model.
+test_files: 
+- spec/fixtures/document.rb
+- spec/fixtures/person.rb
+- spec/fixtures/post.rb
+- spec/fixtures/preference.rb
+- spec/models/eav_model_with_no_arguments_spec.rb
+- spec/models/eav_model_with_options_spec.rb
+- spec/models/eav_validation_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb