has_unique_slug 0.1.0

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# HasUniqueSlug
+Generates a unique slug for use as a drop-in replacement for ids Ruby on Rails Active Record
+
+## Install
+
+Add `gem has_unique_slug` to your Gemfile and run `bundle install` to get it installed.
+
+## Usage
+
+Assume you have a Post model that has a title and slug column in which the slug column is generated from the post title.
+
+	class Post < ActiveRecord::Base
+		has_unique_slug
+	end
+	
+
+A unique slug will be generated automatically on creation.  
+If the generated slug is not unique, "-n" is appended onto the end. n starts at 2 and will increment by 1 until a unique slug is found.
+If a slug is provided, one will not be generated, however the same rule applies as the above if the slug is not unique.
+
+You can specify which column to use to generate the slug and which column to use to store the slug. Below is the default:
+
+	class Post < ActiveRecord::Base
+		has_unique_slug :title, :slug
+	end
+	
+
+Or if only 1 argument is given, use that column to generate the slug
+
+	class Post < ActiveRecord::Base
+		has_unique_slug :name		# Uses the name column to generate the slug
+	end
+	
+
+## TODO:
+
+Would like to write some tests.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/has_unique_slug.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_unique_slug/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has_unique_slug"
+  s.version     = HasUniqueSlug::VERSION
+  s.authors     = ["Brendan Stennett"]
+  s.email       = ["brendan@unknowncollective.com"]
+  s.homepage    = "https://github.com/HuffMoody/has_unique_slug"
+  s.summary     = "Generates a unique slug for use as a drop-in replacement for ids."
+  s.description = "Generates a unique slug for use as a drop-in replacement for ids."
+
+  s.rubyforge_project = "has_unique_slug"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/has_unique_slug/version.rb

@@ -0,0 +1,3 @@
+module HasUniqueSlug
+  VERSION = "0.1.0"
+end

data/lib/has_unique_slug.rb

@@ -0,0 +1,65 @@
+require "has_unique_slug/version"
+
+module HasUniqueSlug
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    
+    def has_unique_slug(*args)
+      
+      # Setup options Hash
+      options = {:generates_with => :title, :slug_column => :slug}
+      options.merge! args.pop if args.last.kind_of? Hash
+      
+      # Standaridize implementation
+      title, slug = options[:generates_with], options[:slug_column]
+      
+      # Add ActiveRecord Callback
+      before_create do |record|
+        
+        # Add a slug if slug doesn't exist
+        if record[slug].blank?
+          record[slug] = record[title].parameterize
+        end
+        
+        # Ensure the current slug is unique in the database, if not, make it unqiue
+        i = 2
+        while not record.class.where(slug => record[slug]).count.zero? 
+          record[slug] = "#{record[slug]}-#{i}"
+          i += 1
+        end  
+      end
+      
+      # Add instance methods to objects using has_unique_slug
+      class_eval do
+        include HasUniqueSlug::InstanceMethods
+      end
+      
+      # Add class methods to objects using has_unique_slug
+      instance_eval do
+        def find(*args)
+          if args.length == 1
+            where(slug => args.first).first
+          else
+            where(slug => args)
+          end
+        end
+      end
+    end
+    
+  end
+  
+  module InstanceMethods
+
+    def to_param
+      slug
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  include HasUniqueSlug
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: has_unique_slug
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brendan Stennett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-12 00:00:00 Z
+dependencies: []
+
+description: Generates a unique slug for use as a drop-in replacement for ids.
+email: 
+- brendan@unknowncollective.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- has_unique_slug.gemspec
+- lib/has_unique_slug.rb
+- lib/has_unique_slug/version.rb
+homepage: https://github.com/HuffMoody/has_unique_slug
+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: has_unique_slug
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generates a unique slug for use as a drop-in replacement for ids.
+test_files: []
+