tagger 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem "rails", "3.0.0"
+gem "rspec-rails", "2.0.0.rc"
+gem "activerecord", "3.0.0"
+gem "sqlite3-ruby"
+
+platforms :mri_19 do
+  gem "ruby-debug19", :require => "ruby-debug"
+end
+
+platforms :mri_18 do
+  gem "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    linecache (0.43)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    rspec-rails (2.0.0.rc)
+      rspec (= 2.0.0.rc)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.0)
+  rails (= 3.0.0)
+  rspec-rails (= 2.0.0.rc)
+  ruby-debug
+  ruby-debug19
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nando Vieira
+
+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/README.rdoc

@@ -0,0 +1,45 @@
+= Tagger
+
+== Installing
+
+1. Install the plugin with <tt>script/plugin install git://github.com/fnando/has_tags.git</tt>
+2. Generate the migration files with <tt>rails generate tagger:install</tt>.
+3. Finally, run the migrations with <tt>rake db:migrate</tt>.
+
+== Usage
+
+Add the method call <tt>taggable</tt> to your model.
+
+  class Link < ActiveRecord::Base
+    taggable :scope => :category
+    belongs_to :category
+  end
+
+  class Category < ActiveRecord::Base
+    has_many :links
+  end
+
+  @post = Post.first
+  @category = Category.first
+
+  # set tags using the chosen tag separator
+  @post.tagged_with = "rails, activerecord, models"
+
+  # get tags joined with the chosen tag separator
+  @post.tagged_with
+
+  # get all tags as objects
+  @post.tags
+
+  # check if an user tagged this object
+  @post.tag_owner?(current_user)
+
+  # generate a tag cloud
+  @tags = Tag.cloud(:link, :limit => 100, :scope => @category)
+
+  # at the view, call the helper tag_cloud
+  tag_cloud @tags do |tag_name, css|
+    <%= link_to tag_name, tag_path(tag_name), :class => css
+  end
+
+Copyright (c) 2008 Nando Vieira, released under the MIT license

data/Rakefile

@@ -0,0 +1,27 @@
+require "rspec/core/rake_task"
+require "./lib/tagger/version"
+
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = %w[-Ilib -Ispec]
+end
+
+begin
+  require "jeweler"
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "tagger"
+    gem.version = Tagger::Version::STRING
+    gem.summary = "Add tagging support for Rails apps"
+    gem.description = "Add tagging support for Rails apps"
+    gem.authors = ["Nando Vieira"]
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/tagger"
+    gem.has_rdoc = false
+    gem.add_dependency "rails", ">= 3.0.0"
+    gem.files = FileList["{Gemfile,Gemfile.lock,Rakefile,MIT-LICENSE,tagger.gemspec,README.rdoc}", "{lib,spec,templates}/**/*"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You don't Jeweler installed, so you won't be able to build gems."
+end

data/lib/tagger/active_record.rb

@@ -0,0 +1,78 @@
+module Tagger
+  module ActiveRecord
+    def self.included(base)
+      base.extend ClassMethods
+
+      class << base
+        attr_accessor :taggable_options
+      end
+    end
+
+    module ClassMethods
+      def taggable(options={})
+        include InstanceMethods
+
+        self.taggable_options = {
+          :separator => options[:separator],
+          :scope => options[:scope]
+        }
+
+        has_many :taggings, :as => :taggable, :dependent => :destroy
+        has_many :tags, :through => :taggings, :order => "tags.name asc"
+
+        after_save :save_tags
+      end
+    end
+
+    module InstanceMethods
+      def tagged_with=(tags)
+        @tagged_with = joined_tags(parsed_tags(tags))
+      end
+
+      def tagged_with
+        @tagged_with ||= joined_tags(tags.all.collect(&:name))
+      end
+
+      private
+      # Parse a tag string using the preferred tag separator.
+      #
+      #   parsed_tags("a, d, c, b")
+      #   #=> ["a", "b", "c", "d"]
+      #
+      def parsed_tags(tags)
+        Tag.parse(tags, self.class.taggable_options[:separator])
+      end
+
+      # Receive an array of tags and join them using the
+      # preferred tag separator.
+      #
+      #   joined_tags %w[b c d a]
+      #   #=> a, b, c, d
+      #
+      def joined_tags(tags)
+        tags = tags.sort_by {|tag| tag.downcase}
+
+        if self.class.taggable_options[:separator] == :space
+          tags.collect {|tag| tag.include?(" ") ? %["#{tag}"] : tag }.join(" ")
+        else
+          tags.join(", ")
+        end
+      end
+
+      # Remove all associated tags and re-create them.
+      def save_tags
+        Tag.transaction do
+          taggings.delete_all
+
+          scope = nil
+          scope = send(self.class.taggable_options[:scope]) if self.class.taggable_options[:scope]
+
+          parsed_tags(tagged_with).each do |tag_name|
+            tag = Tag.find_or_create_by_name(tag_name)
+            self.taggings.create(:tag => tag, :scope => scope)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tagger/generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/base"
+
+module Tagger
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.dirname(__FILE__) + "/../../templates"
+
+    def copy_migrations
+      stamp = proc {|time| time.utc.strftime("%Y%m%d%H%M%S")}
+      copy_file "tags.rb",      "db/migrations/#{stamp[Time.now]}_create_tags.rb"
+      copy_file "taggings.rb",  "db/migrations/#{stamp[1.second.from_now]}_create_taggings.rb"
+    end
+  end
+end

data/lib/tagger/helper.rb

@@ -0,0 +1,26 @@
+module Tagger
+  module Helper
+    # Build a tag cloud based on the provided tags.
+    #
+    #   tag_cloud @tags do {|tag_name, css_class|}
+    #   tag_cloud @tags, %w(t1 t2 t3 t4 t5) do {|tag_name, css_class| #=> do something }
+    #
+    def tag_cloud(tags, css_classes = nil, &block)
+      # set css classes if not specified
+      css_classes ||= %w[s1 s2 s3 s4 s5]
+
+      # collect all tag totals
+      totals = tags.collect(&:total)
+
+      # get max and min totals
+      max = totals.max.to_i
+      min = totals.min.to_i
+
+      divisor = ((max - min) / css_classes.size) + 1
+
+      tags.each do |tag|
+        yield tag.name, css_classes[(tag.total - min) / divisor] if divisor != 0
+      end
+    end
+  end
+end

data/lib/tagger/railtie.rb

@@ -0,0 +1,12 @@
+module Tagger
+  class Railtie < Rails::Railtie
+    generators do
+      require "tagger/generator"
+    end
+
+    initializer "tagger.initializer" do |app|
+      ::ActiveRecord::Base.send :include, ActiveRecord
+      ::ActionView::Base.send   :include, Helper
+    end
+  end
+end

data/lib/tagger/tag.rb

@@ -0,0 +1,51 @@
+class Tag < ActiveRecord::Base
+  SEPARATORS = {
+    :comma => ",",
+    :space => " "
+  }
+
+  has_many :taggings
+  attr_reader :weight
+
+  # Tag.cloud(:post)
+  # Tag.cloud(:post, :scope => @category)
+  # Tag.cloud(:post, :limit => 50)
+  def self.cloud(type, options = {})
+    options[:limit] ||= 100
+
+    scope_condition = "
+      AND scopable_type = #{options[:scope].class.to_s.inspect}
+      AND scopable_id = #{options[:scope].id}" if options[:scope]
+
+    tags = Tag.find_by_sql [%(
+      SELECT tags.id, tags.name, COUNT(*) AS total
+      FROM tags, taggings
+      WHERE
+        tags.id == taggings.tag_id AND
+        taggings.taggable_type = ?
+        #{scope_condition}
+      GROUP BY taggings.tag_id
+      ORDER BY total DESC, name ASC
+      LIMIT ?
+    ), type.to_s.classify, options[:limit]]
+  end
+
+  # Tag.parse(tags_list, :comma)
+  # Tag.parse(tags_list, :space)
+  def self.parse(tag_list, separator)
+    separator = SEPARATORS[separator] || SEPARATORS[:comma]
+    tags = []
+    tag_list = tag_list.dup
+    tag_list.gsub!(/(["'])(.*?)(\1)/ms) {|m| tags << $2; "" }
+    tags += tag_list.split(separator)
+    tags.collect(&:squish).reject(&:blank?).sort_by {|tag| tag.downcase}
+  end
+
+  def total
+    read_attribute(:total).to_i
+  end
+
+  def to_s
+    name
+  end
+end

data/lib/tagger/tagging.rb

@@ -0,0 +1,22 @@
+class Tagging < ActiveRecord::Base
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+
+  before_save :define_scope
+
+  def scope=(object)
+    @scope = object
+  end
+
+  def scope
+    @scope = scopable_type.constantize.find(scopable_id) if !!scopable_id
+  end
+
+  private
+  def define_scope
+    unless @scope.blank?
+      write_attribute(:scopable_type, @scope.class.to_s)
+      write_attribute(:scopable_id, @scope.id)
+    end
+  end
+end

data/lib/tagger/version.rb

@@ -0,0 +1,8 @@
+module Tagger
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/tagger.rb

@@ -0,0 +1,9 @@
+require "rails/railtie"
+require "active_record"
+
+require "tagger/helper"
+require "tagger/tag"
+require "tagger/tagging"
+require "tagger/active_record"
+require "tagger/version"
+require "tagger/railtie"

data/spec/fixtures/categories.yml

@@ -0,0 +1,5 @@
+programming:
+  name: Programming
+  
+essays:
+  name: Essays

data/spec/fixtures/links.yml

@@ -0,0 +1,3 @@
+simples_ideias:
+  title: Simples Idéias
+  url: http://simplesideias.com.br

data/spec/fixtures/posts.yml

@@ -0,0 +1,7 @@
+all_about_rails:
+  title: All About Rails
+  category: programming
+
+ideas:
+  title: Ideas for Startups
+  category: essays

data/spec/fixtures/tags.yml

@@ -0,0 +1,2 @@
+ruby:
+  name: ruby

data/spec/helpers/helper_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Tagger::Helper do
+end

data/spec/schema.rb

@@ -0,0 +1,23 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :categories do |t|
+    t.string :name
+  end
+  
+  create_table :posts do |t|
+    t.references :category
+    t.string :title
+  end
+  
+  create_table :links do |t|
+    t.string :title, :url
+  end
+  
+  create_table :taggings do |t|
+    t.references :tag, :user
+    t.references :scopable, :taggable, :polymorphic => true
+  end
+  
+  create_table :tags do |t|
+    t.string :name
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+ENV["RAILS_ENV"] = "test"
+require "rails"
+require "tagger"
+require File.dirname(__FILE__) + "/support/config/boot"
+require "rspec/rails"
+
+require "support/models"
+
+# Load database schema
+load File.dirname(__FILE__) + "/schema.rb"
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.fixture_path = File.dirname(__FILE__) + "/fixtures"
+  config.use_transactional_fixtures = true
+end

data/spec/support/config/boot.rb

@@ -0,0 +1,14 @@
+ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../../../Gemfile"
+require "bundler"
+Bundler.setup
+require "rails/all"
+Bundler.require(:default)
+
+module Tagger
+  class Application < Rails::Application
+    config.root = File.dirname(__FILE__) + "/.."
+    config.active_support.deprecation = :log
+  end
+end
+
+Tagger::Application.initialize!

data/spec/support/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"