simple_tags 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,70 @@
+= SimpleTags
+
+Simple tagging system for ruby on rails.
+
+== Instalation
+
+  # Gemfile
+  gem 'simple_tags'
+
+
+  rails g simple_tags:migrations
+  rake db:migrate
+
+
+== Configuration
+
+You should add the Taggings module to the models you want to tag:
+
+  class SomeTaggableModel < ActiveRecord::Base
+    include SimpleTags::Taggable
+  end
+
+That's it, no configuration needed. Include `SimpleTags::Taggable` to every model you want to tag.
+
+== Use
+
+=== Adding tags
+
+  model = SomeTaggableModel.first
+  model.tags << [SimpleTags::Tag.create(name: 'cool'), SimpleTags::Tag.create(name: 'nice')
+
+
+
+  model = SomeTaggableModel.first
+  model.tag_list = "cool, nice"
+
+
+=== Listing Tags
+
+  model = SomeTaggableModel.first
+  model.tags
+  # Active relation tag list
+
+
+  model = SomeTaggableModel.first
+  model.tag_list
+  # String with tag names separated by commas
+
+
+=== Taggable listings
+
+Dynamic associations are created everytime you include `SimpleTags::Taggable` to a model. For example:
+
+  class Article < ActiveRecord::Base
+    include SimpleTags::Taggable
+  end
+
+# after that, the Tag models will have an `articles` relation
+
+  tag = SimpleTags::Tag.first
+  tag.articles
+
+
+You can list all taggings of a tag using the `taggings` relation:
+
+  tag.taggings
+
+= License
+
+MIT License. Copyright 2012 Tiago Scolari

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleTags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/simple_tags/tag.rb

@@ -0,0 +1,9 @@
+module SimpleTags
+  class Tag < ActiveRecord::Base
+    self.table_name = :simple_tags_tags
+    has_many :taggings, class_name: 'SimpleTags::Tagging', dependent: :destroy
+    validates :name, uniqueness: true, presence: true
+
+    attr_accessible :name
+  end
+end

data/app/models/simple_tags/tagging.rb

@@ -0,0 +1,10 @@
+module SimpleTags
+  class Tagging < ActiveRecord::Base
+    self.table_name = :simple_tags_taggings
+    belongs_to :tag, class_name: 'SimpleTags::Tag', counter_cache: true
+    belongs_to :taggable, polymorphic: true
+
+    validates :tag_id, uniqueness: { scope: [:taggable_type, :taggable_id] }
+    validates :tag, :taggable, presence: true
+  end
+end

data/app/models/simple_tags.rb

@@ -0,0 +1,2 @@
+module SimpleTags
+end

data/db/migrate/create_taggings.rb

@@ -0,0 +1,17 @@
+class CreateTaggings < ActiveRecord::Migration
+  def change
+    create_table :simple_tags_taggings do |t|
+      t.references :tag, null: false
+      t.references :taggable, null: false, polymorphic: true
+    end
+
+    add_index :simple_tags_taggings, 
+      [:tag_id, :taggable_type, :taggable_id], 
+      name: 'taggings_unq_idx',
+      unique: true
+
+    add_index :simple_tags_taggings,
+      [:taggable_type, :taggable_id],
+      name: 'taggings_taggable_idx'
+  end
+end

data/db/migrate/create_tags.rb

@@ -0,0 +1,9 @@
+class CreateTags < ActiveRecord::Migration
+  def change
+    create_table :simple_tags_tags do |t|
+      t.string :name, null: false
+      t.integer :taggings_count, default: 0, null: false
+    end
+    add_index :simple_tags_tags, :name, unique: true
+  end
+end

data/lib/generators/simple_tags/migrations/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate migrations Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/simple_tags/migrations/migrations_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class SimpleTags::MigrationsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../../../../../db/migrate', __FILE__)
+
+  def copy_migrations
+    migration_template "create_tags.rb", "db/migrate/create_tags.rb"
+    migration_template "create_taggings.rb", "db/migrate/create_taggings.rb"
+  end
+
+  def self.next_migration_number( dirname )
+    next_migration_number = current_migration_number(dirname) + 1
+    if ActiveRecord::Base.timestamped_migrations
+      [Time.now.utc.strftime("%Y%m%d%H%M%S%6N"), "%.20d" % next_migration_number].max
+    else
+      "%.3d" % next_migration_number
+    end
+  end
+end

data/lib/simple_tags/engine.rb

@@ -0,0 +1,5 @@
+module SimpleTags
+  class Engine < ::Rails::Engine
+
+  end
+end

data/lib/simple_tags/taggable.rb

@@ -0,0 +1,43 @@
+module SimpleTags
+  module Taggable
+    extend ActiveSupport::Concern
+
+    included do
+      relation_name = self.name.underscore
+      relation_class_name = self.name
+
+      # Adds a relation in the Tag model for listing this type of taggables
+      #
+      SimpleTags::Tag.class_eval do
+        has_many "#{relation_name}_taggings".to_sym, class_name: 'SimpleTags::Tagging', conditions: ["taggable_type = ?", relation_class_name], foreign_key: 'tag_id'
+        has_many relation_name.pluralize.to_sym, class_name: relation_class_name, through: "#{relation_name}_taggings".to_sym, source: "#{relation_name}_filter".to_sym
+      end
+
+      # Adds a relation in the Tagging model for listing this type of taggables
+      # This relation exists only to serve the Tag model relation for this object
+      #
+      SimpleTags::Tagging.class_eval do
+        belongs_to "#{relation_name}_filter".to_sym, class_name: relation_class_name, foreign_key: 'taggable_id'
+      end
+
+      has_many :taggings, as: 'taggable', dependent: :destroy, class_name: 'SimpleTags::Tagging'
+      has_many :tags, through: :taggings, class_name: 'SimpleTags::Tag'
+    end
+
+    # Public: Return a comma-separated list of this model tags name
+    #
+    def tag_list
+      tags.map(&:name).join(", ")
+    end
+
+    # Public: Sets the model tags
+    # `names` must be a list of tag names, separated by commas
+    #
+    def tag_list=(names)
+      self.tags = names.split(",").map do |n|
+        SimpleTags::Tag.where(name: n.strip).first_or_create!
+      end
+    end
+
+  end
+end

data/lib/simple_tags/version.rb

@@ -0,0 +1,3 @@
+module SimpleTags
+  VERSION = "0.1"
+end

data/lib/simple_tags.rb

@@ -0,0 +1,4 @@
+require 'simple_tags/engine'
+require 'simple_tags/taggable'
+module SimpleTags
+end

data/lib/tasks/simple_tags_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :simple_tags do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: simple_tags
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Tiago Scolari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple tagging system for Ruby on Rails
+email:
+- tscolari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/simple_tags/tag.rb
+- app/models/simple_tags/tagging.rb
+- app/models/simple_tags.rb
+- db/migrate/create_taggings.rb
+- db/migrate/create_tags.rb
+- lib/generators/simple_tags/migrations/migrations_generator.rb
+- lib/generators/simple_tags/migrations/USAGE
+- lib/simple_tags/engine.rb
+- lib/simple_tags/taggable.rb
+- lib/simple_tags/version.rb
+- lib/simple_tags.rb
+- lib/tasks/simple_tags_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/tscolari/simple_tags
+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'
+      segments:
+      - 0
+      hash: 3595926858561685661
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3595926858561685661
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Tagging Gem
+test_files: []