jackdempsey-sequel_taggable 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jack Dempsey
+
+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,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+GEM = "sequel_taggable"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Jack Dempsey"
+EMAIL = "jack.dempsey@gmail.com"
+HOMEPAGE = "http://jackndempsey.blogspot.com"
+SUMMARY = "A gem that provides Sequel::Models with tagging capabilities"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.markdown", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  s.add_dependency "sequel_polymorphic"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README.markdown Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,4 @@
+Add in more advanced capabilities
+  - add/remove multiple tags at once
+
+Look into adding something like dm-tags context so you have a list of tags as well as skills and other things

data/lib/sequel_taggable.rb

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

data/lib/sequel_taggable/migration.rb

@@ -0,0 +1,24 @@
+class CreateTags < Sequel::Migration
+  def up
+    create_table :tags do
+      primary_key :id, :integer, :auto_increment => true
+      varchar :name, :null => false
+    end
+    
+    create_table :taggings do
+      primary_key :id, :integer, :auto_increment => true
+      integer :tag_id, :null => false
+      integer :taggable_id, :null => false
+      varchar :taggable_type, :null => false
+      #varchar :tag_context, :null => false
+      
+      #datetime :created_at #TODO decide on using is_timestamped plugin to autofill this
+      index [:tag_id, :taggable_id, :taggable_type]
+    end
+  end
+
+  def down
+    drop_table :tags
+    drop_table :taggings
+  end
+end

data/lib/sequel_taggable/sequel_taggable.rb

@@ -0,0 +1,21 @@
+module Sequel
+  module Plugins
+    module Taggable
+      # Apply the plugin to the model.
+      def self.apply(model, options = {})
+        model.class_eval %{
+          is :polymorphic
+          has_many :taggings, :as => :taggable
+          many_to_many :tags, :through => :taggings, :as => :taggable
+        }
+      end
+
+      module InstanceMethods
+      end
+
+      module ClassMethods
+      end # ClassMethods
+    end # Taggable
+  end # Plugins
+end # Sequel
+    

data/lib/sequel_taggable/tag.rb

@@ -0,0 +1,6 @@
+class Tag < Sequel::Model
+  one_to_many :taggings
+  
+  validates_presence_of :name
+
+end

data/lib/sequel_taggable/tagging.rb

@@ -0,0 +1,11 @@
+class Tagging < Sequel::Model
+  is :polymorphic
+  many_to_one :tag
+  many_to_one :taggable, :polymorphic => true
+  
+  validates_presence_of :tag_id, :taggable_id, :taggable_type#, :tag_context
+
+#  def taggable
+#    eval("#{taggable_type}.get!(#{taggable_id})") if taggable_type and taggable_id
+#  end
+end

data/spec/sequel-setup.rb

@@ -0,0 +1,18 @@
+DB = Sequel.sqlite
+ 
+require File.dirname(__FILE__) + '/../lib/sequel_taggable/migration'
+CreateTags.apply(DB, :up)
+
+#DB["select * from sqlite_master"].print
+
+
+class TaggedModel < Sequel::Model
+  set_schema do
+    primary_key :id
+    varchar :name
+  end
+
+  is :taggable
+end
+
+TaggedModel.create_table!

data/spec/sequel_taggable/sequel_taggable_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sequel::Plugins::Taggable do
+  before do
+    @tagged_model = TaggedModel.new
+  end
+  
+  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 < Sequel::Model
+        is :taggable
+      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 < Sequel::Model
+        is :taggable
+        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 raise an error message if someone uses has_tags with an argument list" do
+      lambda do 
+        class TagsOnly < Sequel::Model
+          is :taggable
+          has_tags :pets, :skills
+        end
+      end.should raise_error(RuntimeError)
+    end
+  end
+end

data/spec/sequel_taggable/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.should respond_to(:id)
+    @tag.should respond_to(:name)
+  end
+
+  it "should have many Taggings" do
+    Tag.associations.should include(: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/sequel_taggable/tagging_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Tagging do
+  before(:each) do
+    @tagging = Tagging.new
+  end
+
+  it "should have properties: id, tag_id, taggable_id, taggable_type, tagger_id, tagger_type, and tag_context" do
+    @tagging.should respond_to(:id)
+    @tagging.should respond_to(:tag_id)
+    @tagging.should respond_to(:taggable_id)
+    @tagging.should respond_to(:taggable_type)
+    @tagging.should respond_to(: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 many_to_one :tag" do
+    Tagging.associations.should include(:tag)
+    Tagging.association_reflection(:tag)[:class_name].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 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'spec'
+require 'sequel'
+
+require File.dirname(__FILE__) + '/sequel-setup'
+require File.dirname(__FILE__) + '/../lib/sequel_taggable'
+
+
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: jackdempsey-sequel_taggable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jack Dempsey
+autorequire: sequel_taggable
+bindir: bin
+cert_chain: []
+
+date: 2008-12-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel_polymorphic
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A gem that provides Sequel::Models with tagging capabilities
+email: jack.dempsey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO
+- lib/sequel_taggable
+- lib/sequel_taggable/migration.rb
+- lib/sequel_taggable/sequel_taggable.rb
+- lib/sequel_taggable/tag.rb
+- lib/sequel_taggable/tagging.rb
+- lib/sequel_taggable.rb
+- spec/sequel-setup.rb
+- spec/sequel_taggable
+- spec/sequel_taggable/sequel_taggable_spec.rb
+- spec/sequel_taggable/tag_spec.rb
+- spec/sequel_taggable/tagging_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://jackndempsey.blogspot.com
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem that provides Sequel::Models with tagging capabilities
+test_files: []
+