dm-is-remixable 0.9.7 → 0.9.8

data/README.txt

@@ -125,3 +125,46 @@ class Video
 
   #... methods, properties, etc ...#
 end
+
+
+Further, remixables can namespace methods that should exist in the generated and remixing classes, if these
+modules are present the are attached appropriately to the other classes.
+
+module ExampleRemixable
+  include DataMapper::Resource
+  is :remixable
+  
+  #... your properies ...
+  
+  # Class methods that will be attached to class doing the remixing...
+  # 
+  # These methods would be attached to the User class given:
+  #   User.remixes n, :images
+  # 
+  module RemixerClassMethods
+  end
+  
+  # Instances methods that will be attached to objects of the class doing the remixing...
+  # 
+  # These methods would be attached to User objects given:
+  #   User.remixes n, :images
+  #
+  module RemixerInstanceMethods
+  end
+  
+  # Class methods that will be attached to genereated remixed class
+  # 
+  # These methods would be attached to the UserImage class given:
+  #   User.remixes n, :images
+  #
+  module RemixeeClassMethods
+  end
+  
+  # Instances methods that will be attached to objects of the genereated remixed class
+  # 
+  # These methods would be attached to UserImage objects given:
+  #   User.remixes n, :images
+  #
+  module RemixeeInstanceMethods
+  end
+end

data/Rakefile

@@ -10,12 +10,12 @@ AUTHOR = "Cory O'Daniel"
 EMAIL  = "dm-is-remixable [a] coryodaniel [d] com"
 GEM_NAME = "dm-is-remixable"
 GEM_VERSION = DataMapper::Is::Remixable::VERSION
-GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
+GEM_DEPENDENCIES = [['dm-core', "~>#{GEM_VERSION}"]]
 GEM_CLEAN = ["log", "pkg"]
 GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
 
 PROJECT_NAME = "datamapper"
-PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-remixes"
+PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-is-remixable"
 PROJECT_DESCRIPTION = PROJECT_SUMMARY = "dm-is-remixable allow you to create reusable data functionality"
 
 require ROOT.parent + 'tasks/hoe'

data/TODO

@@ -14,17 +14,5 @@ TODO
 - Test nested remixing User remixes Photogenic; Photogenic Remixes comments
 - Test double+ remixing. User remixes Commentable; enhance Commentable remix Commentable
 
-- Harvest Class methods (including it into Remixed Model gets the instance methods, but not class methods...)
-
-- Squash protection;
-  IF    ClassA => remix ModuleB, :table_name => "squashme"
-  AND   ClassC => remix ModuleB, :table_name => "squashme" #SQUASHED THAT TABLE
-
 - Remixable.related(*remixed_models)
-  Taggable.related(Article, JobPostings)
-
-
-CONSIDERATIONS
-==============
-- Customizing Assocations           (http://datamapper.org/docs/associations.html)
-- Adding Conditions to Associations (http://datamapper.org/docs/associations.html)
+  Taggable.related(Article, JobPostings)

data/lib/dm-is-remixable/is/remixable.rb

@@ -55,6 +55,7 @@ module DataMapper
         extend  DataMapper::Is::Remixable::RemixeeClassMethods
         include DataMapper::Is::Remixable::RemixeeInstanceMethods
         @is_remixable = true
+        
         # support clean suffixes for nested modules
         default_suffix = Extlib::Inflection.demodulize(self.name).singular.snake_case
         suffix(options.delete(:suffix) || default_suffix)
@@ -93,7 +94,8 @@ module DataMapper
         #                                   This is the class that will be created from the Remixable Module
         #                                   The storage_name can be changed via 'enhance' in the class that is remixing
         #                                   Default: self.name.downcase + "_" + remixable.suffix.pluralize
-        #                       :as         <String> Alias to access associated data
+        #                       :as         <String> Alters the name that the remixable items will be available through, this WILL NOT
+        #                                   create the standard accessor
         #                                   Default: tableize(:class_name)
         #                       :for|:on    <String> Class name to join to through Remixable
         #                                   This will create a M:M relationship THROUGH the remixable, rather than
@@ -114,7 +116,7 @@ module DataMapper
         #
         #   Tables: users, user_addresses
         #   Classes: User, UserAddress
-        #     User.user_addresses << UserAddress.new
+        #     User.user_addresses << UserAddress.new => Raise No Method Exception since it was alias with :as
         #     User.addresses << UserAddress.new
         #   --------------------------------------------
         #   --------------------------------------------
@@ -175,6 +177,15 @@ module DataMapper
             remixable_key = Extlib::Inflection.demodulize(remixable_module.name).snake_case.to_sym
             populate_remixables_mapping(model, options.merge(:remixable_key => remixable_key))
 
+            # attach RemixerClassMethods and RemixerInstanceMethods to remixer if defined by remixee
+            if Object.full_const_defined? "#{remixable_module}::RemixerClassMethods"
+              extend Object.full_const_get("#{remixable_module}::RemixerClassMethods")
+            end
+
+            if Object.full_const_defined? "#{remixable_module}::RemixerInstanceMethods"
+              include Object.full_const_get("#{remixable_module}::RemixerInstanceMethods")
+            end
+
             #Create relationships between Remixer and remixed class
             if options[:other_model]
               # M:M Class-To-Class w/ Remixable Module as intermediate table
@@ -185,9 +196,6 @@ module DataMapper
               # has n and belongs_to (or One-To-Many)
               remix_one_to_many cardinality, model, options
             end
-
-            #Add accessor alias
-            attach_accessor(options) unless options[:as].nil?
           else
             DataMapper.logger.warn "#{__FILE__}:#{__LINE__} warning: already remixed constant #{options[:class_name]}"
           end
@@ -232,7 +240,6 @@ module DataMapper
         #       belongs_to :bot
         #       belongs_to :tag
         #     end
-
         def enhance(remixable,remixable_model=nil, &block)
           # always use innermost singular snake_cased constant name
           remixable_name = remixable.to_s.singular.snake_case.to_sym
@@ -253,18 +260,6 @@ module DataMapper
 
         private
 
-        # - attach_accessor
-        # ==== Description
-        #   Creates additional alias for r/w accessor
-        # ==== Parameters
-        #   options <Hash> options hash
-        def attach_accessor(options)
-          self.class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-            alias #{options[:as].to_sym} #{options[:table_name].to_sym}
-            alias #{options[:as].to_sym}= #{options[:table_name].to_sym}=
-          EOS
-        end
-
         # - populate_remixables_mapping
         # ==== Description
         #   Populates the Hash of remixables with information about the remixable
@@ -290,7 +285,7 @@ module DataMapper
         #   model       <Class> remixed model that 'self' is relating to
         #   options     <Hash> options hash
         def remix_one_to_many(cardinality, model, options)
-          self.has cardinality, options[:table_name].intern
+          self.has cardinality, (options[:as] || options[:table_name]).to_sym, :class_name => model.name
           model.property Extlib::Inflection.foreign_key(self.name).intern, Integer, :nullable => false
           model.belongs_to Extlib::Inflection.tableize(self.name).intern
         end
@@ -311,7 +306,7 @@ module DataMapper
 
           # Is M:M between two different classes or the same class
           unless self.name == options[:other_model].name
-            self.has cardinality, options[:table_name].intern
+            self.has cardinality, (options[:as] || options[:table_name]).to_sym, :class_name => model.name
             options[:other_model].has cardinality, options[:table_name].intern
 
             model.belongs_to  Extlib::Inflection.tableize(self.name).intern
@@ -319,7 +314,7 @@ module DataMapper
           else
             raise Exception, "options[:via] must be specified when Remixing a module between two of the same class" unless options[:via]
 
-            self.has cardinality, options[:table_name].intern
+            self.has cardinality, (options[:as] || options[:table_name]).to_sym, :class_name => model.name
             model.belongs_to Extlib::Inflection.tableize(self.name).intern
             model.belongs_to options[:via].intern, :class_name => options[:other_model].name, :child_key => ["#{options[:via]}_id".intern]
           end
@@ -350,6 +345,15 @@ module DataMapper
             model.property(prop.name, prop.type, prop.options)
           end
 
+          # attach remixed model access to RemixeeClassMethods and RemixeeInstanceMethods if defined
+          if Object.full_const_defined? "#{remixable}::RemixeeClassMethods"
+            model.send :extend, Object.full_const_get("#{remixable}::RemixeeClassMethods")
+          end
+
+          if Object.full_const_defined? "#{remixable}::RemixeeInstanceMethods"
+            model.send :include, Object.full_const_get("#{remixable}::RemixeeInstanceMethods")
+          end
+          
           model
         end
 
@@ -358,7 +362,7 @@ module DataMapper
       # - RemixeeClassMethods
       # ==== Description
       #   Methods available to any model that is :remixable
-      module RemixeeClassMethods
+      module RemixeeClassMethods                
         # - suffix
         # ==== Description
         #   modifies the storage name suffix, which is by default based on the Remixable Module name

data/lib/dm-is-remixable/is/version.rb

@@ -1,7 +1,7 @@
 module DataMapper
   module Is
     module Remixable
-      VERSION = "0.9.7"
+      VERSION = "0.9.8"
     end
   end
 end

data/spec/data/commentable.rb

@@ -7,4 +7,5 @@ module Commentable
   property :id,         Integer, :key => true, :serial => true
   property :comment,    String
   property :created_at, DateTime
+  
 end

data/spec/data/image.rb

@@ -6,4 +6,40 @@ module Image
   property :id,           Integer, :key => true, :serial => true
   property :description,  String
   property :path,         String
+  
+  # These methods will be available to the class remixing this module
+  #   If 'User' remixes 'Images', these methods will be available to a User class
+  #
+  module RemixerClassMethods
+    def test_remixer_class_method
+      'CLASS METHOD FOR REMIXER'
+    end
+  end
+  
+  # These methods will be available to instantiated objects of the remixing this module
+  #   If 'User' remixes 'Images', these methods will be available to a User object
+  #
+  module RemixerInstanceMethods
+    def test_remixer_instance_method
+      'INSTANCE METHOD FOR REMIXER'
+    end
+  end
+  
+  # These methods will be available to the Generated Remixed Class
+  #   If 'User' remixes 'Images', these methods will be available to UserImage class
+  #
+  module RemixeeClassMethods
+    def test_remixee_class_method
+      'CLASS METHOD FOR REMIXEE'
+    end
+  end
+  
+  # These methods will be available to an instantiated Generated Remixed Class
+  #   If 'User' remixes 'Images', these methods will be available to a UserImage object
+  #
+  module RemixeeInstanceMethods
+    def test_remixee_instance_method
+      'INSTANCE METHOD FOR REMIXEE'
+    end
+  end
 end

data/spec/integration/remixable_spec.rb

@@ -33,7 +33,7 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
 
     it "should not allow enhancements of modules that aren't remixed" do
       lambda {
-        User.enhance Image
+        User.enhance :images
       }.should raise_error
     end
 
@@ -135,7 +135,6 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
     it "should allow creating an accessor alias" do
       article = Article.new
       article.should respond_to("pics")
-      article.should respond_to("article_images")
     end
 
     it "should copy properties from the Remixable Module to the Remixed Model" do
@@ -196,8 +195,10 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       article.pics.path.should == image2.path
     end
 
+    # Example:
+    #   Users are Commentable by many Users
+    #
     it "should allow M:M unary relationships through the Remixable Module" do
-      #User => Commentable => User
       user = User.new
       user.first_name = "Tester"
       user2 = User.new
@@ -206,16 +207,20 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       comment = UserComment.new
       comment.comment = "YOU SUCK!"
       comment.commentor = user2
-      user.user_comments << comment
 
-      user2.user_comments.length.should be(0)
+      user.comments << comment
+
+      user2.comments.length.should be(0)
 
       comment.commentor.first_name.should == "Testy"
-      user.user_comments.length.should be(1)
+      
+      user.comments.length.should be(1)
     end
 
+    # Example:
+    #   Articles are Commentable by many Users
+    #
     it "should allow M:M relationships through the Remixable Module" do
-      #Article => Commentable => User
       user = User.new
       article = Article.new
 
@@ -235,5 +240,89 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
       article.comments.first.should be(ac)
       user.article_comments.first.should be(ac)
     end
+    
+    # Example:
+    # Remixable Image add functionality to any class that remixes it
+    #   Image::RemixerClassMethods defines a method called 'total_images' that counts the total number of images for the class
+    #   Image::RemixerInstanceMethods defines a method called 'most_viewed_image' that find the most viewed image for an object
+    #
+    #   User.remixes n, :images
+    #   User.total_images => count of all images owned by all users
+    #   User.first.most_viewed_image => would return the most viewed image
+    # 
+    it "should add a remixables' 'RemixerClassMethods' modules to the remixing class" do
+      Article.respond_to?(:test_remixer_class_method).should be(true)
+      Article.test_remixer_class_method.should == 'CLASS METHOD FOR REMIXER'
+    end
+    
+    it "should add a remixables' 'RemixerInstanceMethods' modules to the remixing class" do
+      Article.new.respond_to?(:test_remixer_instance_method).should be(true)
+      Article.new.test_remixer_instance_method.should == 'INSTANCE METHOD FOR REMIXER'
+    end
+    
+    # Example:
+    # Remixable Image add functionality to any class that remixes it
+    #   Image::RemixeeClassMethods defines a method called 'damaged_files' would return a list of all images with invalid checksums (or whatev)
+    #   Image::RemixeeInstanceMethods defines a method called 'mime_type' that find the mime type of the particular image
+    #
+    #   Article.remixes n, :images
+    #   # => yields and ArticleImage Class
+    #   ArticleImage.damaged_files => list of all images with invalid checksums
+    #   ArticleImage.first.mime_type => would return the mime type of that image
+    #
+    it "should add a remixables' 'RemixeeClassMethods' modules to the generated remixed class" do
+      ArticleImage.respond_to?(:test_remixee_class_method).should be(true)
+      ArticleImage.test_remixee_class_method.should == 'CLASS METHOD FOR REMIXEE'
+    end
+    
+    it "should add a remixables' 'RemixeeInstanceMethods' modules to the generated remixed class" do
+      ArticleImage.new.respond_to?(:test_remixee_instance_method).should be(true)
+      ArticleImage.new.test_remixee_instance_method.should == 'INSTANCE METHOD FOR REMIXEE'
+    end
+    
+    # Example:
+    # User.remixes n, :images, :as => "pics"
+    # User.first.pics would be the acessor for images
+    # User.first.user_images should raise method not found
+    #
+    it 'should remove the original attribute accessor when attaching an optional one' do
+      Article.new.respond_to?(:pics).should be(true)      
+      User.new.respond_to?(:user_addresses).should be(true)
+    end
+    
+    # Currently:
+    #   Submission.remixes n, :comments
+    #   SubmissionComment.new.user = User.first => throws exception, accessor name is 'users' instead
+    #
+    # Example:
+    #   User.remix 1, :images 
+    #     # => User.image & UserImage.user
+    #
+    #   User.remix n, :images 
+    #     # => User.images & UserImage.user
+    #   
+    #   User.remix n, :comments, :for => 'User', :via => 'commentor'
+    #     # => User.comments & UserComment.user & UserComment.commentor
+    #
+    it 'should pluralize accessor names with respect to cardinality' do
+      pending
+    end
+    
+    # Note:
+    # Currently the :via flag allows one to specify another name for the field, but it always appends _id
+    # 
+    # Example:
+    #   User w/ PK being 'login_name'
+    #   User.remixes n, :comments, :for => 'User', :via => 'commentor'
+    #   
+    #   Comment Table:
+    #     * id 
+    #     * text
+    #     * user_login_name
+    #     * commentor_id #=> should be able to specify it to be commentor_login_name
+    #
+    it 'should allow the primary and child field names to be specified while remixing' do
+      pending
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ gem 'rspec', '>=1.1.3'
 require 'spec'
 require 'pathname'
 require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-remixable'
-require "ruby-debug"
+
 def load_driver(name, default_uri)
   return false if ENV['ADAPTER'] != name.to_s
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-is-remixable
 version: !ruby/object:Gem::Version 
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors: 
 - Cory O'Daniel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-18 00:00:00 -08:00
+date: 2008-12-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,19 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.7
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 0.9.8
     version: 
 description: dm-is-remixable allow you to create reusable data functionality
 email: 
@@ -69,7 +59,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/sam/dm-more/tree/master/dm-remixes
+homepage: http://github.com/sam/dm-more/tree/master/dm-is-remixable
 post_install_message: 
 rdoc_options: 
 - --main