dm-tags 0.0.2

data/spec/classes.rb

@@ -0,0 +1,25 @@
+class TaggedModel
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+
+  has_tags_on :skills, :interests, :tags
+end
+
+class AnotherTaggedModel
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+
+  has_tags_on :skills, :pets
+end
+
+class DefaultTaggedModel
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+
+  has_tags
+end
+
+class UntaggedModel
+  include DataMapper::Resource
+  property :id, Integer, :serial => true
+end

data/spec/dm-setup.rb

@@ -0,0 +1,2 @@
+DataMapper.setup(:default, 'sqlite3::memory:')
+DataMapper.auto_migrate!

data/spec/dm-tags/dm_tags_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe DataMapper::Tags do
+  it "should add a .has_tags method to models which include DataMapper::Resource" do
+    TaggedModel.should respond_to(:has_tags)
+    AnotherTaggedModel.should respond_to(:has_tags)
+    DefaultTaggedModel.should respond_to(:has_tags)
+    UntaggedModel.should respond_to(:has_tags)
+  end
+
+  it "should add a .has_tags_on method to models which include DataMapper::Resource" do
+    TaggedModel.should respond_to(:has_tags_on)
+    AnotherTaggedModel.should respond_to(:has_tags_on)
+    DefaultTaggedModel.should respond_to(:has_tags_on)
+    UntaggedModel.should respond_to(:has_tags_on)
+  end
+
+  describe ".has_tags_on" do
+    it "should accept an array of context names" do
+      class HasTagsOnTestModel
+        include DataMapper::Resource
+        property :id, Integer, :serial => true
+      end
+      lambda{HasTagsOnTestModel.has_tags_on(:should, 'not', :raise)}.should_not raise_error(ArgumentError)
+    end
+
+    it "should create taggable functionality for each of the context names passed" do
+      class TestModel
+        include DataMapper::Resource
+        property :id, Integer, :serial => true
+
+        has_tags_on(:pets, 'skills', :tags)
+      end
+      TestModel.should be_taggable
+      a = TestModel.new
+      a.should be_taggable
+      a.should respond_to(:pet_list)
+      a.should respond_to(:skill_list)
+      a.should respond_to(:tag_list)
+      a.should respond_to(:pet_list=)
+      a.should respond_to(:skill_list=)
+      a.should respond_to(:tag_list=)
+    end
+  end
+
+  describe ".has_tags" do
+    it "should create a taggable with 'tags' context regardless of passed arguments" do
+      class TagsOnly
+        include DataMapper::Resource
+        property :id, Integer, :serial => true
+        has_tags :pets, :skills
+      end
+      TagsOnly.should be_taggable
+      TagsOnly.new.should be_taggable
+      a = TagsOnly.new
+      a.should respond_to(:tag_list)
+      a.should respond_to(:tag_list=)
+      a.should respond_to(:tags)
+      a.should_not respond_to(:pet_list)
+      a.should_not respond_to(:pet_list=)
+      a.should_not respond_to(:pets)
+      a.should_not respond_to(:skill_list)
+      a.should_not respond_to(:skill_list=)
+      a.should_not respond_to(:skills)
+    end
+  end
+end

data/spec/dm-tags/tag_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Tag do
+  before(:each) do
+    @tag = Tag.new
+  end
+  
+  it "should have id and name properties" do
+    @tag.attributes.should have_key(:id)
+    @tag.attributes.should have_key(:name)
+  end
+  
+  it "should have many Taggings" do
+    Tag.relationships.should have_key(:taggings)
+  end
+  
+  it "should validate the presence of name" do
+    @tag.should_not be_valid
+    @tag.name = "Meme"
+    @tag.should be_valid
+  end
+end

data/spec/dm-tags/taggable_spec.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe "Taggable" do
+  before(:each) do
+    TaggedModel.all.destroy!
+    AnotherTaggedModel.all.destroy!
+    DefaultTaggedModel.all.destroy!
+    UntaggedModel.all.destroy!
+    Tag.all.destroy!
+    @taggable = DefaultTaggedModel.new
+  end
+
+  it "should have an id property" do
+    @taggable.attributes.should have_key(:id)
+  end
+
+  it "should return an alphabetically sorted array of the tag names when sent #tag_list" do
+    tag1 = Tag.create!(:name => 'tag1')
+    tag2 = Tag.create!(:name => 'tag2')
+    tag3 = Tag.create!(:name => 'tag3')
+    @taggable.tag_taggings << Tagging.new(:tag => tag1, :taggable_type => DefaultTaggedModel.to_s)
+    @taggable.tag_taggings << Tagging.new(:tag => tag2, :taggable_type => DefaultTaggedModel.to_s)
+    @taggable.tag_taggings << Tagging.new(:tag => tag3, :taggable_type => DefaultTaggedModel.to_s)
+    @taggable.save.should be_true
+    @taggable = DefaultTaggedModel.get!(@taggable.id)
+    @taggable.tag_list.should == ['tag1', 'tag2', 'tag3']
+  end
+
+  it "should set the tag list to a sanitized, stripped, alphabetized, unique array of tag names" do
+    @taggable.tag_list = "tags, !$%^&* !@more-stuff' &, tags , me_again9,  et tu   " # Must check for redundancy
+    valid_array = ["et tu", "me_again9", "more-stuff", "tags"]
+    @taggable.tag_list.should == valid_array
+    @taggable.instance_variable_get(:@tag_list).should == valid_array
+    @taggable.save
+    @taggable = DefaultTaggedModel.first
+    @taggable.tag_list.should == valid_array
+  end
+  
+  it "should set the associated collection of tags to those whose names
+      are in the tag list upon saving, creating and deleting as necessary" do
+    tag1 = Tag.create!(:name => 'tag1')
+    tag2 = Tag.create!(:name => 'tag2')
+    tag3 = Tag.create!(:name => 'tag3')
+    @taggable = TaggedModel.new
+    @taggable.tag_list = 'tag1, tag2, tag3'
+    @taggable.save.should be_true
+    @taggable.tags.sort_by{|tag| tag.id}.should == [tag1, tag2, tag3]
+    @taggable.tag_list = 'tag1, tag2'
+    @taggable.save.should be_true # Should dirty the model when changed.
+    @taggable.tags.sort_by{|tag| tag.id}.should == [tag1, tag2]
+    @taggable.tag_list = 'tag3, tag4'
+    @taggable.save.should be_true
+    @taggable = TaggedModel.first
+    @taggable.tags.sort_by{|tag| tag.id}.should == [tag3, Tag.first(:name => 'tag4')]
+    @taggable.skills.sort_by{|skill| skill.id}.should_not == [tag3, Tag.first(:name => 'tag4')]
+  end
+  
+  describe ".tagged_with" do
+    it "should have a class method .tagged_with" do
+      DefaultTaggedModel.should respond_to(:tagged_with)
+      UntaggedModel.should_not respond_to(:tagged_with)
+    end
+    
+    it "should return taggables tagged with the name given in the first argument" do
+      @taggable.tag_list = 'tag1, tag2, tag3'
+      @taggable.save
+      taggable = DefaultTaggedModel.new
+      taggable.tag_list = 'tag1, goat, fish'
+      taggable.save
+      DefaultTaggedModel.tagged_with('tag1').sort_by{|t| t.id}.to_a.should == [@taggable, taggable]
+    end
+    
+    it "should return taggables of the context specified by the second argument" do
+      taggable1 = TaggedModel.new
+      taggable2 = TaggedModel.new
+      taggable1.tag_list = 'tag1, tag2, tag3'
+      taggable2.skill_list = 'tag1, skill4'
+      taggable1.save
+      taggable2.save
+      TaggedModel.tagged_with('tag1').should == [taggable1, taggable2]
+      TaggedModel.tagged_with('tag1', :on => 'skills').should == [taggable2]
+      TaggedModel.tagged_with('tag1', :on => 'tags').should == [taggable1]
+    end
+  end
+  
+  it "should have a class method .taggable? which returns true if tagging is defined, and false otherwise" do
+    UntaggedModel.taggable?.should be_false
+    TaggedModel.taggable?.should be_true
+  end
+  
+  it "should have an instance method #taggable? which returns the same as the instance's class would" do
+    UntaggedModel.new.taggable?.should == UntaggedModel.taggable?
+    UntaggedModel.new.taggable?.should be_false
+    TaggedModel.new.taggable?.should == TaggedModel.taggable?
+    TaggedModel.new.taggable?.should be_true
+  end
+end

data/spec/dm-tags/tagging_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+include DataMapper::Tags
+
+describe Tagging do
+  before(:each) do
+    @tagging = Tagging.new
+  end
+
+  it "should be a model which includes DataMapper::Resource" do
+    Tagging.should be
+    Tagging.should include(DataMapper::Resource)
+  end
+
+  it "should have properties: id, tag_id, taggable_id, taggable_type, tagger_id, tagger_type, and tag_context" do
+    @tagging.attributes.should have_key(:id)
+    @tagging.attributes.should have_key(:tag_id)
+    @tagging.attributes.should have_key(:taggable_id)
+    @tagging.attributes.should have_key(:taggable_type)
+    # @tagging.attributes.should have_key(:tagger_id)
+    # @tagging.attributes.should have_key(:tagger_type)
+    @tagging.attributes.should have_key(:tag_context)
+  end
+  
+  it "should validate the presence of tag_id, taggable_id, taggable_type and tag_context" do
+    @tagging.should_not be_valid
+    @tagging.tag_id = 1
+    @tagging.should_not be_valid
+    @tagging.taggable_id = 1
+    @tagging.should_not be_valid
+    @tagging.taggable_type = "TaggedModel"
+    @tagging.should_not be_valid
+    @tagging.tag_context = "skills"
+    @tagging.should be_valid
+  end
+
+  it "should belong_to tag" do
+    Tagging.relationships[:tag].should be
+    Tagging.relationships[:tag].parent_model.should == Tag
+  end
+  
+  it "should have a method Tagging#taggable which returns the associated taggable instance" do
+    @tagging.should respond_to(:taggable)
+    @tagging.taggable.should_not be
+    @tagging.taggable_id = 11111
+    @tagging.taggable_type = "TaggedModel"
+    TaggedModel.should_receive(:get!).with(11111)
+    @tagging.taggable
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'spec'
+# require 'merb-core'
+require 'dm-core'
+require 'dm-validations'
+require File.dirname(__FILE__) + '/../lib/dm-tags'
+require File.dirname(__FILE__) + '/classes'
+require File.dirname(__FILE__) + '/dm-setup'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: dm-tags
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Bobby Calderwood
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-31 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+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.
+email: 
+- bobby_calderwood@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- 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
+has_rdoc: true
+homepage: http://dm-tags.rubyforge.org
+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: dm-tags
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: 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.
+test_files: 
+- 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