can_be 0.1.0 → 0.2.0

data/spec/support/models.rb

@@ -10,3 +10,31 @@ end
 class Person < ActiveRecord::Base
   can_be :male, :female, field_name: :gender, default_type: :female
 end
+
+class Upload < ActiveRecord::Base
+  can_be :image_upload, :video_upload, :thumbnail_upload, :document_upload, :pdf_upload
+end
+
+class ImageUploadDetail < ActiveRecord::Base
+  can_be_detail :upload, :image_upload
+end
+
+class VideoUploadDetail < ActiveRecord::Base
+  can_be_detail :upload, :video_upload
+end
+
+class ThumbnailUploadDetail < ActiveRecord::Base
+end
+
+class DocumentUploadDetail
+end
+
+class ConfigSpecModel < ActiveRecord::Base
+  can_be :type1, :type2
+end
+
+class ConfigSpecDetail < ActiveRecord::Base
+end
+
+class ConfigSpecDetail2 < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -2,6 +2,7 @@ ActiveRecord::Schema.define do
   self.verbose = false
 
   create_table :addresses, :force => true do |t|
+    t.string :city
     t.string :can_be_type
     t.timestamps
   end
@@ -10,4 +11,38 @@ ActiveRecord::Schema.define do
     t.string :gender
     t.timestamps
   end
+
+  create_table :uploads, :force => true do |t|
+    t.string :can_be_type
+    t.integer :details_id
+    t.string :details_type
+    t.timestamps
+  end
+
+  create_table :image_upload_details, :force => true do |t|
+    t.string :format
+    t.timestamps
+  end
+
+  create_table :video_upload_details, :force => true do |t|
+    t.string :encoding
+    t.timestamps
+  end
+
+  create_table :thumbnail_upload_details, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :config_spec_models, :force => true do |t|
+    t.string :can_be_type
+    t.timestamps
+  end
+
+  create_table :config_spec_details, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :config_spec_details2, :force => true do |t|
+    t.timestamps
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: can_be
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -107,8 +107,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
-description: Adds helper methods to your Active Record models to control the type
-  of record.
+description: CanBe allows you to track the type of your ActiveRecord model in a consistent
+  simple manner.  With just a little configuration on your part, each type of record
+  can contain different attributes that are specifc to that type of record.
 email:
 - mrstarkman@gmail.com
 executables: []
@@ -118,18 +119,29 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - can_be.gemspec
+- gemfiles/3.1.gemfile
+- gemfiles/3.2.gemfile
 - lib/can_be.rb
-- lib/can_be/initializer.rb
+- lib/can_be/builder.rb
+- lib/can_be/builder/can_be.rb
+- lib/can_be/builder/can_be_detail.rb
+- lib/can_be/config.rb
 - lib/can_be/model_extensions.rb
+- lib/can_be/processor.rb
+- lib/can_be/processor/instance.rb
+- lib/can_be/processor/klass.rb
 - lib/can_be/railtie.rb
 - lib/can_be/version.rb
 - log/.gitkeep
-- spec/can_be/model_additions_spec.rb
+- spec/can_be/config_spec.rb
+- spec/can_be/model_extensions_spec.rb
 - spec/can_be_spec.rb
 - spec/spec_helper.rb
 - spec/support/model_macros.rb
@@ -158,11 +170,19 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Adds helper methods to your Active Record models to control the type of record.
+summary: CanBe allows you to track the type of your ActiveRecord model in a consistent
+  simple manner.  With just a little configuration on your part, each type of record
+  can contain different attributes that are specifc to that type of record.  From
+  a data modelling perspective this is preferred over ActiveRecord STI since you will
+  not have many columns in your database that have null values.  Under the hood, CanBe
+  uses one-to-one Polymorphic Associations to accomplish the different attributes
+  per type.
 test_files:
-- spec/can_be/model_additions_spec.rb
+- spec/can_be/config_spec.rb
+- spec/can_be/model_extensions_spec.rb
 - spec/can_be_spec.rb
 - spec/spec_helper.rb
 - spec/support/model_macros.rb
 - spec/support/models.rb
 - spec/support/schema.rb
+has_rdoc: 

data/lib/can_be/initializer.rb

@@ -1,90 +0,0 @@
-module CanBe
-  class Initializer
-    def initialize(klass, types, options = {})
-      @klass = klass
-      @types = types
-      @options = parse_options(options)
-    end
-
-    def define_methods
-      define_instance_methods
-      define_class_methods
-      define_validations
-    end
-
-    private
-    def parse_options(options)
-      if options.nil?
-        default_options
-      else
-        default_options.merge(options)
-      end
-    end
-
-    def default_options
-      {
-        field_name: :can_be_type,
-        default_type: @types.first
-      }
-    end
-
-    def define_instance_methods
-      field_name = @options[:field_name]
-
-      @types.each do |t|
-        @klass.instance_eval do
-          define_method "#{t}?" do
-            send(field_name) == t
-          end
-
-          define_method "change_to_#{t}" do
-            send("#{field_name}=", t)
-          end
-
-          define_method "change_to_#{t}!" do
-            update_attributes(field_name => t)
-          end
-        end
-      end
-    end
-
-    def define_class_methods
-      field_name = @options[:field_name]
-      default_type = @options[:default_type]
-
-      @types.each do |t|
-        @klass.class_eval <<-EVAL
-          def self.create_#{t}(attributes = {}, options = {}, &block)
-            attributes[:#{field_name}] = '#{t}'
-            create(attributes, options, &block)
-          end
-
-          def self.new_#{t}(attributes = {}, options = {})
-            attributes[:#{field_name}] = '#{t}'
-            new(attributes, options)
-          end
-
-          def self.find_by_can_be_types(*types)
-            where(#{field_name}: types)
-          end
-
-          def self.#{t.pluralize}
-            where(#{field_name}: '#{t}')
-          end
-
-          after_initialize do |model|
-            model.#{field_name} = '#{default_type}' if model.#{field_name}.nil?
-          end
-        EVAL
-      end
-    end
-
-    def define_validations
-      field_name = @options[:field_name]
-
-      @klass.class_eval <<-EVAL
-        validates_inclusion_of :#{field_name}, in: ['#{@types.join(',').gsub(/,/, "', '")}']
-      EVAL
-    end
-  end
-end

data/spec/can_be/model_additions_spec.rb

@@ -1,173 +0,0 @@
-require 'spec_helper'
-
-describe CanBe::ModelExtensions do
-  context "instance methods" do
-    describe "boolean record methods" do
-      it "are created" do
-        rec = new_address
-        rec.should respond_to :home_address?
-        rec.should respond_to :work_address?
-      end
-
-      it "responds true" do
-        new_address(:home_address).should be_home_address
-        new_address(:work_address).should be_work_address
-      end
-
-      it "responds false" do
-        new_address(:work_address).should_not be_home_address
-      end
-    end
-
-    describe "change_to methods" do
-      it "are created" do
-        rec = new_address
-        rec.should respond_to :change_to_home_address
-        rec.should respond_to :change_to_work_address
-      end
-
-      it "updates the record" do
-        rec = new_address(:work_address)
-        rec.change_to_home_address
-        rec.should be_home_address
-      end
-
-      it "does not update the database" do
-        rec = create_address(:work_address)
-        rec.change_to_home_address
-        Address.first.should_not be_home_address
-      end
-    end
-
-    describe "change_to! methods" do
-      it "are created" do
-        rec = create_address
-        rec.should respond_to :change_to_home_address!
-        rec.should respond_to :change_to_work_address!
-      end
-
-      it "updates the record" do
-        rec = create_address(:work_address)
-        rec.change_to_home_address!
-        rec.should be_home_address
-      end
-
-      it "updates the database" do
-        rec = create_address(:work_address)
-        rec.change_to_home_address!
-        Address.first.should be_home_address
-      end
-    end
-  end
-
-  context "class methods" do
-    describe "create methods" do
-      it "are created" do
-        Address.should respond_to :create_home_address
-        Address.should respond_to :create_work_address
-      end
-
-      it "create the records in the database" do
-        a = Address.create_home_address
-        Address.find(a.id).should be_home_address
-
-        a = Address.create_work_address
-        Address.find(a.id).should be_work_address
-      end
-
-      it "creates the records changing to the correct type" do
-        a = Address.create_home_address can_be_type: 'work_address'
-        Address.find(a.id).should be_home_address
-      end
-    end
-
-    describe "new methods" do
-      it "are created" do
-        Address.should respond_to :new_home_address
-        Address.should respond_to :new_work_address
-      end
-
-      it "create the correct type" do
-        Address.new_home_address.should be_home_address
-        Address.new_work_address.should be_work_address
-      end
-
-      it "create the records changing to the correct type" do
-        Address.create_home_address(can_be_type: 'work_address').should be_home_address
-      end
-
-      it "don't create the records in the database" do
-        Address.new_home_address
-        Address.new_work_address
-        Address.count.should == 0
-      end
-    end
-
-    describe "finder methods" do
-      let(:home_count) { 5 }
-      let(:work_count) { 4 }
-      let(:vacation_count) { 3 }
-
-      before :each do
-        home_count.times { Address.create_home_address }
-        work_count.times { Address.create_work_address }
-        vacation_count.times { Address.create_vacation_address }
-      end
-
-      it "are created" do
-        Address.should respond_to :find_by_can_be_types
-        Address.should respond_to 'home_address'.pluralize
-        Address.should respond_to 'work_address'.pluralize
-      end
-
-      it "#find_by_can_be_types returns the correct records" do
-        recs = Address.find_by_can_be_types(:home_address, :work_address)
-        recs.should have(home_count + work_count).items
-        recs.each do |a|
-          a.can_be_type.should =~ /^home_address|work_address$/
-        end
-      end
-
-      it "returns the correct records" do
-        recs = Address.home_addresses
-        recs.should have(home_count).items
-        recs.each { |a| a.should be_home_address }
-
-        recs = Address.work_addresses
-        recs.should have(work_count).items
-        recs.each { |a| a.should be_work_address }
-      end
-    end
-  end
-
-  context "default type" do
-    it "uses the first type as the default" do
-      Address.new.should be_home_address
-    end
-
-    it "uses the specified default_type option" do
-      Person.new.should be_female
-    end
-  end
-
-  context "database field" do
-    it "uses the :can_be_type field (default)" do
-      Address.new_home_address.can_be_type.should == 'home_address'
-    end
-
-    it "uses the specified field" do
-      Person.new_female.gender.should == 'female'
-    end
-  end
-
-  context "validity of type value" do
-    it "should be valid" do
-      Address.new_home_address.should be_valid
-      Address.new_work_address.should be_valid
-    end
-
-    it "should not be valid" do
-      Address.new(can_be_type: 'invalid type').should_not be_valid
-    end
-  end
-end