sluggy 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ary Djmal
+
+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,38 @@
+# Sluggy
+## Minimal slugging/permalink gem for ActiveRecord. Nothing fancy.
+
+Built with rails 3.2 and ruby 1.9.2 in mind.
+
+### Features
+
+* Slug generation with sequence support.
+* Slug validation.
+* **40 LOC** & fully tested.
+
+### Slug pattern
+
+* downcase and strip
+* remove non [a-z0-9-_]
+* replace spaces with '-'
+* if conflict add separator '--' with sequence number
+
+### Validations
+
+* Presence
+* Format with Sluggy::SLUG_REGEX
+* Length within 1..100
+* Uniqueness
+
+### Use like this
+
+    slug_for :title
+    slug_for :title, :column => :slug
+    slug_for :title, :column => :slug, :scope => :account_id
+
+Defaults are `:column => :permalink, :scope => nil`
+
+### Install
+
+    gem 'sluggy'
+
+Copyright (c) 2012 Ary Djmal, released under the MIT license.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the sluggy gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/sluggy.rb

@@ -0,0 +1,44 @@
+module Sluggy
+  SLUG_REGEX = %r{^[a-z0-9\-\_]+$}i
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def slug_for(base, options={})
+      options.reverse_merge!(:column => :permalink, :base => base, :scope => nil)
+      validates options[:column], :presence => true, :format => { :with => Sluggy::SLUG_REGEX }, :length => { :within => 1..100 }, :uniqueness => (options[:scope] ? {:scope => options[:scope]} : true)
+      before_validation :generate_slug
+      class_eval %{ def self.sluggy_options; #{options}; end }
+      include Sluggy::InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    private
+    def slug_column; self.class.sluggy_options[:column]; end
+    def slug_scope;  self.class.sluggy_options[:scope]; end
+    def slug_base;   self.class.sluggy_options[:base]; end
+
+    def generate_slug
+      if send(slug_column).blank?
+        slug = send(slug_base).to_s.downcase.strip.gsub(/[^a-z0-9\s\-\_]/, '').gsub(/\s+/, '-')
+
+        exists = self.class.where("#{slug_column} = ? OR #{slug_column} LIKE ?", slug, "#{slug}--%")
+        exists = exists.where('id != ?', id) unless new_record?
+        exists = exists.where("#{slug_scope} = ?", send(slug_scope)) if slug_scope
+        exists = exists.order("LENGTH(#{slug_column}) DESC, #{slug_column} DESC")
+
+        if conflict = exists.first
+          last_number =  conflict.send(slug_column).gsub(/^#{Regexp.quote(slug)}--/, '').to_i
+          slug << "--#{last_number+1}"
+        end
+
+        send("#{slug_column}=", slug)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Sluggy)

data/sluggy.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'sluggy'
+  s.version     = '0.1.0'
+  s.authors     = ['Ary Djmal']
+  s.email       = ['arydjmal@gmail.com']
+  s.summary     = 'Minimal slugging/permalink gem for ActiveRecord. Nothing fancy.'
+  s.homepage    = 'http://github.com/arydjmal/sluggy'
+
+  s.add_dependency 'activerecord', '>= 3.0.0'
+
+  s.add_development_dependency 'rake'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/test/sluggy_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class SluggyDefaultsTest < Test::Unit::TestCase
+  def setup
+    Post.delete_all
+    Post.send(:slug_for, :title)
+    Post.create!(:title => 'First Post')
+  end
+
+  def test_with_new_title
+    post = Post.create!(:title => 'Second Post')
+    assert_equal('second-post', post.permalink)
+  end
+
+  def test_with_same_title
+    post = Post.create!(:title => 'First Post')
+    assert_equal('first-post--1', post.permalink)
+  end
+
+  def test_with_two_same_title
+    post_1 = Post.create!(:title => 'First Post')
+    post_2 = Post.create!(:title => 'First Post')
+    assert_equal('first-post--1', post_1.permalink)
+    assert_equal('first-post--2', post_2.permalink)
+  end
+
+  def test_slug_should_be_clean
+    post = Post.create!(:title => ' Third   Post\'s! is-good_now!?? ')
+    assert_equal('third-posts-is-good_now', post.permalink)
+  end
+  
+  def test_should_validate_when_updating_slug
+    post = Post.create!(:title => 'First Post')
+    assert_equal('first-post--1', post.permalink)
+    post.update_attributes(:permalink => '')
+    assert_equal('first-post--1', post.permalink)
+    post.update_attributes(:permalink => 'first-post!! iji@@')
+    assert_equal('first-post--1', post.reload.permalink)
+    post.update_attributes(:permalink => 'first-post')
+    assert_equal('first-post--1', post.reload.permalink)
+  end
+end
+
+class SluggyWithOptionsTest < Test::Unit::TestCase
+  def setup
+    User.delete_all
+    User.send(:slug_for, :name, {:column => :handle, :scope => :account_id})
+    User.create!(:name => 'Ary Djmal', :account_id => 1)
+  end
+
+  def test_with_new_title
+    user = User.create!(:name => 'Nati Djmal', :account_id => 1)
+    assert_equal('nati-djmal', user.handle)
+  end
+
+  def test_with_same_name
+    user = User.create!(:name => 'Ary Djmal', :account_id => 1)
+    assert_equal('ary-djmal--1', user.handle)
+  end
+
+  def test_with_two_same_title
+    user_1 = User.create!(:name => 'Ary Djmal', :account_id => 1)
+    user_2 = User.create!(:name => 'Ary Djmal', :account_id => 1)
+    assert_equal('ary-djmal--1', user_1.handle)
+    assert_equal('ary-djmal--2', user_2.handle)
+  end
+
+  def test_with_same_title_but_not_in_scope
+    user = User.create!(:name => 'Ary Djmal', :account_id => 2)
+    assert_equal('ary-djmal', user.handle)
+  end
+
+  def test_should_validate_when_updating_slug
+    user = User.create!(:name => 'Ary Djmal', :account_id => 1)
+    assert_equal('ary-djmal--1', user.handle)
+    user.update_attributes(:handle => '')
+    assert_equal('ary-djmal--1', user.handle)
+    user.update_attributes(:handle => 'ary-djmal!! iji@@')
+    assert_equal('ary-djmal--1', user.reload.handle)
+    user.update_attributes(:handle => 'ary-djmal')
+    assert_equal('ary-djmal--1', user.reload.handle)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'active_record'
+require 'sluggy'
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+})
+
+ActiveRecord::Schema.define do
+  create_table :posts do |t|
+    t.string  :title, :permalink
+  end
+
+  create_table :users do |t|
+    t.string  :name, :handle
+    t.integer :account_id
+  end
+end
+
+class Post < ActiveRecord::Base
+end
+
+class User < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: sluggy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ary Djmal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70257429974860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257429974860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70257429972740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257429972740
+description: 
+email:
+- arydjmal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/sluggy.rb
+- ./MIT-LICENSE
+- ./Rakefile
+- ./README.md
+- ./sluggy.gemspec
+- ./test/sluggy_test.rb
+- ./test/test_helper.rb
+homepage: http://github.com/arydjmal/sluggy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Minimal slugging/permalink gem for ActiveRecord. Nothing fancy.
+test_files: []
+has_rdoc: