urls_for_humans 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4275044760bb0c20648da21ead4b707509dcb524
-  data.tar.gz: a356512224993f2517d88265e853de51e27b3322
+  metadata.gz: 781ea4d78f5f63c5f05cd5cf429a9e22cd4ad95a
+  data.tar.gz: 5c62c5b45cdb175e6d21bffc34f8d6e93c33bbde
 SHA512:
-  metadata.gz: 57b6dbd28a51ab52ae4e9da2f09a6cda4261447a0fdde418ff969e10be42152962208babb3c38b40f585f455032c93e2be3597c7795133a6b1de3fbd7e60d2a4
-  data.tar.gz: e2d702b1f19fb4ee7c1a5fd7050d687e538390484d31885eba6cd4ac2f2bf1eefe66751b486b75e7b659611ebae8fa1920601bd0363b68e94ed781bee697c029
+  metadata.gz: e450763c2eec2fcb6a3a3f3b2c46e1835275292af89eb2db66ff9b07233741758cc3c8352b354aaa356cb9c24feb749e0af22bf3caa79d2c363ae3634ce05140
+  data.tar.gz: 7ed304d075f09ff68290b7d81971176037a48951bba78309a3f790c7726bae0216995d42f3fc7ce3cfa3e3426583b68b44a0e16405cae9af18ba3823cb401afd

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 TODO: Write your name
+Copyright (c) 2014 John Otander
 
 MIT License
 

data/README.md

@@ -1,28 +1,78 @@
-# UrlsForHumans
+# Urls For Humans
 
-TODO: Write a gem description
+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:
+
+  * Simplicity
+  * Lightweight
+  * Persistent urls because changes the the latter portions of a param won't affect it's lookup.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'urls_for_humans'
+```ruby
+gem 'urls_for_humans'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install urls_for_humans
+```bash
+$ gem install urls_for_humans
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+
+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
+
+  # ...
+
+  urls_for_humans :first_name, :last_name
+
+  # ...
+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:
+
+```ruby
+u = User.create(first_name: 'John', last_name: 'Otander')
+
+u.to_param
+# => '1-john-otander'
+
+u.first_name = nil
+u.to_param
+# => '1-otander'
+```
+
+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" 
+```
+
+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.
+
+## Resources
+
+  * <https://github.com/norman/friendly_id>
+  * <https://gist.github.com/cdmwebs/1209732>
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/urls_for_humans/fork )
+1. Fork it ( http://github.com/johnotander/urls_for_humans/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
+
+task :build do
+  system "gem build urls_for_humans.gemspec"
+end

data/lib/urls_for_humans/version.rb

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

data/lib/urls_for_humans.rb

@@ -1,30 +1,23 @@
-require "urls_for_humans/version"
+require 'urls_for_humans/version'
 
-module UrlsForHumans
-  def self.extended(model_class)
-    return if model_class.respond_to?(:urls_for_humans)
-
-    model_class.class_eval do
-      class << self
-        attr_accessor :humanly_attrs
-      end
-
-      extend Base
-      include Model
-    end
-  end
+require 'active_support/concern'
+require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
 
-  module Base
+module UrlsForHumans
+  extend ActiveSupport::Concern
+ 
+  module ClassMethods
+    attr_accessor :humanly_attrs
+ 
     def urls_for_humans(*humanly_attrs)
       @humanly_attrs = humanly_attrs
     end
   end
-
-  module Model
-    def to_param
-      self.class.humanly_attrs.dup.unshift(:id).map do |attrib|
-        send(attrib).to_s.parameterize
-      end.reject(&:blank?).join('-')
-    end
+ 
+  def to_param
+    (self.class.humanly_attrs || humanly_attrs).dup.unshift(:id).map do |attrib|
+      send(attrib).to_s.parameterize
+    end.reject(&:blank?).join('-')
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require 'urls_for_humans'
+
+I18n.enforce_available_locales = false
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+class User
+  include UrlsForHumans
+
+  urls_for_humans :first_name, :last_name
+
+  attr_accessor :first_name, :last_name
+
+  def initialize(first_name, last_name)
+    self.first_name = first_name
+    self.last_name  = last_name
+  end
+
+  def id
+    10
+  end
+end

data/spec/urls_for_humans_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe UrlsForHumans do
+
+  let(:first) { 'John' }
+  let(:last)  { 'Doe'  }
+
+  let(:user) { User.new(first, last) }
+
+  subject { user }
+
+  describe '.to_param' do
+
+    it 'should return the correct string' do
+      expect(subject.to_param).to eq("#{ user.id }-#{ user.first_name.parameterize }-#{ user.last_name.parameterize }")
+    end
+
+    context 'with no first name' do
+
+      let(:user) { User.new(nil, last) }
+
+      it 'should return the correct string' do
+        expect(subject.to_param).to eq("#{ user.id }-#{ user.last_name.parameterize }")
+      end
+    end
+
+    context 'with no last name' do
+
+      let(:user) { User.new(first, nil) }
+
+      it 'should return the correct string' do
+        expect(subject.to_param).to eq("#{ user.id }-#{ user.first_name.parameterize }")
+      end
+    end
+
+    context 'with no first or last name' do
+
+      let(:user) { User.new(nil, nil) }
+
+      it 'should return the correct string' do
+        expect(subject.to_param).to eq(user.id.to_s)
+      end
+    end
+  end
+
+  describe '.urls_for_humans and @humanly_attrs' do
+
+    let(:attrs) { [:fake, :attrs] }
+
+    before { User.urls_for_humans(*attrs) }
+
+    it 'should return the correct attributes' do
+      expect(User.humanly_attrs).to eq(attrs)
+    end
+  end
+end

data/urls_for_humans.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urls_for_humans
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Otander
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A delightfully simple way to make your urls friendly to end users, without
   muddying up the backend.
 email:
@@ -53,6 +81,8 @@ files:
 - Rakefile
 - lib/urls_for_humans.rb
 - lib/urls_for_humans/version.rb
+- spec/spec_helper.rb
+- spec/urls_for_humans_spec.rb
 - urls_for_humans.gemspec
 homepage: https://github.com/johnotander/urls_for_humans
 licenses:
@@ -78,4 +108,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Urls for humans in Rails apps.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/urls_for_humans_spec.rb