polymorphic_model 0.0.6 → 0.0.7

data/README.rdoc

@@ -18,6 +18,7 @@ Simple use case:
     class Configuration < ActiveRecord::Base
       polymorphic_model :with_type_column => :entry_type
       define_type :website_name, :singleton => true, :autocreate => true
+      define_type :website_motto, :singleton => true
       define_type :author
     end
     
@@ -26,6 +27,17 @@ Simple use case:
     @name = Configuration.website_name.value
     @authors = Configuration.author.map(&:value)
 
+    Configuration.author.create!(:value => "John Smith")
+    
+    # this would throw exception (not valid)
+    # Configuration.create!(:entry_type => "website_name")
+
+    Configuration.website_motto
+    => []
+    Configuration.website_motto.create(:value => "Hello world!")
+    Configuration.website_motto.value
+    => "Hello world!"
+
 This is just example. It can be used wherever STI is too drastically splits model file
 or more than one controller is not what you actually want. 
 You can avoid also problems with polymorphic_path.

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/polymorphic_model.rb

@@ -1,19 +1,42 @@
 module PolymorphicModel
   module Initializer
+    # Initializes model to be a polymorphic one
+    # Example usage:
+    #   polymorphic_model :with_type_column => :page_type 
     def polymorphic_model(options = {})
       if options[:with_type_column]
-        @_polymorphic_column = options[:with_type_column]
+        @_polymorphic_column = options[:with_type_column].to_sym
+        @_polymorphic_column.freeze
         @_model_types = []
         extend PolymorphicModel::ClassMethods
+        include PolymorphicModel::InstanceMethods
+        self.instance_eval do
+          define_method :"#{@_polymorphic_column}=" do |value|
+            super(value.to_s)
+          end
+        end
       end
     end
   end
 
+  module InstanceMethods
+    # Returns true if model instance is correct type
+    def valid_type?
+      self.class.types.include?(send(self.class.polymorphic_column_name).to_sym)
+    end
+  end
+
   module ClassMethods
+    # Returns list of allowed model types
     def types
       @_model_types.clone.freeze
     end
 
+    def polymorphic_column_name
+      @_polymorphic_column
+    end
+
+    # Type validation for polymorphic model
     def validates_type
       validates_each @_polymorphic_column, {:on => :save} do |record, attr_name, value|
         unless value.nil? || value == ""
@@ -26,6 +49,7 @@ module PolymorphicModel
       end
     end
 
+    # defines new type for model
     def define_type(t, options = {})
       column = @_polymorphic_column
       @_model_types << t.to_sym

data/polymorphic_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{polymorphic_model}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Artur Roszczyk"]
-  s.date = %q{2009-11-24}
+  s.date = %q{2009-11-28}
   s.description = %q{Alternative for ActiveRecord's Single Table Inheritance}
   s.email = %q{artur.roszczyk@gmail.com}
   s.extra_rdoc_files = [

data/spec/polymorphic_model_spec.rb

@@ -19,6 +19,24 @@ describe "PolymorphicModel" do
       end
     end
 
+    describe :valid_type? do
+      it "should return true if type is on list" do
+        @job = Job.new(:job_type => "some_type")
+        @job.should be_valid_type
+      end
+      it "should return false if type is not on list" do
+        @job = Job.new(:job_type => "incorrect")
+        @job.should_not be_valid_type
+      end
+    end
+
+    it "should allow either string and symbol while setting type via setter" do
+      @job = Job.new(:job_type => :some_type)
+      @job.job_type.should == "some_type"
+      @job.job_type = :other_type
+      @job.job_type.should == "other_type"
+    end
+
     it "should create check methods" do
       Job.instance_methods.should include("some_type?")
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: polymorphic_model
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 +01:00
+date: 2009-11-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency