acts_as_stubbable 0.1.0 → 0.1.2

data/README.md

@@ -1,2 +1,51 @@
 acts_as_stubbable
-=================
+=================
+
+##Why?
+I tend to use a lot of url-friendly strings for SEO in my web apps. Wanting to dry up my code, I created a module mixin for generating stubs, and turned it into a light-weight gem.
+
+##Installation
+
+For Rails 3, in your Gemfile:
+    gem 'acts_as_stubbable'
+
+
+##Usage
+Let's pretend we have a column for our Thing class called name, which is a string.
+First in your ActiveRecord model:
+
+    include Stubbable
+    
+Then, tell Stubbable which column should be used to generate the stub, i.e.
+
+    acts_as_stubbable :column => :name
+    
+So that your model looks like:
+
+    class Thing < ActiveRecord::Base
+      include Stubbable  
+      attr_accessible :name, :stub #for rails 3.2 onwards, 
+      acts_as_stubbable :column => :name
+    end
+    
+Lastly, don't forget to create a migration for your model which adds the :stub column, i.e.
+
+    class AdStubToThings < ActiveRecord::Migration
+      def up
+        add_column :things, :stub, :string
+      end
+      def down
+        remove_column :things, :stub
+      end
+    end
+    
+Now, when a new Thing instance is created with a name, i.e.
+
+    t = Thing.new(:name => 'My name is Lionel Hutz aka Miguel Sanchez!')
+    t.save
+    puts t.stub
+    => 'my-name-is-lionel-hutz-aka-miguel-sanchez'
+    
+you get a url-friendly string, with any special characters stripped and spaced turned into hyphens, using the built-in String.parameterize method. 
+
+Like the ads say, "It's that simple, it really is!"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_stubbable
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Robbie Shepherd
@@ -15,12 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-24 00:00:00 +11:00
+date: 2013-01-25 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  name: rspec
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +45,54 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: shoulda
-  requirement: *id001
+  name: rspec-rails
+  requirement: *id002
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activerecord
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: sqlite3
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,11 +103,11 @@ dependencies:
         - 12
         version: "3.12"
   name: rdoc
-  requirement: *id002
+  requirement: *id006
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -59,11 +117,11 @@ dependencies:
         - 0
         version: "0"
   name: bundler
-  requirement: *id003
+  requirement: *id007
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -75,11 +133,11 @@ dependencies:
         - 4
         version: 1.8.4
   name: jeweler
-  requirement: *id004
+  requirement: *id008
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -89,7 +147,7 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  requirement: *id005
+  requirement: *id009
   type: :development
 description: create a url-friendly stub based on an activerecord column for your models
 email: robbie.shepherd@gmail.com