sluggi 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4eacb5e7a6e4854fe19afd19c33334713eec8fd
-  data.tar.gz: 2947d37f4a2e6bee1e7d78c266779ee3dcb6f7f9
+  metadata.gz: 4e34bbe2f4b5982b3866ede14c2df9c616cd2e96
+  data.tar.gz: 61c5635cd1e788d9d9acadb875abeb0a7a4ab2fd
 SHA512:
-  metadata.gz: 462925b7ad95990ad73e6628f02ee22fe456598ceb6078e72992a3fd66f30c045efab0b2ad2b8b3aa58af00aa9ee8defeef875acf09035ceeacd33a42effc1cf
-  data.tar.gz: 026e843376f90f95a87d724bdbe56158e6906c1671aed4d153e8106c585d2cb627b6381265b79743d2234c217ed1a7b576820afedb94f070e4d31e2d086b1dce
+  metadata.gz: 086b5ecf2710ebf4ed4679b26611e8ba4e500047a184341a7ff4e5658f61f12ebd09d149507f164f837b74542f28a7419c787c04ee2a3a7175f03f593d02ca78
+  data.tar.gz: 0052170046dc4116492555ab5f0a9d2760637b5123e9ab809f6a8d883224b00a73e79f0c3942fade85a7b19ea501e7ba8eaadbd200098462d882d43f03511e74

data/.gitignore

@@ -1,3 +1,4 @@
+.ruby-version
 Gemfile.lock
 coverage
 pkg

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -1,6 +1,7 @@
 # Sluggi
 
-[![Gem Version](https://badge.fury.io/rb/sluggi.png)](http://badge.fury.io/rb/sluggi)
+[![Gem Version](http://img.shields.io/gem/v/sluggi.svg)](http://rubygems.org/gems/sluggi)
+[![Build Status](http://img.shields.io/travis/neighborland/sluggi.svg)](https://travis-ci.org/neighborland/sluggi)
 
 Sluggi is a simple [friendly_id](https://github.com/norman/friendly_id)-inspired slugging library for ActiveRecord models.
 
@@ -46,6 +47,8 @@ Sluggi is Magic Free(tm). Each slugged model must:
 
 ### Simple Slugged Model
 
+Specify the slug value by defining `#slug_value` and `#slug_value_changed?`.
+
 ```ruby
 class Cat < ActiveRecord::Base
   include Sluggi::Slugged
@@ -77,6 +80,9 @@ Cat.find_by_slug('tuxedo-stan')
 
 ### Model with Slugged History
 
+To save slug history, include `Sluggi::History`. You get a `slugs` association. You can search for any
+slug in the history using `.find_slug!`.
+
 ```ruby
 class Cat < ActiveRecord::Base
   include Sluggi::Slugged
@@ -121,6 +127,9 @@ Cat.find_by_slug('tuxedo-stan')
 
 ### Model with Slug Candidates
 
+Override `#slug_candidates` to define cascading candidate values for slugs. This is useful to avoid
+uniqueness conflicts.
+
 ```ruby
 class Cat < ActiveRecord::Base
   include Sluggi::Slugged
@@ -155,9 +164,9 @@ cat_2.id
 
 ## Alternatives
 
-[override ActiveRecord#to_param](http://guides.rubyonrails.org/active_support_core_extensions.html#to-param)
-[use ActiveRecord.to_param](https://github.com/rails/rails/pull/12891)
-[friendly_id](https://github.com/norman/friendly_id)
-[slug](https://github.com/bkoski/slug)
-[slugged](https://github.com/Sutto/slugged)
-[others](https://rubygems.org/search?utf8=%E2%9C%93&query=slug)
+* [override ActiveRecord#to_param](http://guides.rubyonrails.org/active_support_core_extensions.html#to-param)
+* [use ActiveRecord.to_param](https://github.com/rails/rails/pull/12891)
+* [friendly_id](https://github.com/norman/friendly_id)
+* [slug](https://github.com/bkoski/slug)
+* [slugged](https://github.com/Sutto/slugged)
+* [others](https://rubygems.org/search?utf8=%E2%9C%93&query=slug)

data/lib/sluggi/history.rb

@@ -9,9 +9,11 @@ module Sluggi
 
     module ClassMethods
       def find_slug!(slug)
-        where(slug: slug).first ||
-          find_slugs(slug).first.try(:sluggable) ||
-          raise(ActiveRecord::RecordNotFound)
+        object = where(slug: slug).first || find_slugs(slug).first.try(:sluggable)
+        unless object.is_a?(self)
+          raise ActiveRecord::RecordNotFound, "Couldn't find #{self.name} with 'slug'='#{slug}'"
+        end
+        object
       end
 
       def slug_exists?(slug)

data/lib/sluggi/slug.rb

@@ -8,7 +8,7 @@ module Sluggi
 
     class << self
       def find_type(slug, sluggable_type)
-        where(slug: slug).where(sluggable_type: sluggable_type).order(id: :desc)
+        where(slug: slug, sluggable_type: sluggable_type).order(id: :desc)
       end
     end
 

data/lib/sluggi/version.rb

@@ -1,3 +1,3 @@
 module Sluggi
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/sluggi.gemspec

@@ -20,11 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 1.9.3"
 
-  spec.add_dependency "activerecord", ">= 4.0"
+  spec.add_dependency "activerecord", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"
-  spec.add_development_dependency "minitest", "~> 4.7"
   spec.add_development_dependency "sqlite3", "~> 1.3"
-  spec.add_development_dependency "rails", ">= 4.0"
+  spec.add_development_dependency "rails", "~> 4.0"
 end

data/test/history_test.rb

@@ -14,6 +14,25 @@ class HistoryTest < MiniTest::Spec
     end
   end
 
+  class ::Dog < ActiveRecord::Base
+    include Sluggi::Slugged
+    include Sluggi::History
+
+    def slug_value
+      name
+    end
+
+    def slug_value_changed?
+      name_changed?
+    end
+  end
+
+  class ::BigDog < ::Dog
+  end
+
+  class ::LittleDog < ::Dog
+  end
+
   before do
     Cat.delete_all
     Sluggi::Slug.delete_all
@@ -38,6 +57,16 @@ class HistoryTest < MiniTest::Spec
         Cat.find_slug! 'garfield'
       end
     end
+
+    it "finds STI classes" do
+      big_dog = BigDog.create(name: 'Snoop')
+      assert_equal big_dog, Dog.find_slug!('snoop')
+      assert_equal big_dog, BigDog.find_slug!('snoop')
+      error = assert_raises(ActiveRecord::RecordNotFound) do
+        LittleDog.find_slug!('snoop')
+      end
+      assert_equal "Couldn't find LittleDog with 'slug'='snoop'", error.message
+    end
   end
 
   describe ".slug_exists?" do

data/test/test_helper.rb

@@ -29,6 +29,13 @@ unless ActiveRecord::Base.connection.tables.include?('cats')
       t.string   :sluggable_type
       t.datetime :created_at
     end
+
+    create_table :dogs do |t|
+      t.datetime :created_at
+      t.string :type
+      t.string :name
+      t.string :slug
+    end
   end
 end
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: sluggi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +70,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description: A Rails slug generator inspired by friendly_id
@@ -102,7 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -140,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rails Slug Generator
@@ -150,3 +136,4 @@ test_files:
 - test/slug_test.rb
 - test/slugged_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.0