custom_fields 0.0.0.1

data/lib/custom_fields/types/date.rb

@@ -0,0 +1,35 @@
+module CustomFields
+  module Types
+    module Date
+        
+      extend ActiveSupport::Concern
+      
+      included do
+        register_type :date, ::Date
+      end
+    
+      module InstanceMethods
+        
+        def apply_date_type(klass)
+          
+          klass.class_eval <<-EOF
+            def #{self.safe_alias}
+              self.#{self._name}.strftime(I18n.t('date.formats.default')) rescue nil
+            end
+            
+            def #{self.safe_alias}=(value)
+              if value.is_a?(String)
+                date = ::Date._strptime(value, I18n.t('date.formats.default'))
+                value = Date.new(date[:year], date[:mon], date[:mday])
+              end
+              self.#{self._name} = value
+            end
+          EOF
+          
+        end
+          
+      end
+    
+    end
+  end
+end

data/lib/custom_fields/types/default.rb

@@ -0,0 +1,37 @@
+module CustomFields
+  module Types        
+    module Default
+      extend ActiveSupport::Concern
+            
+      included do
+        cattr_accessor :field_types
+      end      
+            
+      module InstanceMethods
+        
+        def apply_default_type(klass)
+          klass.class_eval <<-EOF
+            alias :#{self.safe_alias} :#{self._name}
+            alias :#{self.safe_alias}= :#{self._name}=
+          EOF
+        end
+        
+      end
+      
+      module ClassMethods
+
+        def register_type(kind, klass = ::String)
+          self.field_types ||= {}
+          self.field_types[kind.to_sym] = klass unless klass.nil?
+          
+          self.class_eval <<-EOF
+            def #{kind.to_s}?
+              self.kind.downcase == '#{kind}' rescue false
+            end
+          EOF
+        end
+        
+      end
+    end
+  end
+end

data/lib/custom_fields/types/file.rb

@@ -0,0 +1,27 @@
+module CustomFields
+  module Types
+    module File
+        
+      extend ActiveSupport::Concern
+      
+      included do
+        register_type :file, nil # do not create the default field
+      end
+    
+      module InstanceMethods
+        
+        def apply_file_type(klass)
+          
+          klass.mount_uploader self._name, FileUploader
+
+          self.apply_default_type(klass)
+        end
+          
+      end
+      
+      class FileUploader < ::CarrierWave::Uploader::Base
+      end
+    
+    end
+  end
+end

data/lib/custom_fields/types/string.rb

@@ -0,0 +1,13 @@
+module CustomFields
+  module Types
+    module String
+        
+      extend ActiveSupport::Concern
+      
+      included do
+        register_type :string
+      end
+          
+    end
+  end
+end

data/lib/custom_fields/types/text.rb

@@ -0,0 +1,15 @@
+module CustomFields
+  module Types
+    module Text
+        
+      extend ActiveSupport::Concern
+      
+      included do
+        field :text_formatting, :default => 'html'
+        
+        register_type :text
+      end
+    
+    end
+  end
+end

data/spec/integration/custom_fields_for_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe CustomFields::CustomFieldsFor do
+  
+  describe 'Saving' do
+    
+    before(:each) do
+      @project = Project.new(:name => 'Locomotive')
+      @project.person_custom_fields.build(:label => 'E-mail', :_alias => 'email', :kind => 'String')
+      @project.person_custom_fields.build(:label => 'Age', :_alias => 'age', :kind => 'String')
+    end
+    
+    context '@create' do
+    
+      it 'persists parent object' do
+        lambda { @project.save }.should change(Project, :count).by(1)
+      end
+    
+      it 'persists custom fields' do
+        @project.save && @project.reload
+        @project.person_custom_fields.count.should == 2
+      end
+    
+    end
+    
+  end
+  
+end

data/spec/integration/types/category_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe CustomFields::Types::Category do
+  
+  before(:each) do
+    @project = Project.new(:name => 'Locomotive')
+    @field = @project.task_custom_fields.build(:label => 'Main category', :_alias => 'main_category', :kind => 'Category')
+  end
+    
+  context 'saving category items' do
+
+    before(:each) do
+      @field.category_items.build :name => 'Development'
+      @field.category_items.build :name => 'Design'
+      @field.updated_at = Time.now
+    end
+  
+    it 'persists items' do
+      @field.save.should be_true
+      @project.reload
+      @project.task_custom_fields.first.category_items.size.should == 2
+    end
+    
+    context 'assigning a category and persists' do
+    
+      it 'sets the category from a category name' do
+        task = @project.tasks.build(:main_category => 'Design')
+        task.save && @project.reload
+        @project.tasks.first.main_category.should == 'Design'
+      end
+    
+      it 'sets the category from an id (string)' do
+        task = @project.tasks.build(:main_category => @field.category_items.last._id.to_s)
+        task.save && @project.reload
+        @project.tasks.first.main_category.should == 'Design'
+      end
+    
+      it 'sets the category from an id (BSON::ObjectID)' do
+        task = @project.tasks.build(:main_category => @field.category_items.last._id)
+        task.save && @project.reload
+        @project.tasks.first.main_category.should == 'Design'
+      end
+    
+    end
+    
+  end
+  
+end

data/spec/integration/types/file_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CustomFields::Types::File do
+  
+  before(:each) do
+    @project = Project.new(:name => 'Locomotive')
+    @project.task_custom_fields.build(:label => 'Screenshot', :_alias => 'screenshot', :kind => 'File')
+    @project.save
+    @task = @project.tasks.build
+  end
+  
+  it 'attaches file' do
+    @task.screenshot = FixturedFile.open('doc.txt')
+    @task.save
+    @task.screenshot.url.should == '/uploads/doc.txt'
+  end
+      
+end

data/spec/models/person.rb

@@ -0,0 +1,10 @@
+class Person
+  
+  include Mongoid::Document
+  include CustomFields::ProxyClassEnabler
+  
+  field :full_name
+  
+  embedded_in :project, :inverse_of => :people
+  
+end

data/spec/models/project.rb

@@ -0,0 +1,18 @@
+class Project
+
+  include Mongoid::Document
+  include CustomFields::ProxyClassEnabler
+  include CustomFields::CustomFieldsFor
+
+  field :name
+  field :description
+
+  references_many :people
+  embeds_many :tasks
+
+  custom_fields_for :people
+  custom_fields_for :tasks
+
+  scope :ordered, :order_by => [[:name, :asc]]
+
+end

data/spec/models/task.rb

@@ -0,0 +1,10 @@
+class Task
+  
+  include Mongoid::Document
+  include CustomFields::ProxyClassEnabler
+  
+  field :title
+  
+  embedded_in :project, :inverse_of => :tasks
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+MODELS = File.join(File.dirname(__FILE__), 'models')
+$LOAD_PATH.unshift(MODELS)
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'mongoid'
+require 'mocha'
+require 'rspec'
+require 'custom_fields'
+
+Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+
+require 'support/mongoid'
+require 'support/carrierwave'
+
+Rspec.configure do |config|
+  config.mock_with :mocha  
+  config.after :suite do
+    Mongoid.master.collections.select { |c| c.name != 'system.indexes' }.each(&:drop)
+  end
+end

data/spec/support/carrierwave.rb

@@ -0,0 +1,31 @@
+require 'carrierwave/test/matchers'
+
+CarrierWave.configure do |config|
+  config.storage = :file
+  config.store_dir = "uploads"
+  config.cache_dir = "cache"
+  config.root = File.join(File.dirname(__FILE__), '..', 'tmp')
+end
+
+module FixturedFile
+  def self.open(filename)
+    File.new(self.path(filename))
+  end
+  
+  def self.path(filename)
+    File.join(File.dirname(__FILE__), '..', 'fixtures', filename)
+  end
+  
+  def self.duplicate(filename)
+    dst = File.join(File.dirname(__FILE__), '..', 'tmp', filename)
+    FileUtils.cp self.path(filename), dst
+    dst
+  end
+  
+  def self.reset!
+    FileUtils.rm_rf(File.join(File.dirname(__FILE__), '..', 'tmp'))
+    FileUtils.mkdir(File.join(File.dirname(__FILE__), '..', 'tmp'))
+  end
+end
+
+FixturedFile.reset!

data/spec/support/mongoid.rb

@@ -0,0 +1,6 @@
+Mongoid.configure do |config|
+  name = "custom_fields_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  # config.master = Mongo::Connection.new('localhost', '27017', :logger => Logger.new($stdout)).db(name)
+end

data/spec/unit/custom_field_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe CustomFields::Field do
+  
+  it 'is initialized' do
+    lambda { CustomFields::Field.new }.should_not raise_error
+  end
+  
+  context '#mongoid' do
+    
+    before(:each) do
+      @field = CustomFields::Field.new(:label => 'manager', :_name => 'field_1', :kind => 'String', :_alias => 'manager')
+      @field.stubs(:valid?).returns(true)
+      @project = Project.to_klass_with_custom_fields(@field).new
+    end
+    
+    it 'is added to the list of mongoid fields' do
+      @project.fields['field_1'].should_not be_nil
+    end
+    
+  end
+  
+  context 'on target class' do
+    
+    before(:each) do
+      @field = CustomFields::Field.new(:label => 'manager', :_name => 'field_1', :kind => 'String', :_alias => 'manager')
+      @field.stubs(:valid?).returns(true)
+      @project = Project.to_klass_with_custom_fields(@field).new
+    end
+    
+    it 'has a new field' do
+      @project.respond_to?(:manager).should be_true
+    end
+    
+    it 'sets / retrieves a value' do
+      @project.manager = 'Mickael Scott'
+      @project.manager.should == 'Mickael Scott'
+    end
+    
+  end
+  
+end

data/spec/unit/custom_fields_for_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe CustomFields::CustomFieldsFor do
+    
+  context '#proxy class'  do
+    
+    before(:each) do
+      @project = Project.new
+      @klass = @project.tasks.klass
+    end
+    
+    it 'returns the proxy class in the association' do
+      @klass.should == @project.tasks.build.class
+    end
+    
+    it 'has a link to the parent' do
+      @klass._parent.should == @project
+    end
+    
+    it 'has the association name which references to' do
+      @klass.association_name.should == 'tasks'
+    end
+    
+  end
+    
+  context 'with embedded collection' do
+    
+    context '#association' do
+      
+      before(:each) do
+        @project = Project.new
+      end
+  
+      it 'has custom fields for embedded collection' do
+        @project.respond_to?(:task_custom_fields).should be_true
+      end
+            
+    end
+  
+    context '#building' do
+      
+      before(:each) do
+        @project = Project.new
+        @project.task_custom_fields.build :label => 'Short summary', :_alias => 'summary', :kind => 'String'
+        @task = @project.tasks.build
+      end
+      
+      it 'returns a new document whose Class is different from the original one' do
+        @task.class.should_not == Task
+      end
+      
+      it 'returns a new document with custom field' do
+        @project.tasks.build
+        @project.tasks.build
+        @task.respond_to?(:summary).should be_true
+      end
+      
+      it 'sets/gets custom attributes' do
+        @task.summary = 'Lorem ipsum...'
+        @task.summary.should == 'Lorem ipsum...'
+      end
+      
+    end
+    
+  end
+  
+  context 'with related collection' do
+    
+    context '#association' do
+      
+      before(:each) do
+        @project = Project.new
+      end
+    
+      it 'has custom fields for related collections' do
+        @project.respond_to?(:person_custom_fields).should be_true
+      end
+      
+    end
+    
+    context '#building' do
+      
+      before(:each) do
+        @project = Project.new
+        @project.person_custom_fields.build :label => 'Position in the project', :_alias => 'position', :kind => 'String'
+        @person = @project.people.build
+      end
+      
+      it 'returns a new document whose Class is different from the original one' do
+        @person.class.should_not == Person
+      end
+      
+      it 'returns a new document with custom field' do
+        @person.respond_to?(:position).should be_true
+      end
+      
+      it 'sets/gets custom attributes' do
+        @person.position = 'Designer'
+        @person.position.should == 'Designer'
+      end
+      
+    end
+    
+  end
+  
+end