ffmike-from_param 1.0

data/MIT-LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2007 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/)
+
+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

@@ -0,0 +1,57 @@
+FromParam
+=========
+
+This plugin is an addition to  ActiveRecord::Base that establishes a better 
+convention for finding records based on parameters. It adds a "from_param" class
+method to ActiveRecord::Base as a convention for fetching a model from a URL
+parameter. By default it will find a record based on the to_i of the passed in
+parameter, but storing a parameter in a column is where it becomes especially useful.
+
+If you create a 'param' column in your table (or any other column using set_param_column),
+the to_param of your record will automatically be saved to that column whenever
+you save the record, and you will be able to retrieve it using just a simple
+Model.from_param call with the generated to_param. It is probably wise to add an index
+to the param column if you use one.
+
+It's time to move away from generated-key-dependence, and this plugin is an attempt
+to make that easy, painless, and work easily within the existing systems.
+
+Example
+=======
+
+  # default behavior
+
+  class User < ActiveRecord::Base
+    def to_param
+      "#{id}-#{first_name.downcase}-#{last_name.downcase}"
+    end
+  end
+  
+  class UsersController < ApplicationController
+    # GET /users/1-bobby-mcfarin
+    def show
+      @user = User.from_param(params[:id]) # => <User id=1 first_name="Bobby" last_name="McFarin">
+    end
+  end
+  
+  # using a 'param' column, in this case 'slug'. Note the use of String.urlize to make the title URL-friendly.
+  
+  class Post < ActiveRecord::Base
+    set_param_column "slug" # defaults to "param"
+    def to_param
+      "#{created_at.strftime("%Y-%m-%d")}-#{title.urlize}"
+    end
+  end
+
+  class PostsController < ApplicationController
+    # GET /posts/2008-04-26-from-param-plugin-released
+    @post = Post.from_param(params[:id]) # => <Post title="From Param: Plugin Released" created_at="2008-04-26">
+  end
+  
+Resources
+=========
+
+GitHub: http://github.com/mbleigh/from_param
+Lighthouse: http://mbleigh.lighthouseapp.com/projects/10478-from-param
+
+Copyright (c) 2007 Michael Bleigh (http://mbleigh.com/) and Intridea Inc. (http://intridea.com/), released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the from_param plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the from_param plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'from_param'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/from_param.rb

@@ -0,0 +1,53 @@
+class ActiveRecord::Base
+  # Class Methods
+  class << self
+    # The column that is currently set to be used with
+    # the from_param method.
+    def param_column
+      "param"
+    end
+    alias :param_column= :param_column
+    
+    # Allows you to set the column that will be used
+    # by from_param by default.
+    def set_param_column(val)
+      define_attr_method :param_column, val
+    end
+
+    # Returns true if the param_column is one of the
+    # currently defined columns of your table.
+    def param_column?
+      column_names.include?(param_column)
+    end
+    
+    # Takes a parameter generated by to_param and
+    # tried to find a matching record. If param_column
+    # is set and exists, uses that as the finder, otherwise
+    # uses the id such as in the default Rails to_param.
+    def from_param(parameter)
+      if param_column?
+        send "find_by_#{param_column}", parameter
+      else
+        find_by_id(parameter.to_i)        
+      end
+    end
+  end
+  
+  # Calls param_column? on the class
+  def param_column?
+    self.class.param_column?
+  end
+  
+  # Calls param_column on the class
+  def param_column
+    self.class.param_column
+  end
+  
+  before_save :set_param
+  # Automatically called before saving, sets
+  # the param_column to the current to_param
+  def set_param
+    send "#{param_column}=", to_param if param_column?
+  end
+  
+end

data/lib/string_extensions.rb

@@ -0,0 +1,10 @@
+class String
+  # Convert an arbitrary string into a format suitable for use in a URL
+  # 
+  # * Replaces spaces with dashes
+  # * Converts to all lower-case
+  # * Removes all characters except alphabetic and numeric
+  def urlize
+    self.gsub(" ","-").downcase.gsub(/[^a-z0-9-]/,"")
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'from_param'
+require 'string_extensions'

data/spec/from_param_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe ActiveRecord::Base, "with from_param" do
+  before(:each) do
+    @paramed = ParameteredModel.new
+  end
+  
+  it "#param_column? should be true if there is a param column, false otherwise" do
+    ParameteredModel.param_column?.should be_true
+    UnparameteredModel.param_column?.should be_false
+  end
+  
+  it "should automatically save the to_param to the param field if one exists" do
+    @paramed.name = "Angus McIntyre"
+    @paramed.save
+    ParameteredModel.find(@paramed.id).param.should == "angus-mcintyre"
+  end
+  
+  it "should retrieve a model from its to_param" do
+    @paramed.name = "Bob McFinchalot!!!"
+    @paramed.save
+    ParameteredModel.from_param(@paramed.to_param).should == @paramed
+  end
+  
+  it "#from_param should work on models that don't have a param attribute using the id instead" do
+    unparamed = UnparameteredModel.create(:name => "Something")
+    unparamed.to_param.should == "1-something"
+    UnparameteredModel.from_param(unparamed.to_param).should == unparamed
+  end
+  
+  it "should allow the param column to be set to any column" do
+    @paramed = SluggedModel.new
+    @paramed.name = "Bob McFinchalot!!!"
+    @paramed.save
+    SluggedModel.from_param(@paramed.to_param).should == @paramed
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :parametered_models, :force => true do |t|
+    t.column :name, :string
+    t.column :param, :string
+  end
+  
+  create_table :unparametered_models, :force => true do |t|
+    t.column :name, :string
+  end
+  
+  create_table :slugged_models, :force => true do |t|
+    t.column :name, :string
+    t.column :slug, :string
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+load(File.dirname(__FILE__) + '/schema.rb')
+
+class ParameteredModel < ActiveRecord::Base
+  def to_param
+    name.gsub(" ","-").downcase.gsub(/[^a-z-]/,"")
+  end
+end
+
+class UnparameteredModel < ActiveRecord::Base
+  def to_param
+    "#{id}-#{name.gsub(" ","-").downcase.gsub(/[^a-z-]/,"")}"
+  end
+end
+
+class SluggedModel < ActiveRecord::Base
+  set_param_column "slug"
+  
+  def to_param
+    name.gsub(" ","-").downcase.gsub(/[^a-z-]/,"")
+  end  
+end

data/spec/string_extensions_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "urlize" do
+  
+    it "should replace spaces with dashes" do
+      "a b c".urlize.should == "a-b-c"
+    end
+    
+    it "should downcase the string" do
+      "AbCdE".urlize.should == "abcde"
+    end
+    
+    it "should remove all characters except letters, numbers, and dashes" do
+      "A_b C#d!-e".urlize.should == "ab-cd-e"
+    end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: ffmike-from_param
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This plugin is an addition to  ActiveRecord::Base that establishes a better  convention for finding records based on parameters. It adds a 'from_param' class method to ActiveRecord::Base as a convention for fetching a model from a URL parameter.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- init.rb
+- lib/from_param.rb
+- lib/string_extensions.rb
+- rails/init.rb
+- spec/from_param_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/string_extensions_spec.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/from_param/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Better convention for finding records based on parameters
+test_files: []
+