gutentag 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d6508868235e19bd72405fac2df27f9c54ecb9
-  data.tar.gz: 836f4a7342bb7846878bb679e18473a99c671f21
+  metadata.gz: 34f0e855c14d22751ac57bf0ddc8be91effd346c
+  data.tar.gz: 59c1247fd49e8cc37bb6e22b7fb3903567a8f5af
 SHA512:
-  metadata.gz: 45c8b280565560bfb936d517f9169402f6790b7057705fac454e4e06404c0a60eac90abbdbc45be19b159a7f7390a5d5633d541cb46a3a4e00e1e85ecebc7d89
-  data.tar.gz: d720d6e90ba3450fc55e3a231b4a784c6957864fd02f8cd58c050d026b26ad47d6bb1caf89f9365f08db75f8803b33bbed2f885d47336b8c50f6e35b46a2a415
+  metadata.gz: 03e82d9335afdbe03d9ac06625da1f2608d8394a6397ff405c293585ce38d3206f4bcc39285e8492ee4a49a8afabe101fe09f9772b557e88e8ab1c91999e9a97
+  data.tar.gz: ad34f1a97036b19f73d7e8edf48bac7a73bb8e1f25759107897ec2bfd43ad49943b7d61be7370b6f79756997b8bf646dadd9fbce4917d2ec96163b833eab806e

data/.gitignore

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

data/README.md

@@ -1,14 +1,17 @@
 # Gutentag
 
+[![Build Status](https://travis-ci.org/pat/gutentag.png?branch=master)](https://travis-ci.org/pat/gutentag)
+[![Code Climate](https://codeclimate.com/github/pat/gutentag.png)](https://codeclimate.com/github/pat/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.
+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. If you want to know more, read [this blog post](http://freelancing-gods.com/posts/gutentag_simple_rails_tagging).
 
 ## Installation
 
 Get it into your Gemfile - and don't forget the version constraint!
 
-    gem 'gutentag', '~> 0.1.0'
+    gem 'gutentag', '~> 0.2.0'
 
 Next: your tags get persisted to your database, so let's import and run the migrations to get the tables set up:
 

data/app/models/gutentag/tag.rb

@@ -2,5 +2,13 @@ class Gutentag::Tag < ActiveRecord::Base
   has_many :taggings, :class_name => 'Gutentag::Tagging',
     :dependent => :destroy
 
-  validates :name, :presence => true, :uniqueness => true
+  validates :name, :presence => true, :uniqueness => {:case_sensitive => false}
+
+  before_validation :normalise_name
+
+  private
+
+  def normalise_name
+    self.name = Gutentag::TagName.normalise name
+  end
 end

data/app/models/gutentag/tagging.rb

@@ -4,4 +4,7 @@ class Gutentag::Tagging < ActiveRecord::Base
 
   validates :taggable, :presence => true
   validates :tag,      :presence => true
+  validates :tag_id,   :uniqueness => {
+    :scope => [:taggable_id, :taggable_type]
+  }
 end

data/gutentag.gemspec

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'gutentag'
-  s.version     = '0.1.0'
+  s.version     = '0.2.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.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")

data/lib/gutentag.rb

@@ -4,4 +4,5 @@ end
 
 require 'gutentag/active_record'
 require 'gutentag/engine'
+require 'gutentag/tag_name'
 require 'gutentag/tag_names'

data/lib/gutentag/tag_name.rb

@@ -0,0 +1,17 @@
+class Gutentag::TagName
+  def self.normalise(name)
+    new(name).to_s
+  end
+
+  def initialize(name)
+    @name = name
+  end
+
+  def to_s
+    name.downcase
+  end
+
+  private
+
+  attr_reader :name
+end

data/lib/gutentag/tag_names.rb

@@ -4,7 +4,7 @@ class Gutentag::TagNames
   def self.new_with_names(taggable, names)
     tag_names = new(taggable)
     tag_names.clear
-    names.each { |name| tag_names << name }
+    names.each { |name| tag_names << Gutentag::TagName.normalise(name) }
     tag_names
   end
 
@@ -17,20 +17,31 @@ class Gutentag::TagNames
   end
 
   def +(array)
-    array.each { |name| self.<< name }
+    (normalised(array) - to_a).each { |name| self.<< name }
+
     self
   end
 
   def -(array)
-    array.each { |name| self.delete name }
+    normalised(array).each { |name| self.delete name }
+
     self
   end
 
   def <<(name)
-    tag = Gutentag::Tag.where(:name => name).first ||
-          Gutentag::Tag.create(:name => name)
+    name = Gutentag::TagName.normalise name
+    tag  = Gutentag::Tag.where(:name => name).first ||
+           Gutentag::Tag.create(:name => name)
+
+    taggable.tags << tag unless taggable.tags.include?(tag)
+  end
 
-    taggable.tags << tag
+  def |(array)
+    to_a | normalised(array)
+  end
+
+  def &(array)
+    to_a & normalised(array)
   end
 
   def clear
@@ -48,4 +59,8 @@ class Gutentag::TagNames
   private
 
   attr_reader :taggable
+
+  def normalised(array)
+    array.collect { |name| Gutentag::TagName.normalise(name) }
+  end
 end

data/spec/acceptance/tag_names_spec.rb

@@ -17,6 +17,13 @@ describe "Managing tags via names" do
     article.tags.collect(&:name).should == ['melbourne']
   end
 
+  it "doesn't complain when adding an existing tag" do
+    article.tag_names << 'melbourne'
+    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']
 
@@ -50,6 +57,13 @@ describe "Managing tags via names" do
     article.tags.collect(&:name).should == ['portland', 'oregon', 'ruby']
   end
 
+  it "does not repeat appended names that already exist" do
+    article.tag_names  = ['portland', 'oregon']
+    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'
@@ -63,4 +77,29 @@ describe "Managing tags via names" do
 
     article.tags.collect(&:name).should == ['portland']
   end
+
+  it "provides union operators" do
+    article.tag_names  = ['portland', 'ruby']
+    article.tag_names |= ['ruby', 'melbourne']
+
+    article.tags.collect(&:name).should == ['portland', 'ruby', 'melbourne']
+  end
+
+  it "provides intersection operators" do
+    article.tag_names  = ['portland', 'ruby']
+    article.tag_names &= ['ruby', 'melbourne']
+
+    article.tags.collect(&:name).should == ['ruby']
+  end
+
+  it "matches tag names ignoring case" do
+    article.tag_names  = ['portland']
+    article.tag_names += ['Portland']
+
+    article.tags.collect(&:name).should == ['portland']
+
+    article.tag_names << 'Portland'
+
+    article.tags.collect(&:name).should == ['portland']
+  end
 end

data/spec/gutentag/tag_name_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Gutentag::TagName do
+  describe '.normalise' do
+    it "downcases the provided name" do
+      Gutentag::TagName.normalise('Tasty Pancakes').should == 'tasty pancakes'
+    end
+  end
+end

data/spec/models/gutentag/tag_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Gutentag::Tag do
+  describe '#name' do
+    before :each do
+      Gutentag::TagName.stub :normalise => 'waffles'
+    end
+
+    it "normalises the provided name" do
+      Gutentag::TagName.should_receive(:normalise).with('Pancakes').
+        and_return('waffles')
+
+      Gutentag::Tag.create!(:name => 'Pancakes')
+    end
+
+    it "saves the normalised name" do
+      Gutentag::Tag.create!(:name => 'Pancakes').name.should == 'waffles'
+    end
+  end
+
+  describe '#valid?' do
+    it "ignores case when enforcing uniqueness" do
+      Gutentag::Tag.create! :name => 'pancakes'
+
+      Gutentag::Tag.create(:name => 'Pancakes').should have(1).error_on(:name)
+    end
+  end
+end

data/spec/models/gutentag/tagging_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Gutentag::Tagging do
+  describe '#valid?' do
+    let(:tag)      { Gutentag::Tag.create! :name => 'pancakes' }
+    let(:taggable) { Article.create! }
+
+    it "ensures tags are unique for any given taggable" do
+      Gutentag::Tagging.create! :tag => tag, :taggable => taggable
+
+      Gutentag::Tagging.create(
+        :tag => tag, :taggable => taggable
+      ).should have(1).error_on(:tag_id)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -86,16 +86,21 @@ files:
 - lib/gutentag.rb
 - lib/gutentag/active_record.rb
 - lib/gutentag/engine.rb
+- lib/gutentag/tag_name.rb
 - lib/gutentag/tag_names.rb
 - spec/acceptance/tag_names_spec.rb
 - spec/acceptance/tags_spec.rb
+- spec/gutentag/tag_name_spec.rb
 - spec/internal/app/models/article.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore
+- spec/models/gutentag/tag_spec.rb
+- spec/models/gutentag/tagging_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pat/gutentag
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []