parameterize 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+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)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Peter Browne
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Parameterize
+
+_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'
+    
+## 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
+    
+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
+    
+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
+
+## Copyright
+
+Copyright (c) 2011 [Peter Browne](http://petebrowne.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+task :default => :spec
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/parameterize.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/array/extract_options'
+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.
+  def parameterize(source = :title)
+    include InstanceMethods
+    
+    class_attribute   :param_source_field
+    before_validation :update_param
+    
+    self.param_source_field = source
+  end
+  
+  module InstanceMethods
+    def to_param
+      self.param
+    end
+    
+    # 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
+
+require 'parameterize/railtie' if defined?(Rails)

data/lib/parameterize/matcher.rb

@@ -0,0 +1,11 @@
+require 'rspec/matchers'
+
+RSpec::Matchers.define :parameterize do |source|
+  match do |model|
+    model.class.include?(Parameterize::InstanceMethods) && model.class.param_source_field == source
+  end
+  
+  failure_message_for_should do |model|
+    "expected #{model.class} to parameterize #{source}"
+  end
+end

data/lib/parameterize/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module Parameterize
+  class Railtie < Rails::Railtie
+    initializer 'parameterize.include_macro' do |app|
+      ActiveRecord::Base.extend Parameterize
+    end
+  end
+end

data/lib/parameterize/version.rb

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

data/parameterize.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'parameterize/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'parameterize'
+  s.version     = Parameterize::VERSION
+  s.platform    = Gem::Platform::RUBY
+  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.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_development_dependency 'sqlite3-ruby',  '~> 1.3.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = %w(lib)
+end

data/spec/parameterize_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Parameterize do
+  it 'parameterizes the source field' do
+    post = Post.new :title => "Hey Ho, Let's Go!"
+    post.valid?
+    post.param.should == 'hey-ho-let-s-go'
+  end
+  
+  context 'with a different source field' do
+    it 'parameterizes the source field' do
+      user = User.new :name => 'Donald E. Knuth'
+      user.valid?
+      user.param.should == 'donald-e-knuth'
+    end
+  end
+  
+  describe '#to_param' do
+    it 'returns the param' do
+      post = Post.new :title => "Hey Ho, Let's Go!"
+      post.valid?
+      post.to_param.should == 'hey-ho-let-s-go'
+    end
+  end
+  
+  describe 'matcher' do
+    it 'checks if Post parameterized :title' do
+      Post.new.should parameterize(:title)
+    end
+    
+    it 'checks if User parameterized :name' do
+      User.new.should parameterize(:name)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+lib = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'active_record'
+require 'parameterize'
+require 'parameterize/matcher'
+
+module ActiveRecord
+  class Base
+    extend Parameterize
+    establish_connection :adapter => 'sqlite3', :database => ':memory:'
+  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
+  end
+end
+
+class Post < ActiveRecord::Base
+  parameterize
+end
+
+class User < ActiveRecord::Base
+  parameterize :name
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: parameterize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete
+- Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-29 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id004
+description: It uses ActiveSupport's String#parameterize to create the slug. There are no validations. No slug history. No extra tables or models.
+email: 
+- me@petebrowne.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/parameterize.rb
+- lib/parameterize/matcher.rb
+- lib/parameterize/railtie.rb
+- lib/parameterize/version.rb
+- parameterize.gemspec
+- spec/parameterize_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/petebrowne/parameterize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: parameterize
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The simplest permalink/slug solution for ActiveRecord 3.0
+test_files: 
+- spec/parameterize_spec.rb
+- spec/spec_helper.rb