slugger 0.0.1

data/.gitignore

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

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Seth Faxon
+
+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.rdoc

@@ -0,0 +1,43 @@
+= Slugger
+
+Slugger is yet another slug generator.  It makes pretty urls for Active Record models.  It jumps through some hoops to make sure every slug is unique.  
+
+== Installation
+
+It's a gem. Either run `gem install slugger` at the command line, or add `gem 'slugger'` to your Gemfile.
+
+== Usage
+
+  has_slug :source_column, [options]
+
+The default source column is title.
+
+:source_column can also be an array, for example, if you wanted to create slugs for an Author model on first and last name:
+
+  has_slug [:first_name, :last_name]
+
+== Options
+
+Say you have an Episode model that belongs to TVSeries.  Every episode will have a pilot, but you don't want the unique validation to build silly looking urls:
+
+  class Episode << ActiveRecord::Base
+    belongs_to :series
+    
+    has_slug :title, :scope => :series_id
+  end
+  
+
+== Example
+
+  create_table "collection" do |t|
+    t.string   "title"
+    t.string   "slug"
+  end
+
+  class Project < ActiveRecord::Base
+    has_slug
+  end
+
+  Collection.create(:title => 'Quick foxes jumping')
+  Collection.first.slug => 'quick-foxes-jumping'
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/slugger/version.rb

@@ -0,0 +1,3 @@
+module Slugger
+  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").chomp
+end

data/lib/slugger.rb

@@ -0,0 +1,81 @@
+require 'slugger/version'
+require 'active_record'
+require 'iconv'
+
+module Slugger
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  module ClassMethods
+    def acts_as_sluggable(title_column=nil,sluger_options={})
+      class_inheritable_accessor :sluger_options
+      sluger_options[:title_column]      ||= title_column || 'title'
+      # sluger_options[:title_column]      ||= 'title'
+      sluger_options[:slug_column]       ||= 'slug'
+      sluger_options[:as_param]          ||= true
+      sluger_options[:substitution_char] ||= '-'
+      self.sluger_options = sluger_options
+      
+      # if columns_hash[sluger_options[:title_column].to_s].nil?
+      # 
+      #   raise ArgumentError, "#{self.name} is missing source column"
+      # end
+      raise ArgumentError, "#{self.name} is missing required slug column" if columns_hash[sluger_options[:slug_column]].nil?
+
+      before_validation :create_slug, :on => :create
+
+      validates sluger_options[:slug_column].to_sym, :presence => true
+      if sluger_options[:scope]
+        validates sluger_options[:slug_column].to_sym, :uniqueness => {:scope => sluger_options[:scope]}
+      else
+        validates sluger_options[:slug_column].to_sym, :uniqueness => true
+      end
+
+      send :define_method, :column_to_slug, lambda { self.send(sluger_options[:title_column]) }
+
+      class << self
+        def find(*args)
+          if self.sluger_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
+      sluger_options[:as_param] ? self.slug : self.id
+    end
+
+    protected
+
+    def permalize
+      return if !self.send("#{self.sluggable_conf[:slug_column]}").blank?
+      s = Iconv.iconv('ascii//ignore//translit', 'utf-8', self.send("#{self.sluggable_conf[:title_column]}")).to_s
+      s.gsub!(/\'/, '')   # remove '
+      s.gsub!(/\W+/, ' ') # all non-word chars to spaces
+      s.strip!            # ohh la la
+      s.downcase!         #
+      s.gsub!(/\ +/, '-') # spaces to dashes, preferred separator char everywhere
+      self.send("#{self.sluggable_conf[:slug_column]}=", s) 
+    end
+    def strip_title
+      self.send("#{self.sluggable_conf[:title_column]}").strip!
+    end
+    
+    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]/, sluger_options[:substitution_char])
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Slugger)

data/slugger.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "slugger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "slugger"
+  s.version     = Slugger::VERSION
+  s.authors     = ["Seth Faxon"]
+  s.email       = ["seth.faxon@gmail.com"]
+  s.homepage    = "https://github.com/sfaxon/slugger"
+  s.summary     = %q{Slugger is yet another slug generator.}
+  s.description = %q{Slugger is yet another slug generator.}
+
+  s.rubyforge_project = "slugger"
+
+  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"]
+  
+  s.extra_rdoc_files = [
+    "MIT-LICENSE",
+    "README.rdoc"
+  ]
+  
+  # specify any dependencies here; for example:
+  s.add_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "sqlite3", "~> 1.3.0"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/lib/slugger_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Post do
+  it "should set slug on create" do
+    p = Post.create(:title => "hello world")
+    p.slug.should == "hello-world"
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,44 @@
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby' ? 'jdbcsqlite3' : 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :posts, :force => true do |t|
+      t.string :title
+      t.string :slug
+      t.timestamps
+    end
+    
+    create_table :users, :force => true do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :slug
+      t.timestamps
+    end
+  end
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end
+
+class Post < ActiveRecord::Base
+  acts_as_sluggable
+end
+
+class User < ActiveRecord::Base
+  acts_as_sluggable [:first_name, :last_name]
+
+  def name
+    [first_name, last_name].compact.join(' ')
+  end
+
+  def name=(names)
+    self[:first_name], self[:last_name] = names.split(' ', 2)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+require 'slugger'
+require 'schema'
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

data/tasks/spec.rake

@@ -0,0 +1,34 @@
+ENV['BUNDLE_GEMFILE'] = File.dirname(__FILE__) + '/../Gemfile'
+
+require 'rake'
+require 'rake/testtask'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the test suite"
+task :spec => ['spec:setup', 'spec:slugger_lib', 'spec:cleanup']
+
+namespace :spec do
+  desc "Setup the test environment"
+  task :setup do
+  end
+  
+  desc "Cleanup the test environment"
+  task :cleanup do
+    File.delete(File.expand_path(File.dirname(__FILE__) + '/../spec/test.db'))
+  end
+  
+  desc "Test slugger"
+  RSpec::Core::RakeTask.new(:slugger_lib) do |task|
+    slugger_root = File.expand_path(File.dirname(__FILE__) + '/..')
+    task.pattern = slugger_root + '/spec/lib/**/*_spec.rb'
+  end
+
+  desc "Run the coverage report"
+  RSpec::Core::RakeTask.new(:rcov) do |task|
+    slugger_root = File.expand_path(File.dirname(__FILE__) + '/..')
+    task.pattern = slugger_root + '/spec/lib/**/*_spec.rb'
+    task.rcov=true
+    task.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/}
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: slugger
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Seth Faxon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-23 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
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Slugger is yet another slug generator.
+email: 
+- seth.faxon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/slugger.rb
+- lib/slugger/version.rb
+- slugger.gemspec
+- spec/lib/slugger_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- tasks/spec.rake
+homepage: https://github.com/sfaxon/slugger
+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: slugger
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Slugger is yet another slug generator.
+test_files: 
+- spec/lib/slugger_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb