urls_for_humans 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781ea4d78f5f63c5f05cd5cf429a9e22cd4ad95a
-  data.tar.gz: 5c62c5b45cdb175e6d21bffc34f8d6e93c33bbde
+  metadata.gz: adc219f6fec209e61ef474a4371f16d7787be5da
+  data.tar.gz: 30e269e5d75bae8b28829db3cc1facfeaf6a6269
 SHA512:
-  metadata.gz: e450763c2eec2fcb6a3a3f3b2c46e1835275292af89eb2db66ff9b07233741758cc3c8352b354aaa356cb9c24feb749e0af22bf3caa79d2c363ae3634ce05140
-  data.tar.gz: 7ed304d075f09ff68290b7d81971176037a48951bba78309a3f790c7726bae0216995d42f3fc7ce3cfa3e3426583b68b44a0e16405cae9af18ba3823cb401afd
+  metadata.gz: feb54b5172dd50f1d673b793dd8e7121afcdab7f32ca459a742a93841083da79c427970197702edcc78f77eca04bcf6d56eb31762175a15e363794b47fa69b28
+  data.tar.gz: 3cd6bb0278871ddcdcad586f5b101254d88bda0764b0b5eb5b9cd3f1e305eb2e211094a800f052e8fef34ce08e9895d12e763ef9b316add8ac4969d9668ef1e6

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1

data/README.md

@@ -1,10 +1,31 @@
-# Urls For Humans
+# Urls for Humans
 
-Urls For Humans allows you to apply meaningful names to your Rails Application's urls by leveraging what happens under the covers with `Model.find(params[:id])` and `to_param`. So long as the url is prefixed with the model's id, the lookup will happen exactly how we intend it to with a few key benefits:
+[![Build Status](https://travis-ci.org/johnotander/urls_for_humans.svg?branch=master)](https://travis-ci.org/johnotander/urls_for_humans)
 
-  * Simplicity
-  * Lightweight
-  * Persistent urls because changes the the latter portions of a param won't affect it's lookup.
+Urls for Humans is a gem that allows you to apply meaningful names to your Rails Application's urls
+by leveraging what happens under the covers with `Model.find(params[:id])`, `to_i`, and `to_param`.
+This makes it easy to turn `users/1` to `users/1-john-otander`. So long as the url is prefixed with
+the model's `id` (which Urls for Humans ensures), the lookup will happen exactly how we intend it
+to with a few key benefits:
+
+  * Simple thanks to ActiveSupport.
+  * Lightweight, weighing in at roughly 20 something lines of added gem code to your Rails app (since
+  ActiveSupport is already a dependency).
+  * Persistent urls because changes in the latter portions of a param won't affect it's lookup.
+  * There are no slugs required.
+
+### Why use Urls for Humans in place of Friendly ID?
+
+This is a different approach to friendly URLs than the `friendly_id` gem because it doesn't modify
+the db queries themselves. The `urls_for_humans` approach essentially allows all urls fitting the
+form `resource/<id>-<anything else>` to route to `resource/:id` because `to_i` is called on the
+`id` parameter.
+
+Personally, I prefer this approach because a link out there in the wild to a user's profile
+`users/previous_username` isn't broken (404'd) when they change their username to `users/new_username`
+because the slug has been changed.
+
+Also, I'm biased.
 
 ## Installation
 
@@ -29,11 +50,12 @@ $ gem install urls_for_humans
 ## Usage
 
 
-To use Urls For Humans you need to extend the `UrlsForHumans` module, and call the class method `urls_for_humans`:
+To use Urls For Humans you need to extend the `UrlsForHumans` module, and call the class method
+`urls_for_humans`:
 
 ```ruby
 class User < ActiveRecord::Base
-  extend UrlsForHumans
+  include UrlsForHumans
 
   # ...
 
@@ -43,7 +65,8 @@ class User < ActiveRecord::Base
 end
 ```
 
-The `urls_for_humans` method can be a collection of any information that you'd like to include in the url. For example, with the above class we'd result in:
+The `urls_for_humans` method can be a collection of any information that you'd like to include in
+the url. For example, with the above class we'd result in:
 
 ```ruby
 u = User.create(first_name: 'John', last_name: 'Otander')
@@ -56,14 +79,36 @@ u.to_param
 # => '1-otander'
 ```
 
-With this solution, an ActiveRecord object will always produce the correct url throughout the application:
+With this solution, an ActiveRecord object will always produce the correct url throughout the
+application:
 
 ```ruby
 link_to user.first_name, user
-# => <a href="http://localhost:3000/users/1-john-otander" 
+# => <a href="http://localhost:3000/users/1-john-otander"
 ```
 
-Additionally, any link that hits the internet will persist because `1-random-content`, `1-other-random-content`, and `1-john-doe` will all route to the same resource.
+Additionally, any link that hits the internet will persist because `1-random-content`, `1-other-random-content`,
+and `1-john-doe` will all route to the same resource.
+
+### I don't like it when you leverage executable class bodies
+
+That's fine. You can add a method to your model, instead.
+
+```ruby
+class User < ActiveRecord::Base
+  include UrlsForHumans
+
+  # ...
+
+  def humanly_attrs
+    [:first_name, :last_name, :favorite_food]
+  end
+
+  # ...
+end
+```
+
+This will result in `"#{ id }-#{ first_name }-#{ last_name }-#{ favorite_food }"`. Yay.
 
 ## Resources
 
@@ -77,3 +122,5 @@ Additionally, any link that hits the internet will persist because `1-random-con
 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
+
+Crafted with <3 by [John Otander](http://johnotander.com) ([@4lpine](https://twitter.com/4lpine)).

data/lib/urls_for_humans.rb

@@ -6,15 +6,15 @@ require 'active_support/core_ext/object/blank'
 
 module UrlsForHumans
   extend ActiveSupport::Concern
- 
+
   module ClassMethods
     attr_accessor :humanly_attrs
- 
+
     def urls_for_humans(*humanly_attrs)
       @humanly_attrs = humanly_attrs
     end
   end
- 
+
   def to_param
     (self.class.humanly_attrs || humanly_attrs).dup.unshift(:id).map do |attrib|
       send(attrib).to_s.parameterize

data/lib/urls_for_humans/version.rb

@@ -1,3 +1,3 @@
 module UrlsForHumans
-  VERSION = '0.0.2'
+  VERSION = '1.0.0'
 end

data/spec/spec_helper.rb

@@ -6,10 +6,6 @@ require 'urls_for_humans'
 
 I18n.enforce_available_locales = false
 
-RSpec.configure do |config|
-  config.color_enabled = true
-end
-
 class User
   include UrlsForHumans
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urls_for_humans
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - John Otander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -75,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Urls for humans in Rails apps.