tagtical 1.0.6

data/spec/tagtical/tagtical_spec.rb

@@ -0,0 +1,340 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Tagtical do
+  before(:each) do
+    clean_database!
+  end
+
+  it "should provide a class method 'taggable?' that is false for untaggable models" do
+    UntaggableModel.should_not be_taggable
+  end
+
+  describe "Taggable Method Generation" do
+    before(:each) do
+      clean_database!
+      TaggableModel.write_inheritable_attribute(:tag_types, [])
+      TaggableModel.acts_as_taggable(:tags, :languages, :skills, :needs, :offerings)
+      @taggable = TaggableModel.new(:name => "Bob Jones")
+    end
+
+    it "should respond 'true' to taggable?" do
+      @taggable.class.should be_taggable
+    end
+
+    it "should create a class attribute for tag types" do
+      @taggable.class.should respond_to(:tag_types)
+    end
+
+    it "should create an instance attribute for tag types" do
+      @taggable.should respond_to(:tag_types)
+    end
+
+    it "should have all tag types" do
+      @taggable.tag_types.should == [:tags, :languages, :skills, :needs, :offerings]
+    end
+
+    it "should generate an association for each tag type" do
+      @taggable.should respond_to(:tags, :skills, :languages)
+    end
+
+    it "should add tagged_with and tag_counts to singleton" do
+      TaggableModel.should respond_to(:tagged_with, :tag_counts)
+    end
+
+    it "should generate methods for each tag_type" do
+      TaggableModel.should respond_to(:with_tags, :with_languages, :with_skills, :with_needs, :with_offerings)
+    end
+
+    it "should generate a tag_list accessor/setter for each tag type" do
+      @taggable.should respond_to(:tag_list, :skill_list, :language_list)
+      @taggable.should respond_to(:tag_list=, :skill_list=, :language_list=)
+    end
+
+    it "should generate a tag_list accessor, that includes owned tags, for each tag type" do
+      @taggable.should respond_to(:all_tags_list, :all_skills_list, :all_languages_list)
+    end
+  end
+
+  describe "Single Table Inheritance" do
+    before do
+      @taggable = TaggableModel.new(:name => "taggable")
+      @inherited_same = InheritingTaggableModel.new(:name => "inherited same")
+      @inherited_different = AlteredInheritingTaggableModel.new(:name => "inherited different")
+    end
+
+    it "should pass on tag contexts to STI-inherited models" do
+      @inherited_same.should respond_to(:tag_list, :skill_list, :language_list)
+      @inherited_different.should respond_to(:tag_list, :skill_list, :language_list)
+    end
+
+    it "should have tag contexts added in altered STI models" do
+      @inherited_different.should respond_to(:part_list)
+    end
+  end
+
+  describe "Reloading" do
+    it "should save a model instantiated by Model.find" do
+      taggable = TaggableModel.create!(:name => "Taggable")
+      found_taggable = TaggableModel.find(taggable.id)
+      found_taggable.save
+    end
+  end
+
+  describe "Related Objects" do
+    it "should find related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+
+      taggable2.tag_list = "three, four"
+      taggable2.save
+
+      taggable3.tag_list = "one, four"
+      taggable3.save
+
+      taggable1.find_related_tags.should include(taggable3)
+      taggable1.find_related_tags.should_not include(taggable2)
+    end
+
+    it "should find other related objects based on tag names on context" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.tag_list = "one, two"
+      taggable1.save
+
+      taggable2.tag_list = "three, four"
+      taggable2.save
+
+      taggable3.tag_list = "one, four"
+      taggable3.save
+
+      taggable1.find_related_tags_for(OtherTaggableModel).should include(taggable3)
+      taggable1.find_related_tags_for(OtherTaggableModel).should_not include(taggable2)
+    end
+
+    it "should not include the object itself in the list of related objects" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+
+      taggable1.tag_list = "one"
+      taggable1.save
+
+      taggable2.tag_list = "one, two"
+      taggable2.save
+
+      taggable1.find_related_tags.should include(taggable2)
+      taggable1.find_related_tags.should_not include(taggable1)
+    end
+  end
+
+  describe "Matching Contexts" do
+    it "should find objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+      taggable3 = TaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save!
+
+      taggable2.need_list = "one, two"
+      taggable2.save!
+
+      taggable3.offering_list = "one, two"
+      taggable3.save!
+
+      taggable1.find_matching_contexts(:offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts(:offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should find other related objects with tags of matching contexts" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = OtherTaggableModel.create!(:name => "Taggable 2")
+      taggable3 = OtherTaggableModel.create!(:name => "Taggable 3")
+
+      taggable1.offering_list = "one, two"
+      taggable1.save
+
+      taggable2.need_list = "one, two"
+      taggable2.save
+
+      taggable3.offering_list = "one, two"
+      taggable3.save
+
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should include(taggable2)
+      taggable1.find_matching_contexts_for(OtherTaggableModel, :offerings, :needs).should_not include(taggable3)
+    end
+
+    it "should not include the object itself in the list of related objects" do
+      taggable1 = TaggableModel.create!(:name => "Taggable 1")
+      taggable2 = TaggableModel.create!(:name => "Taggable 2")
+
+      taggable1.tag_list = "one"
+      taggable1.save
+
+      taggable2.tag_list = "one, two"
+      taggable2.save
+
+      taggable1.find_related_tags.should include(taggable2)
+      taggable1.find_related_tags.should_not include(taggable1)
+    end
+  end
+
+  describe 'Tagging Contexts' do
+    it 'should eliminate duplicate tagging contexts ' do
+      TaggableModel.acts_as_taggable(:skills, :skills)
+      TaggableModel.tag_types.freq["skill"].should == 1
+    end
+
+    it "should not contain embedded/nested arrays" do
+      TaggableModel.acts_as_taggable([:skills], [:skills])
+      TaggableModel.tag_types.freq[[:skills]].should == 0
+    end
+
+    it "should _flatten_ the content of arrays" do
+      TaggableModel.acts_as_taggable([:skills], [:skills])
+      TaggableModel.tag_types.freq["skill"].should == 1
+    end
+
+    it "should support tag_types without an associated Tag subclass" do
+      lambda { TaggableModel.acts_as_taggable(:doesnt_exist) }.should_not raise_error
+    end
+
+    it "should not raise an error when passed nil" do
+      lambda {
+        TaggableModel.acts_as_taggable()
+      }.should_not raise_error
+    end
+
+    it "should not raise an error when passed [nil]" do
+      lambda {
+        TaggableModel.acts_as_taggable([nil])
+      }.should_not raise_error
+    end
+
+    context "when Tag subclass is not present" do
+
+      before do
+        TaggableModel.acts_as_taggable(:machines)
+        @taggable_model = TaggableModel.create!(:name => "Taggable 1", :tag_list => "random, tags")
+        @taggable_model.machine_list = "car, plane, train"
+        @taggable_model.save!
+        @taggable_model.reload
+        @tag_type = @taggable_model.tag_types.find { |t| t=="machine" }
+      end
+
+      specify { @tag_type.klass.should be_nil }
+
+      it "should have basic tagging methods" do
+        @taggable_model.machines.map(&:value).sort.should == ["car", "plane", "train"]
+        @taggable_model.tags.machines.map(&:value).sort.should == ["car", "plane", "train"]
+      end
+
+      it "should instantiate with Tagtical::Tag" do
+        @taggable_model.machines.each { |tag| tag.should be_an_instance_of Tagtical::Tag }
+      end
+
+    end
+  end
+
+  describe "Tagging with Symbols" do
+    it "should tag with symbols" do
+      @taggable_model = TaggableModel.create!(:name => "Taggable", :tag_list => [:tag1, :tag2])
+      @taggable_model.tag_list.should == ["tag1", "tag2"]
+    end
+
+  end
+
+  describe "Tagging With Relevance" do
+    before do
+      @taggable_model = TaggableModel.create!(:name => "Taggable", :tag_list => {"random" => 0.45, "tags" => 1.54}, :skill_list => "tennis, pottery")
+    end
+
+    it "should have tags with relevance" do
+      @taggable_model.tags.sort.map(&:relevance).should == [0.45, Tagtical::Tagging.default_relevance, Tagtical::Tagging.default_relevance, 1.54]
+    end
+
+    it "should have skills with relevance" do
+      @taggable_model.skills.first.relevance.should == Tagtical::Tagging.default_relevance
+    end
+
+    it "should overwrite relevance" do
+      @taggable_model.tag_list = {"tennis" => 6.0}
+      @taggable_model.save!
+      @taggable_model.reload
+      @taggable_model.skills.find_by_value("tennis").relevance.should == 6.0
+    end
+
+    it "should be able to change the tag type and update the relevance" do
+      @taggable_model.craft_list = {"pottery" => 4.56}
+      @taggable_model.save!
+      @taggable_model.reload
+      skills = @taggable_model.skills.find_all_by_value("pottery")
+      skills.should have(1).items
+      skills.first.relevance.should == 4.56
+      skills.first.should be_an_instance_of Tag::Craft
+    end
+
+  end
+
+  describe 'Caching' do
+    before(:each) do
+      @taggable = CachedModel.new(:name => "Bob Jones")
+    end
+
+    it "should add saving of tag lists and cached tag lists to the instance" do
+      @taggable.should respond_to(:save_cached_tag_list)
+      @taggable.should respond_to(:save_tags)
+    end
+
+    it "should generate a cached column checker for each tag type" do
+      CachedModel.should respond_to(:caching_tag_list?)
+    end
+
+    it 'should not have cached tags' do
+      @taggable.cached_tag_list.should be_blank
+    end
+
+    it 'should cache tags' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.cached_tag_list.should == 'awesome, epic'
+    end
+
+    it 'should keep the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable)
+      @taggable.save!
+      @taggable.cached_tag_list.should == 'awesome, epic'
+    end
+
+    it 'should update the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.update_attributes(:tag_list => 'awesome')
+      @taggable.cached_tag_list.should == 'awesome'
+    end
+
+    it 'should remove the cache' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable.update_attributes(:tag_list => '')
+      @taggable.cached_tag_list.should be_blank
+    end
+
+    it 'should have a tag list' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable.id)
+      @taggable.tag_list.sort.should == %w(awesome epic).sort
+    end
+
+    it 'should keep the tag list' do
+      @taggable.update_attributes(:tag_list => 'awesome, epic')
+      @taggable = CachedModel.find(@taggable.id)
+      @taggable.save!
+      @taggable.tag_list.sort.should == %w(awesome epic).sort
+    end
+  end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: tagtical
+version: !ruby/object:Gem::Version
+  version: 1.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Aryk Grosz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2161646020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161646020
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: &2161645540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161645540
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2161645060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161645060
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2161644580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161644580
+description: Tagtical allows you do create subclasses for Tag and add additional functionality
+  in an STI fashion. For example. You could do Tag::Color.find_by_name('blue').to_rgb.
+  It also supports storing weights or relevance on the taggings.
+email: aryk@mixbook.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/tagtical_migration/tagtical_migration_generator.rb
+- generators/tagtical_migration/templates/migration.rb
+- lib/generators/tagtical/migration/migration_generator.rb
+- lib/generators/tagtical/migration/templates/active_record/migration.rb
+- lib/tagtical.rb
+- lib/tagtical/acts_as_tagger.rb
+- lib/tagtical/compatibility/Gemfile
+- lib/tagtical/compatibility/active_record_backports.rb
+- lib/tagtical/tag.rb
+- lib/tagtical/tag_list.rb
+- lib/tagtical/taggable.rb
+- lib/tagtical/taggable/cache.rb
+- lib/tagtical/taggable/collection.rb
+- lib/tagtical/taggable/core.rb
+- lib/tagtical/taggable/ownership.rb
+- lib/tagtical/taggable/related.rb
+- lib/tagtical/tagging.rb
+- lib/tagtical/tags_helper.rb
+- rails/init.rb
+- spec/bm.rb
+- spec/database.yml
+- spec/database.yml.sample
+- spec/models.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/tagtical/acts_as_tagger_spec.rb
+- spec/tagtical/tag_list_spec.rb
+- spec/tagtical/tag_spec.rb
+- spec/tagtical/taggable_spec.rb
+- spec/tagtical/tagger_spec.rb
+- spec/tagtical/tagging_spec.rb
+- spec/tagtical/tags_helper_spec.rb
+- spec/tagtical/tagtical_spec.rb
+homepage: https://github.com/Mixbook/tagtical
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Tagtical is a tagging plugin for Rails that provides weighting, contexts,
+  and inheritance for tags.
+test_files: []