tagged 0.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.swp

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |g|
+    g.name = 'tagged'
+    g.summary = %(Simple ORM agnostic tagging.)
+    g.description = %(Simple ORM agnostic tagging.)
+    g.email = 'matt@toastyapps.com'
+    g.homepage = 'http://github.com/toastyapps/tagged'
+    g.authors = %w(toastyapps)
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+ 
+Rake::TestTask.new do |t|
+  t.libs = %w(test)
+  t.pattern = 'test/**/*_test.rb'
+end
+ 
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/generators/tagged_migration/tagged_migration_generator.rb

@@ -0,0 +1,11 @@
+class VestalVersionsMigrationGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+ 
+  def file_name
+    'create_tagged'
+  end
+end

data/generators/tagged_migration/templates/migration.rb

@@ -0,0 +1,23 @@
+class CreateTagged < ActiveRecord::Migration
+  def self.up
+    create_table :taggings do |t|
+      t.belongs_to :tagged, :polymorphic => true
+      t.belongs_to :tag
+      t.datetime :created_at
+    end
+ 
+    create_table :tags do |t|
+      t.string :name
+    end
+    
+    add_index :tags, :name
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_id, :taggable_type]
+    
+  end
+ 
+  def self.down
+    drop_table :taggings
+    drop_table :tags
+  end
+end

data/lib/tagged.rb

@@ -0,0 +1,57 @@
+module Tagged
+  
+  module Extension
+    def self.included(base)
+      base.class_eval do
+        def self.tagged
+          include Tagged::Base
+        end
+      end
+    end
+  end
+  
+  module Base
+    
+    def self.included(model)
+      model.class_eval do
+        def self.delimiter
+          @@delimiter ||= ','
+        end
+        
+        def self.delimiter=(value)
+          @@delimiter = value
+        end
+      end
+    end
+    
+    def delimiter
+      self.class.delimiter
+    end
+    
+    def tag_list
+      self._tag_list
+    end
+    
+    def tag_list=(list)
+      self._tag_list = Tagged::TagList.new(list.split(delimiter).map(&:strip))
+    end
+    
+    def tag(list)
+      list.split(delimiter).map {|tag| self._tag_list << tag.strip }
+    end
+    
+    def untag(items)
+      items.split(delimiter).map{|tag| self._tag_list.delete(tag.strip)}
+    end
+        
+    def _tag_list
+      @tag_list ||= Tagged::TagList.new([], delimiter)
+    end
+  end
+end
+
+require 'tagged/tag'
+require 'tagged/tag_list'
+require 'tagged/adapters/abstract_adapter'
+
+

data/lib/tagged/adapters/abstract_adapter.rb

@@ -0,0 +1,4 @@
+module Tagged
+  class AbstractAdapter
+  end
+end

data/lib/tagged/adapters/active_record_adapter.rb

@@ -0,0 +1,35 @@
+require 'tagged'
+
+module Tagged
+  
+  module ActiveRecordExtension
+    def self.included(base)
+      base.class_eval do
+        @@tagged_adapter = ActiveRecordAdapter.new
+        extend ClassMethods
+        include Tagged::Base
+      end
+    end
+    
+    module ClassMethods
+      def tagged
+        self.class_eval do
+          has_many :taggings, :as => :tagged, :dependent => :destroy
+          has_many :tags, :through => :taggings
+          after_save :save_tags
+        end
+      end
+    end
+    
+    def save_tags
+      tag_list.each do |tag_name|
+        tags << ::Tag.find_or_initialize_by_name(tag_name) 
+      end
+    end
+  end
+  class ActiveRecordAdapter < AbstractAdapter
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Tagged::ActiveRecordExtension)

data/lib/tagged/adapters/mongo_mapper_adapter.rb

@@ -0,0 +1,32 @@
+require 'tagged'
+
+module Tagged
+  
+  module MongoMapperExtension
+    def self.included(base)
+      base.class_eval do
+        @@tagged_adapter = MongoMapperAdapter.new
+        include Tagged::Base
+      end
+    end
+  end
+  class MongoMapperAdapter < AbstractAdapter
+    
+  end
+end
+
+module MongoMapper
+  module Document
+    module ClassMethods
+      def tagged
+        include Tagged::MongoMapperExtension
+        key :tags, Array
+        before_save :save_tags
+      end
+    end
+    
+    def save_tags
+      self.tags = self.tag_list
+    end
+  end
+end

data/lib/tagged/tag.rb

@@ -0,0 +1,5 @@
+module Tagged
+  class Tag
+    attr_accessor :name, :kind
+  end
+end

data/lib/tagged/tag_list.rb

@@ -0,0 +1,22 @@
+module Tagged
+  class TagList < Array
+    attr_accessor :tags, :delimiter
+    def initialize(*list)
+      self.delimiter = ','
+      if list[0].is_a?(Array)
+        self.delimiter = list[1]
+        list = list[0]
+      end
+      list = list.is_a?(Array) ? list : list.split(self.delimiter).collect(&:strip).reject(&:blank)
+      super(list)
+    end
+    
+    def +(list)
+      Tagged::TagList.new(self.to_a + list, self.delimiter)
+    end
+    
+    def to_s(delimiter = nil)
+      join(delimiter || self.delimiter)
+    end
+  end
+end

data/lib/tagged/tagging.rb

@@ -0,0 +1,4 @@
+module Tagged
+  class Tagging
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'tagged'

data/test/active_record_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+require 'active_record'
+require 'tagged/adapters/active_record_adapter'
+require 'schema'
+
+
+class ActiveRecordTest < Test::Unit::TestCase
+  context "A Tagged ActiveRecord class" do
+    should "respond to tagged class methods" do
+      [:delimiter, :delimiter=].each do |method|
+        assert Post.respond_to?(method)
+      end
+    end
+  end
+  
+  context "A Tagged ActiveRecord instance" do
+    setup do
+      @post = Post.new
+    end
+    
+    should "respond to tagged instance methods" do
+      [:tag, :tag_list, :untag].each do |method|
+        assert @post.respond_to?(method)
+      end
+    end
+    
+    should "respond to taggings" do
+      assert @post.respond_to?(:taggings)
+    end
+    
+    should "have no tags to begin with" do
+      assert_equal [], @post.tag_list
+    end
+    
+    should "be able to add a tag" do
+      @post.tag('foo')
+      assert_equal ['foo'], @post.tag_list
+    end
+    
+    should "be able to remove a tag" do
+      @post.tag('foo')
+      @post.untag('foo')
+      assert_equal [], @post.tag_list
+    end
+    
+    should "be able to save tags" do
+      @post.tag('foo,bar')
+      @post.save
+      assert_equal 2, Tag.count
+      assert_equal 2, Tagging.count
+    end
+    
+  end
+end
+

data/test/delimiter_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class Bar
+  include Tagged::Base
+end
+
+class TaggingTest < Test::Unit::TestCase
+  context "A tagged instance with a custom delimiter" do
+    setup do
+      Bar.delimiter = '|'
+      @bar = Bar.new
+      @bar.tag('hoge|fuga|piyo')
+    end
+    
+    should "respond with the correct tags" do
+      assert_equal ['hoge', 'fuga', 'piyo'], @bar.tag_list
+    end
+    
+    should "be able to represent the tags as a string" do
+      assert_equal "hoge|fuga|piyo", @bar.tag_list.to_s
+    end
+    
+  end
+end

data/test/mongo_mapper_schema.rb

@@ -0,0 +1,8 @@
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1')
+MongoMapper.database = "testing_tagged"
+
+class Article
+  include MongoMapper::Document
+  key :title, String
+  tagged
+end

data/test/mongo_mapper_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'mongo_mapper'
+require 'tagged/adapters/mongo_mapper_adapter'
+require 'mongo_mapper_schema'
+
+
+class MongoMapperTest < Test::Unit::TestCase
+  context "A Tagged MongoMapper class" do
+    should "respond to tagged class methods" do
+      [:delimiter, :delimiter=].each do |method|
+        assert Article.respond_to?(method)
+      end
+    end
+  end
+  
+  context "A Tagged MongoMapper instance" do
+    setup do
+      @article = Article.new
+    end
+    
+    should "respond to tagged instance methods" do
+      [:tag, :tag_list, :untag].each do |method|
+        assert @article.respond_to?(method)
+      end
+    end
+    
+    should "have no tags to begin with" do
+      assert_equal [], @article.tag_list
+    end
+    
+    should "be able to add a tag" do
+      @article.tag('foo')
+      assert_equal ['foo'], @article.tag_list
+    end
+    
+    should "be able to remove a tag" do
+      @article.tag('foo')
+      @article.untag('foo')
+      assert_equal [], @article.tag_list
+    end
+    
+    should "be able to save tags" do
+      @article.tag('foo,bar')
+      @article.save
+      @find_article = Article.find(@article.id)
+      assert_equal ['foo', 'bar'], @find_article.tags
+    end
+    
+  end
+end
+

data/test/schema.rb

@@ -0,0 +1,38 @@
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :taggings do |t|
+      t.belongs_to :tagged, :polymorphic => true
+      t.belongs_to :tag
+      t.datetime :created_at
+    end
+ 
+    create_table :tags do |t|
+      t.string :name
+    end
+    create_table :posts do |t|
+      t.string :title, :default => ''
+    end
+  end  
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end
+ 
+class Tagging < ActiveRecord::Base
+  belongs_to :tag
+  belongs_to :tagged, :polymorphic => true
+end
+
+class Post < ActiveRecord::Base
+  tagged
+end
+
+class Tag < ActiveRecord::Base
+  has_many :taggings, :dependent => :destroy
+end

data/test/tag_list_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class TaggingTest < Test::Unit::TestCase
+  context "A tag_list" do
+    setup do
+      @list = Tagged::TagList.new
+    end
+    
+    should 'be able to add tags with tags#+=' do
+      tags = ['foo', 'bar']
+      @list += tags
+      assert_equal tags, @list
+    end
+    
+    should 'be able to add tags with <<' do
+      tags = ['foo', 'bar']
+      tags.each do |tag|
+        @list <<  tag
+      end
+      assert_equal tags, @list
+    end
+    
+    should 'be able to represent the tags in a string' do
+      tags = ['foo', 'bar']
+      @list += tags      
+      assert_equal "foo,bar", @list.to_s
+    end
+    
+    should 'be able to remove tags' do
+      tags = ['foo', 'bar']
+      @list += tags
+      @list.delete('foo')
+      assert_equal ['bar'], @list
+    end
+    
+  end  
+end

data/test/tagging_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class Foo
+  include Tagged::Base
+end
+
+class TaggingTest < Test::Unit::TestCase
+  context "A tagged instance" do
+    setup do
+      @foo = Foo.new
+      @foo.tag("hoge, fuga, piyo")
+    end
+    
+    should "respond with the correct tags" do
+      assert_equal ['hoge', 'fuga', 'piyo'], @foo.tag_list
+    end
+    
+    should "be able to add tags" do
+      @foo.tag('osake')
+      assert_equal ['hoge', 'fuga', 'piyo', 'osake'], @foo.tag_list
+    end
+    
+    should "be able to remove a tag" do
+      @foo.untag('fuga')
+      assert_equal ['hoge', 'piyo'], @foo.tag_list
+    end
+    
+    should "be able to remove multiple tags" do
+      @foo.untag('hoge, fuga')
+      assert_equal ['piyo'], @foo.tag_list
+    end
+    
+    should "be able to represent the tags as a string" do
+      assert_equal "hoge,fuga,piyo", @foo.tag_list.to_s
+    end
+    
+    should "be able to represent the tags as a custom string" do
+      assert_equal "hoge, fuga, piyo", @foo.tag_list.to_s(', ')
+    end
+  end  
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.dirname(__FILE__)
+require 'rubygems'
+require 'test/unit'
+require 'tagged'
+require 'shoulda'
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: tagged
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- toastyapps
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simple ORM agnostic tagging.
+email: matt@toastyapps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Rakefile
+- VERSION
+- generators/tagged_migration/tagged_migration_generator.rb
+- generators/tagged_migration/templates/migration.rb
+- lib/tagged.rb
+- lib/tagged/adapters/abstract_adapter.rb
+- lib/tagged/adapters/active_record_adapter.rb
+- lib/tagged/adapters/mongo_mapper_adapter.rb
+- lib/tagged/tag.rb
+- lib/tagged/tag_list.rb
+- lib/tagged/tagging.rb
+- rails/init.rb
+- test/active_record_test.rb
+- test/delimiter_test.rb
+- test/mongo_mapper_schema.rb
+- test/mongo_mapper_test.rb
+- test/schema.rb
+- test/tag_list_test.rb
+- test/tagging_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/toastyapps/tagged
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Simple ORM agnostic tagging.
+test_files: 
+- test/active_record_test.rb
+- test/delimiter_test.rb
+- test/mongo_mapper_schema.rb
+- test/mongo_mapper_test.rb
+- test/schema.rb
+- test/tag_list_test.rb
+- test/tagging_test.rb
+- test/test_helper.rb