dm-tags 0.0.2

data/History.txt

@@ -0,0 +1,9 @@
+== 0.0.1 2008-07-29
+
+* 1 major enhancement:
+  * Initial release
+
+== 0.0.2 2008-07-30
+
+* 1 major enhancement:
+  * Added contextual finding to Model.tagged_with

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Bobby Calderwood
+
+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,20 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/dm-tags.rb
+lib/dm-tags/dm_tags.rb
+lib/dm-tags/tag.rb
+lib/dm-tags/tagging.rb
+lib/dm-tags/version.rb
+setup.rb
+spec/classes.rb
+spec/dm-setup.rb
+spec/dm-tags/dm_tags_spec.rb
+spec/dm-tags/tag_spec.rb
+spec/dm-tags/taggable_spec.rb
+spec/dm-tags/tagging_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.txt

@@ -0,0 +1,113 @@
+= dm-tags
+
+http://dm-tags.rubyforge.org/
+http://github.com/bobby/dm-tags/
+
+== Description
+
+This package brings tagging to DataMapper.  It is inspired by Acts As Taggable On by Michael Bleigh, github's mbleigh.  Props to him for the contextual tagging based on Acts As Taggable on Steroids.
+
+== Features and Problems
+
+=== Features
+
+* Contextual tagging using Model.has_tags_on (see below for usage)
+* Traditional 'tags-only' tagging using Model.has_tags
+
+=== Problems
+
+* None known yet, but this is very alpha software.  Sorry if it misbehaves.  Please send me a github message if you find a bug.
+
+== Synopsis
+
+require 'rubygems'
+require 'dm-core'
+require 'dm-tags'
+
+DataMapper.setup(:default, "sqlite3::memory:")
+
+class MyModel
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+  has_tags_on :tags, :skills
+end
+
+DataMapper.auto_migrate!
+
+# Contextual tagging
+MyModel.taggable? #=> true
+MyModel.new.taggable? #=> true
+
+model = MyModel.new
+model.tag_list = 'test, me out,   please   '
+model.tag_list #=> ['me out', 'please', 'test'] # Sanitized and alphabetized
+model.save #=> true
+model.tags #=> [#<Tag id=1 name="me out">, #<Tag id=2 name="please">, #<Tag id=3 name="test">]
+model.tag_list = 'test, again'
+model.save #=> true
+model.tags #=> [#<Tag id=3 name="test">, #<Tag id=4 name="again">] # Checks for existing tags
+Tag.all #=> [#<Tag id=1 name="me out">, #<Tag id=2 name="please">, #<Tag id=3 name="test">, #<Tag id=4 name="again">]
+another = MyModel.new
+another.skill_list = 'test, all, you, like'
+another.save #=> true
+another.tag_list #=> []
+another.skills
+#=> [#<Tag id=5 name="all">, #<Tag id=6 name="like">, #<Tag id=3 name="test">, #<Tag id=7 name="you">]
+
+MyModel.tagged_with('test') #=> [#<MyModel id=1>, #<MyModel id=2>]
+MyModel.tagged_with('test', :on => 'tags') #=> [#<MyModel id=1>]
+MyModel.tagged_with('test', :on => 'skills') #=> [#<MyModel id=2>]
+
+# Traditional 'tags only' tagging
+
+class TagsOnly
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+  has_tags
+end
+
+TagsOnly.auto_migrate!
+
+TagsOnly.taggable? #=> true
+TagsOnly.new.taggable? #=> true
+
+tags_only = TagsOnly.new
+tags_only.tag_list = 'tags, only'
+tags_only.tag_list #=> ['only', 'tags']
+tags_only.save #=> true
+tags_only.tags #=> [#<Tag id=8 name="only">, #<Tag id=9 name="tags">]
+
+== Requirements
+
+* DataMapper (dm-core)
+
+== Installation
+
+  git clone http://github.com/bobby/dm-tags
+  cd dm-tags
+  rake install
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008 Bobby Calderwood
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/lib/dm-tags/dm_tags.rb

@@ -0,0 +1,97 @@
+require 'dm-core'
+module DataMapper
+  module Resource
+    class << self
+      alias_method :old_included, :included
+      def included(receiver)
+        old_included(receiver)
+        receiver.send(:include, DataMapper::Tags)
+      end
+    end
+  end
+end
+module DataMapper
+  module Tags
+    module ClassMethods
+      def has_tags_on(*args)
+        args.flatten!
+        args.uniq!
+        
+        self.extend(DataMapper::Tags::SingletonMethods)
+        
+        args.map{|arg| arg.to_sym}.each do |arg|
+          class_eval <<-RUBY
+          property :frozen_#{arg.to_s.singular}_list, String
+          has n, :#{arg.to_s.singular}_taggings, :class_name => "Tagging", :child_key => [:taggable_id],
+          :taggable_type => self.to_s, :tag_context => "#{arg}"
+          before :save, :update_#{arg}
+
+          def #{arg}
+            #{arg.to_s.singular}_taggings.map{|tagging| tagging.tag}
+          end
+
+          def #{arg.to_s.singular}_list
+            @#{arg.to_s.singular}_list || #{arg}.map{|#{arg.to_s.singular}| #{arg.to_s.singular}.name}.sort
+          end
+
+          def #{arg.to_s.singular}_list=(string)
+            @#{arg.to_s.singular}_list = string.to_s.split(",").map{|name| name.gsub(/[^\\w\\s_-]/i,"").strip}.uniq.sort
+          end
+
+          def update_#{arg}
+            return if #{arg.to_s.singular}_list.empty?
+            deleted_#{arg} = frozen_#{arg.to_s.singular}_list.to_s.split(',') - #{arg.to_s.singular}_list
+            deleted_#{arg}.each do |name|
+              tag = Tag.first(:name => name)
+              tagging = #{arg.to_s.singular}_taggings.first(:tag_id => tag.id)
+              tagging.destroy
+              #{arg.to_s.singular}_taggings.reload
+            end
+            #{arg.to_s.singular}_list.each do |name|
+              tag = Tag.first(:name => name)
+              next if #{arg}.to_a.include?(tag)
+              tag = Tag.create!(:name => name) unless tag
+              #{arg.to_s.singular}_taggings << Tagging.new(:tag => tag, :taggable_type => self.class.to_s, :tag_context => "#{arg}")
+            end
+            self.frozen_#{arg.to_s.singular}_list = #{arg}.map{|#{arg.to_s.singular}| #{arg.to_s.singular}.name}.sort.join(',')
+          end
+        RUBY
+      end
+    end
+
+  def has_tags(*args)
+    has_tags_on :tags
+  end
+
+  def taggable?
+    false
+  end
+end
+
+module SingletonMethods
+  # Class Methods
+  def tagged_with(string, options = {})
+    tag = Tag.first(:name => string)
+    conditions = {}
+    conditions[:tag_id] = tag.id
+    conditions[:tag_context] = options[:on] if options[:on]
+    Tagging.all(conditions).map{|tagging| tagging.taggable}
+  end
+  
+  def taggable?
+    true
+  end
+end
+
+module InstanceMethods
+  def taggable?
+    self.class.taggable?
+  end
+end
+
+def self.included(receiver)
+  receiver.send(:include, InstanceMethods)
+  receiver.extend(ClassMethods)
+end
+end
+end

data/lib/dm-tags/tag.rb

@@ -0,0 +1,11 @@
+class Tag
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+  property :name, String, :nullable => false, :unique => true
+
+  has n, :taggings
+  
+  def taggables
+    taggings.map{|tagging| tagging.taggable}
+  end
+end

data/lib/dm-tags/tagging.rb

@@ -0,0 +1,14 @@
+class Tagging
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+  property :tag_id, Integer, :nullable => false
+  property :taggable_id, Integer, :nullable => false
+  property :taggable_type, String, :nullable => false
+  property :tag_context, String, :nullable => false
+  
+  belongs_to :tag
+  
+  def taggable
+    eval("#{taggable_type}.get!(#{taggable_id})") if taggable_type and taggable_id
+  end
+end

data/lib/dm-tags/version.rb

@@ -0,0 +1,10 @@
+require 'dm-core'
+module DataMapper::Tags
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/dm-tags.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'dm-tags/tagging'
+require 'dm-tags/tag'
+require 'dm-tags/dm_tags'