parameterize 0.1.0 → 0.1.1

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+Gemfile.lock

data/README.md

@@ -1,51 +1,66 @@
 # Parameterize
 
-_The simplest permalink/slug solution for ActiveRecord 3.0._
+_The simplest permalink/slug solution for ActiveRecord >= 3.0._
 
 It uses ActiveSupport's `String#parameterize` to create the slug. There are no validations. No slug history. No extra tables or models.
 
 ## Getting Started
 
-    rails generate model User name:string param:string
-    
-    class User < ActiveRecord::Base
-      parameterize :name
-    end
-    
-    user = User.new :name => 'John Doe'
-    user.valid?
-    user.param = 'john-doe'
-    user.to_param = 'john-doe'
+```ruby
+# Gemfile
+gem 'parameterize'
+```
+
+```
+bundle install
+rails generate model User name:string param:string
+```
+   
+```ruby
+# models/user.rb
+class User < ActiveRecord::Base
+  parameterize :name
+end
+
+# elsewhere
+user = User.new :name => 'John Doe'
+user.valid?
+user.param = 'john-doe'
+user.to_param = 'john-doe'
+```
     
 ## Notes
 
 Validations **are not** included. I prefer to be able to customize my validations directly in the model. The most common validations you would add are:
 
-    class Post < ActiveRecord::Base
-      parameterize
-      validates_presence_of :param
-      validates_uniqueness_of :param
-    end
+```ruby
+class Post < ActiveRecord::Base
+  parameterize
+  validates_presence_of :param
+  validates_uniqueness_of :param
+end
+```
     
 You could easily use [Babosa's](http://github.com/norman/babosa) #to_identifier or [Stringex's](http://github.com/rsl/stringex) #to_url instead of ActiveSupport's #parameterize by just aliasing the method you want to use:
 
-    require 'babosa'
-    class String
-      alias :parameterize :to_identifier
-    end
+```ruby
+require 'babosa'
+class String
+  alias :parameterize :to_identifier
+end
+```
     
 There is also a Shoulda-style RSpec matcher available for use in your specs:
 
-    # spec_helper.rb
-    ...
-    require 'parameterize/matcher'
-    ...
-    
-    # post_spec.rb
-    ...
-    describe Post do
-      it { should parameterize(:title) }
-    end
+```ruby
+# spec_helper.rb
+require 'parameterize/matcher'
+
+# post_spec.rb
+describe Post do
+  it { should parameterize(:title) }
+end
+```
 
 ## Copyright
 

data/lib/parameterize.rb

@@ -4,6 +4,8 @@ require 'active_support/core_ext/string/inflections'
 module Parameterize
   # Adds a before validation filter for updating the param field
   # with the parameterized version of the given source field.
+  #
+  # @param [Symbol, String] source The field to parameterize
   def parameterize(source = :title)
     include InstanceMethods
     
@@ -14,15 +16,17 @@ module Parameterize
   end
   
   module InstanceMethods
+    # Overwrite #to_param to return the generated param.
     def to_param
       self.param
     end
     
+    protected
+    
     # Updates the param field with the parameterized version of the source field.
     def update_param
       self.param = __send__(self.class.param_source_field).to_s.parameterize
     end
-    protected :update_param
   end
 end
 

data/lib/parameterize/version.rb

@@ -1,3 +1,3 @@
 module Parameterize
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/parameterize.gemspec

@@ -9,14 +9,14 @@ Gem::Specification.new do |s|
   s.authors     = %w(Pete Browne)
   s.email       = %w(me@petebrowne.com)
   s.homepage    = 'http://github.com/petebrowne/parameterize'
-  s.summary     = %{The simplest permalink/slug solution for ActiveRecord 3.0}
+  s.summary     = %{The simplest permalink/slug solution for ActiveRecord >= 3.0}
   s.description = %{It uses ActiveSupport's String#parameterize to create the slug. There are no validations. No slug history. No extra tables or models.}
 
   s.rubyforge_project = 'parameterize'
   
-  s.add_dependency             'activerecord',  '~> 3.0.3'
-  s.add_dependency             'activesupport', '~> 3.0.3'
-  s.add_development_dependency 'rspec',         '~> 2.4.0'
+  s.add_dependency             'activerecord',  '~> 3.0'
+  s.add_dependency             'activesupport', '~> 3.0'
+  s.add_development_dependency 'rspec',         '~> 2.6.0'
   s.add_development_dependency 'sqlite3-ruby',  '~> 1.3.3'
 
   s.files         = `git ls-files`.split("\n")

data/spec/spec_helper.rb

@@ -1,31 +1,21 @@
-lib = File.expand_path('../../lib', __FILE__)
-$:.unshift(lib) unless $:.include?(lib)
-
 require 'rubygems'
 require 'bundler/setup'
-require 'rspec'
+Bundler.require :default, :development
 require 'active_record'
-require 'parameterize'
 require 'parameterize/matcher'
 
-module ActiveRecord
-  class Base
-    extend Parameterize
-    establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Base.extend Parameterize
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define :version => 1 do
+  create_table :posts do |t|
+    t.string :title
+    t.string :param
   end
   
-  Migration.verbose = false
-  
-  Schema.define(:version => 1) do
-    create_table :posts do |t|
-      t.string :title
-      t.string :param
-    end
-    
-    create_table :users do |t|
-      t.string :name
-      t.string :param
-    end
+  create_table :users do |t|
+    t.string :name
+    t.string :param
   end
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: parameterize
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Pete
@@ -15,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-29 00:00:00 -06:00
-default_executable: 
+date: 2011-07-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -26,11 +26,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 3
         - 0
-        - 3
-        version: 3.0.3
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -41,11 +41,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 3
         - 0
-        - 3
-        version: 3.0.3
+        version: "3.0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -56,11 +56,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 2
-        - 4
+        - 6
         - 0
-        version: 2.4.0
+        version: 2.6.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -71,6 +72,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 29
         segments: 
         - 1
         - 3
@@ -90,7 +92,6 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -101,7 +102,6 @@ files:
 - parameterize.gemspec
 - spec/parameterize_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/petebrowne/parameterize
 licenses: []
 
@@ -115,6 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -123,16 +124,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: parameterize
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: The simplest permalink/slug solution for ActiveRecord 3.0
+summary: The simplest permalink/slug solution for ActiveRecord >= 3.0
 test_files: 
 - spec/parameterize_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    parameterize (0.1.0)
-      activerecord (~> 3.0.3)
-      activesupport (~> 3.0.3)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.3)
-    arel (2.0.7)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    i18n (0.5.0)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
-    sqlite3 (1.3.3)
-    sqlite3-ruby (1.3.3)
-      sqlite3 (>= 1.3.3)
-    tzinfo (0.3.24)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  parameterize!
-  rspec (~> 2.4.0)
-  sqlite3-ruby (~> 1.3.3)