gutentag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69d6508868235e19bd72405fac2df27f9c54ecb9
+  data.tar.gz: 836f4a7342bb7846878bb679e18473a99c671f21
+SHA512:
+  metadata.gz: 45c8b280565560bfb936d517f9169402f6790b7057705fac454e4e06404c0a60eac90abbdbc45be19b159a7f7390a5d5633d541cb46a3a4e00e1e85ecebc7d89
+  data.tar.gz: d720d6e90ba3450fc55e3a231b4a784c6957864fd02f8cd58c050d026b26ad47d6bb1caf89f9365f08db75f8803b33bbed2f885d47336b8c50f6e35b46a2a415

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+spec/internal/db/*.sqlite

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: bundle exec rspec spec
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Pat Allan
+
+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.md

@@ -0,0 +1,38 @@
+# Gutentag
+
+A good, simple, solid tagging extension for ActiveRecord.
+
+This was built partly as a proof-of-concept, and partly to see how a tagging gem could work when it's not all stuffed within models, and partly just because I wanted a simpler tagging library.
+
+## Installation
+
+Get it into your Gemfile - and don't forget the version constraint!
+
+    gem 'gutentag', '~> 0.1.0'
+
+Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:
+
+    rake gutentag:install:migrations
+    rake db:migrate
+
+## Usage
+
+The first step is easy: add the tag associations to whichever models should have tags (in these examples, the Article model):
+
+    class Article < ActiveRecord::Base
+      # ...
+      has_many_tags
+      # ...
+    end
+
+That's all it takes to get a tags association on each article. Of course, populating tags can be a little frustrating, unless you want to manage Gutentag::Tag instances yourself? As an alternative, just use the tag_names accessor to get/set tags via string representations.
+
+    article.tag_names #=> ['pancakes', 'melbourne', 'ruby']
+    article.tag_names << 'portland'
+    article.tag_names #=> ['pancakes', 'melbourne', 'ruby', 'portland']
+    article.tag_names -= ['ruby']
+    article.tag_names #=> ['pancakes', 'melbourne', 'portland']
+
+## Licence
+
+Copyright (c) 2013, Gutentag is developed and maintained by Pat Allan, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/app/models/gutentag/tag.rb

@@ -0,0 +1,6 @@
+class Gutentag::Tag < ActiveRecord::Base
+  has_many :taggings, :class_name => 'Gutentag::Tagging',
+    :dependent => :destroy
+
+  validates :name, :presence => true, :uniqueness => true
+end

data/app/models/gutentag/tagging.rb

@@ -0,0 +1,7 @@
+class Gutentag::Tagging < ActiveRecord::Base
+  belongs_to :taggable, :polymorphic => true
+  belongs_to :tag, :class_name => 'Gutentag::Tag'
+
+  validates :taggable, :presence => true
+  validates :tag,      :presence => true
+end

data/db/migrate/1_gutentag_tables.rb

@@ -0,0 +1,27 @@
+class GutentagTables < ActiveRecord::Migration
+  def up
+    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
+
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_type, :taggable_id]
+    add_index :taggings, [:taggable_type, :taggable_id, :tag_id],
+      :unique => true, :name => 'unique_taggings'
+
+    create_table :tags do |t|
+      t.string :name, :null => false
+      t.timestamps
+    end
+
+    add_index :tags, :name, :unique => true
+  end
+
+  def down
+    drop_table :tags
+    drop_table :taggings
+  end
+end

data/gutentag.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = 'gutentag'
+  s.version     = '0.1.0'
+  s.authors     = ['Pat Allan']
+  s.email       = ['pat@freelancing-gods.com']
+  s.homepage    = 'https://github.com/pat/gutentag'
+  s.summary     = 'Good Tags'
+  s.description = 'A good, simple, solid tagging extension for ActiveRecord'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency     'activerecord', '>= 3.2.0'
+  s.add_development_dependency 'combustion',   '~> 0.4.0'
+  s.add_development_dependency 'rspec-rails',  '~> 2.13'
+  s.add_development_dependency 'sqlite3',      '~> 1.3.7'
+end

data/lib/gutentag.rb

@@ -0,0 +1,7 @@
+module Gutentag
+  #
+end
+
+require 'gutentag/active_record'
+require 'gutentag/engine'
+require 'gutentag/tag_names'

data/lib/gutentag/active_record.rb

@@ -0,0 +1,26 @@
+require 'active_support/concern'
+
+module Gutentag::ActiveRecord
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_many_tags
+      has_many :taggings, :class_name => 'Gutentag::Tagging', :as => :taggable,
+        :dependent => :destroy
+      has_many :tags,     :class_name => 'Gutentag::Tag',
+        :through => :taggings
+    end
+  end
+
+  def tag_names
+    @tag_names ||= Gutentag::TagNames.new self
+  end
+
+  def tag_names=(names)
+    if names.is_a?(Gutentag::TagNames)
+      @tag_names = names
+    else
+      @tag_names = Gutentag::TagNames.new_with_names self, names
+    end
+  end
+end

data/lib/gutentag/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/engine'
+
+class Gutentag::Engine < Rails::Engine
+  engine_name :gutentag
+
+  ActiveSupport.on_load :active_record do
+    include Gutentag::ActiveRecord
+  end
+end

data/lib/gutentag/tag_names.rb

@@ -0,0 +1,51 @@
+class Gutentag::TagNames
+  include Enumerable
+
+  def self.new_with_names(taggable, names)
+    tag_names = new(taggable)
+    tag_names.clear
+    names.each { |name| tag_names << name }
+    tag_names
+  end
+
+  def initialize(taggable)
+    @taggable = taggable
+  end
+
+  def to_a
+    taggable.tags.collect &:name
+  end
+
+  def +(array)
+    array.each { |name| self.<< name }
+    self
+  end
+
+  def -(array)
+    array.each { |name| self.delete name }
+    self
+  end
+
+  def <<(name)
+    tag = Gutentag::Tag.where(:name => name).first ||
+          Gutentag::Tag.create(:name => name)
+
+    taggable.tags << tag
+  end
+
+  def clear
+    taggable.tags.clear
+  end
+
+  def delete(name)
+    taggable.tags.delete Gutentag::Tag.where(:name => name).first
+  end
+
+  def each(&block)
+    to_a.each &block
+  end
+
+  private
+
+  attr_reader :taggable
+end

data/spec/acceptance/tag_names_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "Managing tags via names" do
+  let(:article)   { Article.create }
+
+  it "returns tag names" do
+    melbourne = Gutentag::Tag.create :name => 'melbourne'
+
+    article.tags << melbourne
+
+    article.tag_names.to_a.should == ['melbourne']
+  end
+
+  it "adds tags via their names" do
+    article.tag_names << 'melbourne'
+
+    article.tags.collect(&:name).should == ['melbourne']
+  end
+
+  it "accepts a completely new set of tags" do
+    article.tag_names = ['portland', 'oregon']
+
+    article.tags.collect(&:name).should == ['portland', 'oregon']
+  end
+
+  it "enumerates through tag names" do
+    article.tag_names = ['melbourne', 'victoria']
+    names = []
+
+    article.tag_names.each do |name|
+      names << name
+    end
+
+    names.should == ['melbourne', 'victoria']
+  end
+
+  it "does not allow duplication of tags" do
+    existing = Article.create
+    existing.tags << Gutentag::Tag.create(:name => 'portland')
+
+    article.tag_names = ['portland']
+
+    existing.tag_ids.should == article.tag_ids
+  end
+
+  it "appends tag names" do
+    article.tag_names  = ['portland']
+    article.tag_names += ['oregon', 'ruby']
+
+    article.tags.collect(&:name).should == ['portland', 'oregon', 'ruby']
+  end
+
+  it "removes a single tag name" do
+    article.tag_names = ['portland', 'oregon']
+    article.tag_names.delete 'oregon'
+
+    article.tags.collect(&:name).should == ['portland']
+  end
+
+  it "removes tag names" do
+    article.tag_names  = ['portland', 'oregon', 'ruby']
+    article.tag_names -= ['oregon', 'ruby']
+
+    article.tags.collect(&:name).should == ['portland']
+  end
+end

data/spec/acceptance/tags_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'Adding and removing tags' do
+  let(:article)  { Article.create }
+  let(:pancakes) { Gutentag::Tag.create :name => 'pancakes' }
+
+  it "stores new tags" do
+    article.tags << pancakes
+
+    article.tags.reload.should == [pancakes]
+  end
+
+  it "removes existing tags" do
+    article.tags << pancakes
+
+    article.tags.delete pancakes
+
+    article.tags.reload.should == []
+  end
+
+  it "removes taggings when an article is deleted" do
+    article.tags << pancakes
+
+    article.destroy
+
+    Gutentag::Tagging.where(
+      :taggable_type => 'Article', :taggable_id => article.id
+    ).count.should be_zero
+  end
+
+  it "removes taggings when a tag is deleted" do
+    article.tags << pancakes
+
+    pancakes.destroy
+
+    Gutentag::Tagging.where(:tag_id => pancakes.id).count.should be_zero
+  end
+end

data/spec/internal/app/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  has_many_tags
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table :articles, :force => true do |t|
+    t.string  :title
+    t.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: gutentag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: A good, simple, solid tagging extension for ActiveRecord
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- app/models/gutentag/tag.rb
+- app/models/gutentag/tagging.rb
+- db/migrate/1_gutentag_tables.rb
+- gutentag.gemspec
+- lib/gutentag.rb
+- lib/gutentag/active_record.rb
+- lib/gutentag/engine.rb
+- lib/gutentag/tag_names.rb
+- spec/acceptance/tag_names_spec.rb
+- spec/acceptance/tags_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+homepage: https://github.com/pat/gutentag
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Good Tags
+test_files: []