sequel_sluggable 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pavel Kunc
+
+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,18 @@
+= sequel_sluggable
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Pavel Kunc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rake'
+
+# Load this library's version information
+require File.expand_path('../lib/version', __FILE__)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = Sequel::Plugins::Sluggable::VERSION
+    gem.name = "sequel_sluggable"
+    gem.summary = "Sequel plugin which provides Slug functionality for model."
+    gem.description = gem.summary
+    gem.email = "pavel.kunc@gmail.com"
+    gem.homepage = "http://github.com/pk/sequel_sluggable"
+    gem.authors = ["Pavel Kunc"]
+    gem.add_dependency "sequel"
+    gem.add_development_dependency "sqlite3-ruby"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "yard"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/TODO

@@ -0,0 +1,3 @@
+== TODO
+* Add posibility to configure algorithm how slug is generated
+* Add posibility to donfigure field which holds slug

data/VERSION

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

data/lib/sequel_sluggable.rb

@@ -0,0 +1,92 @@
+module Sequel
+  module Plugins
+
+    # The Sluggable plugin creates hook that automatically sets 
+    # 'slug' field to the slugged value of the column specified
+    # by :source option.
+    #
+    # You need to have "target" column in your model.
+    module Sluggable
+      DEFAULT_TARGET_COLUMN = :slug
+
+      # Plugin configuration
+      def self.configure(model, opts={})
+        model.sluggable_options = opts
+      end
+
+      module ClassMethods
+        attr_reader :sluggable_options
+
+        # Finds model by slug or PK
+        #
+        # @return [Sequel::Model, nil]
+        def find_by_pk_or_slug(value)
+          value.to_s =~ /^\d+$/ ? self[value] : self.find_by_slug(value)
+        end
+
+        # Finds model by Slug column
+        #
+        # @return [Sequel::Model, nil]
+        def find_by_slug(value)
+          self[@sluggable_options[:target] => value.chomp]
+        end
+
+        # Set the plugin options
+        #
+        # Options:
+        # @param [Hash] plugin options
+        # @option source    [Symbol] :Column to get value to be slugged from.       
+        # @option target    [Symbol] :Column to write value of the slug to.
+        # @option sluggator [Proc]   :Algorithm to convert string to slug.
+        def sluggable_options=(options)
+          raise ArgumentError, "You must provide :source column" unless options[:source]
+          if options[:sluggator] &&
+             !options[:sluggator].is_a?(Symbol) &&
+             !options[:sluggator].respond_to?(:call)
+            raise ArgumentError, "If you provide :sluggator it must be Symbol or callable." 
+          end
+          options[:source]    = options[:source].to_sym
+          options[:target]    = options[:target] ? options[:target].to_sym : DEFAULT_TARGET_COLUMN
+          @sluggable_options  = options
+        end
+      end
+
+      module InstanceMethods
+
+        # Sets a slug column to the slugged value
+        def before_save
+          super
+          target = "#{self.class.sluggable_options[:target]}="
+          source = self.class.sluggable_options[:source]
+          self.send(target, self.send(source))
+        end
+
+        private
+
+        # Sets the slug to the normalized URL friendly string
+        #
+        # Compute slug for the value
+        #
+        # @param [String] String to be slugged
+        # @return [String]
+        def slug=(v)
+          slug = if self.class.sluggable_options[:sluggator]
+                   self.class.sluggable_options[:sluggator].call(v, self)
+                 else
+                   to_slug(v)
+                 end
+          super(slug)
+        end
+
+        # Generate slug from the passed value
+        #
+        # @param [String] String to be slugged
+        # @return [String]
+        def to_slug(v)
+          v.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
+        end
+
+      end # InstanceMethods
+    end # Sluggable
+  end # Plugins
+end # Sequel

data/lib/sluggable_rspec_helper.rb

@@ -0,0 +1,23 @@
+module Sequel::Plugins::Sluggable::SluggableRSpecHelper
+  def it_should_behave_like_sluggable(klass)
+    it "should have slug when created" do
+      model = klass.make(klass.slug_source_column => 'Test String')
+      model.slug.should eql 'test-string'
+    end
+
+    it "should update slug when #{klass.slug_source_column} is updated" do
+      model = klass.make(klass.slug_source_column => 'Test String')
+      lambda { model.update(klass.slug_source_column => 'Test String Two') }.should change(model,:slug).to('test-string-two')
+    end
+
+    it "should find #{klass} by it's ID" do
+      model = klass.make(klass.slug_source_column => 'Test String')
+      klass.find_by_id_or_slug(model.id).should eql model
+    end
+
+    it "should find #{klass} by it's slug" do
+      model = klass.make(klass.slug_source_column => 'Test String')
+      klass.find_by_id_or_slug('test-string').should eql model
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module Sluggable
+      VERSION = '0.0.2'.freeze
+    end
+  end
+end

data/sequel_sluggable.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sequel_sluggable}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pavel Kunc"]
+  s.date = %q{2010-02-14}
+  s.description = %q{Sequel plugin which provides Slug functionality for model.}
+  s.email = %q{pavel.kunc@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "lib/sequel_sluggable.rb",
+     "lib/sluggable_rspec_helper.rb",
+     "lib/version.rb",
+     "sequel_sluggable.gemspec",
+     "spec/sequel_sluggable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/pk/sequel_sluggable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sequel plugin which provides Slug functionality for model.}
+  s.test_files = [
+    "spec/sequel_sluggable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sequel>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<sequel>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sequel>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/sequel_sluggable_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Item < Sequel::Model; end
+
+describe "SequelSluggable" do
+  before(:each) do
+    Item.plugin :sluggable,
+                :source => :name,
+                :target => :slug
+  end
+
+  it "should be loaded using Model.plugin" do
+    Item.plugins.should include(Sequel::Plugins::Sluggable)
+  end
+
+  it "should add find_by_pk_or_slug" do
+    Item.should respond_to(:find_by_pk_or_slug)
+  end
+
+  it "should add find_by_slug" do
+    Item.should respond_to(:find_by_slug)
+  end
+
+  it "should generate slug when saved" do
+    Item.create(:name => 'Pavel Kunc').slug.should eql 'pavel-kunc'
+  end
+
+  describe "options handling" do
+    before(:each) do
+      @sluggator = Proc.new {|value, model| value.chomp.downcase}
+      class Item < Sequel::Model; end
+      Item.plugin :sluggable,
+                  :source    => :name,
+                  :target    => :slug,
+                  :sluggator => @sluggator
+    end
+
+    it "should accept source option" do
+      Item.sluggable_options[:source].should eql :name
+    end
+
+    it "should accept target option" do
+      Item.sluggable_options[:target].should eql :slug
+    end
+
+    it "should accept sluggator option" do
+      Item.sluggable_options[:sluggator].should eql @sluggator
+    end
+
+    it "should require source option" do
+      class Item < Sequel::Model; end
+      lambda { Item.plugin :sluggable }.should raise_error(ArgumentError, "You must provide :source column")
+    end
+
+    it "should default target option to :slug when not provided" do
+      class Item < Sequel::Model; end
+      Item.plugin :sluggable, :source => :name
+      Item.sluggable_options[:target].should eql :slug
+    end
+
+    it "should require sluggator to be Symbol or callable" do
+      class Item < Sequel::Model; end
+      lambda { Item.plugin :sluggable, :source => :name, :sluggator => 'xy' }.should raise_error(ArgumentError, "If you provide :sluggator it must be Symbol or callable.")
+    end
+  end
+
+  describe "::find_by_pk_or_slug" do
+    it "should find model by slug" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_pk_or_slug('pavel-kunc').should eql item
+    end
+
+    it "should find model by id" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_pk_or_slug(item.id).should eql item
+    end
+
+    it "should return nil if model not found and searching by slug" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_pk_or_slug('tonda-kunc').should be_nil
+    end
+
+    it "should return nil if model not found and searching by id" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_pk_or_slug(1000).should be_nil
+    end
+  end
+
+  describe "::find_by_slug" do
+    it "should find model by slug" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_slug('pavel-kunc').should eql item
+    end
+
+    it "should return nil if model not found" do
+      item = Item.create(:name => 'Pavel Kunc')
+      Item.find_by_slug('tonda-kunc').should be_nil
+    end
+  end
+
+  describe "slug algorithm customization" do
+    before(:each) do
+      class Item < Sequel::Model; end
+    end
+
+    it "should use to_slug method on model if available" do
+      Item.plugin :sluggable,
+                  :source => :name,
+                  :target => :slug
+      Item.class_eval do
+        def to_slug(v)
+           v.chomp.downcase.gsub(/[^a-z0-9]+/,'_')
+        end
+      end
+      Item.create(:name => 'Pavel Kunc').slug.should eql 'pavel_kunc'
+    end
+
+    it "should use only :sluggator proc if defined" do
+      Item.plugin :sluggable,
+                  :source    => :name,
+                  :target    => :slug,
+                  :sluggator => Proc.new {|value, model| value.chomp.downcase.gsub(/[^a-z0-9]+/,'_')}
+      Item.create(:name => 'Pavel Kunc').slug.should eql 'pavel_kunc'
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sequel'
+require 'sequel_sluggable'
+require 'spec'
+require 'spec/autorun'
+
+# Create model to test on
+DB = Sequel.sqlite
+DB.create_table :items do
+  primary_key :id
+  String :name
+  String :slug
+end
+
+class Item < Sequel::Model; end
+
+Spec::Runner.configure do |config|
+  config.after(:each)  { Item.delete }
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_sluggable
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Pavel Kunc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-14 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Sequel plugin which provides Slug functionality for model.
+email: pavel.kunc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- lib/sequel_sluggable.rb
+- lib/sluggable_rspec_helper.rb
+- lib/version.rb
+- sequel_sluggable.gemspec
+- spec/sequel_sluggable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pk/sequel_sluggable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Sequel plugin which provides Slug functionality for model.
+test_files: 
+- spec/sequel_sluggable_spec.rb
+- spec/spec_helper.rb