dm-is-remixable 0.9.7

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.9.3 / 2008-07-31
+
+* 1 major enhancement
+
+  * Pre-Release, super beta.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Cory ODaniel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-is-remixable.rb
+lib/dm-is-remixable/is/remixable.rb
+lib/dm-is-remixable/is/version.rb
+spec/data/addressable.rb
+spec/data/article.rb
+spec/data/billable.rb
+spec/data/bot.rb
+spec/data/commentable.rb
+spec/data/image.rb
+spec/data/rating.rb
+spec/data/tag.rb
+spec/data/taggable.rb
+spec/data/topic.rb
+spec/data/user.rb
+spec/data/viewable.rb
+spec/integration/remixable_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,127 @@
+= dm-is-remixable
+
+DataMapper::Is::Remixable allows you to create re-usable chunks of relational data, its kind of like multiple
+inheritance for models.
+
+
+For example:
+#Comments are everywhere, why define them over and over?
+module Comment
+  include DataMapper::Resource
+  is :remixable
+
+  property :id,         Integer, :key => true, :serial => true
+  property :body,       String
+  property :created_at, DateTime
+end
+
+#Lots of things can be addressable; people, buildings
+module Addressable
+  include DataMapper::Resource
+
+  is :remixable,
+    :suffix => "address" #Default suffix is module name pluralized
+
+  property :id,         Integer, :key => true, :serial => true
+
+  property :label,      String #home, work, etc...
+
+  property :address1,   String, :length => 255
+  property :address2,   String, :length => 255
+
+  property :city,       String, :length => 128
+  property :state,      String, :length => 2
+  property :zip,        String, :length => 5..10
+end
+
+module Vote
+  include DataMapper::Resource
+
+  is :remixable
+
+  property :id,         Integer, :key => true, :serial => true
+  property :opinion,    Enum.new("good","bad")
+
+end
+
+class Location
+  include DataMapper::Resource
+
+  #Location can have 1 address
+  remix 1, :addressables
+
+  # This does the following:
+  # - creates a class called LocationAddress
+      (default name would be LocationAddressable, but Addressable#suffix was specified)
+  # - duplicates the properties of Addressable within LocationAddress
+  # - a table called location_addresses
+  # - creates Location#location_addresses accessor
+
+  #... methods, properties, etc ...#
+end
+
+
+class User
+  include DataMapper::Resource
+
+  #User can have many addresses
+  remix n, :addressables, :as => "addresses"
+  # - creates a class called UserAddress
+      (default name would be UserAddressable, but Addressable#suffix was specified)
+  # - duplicates the properties of Addressable within UserAddress
+  # - a table called user_addresses
+  # - creates User#user_addresses accessor
+  # - creates an accessor alias User#addresses
+
+  enhance :addressables do
+    storage_names[:default] = "a_different_table_name"
+    property :label, Enum.new("work","home")
+
+    #This adds a column to user_addresses to store an address label
+  end
+
+  #... methods, properties, etc ...#
+end
+
+class Article
+  include DataMapper::Resource
+
+  remix n, :comments, :for => "User"
+  # - creates a class called ArticleComment
+  # - duplicates the properties of Comment within ArticleComment
+  # - a table called article_comments
+  # - creates Article#article_comments
+  # - creates User#article_comments
+
+  #... methods, properties, etc ...#
+
+end
+
+class Video
+  include DataMapper::Resource
+
+  remix n, :comments, :for => "User", :as => "comments"
+  # - creates a class called VideoComment
+  # - duplicates the properties of Comment within VideoComment
+  # - a table called video_comments
+  # - creates Video#video_comments
+  # - creates User#video_comments
+  # - create Video#comments
+
+  enhance :comments do
+    # VideoComment now has the method #reverse
+    def reverse
+      return self.body.reverse
+    end
+
+    #I like YouTubes ability for users to vote comments up and down
+    remix 1, :votes, :for => "User"
+    # - creates a class called VideoCommentVote
+    # - duplicates the properties of Vote within VideoCommentVote
+    # - a table called video_comment_votes
+    # - creates Video#video_comments#votes
+
+  end
+
+  #... methods, properties, etc ...#
+end

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-is-remixable/is/version'
+
+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_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_DESCRIPTION = PROJECT_SUMMARY = "dm-is-remixable allow you to create reusable data functionality"
+
+require ROOT.parent + 'tasks/hoe'
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-ri --no-rdoc --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/TODO

@@ -0,0 +1,30 @@
+FIXME
+====
+Add ability to have a unique relationship when joining through remixable
+  This is stubbed at remixable.rb @~ line 223; waiting on stategic eager loading
+  M:M Video.remix n, :commentables, :as => "comments", :for => "User", :unique => false
+  M:M Article.remix n, :views, :for => "User", :unique => true
+    in the generated table article_views article_id and user_id would be a unique key,
+      only counting a users viewing of an article once
+
+TODO
+====
+- Add ability to set primary keys and indexes when remixing
+
+- 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)

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

@@ -0,0 +1,402 @@
+# reopen sam/extlib/lib/extlib/object.rb
+class Object
+
+  def full_const_defined?(name)
+    !!full_const_get(name) rescue false
+  end
+
+end
+
+Extlib::Inflection.rule 'ess', 'esses'
+
+module DataMapper
+  module Is
+    module Remixable
+
+      #==============================INCLUSION METHODS==============================#
+
+      # Adds remixer methods to DataMapper::Resource
+      def self.included(base)
+        base.send(:include,RemixerClassMethods)
+        base.send(:include,RemixerInstanceMethods)
+      end
+
+      # - is_remixable
+      # ==== Description
+      #   Adds RemixeeClassMethods and RemixeeInstanceMethods to any model that is: remixable
+      # ==== Examples
+      # class User #Remixer
+      #   remixes Commentable
+      #   remixes Vote
+      # end
+      #
+      # module Commentable #Remixable
+      #   include DataMapper::Resource
+      #
+      #   is :remixable,
+      #     :suffix => "comment"
+      # end
+      #
+      # module Vote #Remixable
+      #   include DataMapper::Resource
+      #
+      #   is :remixable
+      #
+      # ==== Notes
+      #   These options are just available for whatever reason your Remixable Module name
+      #   might not be what you'd like to see the table name and property accessor named.
+      #   These are just configurable defaults, upon remixing the class_name and accessor there
+      #   take precedence over the defaults set here
+      # ==== Options
+      #   :suffix   <String>
+      #             Table suffix, defaults to YourModule.name.downcase.singular
+      #             Yields table name of remixer_suffix; ie user_comments, user_votes
+      def is_remixable(options={})
+        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)
+      end
+
+
+      #==============================CLASS METHODS==============================#
+
+      # - RemixerClassMethods
+      # ==== Description
+      #   Methods available to all DataMapper::Resources
+      module RemixerClassMethods
+        def self.included(base);end;
+
+        def is_remixable?
+          @is_remixable ||= false
+        end
+
+        # - remixables
+        # ==== Description
+        #   Returns a hash of the remixables used by this class
+        # ==== Returns
+        #   <Hash> Remixable Class Name => Remixed Class Name
+        def remixables
+          @remixables
+        end
+
+        # - remix
+        # ==== Description
+        #   Remixes a Remixable Module
+        # ==== Parameters
+        #   cardinality <~Fixnum> 1, n, x ...
+        #   remixable   <Symbol> plural of remixable; i.e. Comment => :comments
+        #   options     <Hash>   options hash
+        #                       :class_name <String> Remixed Model name (Also creates a storage_name as tableize(:class_name))
+        #                                   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
+        #                                   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
+        #                                   a 1:M with the remixable
+        #                       :via        <String> changes the name of the second id in a unary relationship
+        #                                   see example below; only used when remixing a module between the same class twice
+        #                                   ie: self.class.to_s == options[:for||:on]
+        #                       :unique     <Boolean> Only works with :for|:on; creates a unique composite key
+        #                                   over the two table id's
+        # ==== Examples
+        # Given: User (Class), Addressable (Module)
+        #
+        #   One-To-Many; Class-To-Remixable
+        #
+        #   remix n, :addressables,
+        #     :class_name => "UserAddress",
+        #     :as         => "addresses"
+        #
+        #   Tables: users, user_addresses
+        #   Classes: User, UserAddress
+        #     User.user_addresses << UserAddress.new
+        #     User.addresses << UserAddress.new
+        #   --------------------------------------------
+        #   --------------------------------------------
+        #
+        # Given: User (Class), Video (Class), Commentable (Module)
+        #
+        #   Many-To-Many; Class-To-Class through RemixableIntermediate (Video allows Commentable for User)
+        #
+        #   Video.remix n, :commentables
+        #     :for        => 'User'    #:for & :on have same effect, just a choice of wording...
+        #   --------------------------------------------
+        #   --------------------------------------------
+        #
+        # Given: User (Class), User (Class), Commentable (Module)
+        #
+        #   Many-To-Many Unary relationship between User & User through comments
+        #   User.remix n, :commentables, :as => "comments", :for => 'User', :via => "commentor"
+        #   => This would create user_id and commentor_id as the
+        #
+        def remix(cardinality, remixable, options={})
+          #A map for remixable names to Remixed Models
+          @remixables = {} if @remixables.nil?
+
+          # Allow nested modules to be remixable to better support using dm-is-remixable in gems
+          # Example (from my upcoming dm-is-rateable gem)
+          # remix n, "DataMapper::Is::Rateable::Rating", :as => :ratings
+          remixable_module = Object.full_const_get(Extlib::Inflection.classify(remixable))
+
+          unless remixable_module.is_remixable?
+            raise Exception, "#{remixable_module} is not remixable"
+          end
+
+          #Merge defaults/options
+          options = {
+            :as         => nil,
+            :class_name => Extlib::Inflection.classify(self.name.snake_case + "_" + remixable_module.suffix.pluralize),
+            :for        => nil,
+            :on         => nil,
+            :unique     => false,
+            :via        => nil
+          }.merge(options)
+
+          #Make sure the class hasn't been remixed already
+          unless Object.full_const_defined?(Extlib::Inflection.classify(options[:class_name]))
+
+            #Storage name of our remixed model
+            options[:table_name] = Extlib::Inflection.tableize(options[:class_name])
+
+            #Other model to mix with in case of M:M through Remixable
+            options[:other_model] = options[:for] || options[:on]
+
+            DataMapper.logger.info "Generating Remixed Model: #{options[:class_name]}"
+            model = generate_remixed_model(remixable_module, options)
+
+            # map the remixable to the remixed model
+            # since this will be used from 'enhance api' i think it makes perfect sense to
+            # always refer to a remixable by its demodulized snake_cased constant name
+            remixable_key = Extlib::Inflection.demodulize(remixable_module.name).snake_case.to_sym
+            populate_remixables_mapping(model, options.merge(:remixable_key => remixable_key))
+
+            #Create relationships between Remixer and remixed class
+            if options[:other_model]
+              # M:M Class-To-Class w/ Remixable Module as intermediate table
+              # has n and belongs_to (or One-To-Many)
+              remix_many_to_many cardinality, model, options
+            else
+              # 1:M Class-To-Remixable
+              # 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
+        end
+
+        # - enhance
+        # ==== Description
+        #   Enhance a remix; allows nesting remixables, adding columns & functions to a remixed resource
+        # ==== Parameters
+        #   remixable <Symbol> Name of remixable to enhance (plural or singular name of is :remixable module)
+        #   model_class <Class, symbol, String> Name of the remixable generated Model Class.
+        #   block     <Proc>    Enhancements to perform
+        # ==== Examples
+        #   When you have one remixable:
+        #
+        #   class Video
+        #     include DataMapper::Resource
+        #     remix Comment
+        #
+        #     enhance :comments do
+        #       remix n, :votes        #This would result in something like YouTubes Voting comments up/down
+        #
+        #       property :updated_at, DateTime
+        #
+        #       def backwards; self.test.reverse; end;
+        #     end
+        #
+        #  When you remixe the same remixable modules twice:
+        #
+        #   class Article
+        #     include DataMapper::Resource
+        #     remix n, :taggings, :for => User, :class_name => "UserArticleTagging"
+        #     remix n, :taggings, :for => Bot,  :class_name => "BotArticleTagging"
+        #
+        #     enhance :taggings, "UserArticleTagging" do
+        #       property :updated_at, DateTime
+        #       belongs_to :user
+        #       belongs_to :tag
+        #     end
+        #
+        #     enhance :taggings, "BotArticleTagging" do
+        #       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
+          class_name = if remixable_model.nil?
+            @remixables[remixable_name].keys.first
+          else
+            Extlib::Inflection.demodulize(remixable_model.to_s).snake_case.to_sym
+          end
+
+          model = @remixables[remixable_name][class_name][:model] unless @remixables[remixable_name][class_name].nil?
+
+          unless model.nil?
+            model.class_eval &block
+          else
+            raise Exception, "#{remixable} must be remixed with :class_name option as #{remixable_model} before it can be enhanced"
+          end
+        end
+
+        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
+        # ==== Parameters
+        #   remixable
+        #   options <Hash> options hash
+        def populate_remixables_mapping(remixable_model, options)
+          key = options[:remixable_key]
+          accessor_name = options[:as] ? options[:as] : options[:table_name]
+          @remixables[key] ||= {}
+          model_key = Extlib::Inflection.demodulize(remixable_model.to_s).snake_case.to_sym
+          @remixables[key][model_key] ||= {}
+          @remixables[key][model_key][:reader] ||= accessor_name.to_sym
+          @remixables[key][model_key][:writer] ||= "#{accessor_name}=".to_sym
+          @remixables[key][model_key][:model] ||= remixable_model
+        end
+
+        # - remix_one_to_many
+        # ==== Description
+        #   creates a one to many relationship Class has many of remixed model
+        # ==== Parameters
+        #   cardinality <Fixnum> cardinality of relationship
+        #   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
+          model.property Extlib::Inflection.foreign_key(self.name).intern, Integer, :nullable => false
+          model.belongs_to Extlib::Inflection.tableize(self.name).intern
+        end
+
+        # - remix_many_to_many
+        # ==== Description
+        #   creates a many to many relationship between two DataMapper models THROUGH a Remixable module
+        # ==== Parameters
+        #   cardinality <Fixnum> cardinality of relationship
+        #   model       <Class> remixed model that 'self' is relating through
+        #   options     <Hash> options hash
+        def remix_many_to_many(cardinality, model, options)
+          options[:other_model] = Object.full_const_get(Extlib::Inflection.classify(options[:other_model]))
+
+          #TODO if options[:unique] the two *_id's need to be a unique composite key, maybe even
+          # attach a validates_is_unique if the validator is included.
+          puts " ~ options[:unique] is not yet supported" if options[:unique]
+
+          # 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
+            options[:other_model].has cardinality, options[:table_name].intern
+
+            model.belongs_to  Extlib::Inflection.tableize(self.name).intern
+            model.belongs_to  Extlib::Inflection.tableize(options[:other_model].name).intern
+          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
+            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
+        end
+
+        # - generate_remixed_model
+        # ==== Description
+        #   Generates a Remixed Model Class from a Remixable Module and options
+        # ==== Parameters
+        #   remixable <Module> module that is being remixed
+        #   options   <Hash> options hash
+        # ==== Returns
+        #   <Class> remixed model
+        def generate_remixed_model(remixable,options)
+          #Create Remixed Model
+          klass = Class.new Object do
+            include DataMapper::Resource
+          end
+
+          #Give remixed model a name and create its constant
+          model = Object.full_const_set(options[:class_name], klass)
+
+          #Get instance methods & validators
+          model.send(:include,remixable)
+
+          #port the properties over...
+          remixable.properties.each do |prop|
+            model.property(prop.name, prop.type, prop.options)
+          end
+
+          model
+        end
+
+      end # RemixerClassMethods
+
+      # - RemixeeClassMethods
+      # ==== Description
+      #   Methods available to any model that is :remixable
+      module RemixeeClassMethods
+        # - suffix
+        # ==== Description
+        #   modifies the storage name suffix, which is by default based on the Remixable Module name
+        # ==== Parameters
+        #   suffix <String> storage name suffix to use (singular)
+        def suffix(sfx=nil)
+          @suffix = sfx unless sfx.nil?
+          @suffix
+        end
+
+        # Squash auto_migrate!
+        # model.auto_migrate! never gets called directly from dm-core/auto_migrations.rb
+        # The models are explicitly migrated down and up again.
+        def auto_migrate_up!(args=nil)
+          DataMapper.logger.warn("Skipping auto_migrate_up! for remixable module (#{self.name})")
+        end
+
+        def auto_migrate_down!(args=nil)
+          DataMapper.logger.warn("Skipping auto_migrate_down! for remixable module (#{self.name})")
+        end
+
+        #Squash auto_upgrade!
+        def auto_upgrade!(args=nil)
+          DataMapper.logger.warn("Skipping auto_upgrade! for remixable module (#{self.name})")
+        end
+      end # RemixeeClassMethods
+
+
+      #==============================INSTANCE METHODS==============================#
+
+      module RemixeeInstanceMethods
+        def self.included(base);end;
+      end # RemixeeInstanceMethods
+
+      module RemixerInstanceMethods
+        def self.included(base);end;
+      end # RemixerInstanceMethods
+
+    end # Example
+  end # Is
+end # DataMapper

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

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

data/lib/dm-is-remixable.rb

@@ -0,0 +1,19 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~>0.9.7'
+require 'dm-core'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-remixable' / 'is' / 'remixable.rb'
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Is::Remixable
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/spec/data/addressable.rb

@@ -0,0 +1,15 @@
+module Addressable
+  include DataMapper::Resource
+
+  is :remixable,
+    :suffix => "address"
+
+  property :id,         Integer, :key => true, :serial => true
+
+  property :address1,   String, :length => 255
+  property :address2,   String, :length => 255
+
+  property :city,       String, :length => 128
+  property :state,      String, :length => 2
+  property :zip,        String, :length => 5..10
+end

data/spec/data/article.rb

@@ -0,0 +1,51 @@
+require Pathname(__FILE__).dirname / "image"
+require Pathname(__FILE__).dirname / "commentable"
+require Pathname(__FILE__).dirname / "viewable"
+require Pathname(__FILE__).dirname / "taggable"
+require Pathname(__FILE__).dirname / "user"
+require Pathname(__FILE__).dirname / "bot"
+require Pathname(__FILE__).dirname / "tag"
+
+class Article
+  include DataMapper::Resource
+
+  property :id, Integer, :key => true, :serial => true
+  property :title, String
+  property :url, String
+
+
+  remix 1, :images, :as => "pics"
+
+  remix n, :viewables, :as => "views"
+
+  remix n, :commentables, :as => "comments", :for => "User"
+
+  remix n, "My::Nested::Remixable::Rating", :as => :ratings
+
+  remix n, :taggable, :as => "user_taggings", :for => "User", :class_name => "UserTagging"
+
+  remix n, :taggable, :as => "bot_taggings", :for => "Bot", :class_name => "BotTagging"
+
+  enhance :viewables do
+    belongs_to :user
+  end
+
+  enhance :taggable, "UserTagging" do
+    belongs_to :user
+    belongs_to :tag
+  end
+
+  enhance :taggable, "BotTagging" do
+    belongs_to :bot
+    belongs_to :tag
+  end
+
+  def viewed_by(usr)
+    art_view = ArticleView.new
+    art_view.ip = "127.0.0.1"
+    art_view.user_id = usr.id
+
+    self.views << art_view
+  end
+
+end

data/spec/data/billable.rb

@@ -0,0 +1,12 @@
+module Billable
+  include DataMapper::Resource
+
+  is :remixable,
+    :suffix => "billing_account"
+
+  property :id,         Integer, :key => true, :serial => true
+
+  property :cc_type,    Enum.new("mastercard","amex","visa")
+  property :cc_num,     String, :length => 12..20
+  property :expiration, Date
+end

data/spec/data/bot.rb

@@ -0,0 +1,21 @@
+require Pathname(__FILE__).dirname / "viewable"
+require Pathname(__FILE__).dirname / "billable"
+require Pathname(__FILE__).dirname / "addressable"
+require Pathname(__FILE__).dirname / "rating"
+
+class Bot
+  include DataMapper::Resource
+
+  property :id,             Integer,
+    :key          => true,
+    :serial       => true
+
+  property :bot_name,     String,
+    :nullable     => false,
+    :length       => 2..50
+
+  property :bot_version,      String,
+    :nullable     => false,
+    :length       => 2..50
+
+end

data/spec/data/commentable.rb

@@ -0,0 +1,10 @@
+module Commentable
+  include DataMapper::Resource
+
+  is :remixable,
+    :suffix => "comment"
+
+  property :id,         Integer, :key => true, :serial => true
+  property :comment,    String
+  property :created_at, DateTime
+end

data/spec/data/image.rb

@@ -0,0 +1,9 @@
+module Image
+  include DataMapper::Resource
+
+  is :remixable
+
+  property :id,           Integer, :key => true, :serial => true
+  property :description,  String
+  property :path,         String
+end

data/spec/data/rating.rb

@@ -0,0 +1,37 @@
+module My
+  module Nested
+    module Remixable
+
+      module Rating
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        include DataMapper::Resource
+
+        is :remixable
+
+        # properties
+
+        property :id,      Integer, :serial => true
+
+        property :user_id, Integer, :nullable => false
+        property :rating,  Integer, :nullable => false, :default => 0
+
+        module ClassMethods
+
+          # total rating for all rateable instances of this type
+          def total_rating
+            rating_sum = self.sum(:rating).to_f
+            rating_count = self.count.to_f
+            rating_count > 0 ? rating_sum / rating_count : 0
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

data/spec/data/tag.rb

@@ -0,0 +1,6 @@
+class Tag
+  include DataMapper::Resource
+
+  property :id, Integer, :key => true, :serial => true
+  property :name, String, :unique => true, :nullable => false
+end

data/spec/data/taggable.rb

@@ -0,0 +1,24 @@
+module Taggable
+  def self.included(base)
+    base.extend Taggable::ClassMethods
+  end
+
+  include DataMapper::Resource
+
+  is :remixable
+
+  property :id, Integer, :key => true, :serial => true
+  property :tag_id, Integer
+
+
+
+
+  module ClassMethods
+
+    def related_tags
+      puts "should work"
+    end
+
+  end
+
+end

data/spec/data/topic.rb

@@ -0,0 +1,15 @@
+require Pathname(__FILE__).dirname / "rating"
+
+class Topic
+  include DataMapper::Resource
+
+  property :id, Integer, :key => true, :serial => true
+
+  property :name, String
+  property :description, String
+
+  remix n, My::Nested::Remixable::Rating,
+    :as => :ratings_for_topic,
+    :class_name => "Rating"
+
+end

data/spec/data/user.rb

@@ -0,0 +1,34 @@
+require Pathname(__FILE__).dirname / "viewable"
+require Pathname(__FILE__).dirname / "billable"
+require Pathname(__FILE__).dirname / "addressable"
+require Pathname(__FILE__).dirname / "rating"
+
+class User
+  include DataMapper::Resource
+
+  property :id,             Integer,
+    :key          => true,
+    :serial       => true
+
+  property :first_name,     String,
+    :nullable     => false,
+    :length       => 2..50
+
+  property :last_name,      String,
+    :nullable     => false,
+    :length       => 2..50
+
+  remix n, :viewables
+
+  remix n, :billables, :class_name => "Account"
+
+  remix n, :addressables
+
+  remix n, :commentables, :as => "comments", :for => "User", :via => "commentor"
+
+  remix n, "My::Nested::Remixable::Rating"
+
+  enhance :addressables do
+    property :label, Enum.new('home','work')
+  end
+end

data/spec/data/viewable.rb

@@ -0,0 +1,11 @@
+module Viewable
+  include DataMapper::Resource
+
+  is :remixable,
+    :suffix => "view"
+
+  property :id, Integer, :key => true, :serial => true
+
+  property :created_at, DateTime
+  property :ip, String
+end

data/spec/integration/remixable_spec.rb

@@ -0,0 +1,239 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+require "dm-types"
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'addressable'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'billable'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'commentable'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'article'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'image'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'user'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'viewable'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'topic'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'rating'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'taggable'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'bot'
+require Pathname(__FILE__).dirname.expand_path.parent / 'data' / 'tag'
+DataMapper.auto_migrate!
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Remixable' do
+    describe 'DataMapper::Resource' do
+      it "should know if it is remixable" do
+        User.is_remixable?.should be(false)
+        Image.is_remixable?.should be(true)
+        Article.is_remixable?.should be(false)
+        Commentable.is_remixable?.should be(true)
+      end
+    end
+
+    it "should only allow remixables to be remixed" do
+      lambda { User.remix 1, :articles }.should raise_error(Exception)
+    end
+
+    it "should not allow enhancements of modules that aren't remixed" do
+      lambda {
+        User.enhance Image
+      }.should raise_error
+    end
+
+    it "should provide a default suffix values for models that do 'is :remixable'" do
+      Image.suffix.should == "image"
+    end
+
+    it "should allow enhancing a model that is remixed" do
+      Article.enhance :images do
+        def self.test_enhance
+          true
+        end
+      end
+
+      ArticleImage.should respond_to("test_enhance")
+    end
+
+    it "should allow enhancing a model that was remixed from a nested module" do
+      Article.enhance :ratings do
+        def self.test_enhance
+          true
+        end
+      end
+
+      ArticleRating.should respond_to("test_enhance")
+      ArticleRating.should respond_to("total_rating")
+      ArticleRating.new.should respond_to("user_id")
+      ArticleRating.new.should respond_to("rating")
+    end
+
+    it "should allow enhancing the same remixable twice with different class_name attributes" do
+      Article.enhance :taggable, "UserTagging" do
+        def self.test_enhance
+          true
+        end
+      end
+
+      UserTagging.should respond_to("test_enhance")
+      UserTagging.should respond_to("related_tags")
+      UserTagging.new.should respond_to("user_id")
+      UserTagging.new.should respond_to("tag")
+
+      Article.enhance :taggable, "BotTagging" do
+        def self.test_enhance_2
+          true
+        end
+      end
+      BotTagging.should respond_to("test_enhance_2")
+      BotTagging.should respond_to("related_tags")
+      BotTagging.new.should respond_to("bot_id")
+      BotTagging.new.should respond_to("tag")
+    end
+
+    it "should through exception when enhancing an unknown class" do
+      lambda {
+        Article.enhance :taggable, "NonExistentClass"
+      }.should raise_error
+    end
+
+    it "should provided a map of Remixable Modules to Remixed Models names" do
+      User.remixables.should_not be(nil)
+    end
+
+    it "should store the remixed model in the map of Remixable Modules to Remixed Models" do
+      User.remixables[:billable][:account][:model].should == Account
+      # nested remixables
+      User.remixables[:rating][:user_rating][:model].should == UserRating
+      Article.remixables[:rating][:article_rating][:model].should == ArticleRating
+      Topic.remixables[:rating][:rating][:model].should == Rating
+    end
+
+    it "should store the remixee reader name in the map of Remixable Modules to Remixed Models" do
+      User.remixables[:billable][:account][:reader].should == :accounts
+      # nested remixables
+      User.remixables[:rating][:user_rating][:reader].should == :user_ratings
+      Article.remixables[:rating][:article_rating][:reader].should == :ratings
+      Topic.remixables[:rating][:rating][:reader].should == :ratings_for_topic
+    end
+
+    it "should store the remixee writer name in the map of Remixable Modules to Remixed Models" do
+      User.remixables[:billable][:account][:writer].should == :accounts=
+      # nested remixables
+      User.remixables[:rating][:user_rating][:writer].should == :user_ratings=
+      Article.remixables[:rating][:article_rating][:writer].should == :ratings=
+      Topic.remixables[:rating][:rating][:writer].should == :ratings_for_topic=
+    end
+
+    it "should allow specifying an alternate class name" do
+      User.remixables[:billable][:account][:model].name.should_not == "UserBillable"
+      User.remixables[:billable][:account][:model].name.should == "Account"
+    end
+
+    it "should create a storage name based on the class name" do
+
+      Article.remixables[:image][:article_image][:model].storage_names[:default].should == "article_images"
+      User.remixables[:billable][:account][:model].storage_names[:default].should == "accounts"
+    end
+
+    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
+      #Billabe => Account
+      account = Account.new
+
+      account.should respond_to("cc_num")
+      account.should respond_to("cc_type")
+      account.should respond_to("expiration")
+    end
+
+    it "should allow 1:M relationships with the Remixable Module" do
+      user = User.new
+      addy = UserAddress.new
+      addy2 = UserAddress.new
+
+      user.first_name = "Jack"
+      user.last_name = "Tester"
+
+      addy.address1 = "888 West Whatnot Ave."
+      addy.city = "Los Angeles"
+      addy.state = "CA"
+      addy.zip = "90230"
+
+      addy2.address1 = "325 East NoWhere Lane"
+      addy2.city = "Fort Myers"
+      addy2.state = "FL"
+      addy2.zip = "33971"
+
+      user.user_addresses << addy
+      user.user_addresses << addy2
+
+      user.user_addresses.length.should be(2)
+    end
+
+    it "should allow 1:1 relationships with the Remixable Module" do
+      article = Article.new
+      image1  = ArticleImage.new
+      image2  = ArticleImage.new
+
+      article.title = "Really important news!"
+      article.url = "http://example.com/index.html"
+
+      image1.description = "Shocking and horrific photo!"
+      image1.path = "~/pictures/shocking.jpg"
+
+      image2.description = "Other photo"
+      image2.path = "~/pictures/mom_naked.yipes"
+
+      begin
+        article.pics << image1
+        false
+      rescue Exception => e
+        e.class.should be(NoMethodError)
+      end
+
+      article.pics = image2
+      article.pics.path.should == image2.path
+    end
+
+    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
+      user2.first_name = "Testy"
+
+      comment = UserComment.new
+      comment.comment = "YOU SUCK!"
+      comment.commentor = user2
+      user.user_comments << comment
+
+      user2.user_comments.length.should be(0)
+
+      comment.commentor.first_name.should == "Testy"
+      user.user_comments.length.should be(1)
+    end
+
+    it "should allow M:M relationships through the Remixable Module" do
+      #Article => Commentable => User
+      user = User.new
+      article = Article.new
+
+      ac = ArticleComment.new
+
+      user.first_name = "Talker"
+      user.last_name = "OnTheInternetz"
+
+      article.url = "Http://example.com/"
+      article.title = "Important internet thingz, lol"
+
+      ac.comment = "This article sux!"
+
+      article.comments << ac
+      user.article_comments << ac
+
+      article.comments.first.should be(ac)
+      user.article_comments.first.should be(ac)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+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
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '~>0.9.7'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-remixable
+version: !ruby/object:Gem::Version 
+  version: 0.9.7
+platform: ruby
+authors: 
+- Cory O'Daniel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  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: 
+description: dm-is-remixable allow you to create reusable data functionality
+email: 
+- dm-is-remixable [a] coryodaniel [d] com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- LICENSE
+- TODO
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/dm-is-remixable.rb
+- lib/dm-is-remixable/is/remixable.rb
+- lib/dm-is-remixable/is/version.rb
+- spec/data/addressable.rb
+- spec/data/article.rb
+- spec/data/billable.rb
+- spec/data/bot.rb
+- spec/data/commentable.rb
+- spec/data/image.rb
+- spec/data/rating.rb
+- spec/data/tag.rb
+- spec/data/taggable.rb
+- spec/data/topic.rb
+- spec/data/user.rb
+- spec/data/viewable.rb
+- spec/integration/remixable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-remixes
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: datamapper
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: dm-is-remixable allow you to create reusable data functionality
+test_files: []
+