sluggerize 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sluggerize.gemspec
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# Sluggerize
+
+A simple plugin that automatically generates a slug for a model on create. It takes care of protecting the key, automatically generating it and making sure it is unique.
+
+## Usage
+
+    sluggerize :source_column, [options]
+
+### Source Column
+
+If you don't provide a source column, it will default to looking for a "title" column.
+
+### Options
+
+* **as_params** [*False*] If true, this will be used as the id of the object when creating URLs and you will be able to Object.find(slug)
+* **substitution_char** - [-] The character to use when replacing spaces and other unsupported characters
+
+## Example
+
+    create_table "projects" do |t|
+      t.string   "title"
+      t.string   "slug"
+    end
+
+    class Project < ActiveRecord::Base
+      sluggerize
+    end
+
+    Project.create(:title => 'A Very Happy Project')
+    Project.first.slug
+    => 'a-very-happy-project'
+
+Copyright (c) 2011 Jeremy Hubert, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/sluggerize/version.rb

@@ -0,0 +1,3 @@
+module Sluggerize
+  VERSION = "0.0.1"
+end

data/lib/sluggerize.rb

@@ -0,0 +1,54 @@
+module Sluggerize
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  module ClassMethods
+    def sluggerize(attr=nil,options={})
+      class_inheritable_accessor :options
+      attr ||= :title
+      options[:as_param] ||= true
+      options[:substitution_char] ||= '-'
+      self.options = options
+
+      raise ArgumentError, "#{self.name} is missing source column" if columns_hash[attr.to_s].nil?
+      raise ArgumentError, "#{self.name} is missing required slug column" if columns_hash['slug'].nil?
+
+      before_validation_on_create :create_slug
+
+      validates_presence_of :slug
+      validates_uniqueness_of :slug, :allow_nil => (options[:as_param] ? true : false)
+
+      send :define_method, :column_to_slug, lambda { self.send(attr) }
+
+      class << self
+        def find(*args)
+          if self.options[:as_param] && args.first.is_a?(String)
+            find_by_slug(args)
+          else
+            super(*args)
+          end
+        end
+      end
+    
+      include InstanceMethods
+    end
+  end
+  module InstanceMethods
+
+    def to_param
+      options[:as_param] ? self.slug : self.id
+    end
+
+    protected
+
+    def create_slug
+      self.slug ||= clean("#{column_to_slug}")
+    end
+  
+    def clean(string)
+      string.downcase.gsub(/[^\w\s\d\_\-]/,'').gsub(/\s\s+/,' ').gsub(/[^\w\d]/, options[:substitution_char])
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Sluggerize)

data/sluggerize.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sluggerize/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sluggerize"
+  s.version     = Sluggerize::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeremy Hubert"]
+  s.email       = ["jhubert@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple library for creating a slug column from another string column}
+  s.description = %q{Creates a slug from the specified column of any model.}
+
+  s.rubyforge_project = "sluggerize"
+
+  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 = ["lib"]
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: sluggerize
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeremy Hubert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Creates a slug from the specified column of any model.
+email: 
+- jhubert@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/sluggerize.rb
+- lib/sluggerize/version.rb
+- sluggerize.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sluggerize
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Simple library for creating a slug column from another string column
+test_files: []
+