sluggerize 0.0.3 → 0.1.0

data/Gemfile

@@ -1,4 +1,9 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in sluggerize.gemspec
+# Specify your gem's dependencies in acts_as_keyed.gemspec
 gemspec
+
+# Development dependencies 
+gem "rake"
+gem "activesupport", "~>3.0"
+gem "sqlite3-ruby"

data/Rakefile

@@ -1,2 +1,15 @@
 require 'bundler'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the restful_authentication plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
 Bundler::GemHelper.install_tasks

data/lib/sluggerize.rb

@@ -1,54 +1,12 @@
+require 'active_record'
+require 'sluggerize/errors'
+require 'sluggerize/class_methods'
+require 'sluggerize/instance_methods'
+
 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 :create_slug, :on => :create
-
-      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/lib/sluggerize/class_methods.rb

@@ -0,0 +1,38 @@
+module Sluggerize
+  module ClassMethods
+    def sluggerize(attr=nil, options={})
+      class_attribute :options
+
+      attr ||= :title
+      options[:as_param] = true unless options[:as_param] == false
+      options[:substitution_char] ||= '-'
+      self.options = options
+
+      raise ArgumentError unless options[:substitution_char].is_a?(String)
+
+      if ActiveRecord::Base.connection.table_exists?(self.table_name)
+        raise NoSourceColumnError, "#{self.name} is missing source column" if columns_hash[attr.to_s].nil?
+        raise NoSlugColumnError, "#{self.name} is missing required slug column" if columns_hash['slug'].nil?
+      end
+
+      before_validation :create_slug, :on => :create
+
+      validates_presence_of :slug, :allow_nil => (options[:as_param] ? true : false)
+      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
+end

data/lib/sluggerize/errors.rb

@@ -0,0 +1,12 @@
+module Sluggerize
+  class NoSlugColumnError < StandardError
+    def to_s
+      'There must be a slug column defined in the database table for this model'
+    end
+  end
+  class NoSourceColumnError < StandardError
+    def to_s
+      'The column matching the attribute you want to sluggerize can not be found in the database table'
+    end
+  end
+end

data/lib/sluggerize/instance_methods.rb

@@ -0,0 +1,18 @@
+module Sluggerize
+  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

data/lib/sluggerize/version.rb

@@ -1,3 +1,3 @@
 module Sluggerize
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/sluggerize.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   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.add_dependency "activerecord", "~> 3.0"
   s.rubyforge_project = "sluggerize"
 
   s.files         = `git ls-files`.split("\n")

data/test/sluggerize_test.rb

@@ -0,0 +1,88 @@
+require 'test/test_helper'
+
+class SluggerizeBaseTest < ActiveSupport::TestCase
+end
+
+class SluggerizeTest < SluggerizeBaseTest
+  test "should generate slug on create" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    assert_difference('ObjectWithTitleAndSlug.count') do
+      o = ObjectWithTitleAndSlug.create(:title => 'hello')
+      assert_not_nil o.slug
+    end
+  end
+
+  test "should be invalid with a blank slug" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    assert_no_difference('ObjectWithTitleAndSlug.count') do
+      o = ObjectWithTitleAndSlug.create
+    end
+  end
+
+  test "should format the source for a slug" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    o = ObjectWithTitleAndSlug.create(:title => 'Jeremy Was Here')
+    assert_equal 'jeremy-was-here', o.slug
+  end
+
+  test "should remove all non url friendly characters" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    o = ObjectWithTitleAndSlug.create(:title => 'a!@#$%^&*()_+a')
+    assert_equal 'a_a', o.slug
+  end
+
+  test "should replace all spaces with the substitution char" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    o = ObjectWithTitleAndSlug.create(:title => 'a a')
+    assert_equal 'a-a', o.slug
+  end
+
+  test "should set defaults if no options are passed in" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    assert_not_nil ObjectWithTitleAndSlug.options[:substitution_char]
+    assert_not_nil ObjectWithTitleAndSlug.options[:as_param]
+  end
+
+  test "should default to as_params true" do
+    ObjectWithTitleAndSlug.sluggerize
+
+    assert ObjectWithTitleAndSlug.options[:as_param]
+  end
+
+  test "should set as_params to true if anything other than false is passed in to parameters" do
+    ObjectWithTitleAndSlug.sluggerize(nil, :as_param => 'test')
+
+    assert ObjectWithTitleAndSlug.options[:as_param]
+  end
+
+  test "should set as_params to false via parameters" do
+    ObjectWithTitleAndSlug.sluggerize(nil, :as_param => false)
+
+    assert !ObjectWithTitleAndSlug.options[:as_param]
+  end
+
+  test "should raise an error if the substitution char is not a string" do
+    assert_raise ArgumentError do
+      ObjectWithTitleAndSlug.sluggerize(nil, :substitution_char => Object)
+    end
+  end
+
+  test "should raise an error if the source column does not exist" do
+    assert_raise Sluggerize::NoSourceColumnError do
+      ObjectWithNonTitleColumnAndSlug.sluggerize
+    end
+  end
+
+  test "should raise an error if the slug column does not exist" do
+    assert_raise Sluggerize::NoSlugColumnError do
+      ObjectWithoutSlug.sluggerize
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_record'
+require 'active_model'
+
+$:.unshift "#{File.dirname(__FILE__)}/../"
+$:.unshift "#{File.dirname(__FILE__)}/../lib/"
+
+require 'sluggerize'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :objects_with_title_and_slug do |t|
+    t.string    :title
+    t.string    :slug
+  end
+
+  create_table :objects_with_non_title_column_and_slug do |t|
+    t.string    :name
+    t.boolean   :slug
+  end
+
+  create_table :objects_without_slug do |t|
+    t.string    :title
+  end
+end
+
+class ObjectWithTitleAndSlug < ActiveRecord::Base
+  self.table_name = 'objects_with_title_and_slug'
+end
+
+class ObjectWithNonTitleColumnAndSlug < ActiveRecord::Base
+  self.table_name = 'objects_with_non_title_column_and_slug'
+end
+
+class ObjectWithoutSlug < ActiveRecord::Base
+  self.table_name = 'objects_without_slug'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sluggerize
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jeremy Hubert
@@ -15,9 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-24 00:00:00 Z
-dependencies: []
-
+date: 2012-02-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
 description: Creates a slug from the specified column of any model.
 email: 
 - jhubert@gmail.com
@@ -28,13 +42,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - Gemfile
 - README.md
 - Rakefile
 - lib/sluggerize.rb
+- lib/sluggerize/class_methods.rb
+- lib/sluggerize/errors.rb
+- lib/sluggerize/instance_methods.rb
 - lib/sluggerize/version.rb
 - sluggerize.gemspec
+- test/sluggerize_test.rb
+- test/test_helper.rb
 homepage: ""
 licenses: []
 
@@ -68,5 +88,6 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Simple library for creating a slug column from another string column
-test_files: []
-
+test_files: 
+- test/sluggerize_test.rb
+- test/test_helper.rb