slugworth 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72bc1085707d9ccfb3438869fe15c2052d9b9512
-  data.tar.gz: 25f6d11385d7cc75e02fb1fc539e3bcea4ee3dc9
+  metadata.gz: 580a1a33372ba7781fca6dae4df6e8ac523e8dfd
+  data.tar.gz: 4d8c73c9c421d5ae254bc5759e4617554e582f03
 SHA512:
-  metadata.gz: a3ad7d1f90683c938bcd897ce92cb7f1ed2769f801ff51898b8e811a2a03cebbcd3ae0e9501199906cbf1f112b5982952358d764cef5dfb43e7af1540eaa3c97
-  data.tar.gz: ad736a6ae681cbf4a534abb21828fc3be99d6ea3165d8cbce994ad8d81f5801c5bf3af8bc5dc29f8baf837dbe192ab0c3068d70c8e9f1c36005cf87a5ded1aa2
+  metadata.gz: f24f96d281279619fcbd20cb8ef0509c4f38477f0b4c1ca8c9ce3616e63ab3d049c6158f2a01e11b35ca2dd5381ac507fd3d9492bb97ed6fdc4e451316dc2483
+  data.tar.gz: a844d24078f0684af671ba5941ce92173d3bbd4bafae7b54db25178f18cb50fa933f60416bcca06f37b8d290201b9f6322226fa1e8b2b7e2d124f7690e6ddd19

data/{CHANGELOG → CHANGELOG.md}

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+- `#find_by_slug` has been changed to `#find_by_slug` to keep in line with AR
+  finder syntax
+
 ## 1.0.2
 
 - [Bug fix] Bypassing validations for `#find_by_slug` spec in shared example.

data/README.md

@@ -1,8 +1,8 @@
-# Slugworth
+![Slugworth](http://f.cl.ly/items/3T1K3g040S0u2l0G0d3V/slugworth_header.png)
 
 [![Gem Version](https://badge.fury.io/rb/slugworth.png)](http://badge.fury.io/rb/sluggle)
-[![Build Status](https://travis-ci.org/mattpolito/slugworth.png?branch=master)](https://travis-ci.org/mattpolito/sluggle)
-[![Code Climate](https://codeclimate.com/github/mattpolito/slugworth.png)](https://codeclimate.com/github/mattpolito/sluggle)
+[![Build Status](https://travis-ci.org/mattpolito/slugworth.png?branch=master)](https://travis-ci.org/mattpolito/slugworth)
+[![Code Climate](https://codeclimate.com/github/mattpolito/slugworth.png)](https://codeclimate.com/github/mattpolito/slugworth)
 
 Simple slug functionality for your ActiveRecord objects
 
@@ -32,7 +32,7 @@ install it yourself with
 
 Getting started is easy! Just ensure that your model has a database column of type `String` called `slug`
 
-To use just add two declarations to your module and away you go!
+To use, just add two declarations to your `ActiveRecord` class and away you go!
 
 ```ruby
 class User < ActiveRecord::Base
@@ -41,11 +41,29 @@ class User < ActiveRecord::Base
 end
 ```
 
+After you `include` the `Slugworth` module, all you need to do is declare what method will be used to create the slug. The method passed to `slugged_with` will then be paramterized.
+
 This provides most of the default slug functionality you would need.
 
-* A finder `.find_by_slug` is provided. This will, of course, do what you expect and find a single record by the slug attribute provided. However, it will throw an `ActiveRecord::RecordNotFound` exception... if not found.
+* Finders `.find_by_slug` & `.find_by_slug!` are provided. This will, of course, do what you expect and find a single record by the slug attribute provided.
 * `#to_param` has been defined as a paramaterized version of the attribute declared to `slugged_with`.
-* Validations stating that slug is present and unique in the database.
+* Validations stating that `slug` is present and unique in the database.
+
+## Test Helper
+
+To aid in testing your models that implement the Slugworth functionality, I've added a shared example group that can be added to your test suite. Add this to your `spec_helper.rb`
+
+```ruby
+include 'slugworth_shared_examples'
+```
+
+And then in your specs just add:
+
+```ruby
+it_behaves_like :has_slug_functionality
+```
+
+This will add the same specs to your model that get run on Slugworth itself!
 
 ## Contributing
 
@@ -54,3 +72,9 @@ This provides most of the default slug functionality you would need.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Thanks
+
+* [Rye Mason][] for the fantastic heading image.
+
+[Rye Mason]: https://github.com/ryenotbread

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/slugworth.rb

@@ -14,9 +14,13 @@ module Slugworth
       self.slug_attribute = slug_attribute
     end
 
-    def find_by_slug(slug)
+    def find_by_slug!(slug)
       find_by!(slug: slug)
     end
+
+    def find_by_slug(slug)
+      find_by(slug: slug)
+    end
   end
 
   def to_param; slug; end
@@ -27,6 +31,6 @@ module Slugworth
   end
 
   def processed_slug
-    send(slug_attribute).parameterize
+    public_send(slug_attribute).parameterize
   end
 end

data/lib/slugworth/version.rb

@@ -1,3 +1,3 @@
 module Slugworth
-  VERSION = "1.0.2"
+  VERSION = "1.1.0".freeze
 end

data/lib/slugworth_shared_examples.rb

@@ -51,8 +51,12 @@ shared_examples_for :has_slug_functionality do
     end
 
     context 'when record is not found' do
-      specify 'error is returned' do
-        expect { described_class.find_by_slug('named-slug') }.to raise_error(ActiveRecord::RecordNotFound)
+      specify 'nil is returned' do
+        expect(described_class.find_by_slug('named-slug')).to eq(nil)
+      end
+
+      specify 'error is raised' do
+        expect{ described_class.find_by_slug!('named-slug') }.to raise_error(ActiveRecord::RecordNotFound)
       end
     end
   end

data/slugworth.gemspec

@@ -14,15 +14,16 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.2'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.13"
   spec.add_development_dependency 'activerecord', '~> 4.0.0'
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "database_cleaner", '~> 1.0.1'
   spec.add_development_dependency "sqlite3"
 end

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
 require 'rspec'
 require 'database_cleaner'
-
-require 'active_support/concern'
 require 'active_record'
 
 ActiveRecord::Base.establish_connection(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slugworth
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Polito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -116,9 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .ruby-gemset
-- .ruby-version
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -149,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Easy slug functionality

data/.ruby-gemset

@@ -1 +0,0 @@
-slugworth

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0