tagutils

tagutils gems - tag utilities (tag, taggings, tag list, etc.)

• home :: github.com/rubylibs/tagutils
• bugs :: github.com/rubylibs/tagutils/issues
• gem :: rubygems.org/gems/tagutils
• rdoc :: rubydoc.info/gems/tagutils

Usage

Schema / Tables

Use TagDb.create to build the tags and taggings tables and CategoryDb.create to build the categories and categorizations tables. Example:

# ...
TagDb.create
# ...
CategoryDb.create
# ...

Models

Add the associations yourself with the standard has_many class macro:

class Movie < ActiveRecord::Base
  # ...
  has_many :taggings, class_name: 'TagDb::Model::Tagging', :as      => :taggable
  has_many :tags,     class_name: 'TagDb::Model::Tag',     :through => :taggings
  # ...
  has_many :categorizations, class_name: 'CategoryDb::Model::Categorizations', :as      => :categorizable
  has_many :categories,      class_name: 'CategoryDb::Model::Category',        :through => :categorizations
  # ...
end

or use the built-in class macro shortcuts:

class Movie < ActiveRecord::Base
  # ...
  has_many_tags
  # ...
  has_many_categories
  # ...
end

The has_many_tags also adds the following methods:

Movie.with_tag( 'doc' )
# e.g. scope :with_tag, ->(tag_key){ joins(:tags).where('tags.key' => tag_key) }

The has_many_categories also adds the following methods:

Movie.with_category( 'doc' )
# e.g. scope :with_category, ->(category_key){ joins(:categories).where('categories.key' => category_key) }

Reader

The TagReader lets you read plain text fixtures (data sets). Example:

tags.1.yml:
-----------

# organizations

orgs: un, g5, g8, g20, eu, commonwealth, mercosur, nafta
football: fifa, uefa, afc, ofc, caf, csf, concacaf

# national regions

brasil: s|South, se|Southeast, co|Centerwest, ne|Northeast, n|North

To read the tags use:

TagReader.new( <include_path>).read( `tags.1` )

Real World Usage

• worlddb gem - continent, country, region, metro, city, district etc. models
• winedb gem - wine, winery, winemaker, vineyards, etc. models
• beerdb gem - beer, brand, brewery, etc. models

Alternatives

Tags

• gutentag

create_table :taggings do |t|
  t.integer    :tag_id,        null: false
  t.integer    :taggable_id,   null: false
  t.string     :taggable_type, null: false
  t.timestamps
end

create_table :tags do |t|
  t.string      :name,           null: false
  t.integer     :taggings_count, null: false, default: 0
  t.timestamps
end

• acts_as_taggable_on

create_table :tags do |t|
  t.string  :name
end

create_table :taggings do |t|
  t.references :tag
  t.references :taggable, polymorphic: true
  t.references :tagger,   polymorphic: true
  t.string     :context,  limit: 128
  t.datetime   :created_at
end

(Source: db/migrate/1_acts_as_taggable_on_migration.rb)

• is_taggable

create_table :tags do |t|
  t.string :name, default: ''
  t.string :kind, default: ''
end

create_table :taggings do |t|
  t.integer :tag_id

  t.string  :taggable_type, default: ''
  t.integer :taggable_id
end

(Source: generators/is_taggable_migration/templates/migration.rb)

• rocket_tag

create_table :tags do |t|
  t.string :name
end

create_table :taggings do |t|
  t.references :tag
  t.references :taggable, polymorphic: true
  t.references :tagger,   polymorphic: true
  t.string     :context
  t.datetime   :created_at
end

create_table :alias_tags, :id => false do |t|
  t.integer :tag_id
  t.integer :alias_id
end

(Source: generators/rocket_tag/migration/templates/active_record/migration.rb)

• acts_as_taggable_redux

create_table :tags do |t|
  t.string  :name
  t.integer :taggings_count,  null: false, default: 0
end

create_table :taggings do |t|
  t.integer :tag_id
  t.integer :taggable_id
  t.string  :taggable_type
  t.integer :user_id
end 

(Source: generators/acts_as_taggable_tables/templates/migration.rb)

• acts_as_taggable_on_steroids

create_table :tags do |t|
  t.string :name
end

create_table :taggings do |t|
  t.integer  :tag_id
  t.integer  :taggable_id
  t.string   :taggable_type

  t.datetime :created_at
end

(Source: generators/acts_as_taggable_migration/templates/migration.rb)

• Ruby Toolbook - Rails Tagging Category

Categories

• categoryz3

create_table :categoryz3_categories do |t|
  t.string     :name
  t.references :parent
  t.integer    :items_count,       default: 0
  t.integer    :child_items_count, default: 0
  t.integer    :childrens_count,   default: 0
  t.timestamps
end

create_table :categoryz3_items do |t|
  t.references :category,      null: false
  t.references :categorizable, null: false, polymorphic: true
  t.timestamps
end

create_table :categoryz3_child_items do |t|
  t.references :category,      null: false
  t.references :categorizable, null: false, polymorphic: true
  t.references :master_item,   null: false
  t.timestamps
end

• categorizable

create_table :categories do |t|
  t.string     :name, null: false
  t.timestamps
end

create_table :categorizations do |t|
  t.references :category,      null: false
  t.references :categorizable, null: false, :polymorphic: true
  t.timestamps
end

• acts_as_category

License

The tagutils scripts are dedicated to the public domain. Use it as you please with no restrictions whatsoever.