has_custom_fields 0.0.5 → 0.1.1

data/spec/has_custom_fields_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe 'Has Custom Fields' do
+
+  context "with no fields defined" do
+  
+    describe "class methods" do
+
+      it "raises an error if missing a scope to the has_custom_fields class" do
+        class TestUser < ActiveRecord::Base; end
+        expect {
+          TestUser.send(:has_custom_fields)
+        }.to raise_error(ArgumentError, 'Must define :scope => [] on the has_custom_fields class method')
+      end
+
+      it "returns an empty array" do
+        org = Organization.create!(:name => 'ABC Corp')
+        User.custom_field_fields(:organization, org.id).should == []
+      end
+
+      it "returns an empty array if the scoped object doesn't exist" do
+        User.custom_field_fields(:organization, nil).should == []
+      end
+
+      it "raises an exception if the scope doesn't exist" do
+        expect {
+          User.custom_field_fields(:something, nil)  
+        }.to raise_error(HasCustomFields::InvalidScopeError, 'Class User does not have scope :something defined for has_custom_fields')
+      end
+
+    end
+
+    describe "instance methods" do
+
+      before(:each) do
+        @org = Organization.create!(:name => 'ABC Corp')
+        @user = User.create!(:name => 'Mikel')       
+      end
+
+      it "raises an exception if the field does not exist" do
+        expect {
+          @user.custom_fields[:organization][@org.id]['High Potential']
+        }.to raise_error(ActiveRecord::RecordNotFound, 'No field High Potential for organization 1')
+      end
+
+    end
+
+  end
+
+  describe "creating fields" do
+
+    it "creates the fields" do
+      @org = Organization.create!(:name => 'ABC Corp')
+      expect {
+        UserField.create!(:organization_id => @org.id, :name => 'Value', :style => 'text')
+      }.to change(HasCustomFields::UserField, :count).by(1)
+    end
+
+  end
+
+  context "with fields defined" do
+
+    before(:each) do
+      @org = Organization.create!(:name => 'ABC Corp')
+      UserField.create!(:organization_id => @org.id, :name => 'Value', :style => 'text')
+      UserField.create!(:organization_id => @org.id, :name => 'Customer', :style => 'checkbox')
+      UserField.create!(:organization_id => @org.id, :name => 'Category', :style => 'select',
+                        :user_field_select_options => [UserFieldSelectOption.create!(:option => 'CatA'),
+                                           UserFieldSelectOption.create!(:option => 'CatB'),
+                                           UserFieldSelectOption.create!(:option => 'CatC')])
+    end
+
+    describe "class methods" do
+
+      it "returns an array of UserFields" do
+        User.custom_field_fields(:organization, @org.id).length.should == 3
+        values = User.custom_field_fields(:organization, @org.id).map(&:name)
+        values.should include('Customer')
+        values.should include('Value')
+        values.should include('Category')
+      end
+      
+      it "returns an array of select options" do
+        select_options = User.custom_field_fields(:organization, @org.id).last.user_field_select_options.map(&:option)
+        select_options.should == ["CatA","CatB","CatC"]
+      end
+      
+      it "should return an array of select options" do
+        select_options = User.custom_field_fields(:organization, @org.id).last.select_options_data
+        select_options.should == ["CatA","CatB","CatC"]
+      end
+      
+      it "should set up the has_many and belongs_to relationships" do
+        User.custom_field_fields(:organization, @org.id).first.respond_to?(:user_field_select_options).should == true
+        User.custom_field_fields(:organization, @org.id).last.user_field_select_options.first.respond_to?(:user_field).should == true
+      end
+
+    end
+
+    describe "instance methods" do
+
+      before(:each) do
+        @user = User.create!(:name => 'Mikel', :organization => @org)
+      end
+
+      it "sets attributes accessible on the custom_fields virtual attribute" do
+        @user.update_attributes(:name => 'Mikel', :email => 'mikel@example.org',
+                                :custom_fields => {:organization => {@org.id => {'Value' => '10000'}}})
+        @user.name.should == 'Mikel'
+        @user.email.should == 'mikel@example.org'
+        @user.custom_fields[:organization][@org.id]['Value'].should_not be_nil
+      end
+
+      it "returns nil if there is no value defined" do
+        @user.custom_fields[:organization][@org.id]['Customer'].should be_nil
+        @user.custom_fields[:organization][@org.id]['Value'].should be_nil
+      end
+
+      it "sets the value of the field and persists it in the database" do
+        expect {
+          @user.update_attributes(:custom_fields => {:organization => {@org.id => {'Value' => '10000', 'Customer' => '1'}}})
+          @user.custom_fields[:organization][@org.id]['Customer'].should == '1'
+          @user.custom_fields[:organization][@org.id]['Value'].should == '10000'
+        }.to change(UserAttribute, :count).by(2)
+      end
+
+      it "does not persist in the database if the value is nil or blank" do
+        expect {
+          @user.update_attributes(:custom_fields => {:organization => {@org.id => {'Value' => '', 'Customer' => nil}}})
+          @user.custom_fields[:organization][@org.id]['Customer'].should be_nil
+          @user.custom_fields[:organization][@org.id]['Value'].should be_nil
+        }.to change(UserAttribute, :count).by(0)
+      end
+
+      it "deletes the value from the database if the value is nil or blank" do
+        @user.update_attributes(:custom_fields => {:organization => {@org.id => {'Value' => '10000', 'Customer' => '1'}}})
+
+        expect {
+          @user.update_attributes(:custom_fields => {:organization => {@org.id => {'Value' => '', 'Customer' => nil}}})
+          @user.custom_fields[:organization][@org.id]['Customer'].should be_nil
+          @user.custom_fields[:organization][@org.id]['Value'].should be_nil
+        }.to change(UserAttribute, :count).by(-2)
+      end
+
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -1,34 +1,37 @@
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+require "active_support"
+require "active_record"
+require "database_cleaner"
 
-ENV["RAILS_ENV"] ||= "test"
+ENV['debug'] = 'test' unless ENV['debug']
 
-require "rubygems"
-require 'spec'
-require File.expand_path(File.join(File.dirname(__FILE__), "../../../../config/environment"))
-require 'spec/rails'
-require 'active_record/fixtures'
+# 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'])
 
-begin
-  require 'ruby-debug'
-  Debugger.start
-rescue LoadError
-end
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
 
-require "acts_as_custom_fields"
+require File.dirname(__FILE__) + '/../init'
 
-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'])
+# Load in the test models
 
-plugin_fixture_path = File.expand_path(File.dirname(__FILE__) + "/fixtures/")
-$LOAD_PATH.unshift(plugin_fixture_path)
+require File.dirname(__FILE__) + '/test_models/user'
+require File.dirname(__FILE__) + '/test_models/organization'
 
-Spec::Runner.configure do |config|
-  config.use_transactional_fixtures = true
-  config.use_instantiated_fixtures  = false
-  config.fixture_path = plugin_fixture_path
-end
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
 
-load(File.dirname(__FILE__) + "/schema.rb")
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
 
-alias :doing :lambda
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

data/spec/test_models/organization.rb

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

data/spec/test_models/user.rb

@@ -0,0 +1,6 @@
+class User < ActiveRecord::Base
+  belongs_to :organization
+  has_custom_fields :scopes => [:organization]
+
+  attr_accessible :name, :email
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_custom_fields
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 25
   prerelease: 
   segments: 
   - 0
-  - 0
-  - 5
-  version: 0.0.5
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - kylejginavan
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-27 00:00:00 -06:00
+date: 2012-02-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: builder
+  name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -28,10 +28,54 @@ dependencies:
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
+        - 3
+        - 1
         - 0
-        version: "0"
+        version: 3.1.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Uses a vertical schema to add custom fields.
 email: kylejginavan@gmail.com
 executables: []
@@ -40,34 +84,25 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
-- LICENSE
-- README.rdoc
+- Gemfile
+- init.rb
 - Rakefile
-- SPECDOC
-- VERSION
+- LICENSE
+- README.md
 - has_custom_fields.gemspec
-- has_custom_fields.tmproj
-- lib/custom_fields/custom_field_base.rb
+- lib/has_custom_fields/base.rb
+- lib/has_custom_fields/class_methods.rb
+- lib/has_custom_fields/instance_methods.rb
+- lib/has_custom_fields/railtie.rb
+- lib/has_custom_fields/version.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/db/database.yml
+- spec/db/schema.rb
+- spec/test_models/user.rb
+- spec/test_models/organization.rb
+- spec/has_custom_fields_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/kylejginavan/has_custom_fields

data/README.rdoc

@@ -1,117 +0,0 @@
-HasCustomFields
-==============
-
-HasCustomFields allow for the Entity-attribute-value model (EAV), also 
-known as object-attribute-value model and open schema on any of your ActiveRecord
-models. 
-
-= What is Entity-attribute-value model?
-Entity-attribute-value model (EAV) is a data model that is used in circumstances 
-where the number of attributes (properties, parameters) that can be used to describe 
-a thing (an "entity" or "object") is potentially very vast, but the number that will 
-actually apply to a given entity is relatively modest.
-
-= Typical Problem
-A good example of this is where you need to store
-lots (possible hundreds) of optional attributes on an object. My typical
-reference example is when you have a User object. You want to store the
-user's preferences between sessions. Every search, sort, etc in your
-application you want to keep track of so when the user visits that section
-of the application again you can simply restore the display to how it was.
-
-So your controller might have:
-
-  Project.find :all, :conditions => current_user.project_search,
-    :order => current_user.project_order
-
-But there could be hundreds of these little attributes that you really don't
-want to store directly on the user object. It would make your table have too
-many columns so it would be too much of a pain to deal with. Also there might
-be performance problems. So instead you might do something like
-this:
-
-  class User < ActiveRecord::Base
-    has_many :preferences
-  end
-
-  class Preferences < ActiveRecord::Base
-    belongs_to :user
-  end
-
-Now simply give the Preference model a "name" and "value" column and you are
-set..... except this is now too complicated. To retrieve a attribute you will
-need to do something like:
-
-  Project.find :all,
-    :conditions => current_user.preferences.find_by_name('project_search').value,
-    :order => current_user.preferences.find_by_name('project_order').value
-
-Sure you could fix this through a few methods on your model. But what about
-saving?
-
-  current_user.preferences.create :name => 'project_search',
-    :value => "lastname LIKE 'jones%'"
-  current_user.preferences.create :name => 'project_order',
-    :value => "name"
-
-Again this seems to much. Again we could add some methods to our model to
-make this simpler but do we want to do this on every model. NO! So instead
-we use this plugin which does everything for us.
-
-= Capabilities
-
-The HasCustomFields plugin is capable of modeling this problem in a intuitive
-way. Instead of having to deal with a related model you treat all attributes
-(both on the model and related) as if they are all on the model. The plugin
-will try to save all attributes to the model (normal ActiveRecord behavior)
-but if there is no column for an attribute it will try to save it to a
-related model whose purpose is to store these many sparsely populated
-attributes.
-
-The main design goals are:
-
-* Have the eav attributes feel like normal attributes. Simple gets and sets
-  will add and remove records from the related model.
-* Allow for more than one related model. So for example on my User model I might
-  have some eav behavior going into a contact_info table while others are
-  going in a user_preferences table.
-* Allow a model to determine what a valid eav attribute is for a given
-  related model so our model still can generate a NoMethodError.
-
-Example
-=======
-
-Will make the current class have eav behaviour.
-
-  class Post < ActiveRecord::Base
-    has_custom_field_behavior
-  end
-  post = Post.find_by_title 'hello world'
-  puts "My post intro is: #{post.intro}"
-  post.teaser = 'An awesome introduction to the blog'
-  post.save
-
-The above example should work even though "intro" and "teaser" are not
-attributes on the Post model.
-
-= Installation
-
-    ./script/plugin install acts_as_custom_field_model
-
-= RUNNING UNIT TESTS
-
-== Creating the test database
-
-The test databases will be created from the info specified in test/database.yml.
-Either change that file to match your database or change your database to
-match that file.
-
-== Running with Rake
-
-The easiest way to run the unit tests is through Rake. By default sqlite3
-will be the database run. Just change your env variable DB to be the database
-adaptor (specified in database.yml) that you want to use. The database and
-permissions must already be setup but the tables will be created for you
-from schema.rb.
-
-Copyright (c) 2008 Marcus Wyatt, released under the MIT license