gutentag 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d85f0029e162907bb00faea63223b0b8c1207fec
-  data.tar.gz: fa0aee9f34395cb1af2885da0c70a04427e26da7
+  metadata.gz: f6d5be313a5546f19c11c2c5a74b0164665c795e
+  data.tar.gz: e9dee9503ecbae393676a9d5d897e79b12876236
 SHA512:
-  metadata.gz: 6bd5622a2935365c92ef8bab94768913a194fd34c98f28057beb8369b875d40e0797d525593bf7641daa9f360765d72560dd4998cdb8409d1241a4829cf7b5b7
-  data.tar.gz: 9b17cb1f4ae54e5205c6eaf8ee514c3e48bca171ee392ca18feb80562c5fdaae381eeeaefe912a537e922251d375fb152aa4b9c848784b53e5fe284a5444d36d
+  metadata.gz: 5d353d61f4c35f34c56c4545cac40eef7a6a187da84515bcc99c883de01892a01823f746cedf5e7a1f8b26878023fddef5bb4ae09d48c8e262a761968a4324ca
+  data.tar.gz: d22d8a4f863229adeda019d80919f63fe55adf653e0be3cd813190e529474e9d7b86f247909506debead2ad69a5b940d81fc3954fd3752896563d7b4a13be6ff

data/README.md

@@ -10,20 +10,24 @@ This was built partly as a proof-of-concept, and partly to see how a tagging gem
 
 ## Installation
 
-**Upgrading?** Gutentag has recently switched table names from `tags` and `taggings` to `gutentag_tags` and `gutentag_taggings`, to avoid conflicting with the more generic table names that may exist in Rails apps already. If you already have been using Gutentag, you'll need to create a migration manually that renames these tables:
-
-    rename_table :tags,     :gutentag_tags
-    rename_table :taggings, :gutentag_taggings
-
 Get it into your Gemfile - and don't forget the version constraint!
 
-    gem 'gutentag', '~> 0.5.0'
+    gem 'gutentag', '~> 0.5.1'
 
 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
 
+## Upgrading
+
+Between 0.4.0 and 0.5.0, Gutentag switched table names from `tags` and `taggings` to `gutentag_tags` and `gutentag_taggings`. This has been done to avoid conflicting with the more generic table names that may exist in Rails apps already.
+
+If you were using Gutentag 0.4.0 (or older) and now want to upgrade, you'll need to create a migration manually that renames these tables:
+
+    rename_table :tags,     :gutentag_tags
+    rename_table :taggings, :gutentag_taggings
+
 ## Usage
 
 The first step is easy: add the tag associations to whichever models should have tags (in these examples, the Article model):

data/app/models/gutentag/tag.rb

@@ -13,7 +13,7 @@ class Gutentag::Tag < ActiveRecord::Base
   before_validation :normalise_name
 
   def self.find_by_name(name)
-    where(:name => Gutentag::TagName.normalise(name)).first
+    where(:name => Gutentag.normaliser.call(name)).first
   end
 
   def self.find_or_create(name)
@@ -23,6 +23,6 @@ class Gutentag::Tag < ActiveRecord::Base
   private
 
   def normalise_name
-    self.name = Gutentag::TagName.normalise name
+    self.name = Gutentag.normaliser.call name
   end
 end

data/gutentag.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'gutentag'
-  s.version     = '0.5.0'
+  s.version     = '0.5.1'
   s.authors     = ['Pat Allan']
   s.email       = ['pat@freelancing-gods.com']
   s.homepage    = 'https://github.com/pat/gutentag'
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency     'activerecord', '>= 3.2.0'
-  s.add_development_dependency 'combustion',   '~> 0.5.1'
+  s.add_development_dependency 'combustion',   '0.5.1'
   s.add_development_dependency 'rspec-rails',  '~> 2.13'
   s.add_development_dependency 'sqlite3',      '~> 1.3.7'
 end

data/lib/gutentag.rb

@@ -1,8 +1,15 @@
 module Gutentag
-  #
+  def self.normaliser
+    @normaliser ||= Gutentag::TagName
+  end
+
+  def self.normaliser=(normaliser)
+    @normaliser = normaliser
+  end
 end
 
 require 'gutentag/active_record'
+require 'gutentag/dirty'
 require 'gutentag/engine'
 require 'gutentag/persistence'
 require 'gutentag/tag_name'

data/lib/gutentag/active_record.rb

@@ -23,6 +23,8 @@ module Gutentag::ActiveRecord
   end
 
   def tag_names=(names)
+    Gutentag::Dirty.call self, names
+
     @tag_names = names
   end
 end

data/lib/gutentag/dirty.rb

@@ -0,0 +1,25 @@
+class Gutentag::Dirty
+  def self.call(instance, tag_names)
+    new(instance, tag_names).call
+  end
+
+  def initialize(instance, tag_names)
+    @instance, @tag_names = instance, tag_names
+  end
+
+  def call
+    instance.changed_attributes[:tag_names] = existing if changes.present?
+  end
+
+  private
+
+  attr_reader :instance, :tag_names
+
+  def changes
+    (existing + tag_names).uniq - (existing & tag_names)
+  end
+
+  def existing
+    instance.tag_names
+  end
+end

data/lib/gutentag/persistence.rb

@@ -40,6 +40,6 @@ class Gutentag::Persistence
   end
 
   def normaliser
-    @normaliser ||= Proc.new { |name| Gutentag::TagName.normalise(name) }
+    @normaliser ||= Proc.new { |name| Gutentag.normaliser.call(name) }
   end
 end

data/lib/gutentag/tag_name.rb

@@ -1,5 +1,5 @@
 class Gutentag::TagName
-  def self.normalise(name)
+  def self.call(name)
     new(name).to_s
   end
 

data/spec/acceptance/tag_names_spec.rb

@@ -8,14 +8,42 @@ describe "Managing tags via names" do
 
     article.tags << melbourne
 
-    article.tag_names.should == ['melbourne']
+    expect(article.tag_names).to eq(['melbourne'])
   end
 
   it "adds tags via their names" do
     article.tag_names << 'melbourne'
     article.save!
 
-    article.tags.collect(&:name).should == ['melbourne']
+    expect(article.tags.collect(&:name)).to eq(['melbourne'])
+  end
+
+  it "makes model dirty when changing through tag_names" do
+    article.tag_names << 'melbourne'
+    article.save!
+
+    article.tag_names = ['sydney']
+
+    expect(article.changed_attributes.stringify_keys).
+      to eq('tag_names' => ['melbourne'])
+  end
+
+  it "does not make model dirty when changing through tag_names" do
+    article.tag_names << 'melbourne'
+    article.save!
+
+    article.tag_names = ['melbourne']
+
+    expect(article.changed_attributes).to eq({})
+  end
+
+  it "allows for different tag normalisation" do
+    Gutentag.normaliser = lambda { |name| name.upcase }
+
+    tag = Gutentag::Tag.create(:name => 'melbourne')
+    expect(tag.name).to eq('MELBOURNE')
+
+    Gutentag.normaliser = nil
   end
 
   it "doesn't complain when adding an existing tag" do
@@ -23,14 +51,14 @@ describe "Managing tags via names" do
     article.tag_names << 'melbourne'
     article.save!
 
-    article.tags.collect(&:name).should == ['melbourne']
+    expect(article.tags.collect(&:name)).to eq(['melbourne'])
   end
 
   it "accepts a completely new set of tags" do
     article.tag_names = ['portland', 'oregon']
     article.save!
 
-    article.tags.collect(&:name).should == ['portland', 'oregon']
+    expect(article.tags.collect(&:name)).to eq(['portland', 'oregon'])
   end
 
   it "does not allow duplication of tags" do
@@ -40,7 +68,7 @@ describe "Managing tags via names" do
     article.tag_names = ['portland']
     article.save!
 
-    existing.tag_ids.should == article.tag_ids
+    expect(existing.tag_ids).to eq(article.tag_ids)
   end
 
   it "appends tag names" do
@@ -48,7 +76,7 @@ describe "Managing tags via names" do
     article.tag_names += ['oregon', 'ruby']
     article.save!
 
-    article.tags.collect(&:name).should == ['portland', 'oregon', 'ruby']
+    expect(article.tags.collect(&:name)).to eq(['portland', 'oregon', 'ruby'])
   end
 
   it "does not repeat appended names that already exist" do
@@ -56,7 +84,7 @@ describe "Managing tags via names" do
     article.tag_names += ['oregon', 'ruby']
     article.save!
 
-    article.tags.collect(&:name).should == ['portland', 'oregon', 'ruby']
+    expect(article.tags.collect(&:name)).to eq(['portland', 'oregon', 'ruby'])
   end
 
   it "removes a single tag name" do
@@ -64,7 +92,7 @@ describe "Managing tags via names" do
     article.tag_names.delete 'oregon'
     article.save!
 
-    article.tags.collect(&:name).should == ['portland']
+    expect(article.tags.collect(&:name)).to eq(['portland'])
   end
 
   it "removes tag names" do
@@ -72,7 +100,7 @@ describe "Managing tags via names" do
     article.tag_names -= ['oregon', 'ruby']
     article.save!
 
-    article.tags.collect(&:name).should == ['portland']
+    expect(article.tags.collect(&:name)).to eq(['portland'])
   end
 
   it "matches tag names ignoring case" do
@@ -80,22 +108,22 @@ describe "Managing tags via names" do
     article.tag_names += ['Portland']
     article.save!
 
-    article.tags.collect(&:name).should == ['portland']
+    expect(article.tags.collect(&:name)).to eq(['portland'])
 
     article.tag_names << 'Portland'
     article.save!
 
-    article.tags.collect(&:name).should == ['portland']
+    expect(article.tags.collect(&:name)).to eq(['portland'])
   end
 
   it "allows setting of tag names on unpersisted objects" do
     article = Article.new :tag_names => ['melbourne', 'pancakes']
     article.save!
 
-    article.tag_names.should == ['melbourne', 'pancakes']
+    expect(article.tag_names).to eq(['melbourne', 'pancakes'])
   end
 
   it "allows overriding of tag_names=" do
-    Article.instance_methods(false).should_not include(:tag_names=)
+    expect(Article.instance_methods(false)).to_not include(:tag_names=)
   end
 end

data/spec/acceptance/tags_spec.rb

@@ -7,7 +7,7 @@ describe 'Adding and removing tags' do
   it "stores new tags" do
     article.tags << pancakes
 
-    article.tags.reload.should == [pancakes]
+    expect(article.tags.reload).to eq([pancakes])
   end
 
   it "removes existing tags" do
@@ -15,7 +15,7 @@ describe 'Adding and removing tags' do
 
     article.tags.delete pancakes
 
-    article.tags.reload.should == []
+    expect(article.tags.reload).to eq([])
   end
 
   it "removes taggings when an article is deleted" do
@@ -23,9 +23,9 @@ describe 'Adding and removing tags' do
 
     article.destroy
 
-    Gutentag::Tagging.where(
+    expect(Gutentag::Tagging.where(
       :taggable_type => 'Article', :taggable_id => article.id
-    ).count.should be_zero
+    ).count).to be_zero
   end
 
   it "removes taggings when a tag is deleted" do
@@ -33,7 +33,7 @@ describe 'Adding and removing tags' do
 
     pancakes.destroy
 
-    Gutentag::Tagging.where(:tag_id => pancakes.id).count.should be_zero
+    expect(Gutentag::Tagging.where(:tag_id => pancakes.id).count).to be_zero
   end
 
   it 'should have a mean tag cloud' do
@@ -41,10 +41,10 @@ describe 'Adding and removing tags' do
     another_article = Article.create
 
     article.tags << pancakes
-    Gutentag::Tag.by_weight.first.should == pancakes
+    expect(Gutentag::Tag.by_weight.first).to eq(pancakes)
 
     article.tags << gorillas
     another_article.tags << gorillas
-    Gutentag::Tag.by_weight.first.should == gorillas
+    expect(Gutentag::Tag.by_weight.first).to eq(gorillas)
   end
 end

data/spec/gutentag/tag_name_spec.rb

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

data/spec/models/gutentag/tag_spec.rb

@@ -5,17 +5,17 @@ describe Gutentag::Tag do
     it "returns a tag with the same name" do
       existing = Gutentag::Tag.create! :name => 'pancakes'
 
-      Gutentag::Tag.find_by_name('pancakes').should == existing
+      expect(Gutentag::Tag.find_by_name('pancakes')).to eq(existing)
     end
 
     it "returns a tag with the same normalised name" do
       existing = Gutentag::Tag.create! :name => 'pancakes'
 
-      Gutentag::Tag.find_by_name('Pancakes').should == existing
+      expect(Gutentag::Tag.find_by_name('Pancakes')).to eq(existing)
     end
 
     it "otherwise returns nil" do
-      Gutentag::Tag.find_by_name('pancakes').should be_nil
+      expect(Gutentag::Tag.find_by_name('pancakes')).to be_nil
     end
   end
 
@@ -23,34 +23,34 @@ describe Gutentag::Tag do
     it "returns a tag with the same name" do
       existing = Gutentag::Tag.create! :name => 'pancakes'
 
-      Gutentag::Tag.find_or_create('pancakes').should == existing
+      expect(Gutentag::Tag.find_or_create('pancakes')).to eq(existing)
     end
 
     it "returns a tag with the same normalised name" do
       existing = Gutentag::Tag.create! :name => 'pancakes'
 
-      Gutentag::Tag.find_or_create('Pancakes').should == existing
+      expect(Gutentag::Tag.find_or_create('Pancakes')).to eq(existing)
     end
 
     it "creates a new tag if no matches exist" do
-      Gutentag::Tag.find_or_create('pancakes').should be_persisted
+      expect(Gutentag::Tag.find_or_create('pancakes')).to be_persisted
     end
   end
 
   describe '#name' do
     before :each do
-      Gutentag::TagName.stub :normalise => 'waffles'
+      allow(Gutentag::TagName).to receive(:call).and_return('waffles')
     end
 
     it "normalises the provided name" do
-      Gutentag::TagName.should_receive(:normalise).with('Pancakes').
+      expect(Gutentag::TagName).to receive(:call).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'
+      expect(Gutentag::Tag.create!(:name => 'Pancakes').name).to eq('waffles')
     end
   end
 
@@ -58,7 +58,8 @@ describe Gutentag::Tag do
     it "ignores case when enforcing uniqueness" do
       Gutentag::Tag.create! :name => 'pancakes'
 
-      Gutentag::Tag.create(:name => 'Pancakes').should have(1).error_on(:name)
+      tag = Gutentag::Tag.create(:name => 'Pancakes')
+      expect(tag.errors[:name].length).to eq(1)
     end
   end
 end

data/spec/models/gutentag/tagging_spec.rb

@@ -14,7 +14,9 @@ describe Gutentag::Tagging do
       tagging = Gutentag::Tagging.new
       tagging.tag      = tag
       tagging.taggable = taggable
-      tagging.should have(1).error_on(:tag_id)
+
+      tagging.valid?
+      expect(tagging.errors[:tag_id].length).to eq(1)
     end
   end
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: gutentag
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2014-07-29 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.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !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
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENCE
 - README.md
@@ -87,6 +87,7 @@ files:
 - gutentag.gemspec
 - lib/gutentag.rb
 - lib/gutentag/active_record.rb
+- lib/gutentag/dirty.rb
 - lib/gutentag/engine.rb
 - lib/gutentag/persistence.rb
 - lib/gutentag/tag_name.rb
@@ -110,17 +111,17 @@ 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.1.0
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Good Tags