sequel_sluggable 0.0.2 → 0.0.3

data/.gitignore

@@ -15,6 +15,7 @@ tmtags
 
 ## PROJECT::GENERAL
 coverage
+doc
 rdoc
 pkg
 

data/README.rdoc

@@ -1,8 +1,67 @@
 = sequel_sluggable
 
-Description goes here.
+== Install
 
-== Note on Patches/Pull Requests
+Add gemcutter.org source if you don't have it:
+  gem source http://gemcutter.org
+
+Install:
+  [sudo] gem install sequel_sluggable
+
+== Usage
+
+This plug-in provide functionality to allow Sequel::Model to have a slug.
+Slug is created in the *before_save* hook which is called when you're
+*creating* or *updating* your model.
+
+To use plug-in you add plug-in to your model:
+
+  class MyModel < Sequel::Model
+    plugin :sluggable, :source => :name
+  end
+
+You can use following options:
+*source*:: Column which value will be used to generate slug.
+*target*:: Column where slug will be written, defaults to *:slug*.
+*sluggator*:: Proc or Symbol to call to create slug.
+
+Options *target* and *sluggator* are optional.
+
+== Algorithm customization
+
+You can customize algorithm of the slug creation in several places.
+If you provide _:sluggator_ Proc or Symbol the sluggator will be called:
+
+  class MyModel < Sequel::Model
+    plugin :sluggable,
+           :source    => :name,
+           :sluggator => Proc.new {|value, model| do_something }
+  end
+
+OR
+
+  class MyModel < Sequel::Model
+    plugin :sluggable,:source => :name, :sluggator => :my_to_slug
+  end
+
+If you don't provide _:sluggator_ sequel_sluggable will try to use
+<b>Model#to_slug(value)</b>. So if you have in your model this method
+it will be used:
+
+  class MyModel < Sequel::Model
+    plugin :sluggable, :source => :name
+
+    def to_slug(value)
+      value.upcase
+    end
+  end
+
+If you don't define <b>Model#to_slug</b> or *:sluggator* sequel_sluggable
+will use it's own default implementation which does following:
+
+  model.source_column.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
+
+= Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.

data/Rakefile

@@ -13,7 +13,7 @@ begin
     gem.email = "pavel.kunc@gmail.com"
     gem.homepage = "http://github.com/pk/sequel_sluggable"
     gem.authors = ["Pavel Kunc"]
-    gem.add_dependency "sequel"
+    gem.add_dependency "sequel", ">= 3.0.0"
     gem.add_development_dependency "sqlite3-ruby"
     gem.add_development_dependency "rspec"
     gem.add_development_dependency "yard"

data/lib/sequel_sluggable.rb

@@ -35,14 +35,13 @@ module Sequel
         #
         # Options:
         # @param [Hash] plugin options
-        # @option source    [Symbol] :Column to get value to be slugged from.       
+        # @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.
+        # @option sluggator [Proc, Symbol] :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)
+          sluggator = options[:sluggator]
+          if sluggator && !sluggator.is_a?(Symbol) && !sluggator.respond_to?(:call)
             raise ArgumentError, "If you provide :sluggator it must be Symbol or callable." 
           end
           options[:source]    = options[:source].to_sym
@@ -69,12 +68,11 @@ module Sequel
         #
         # @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
+        def slug=(value)
+          sluggator = self.class.sluggable_options[:sluggator]
+          slug = sluggator.call(value, self)   if sluggator.respond_to?(:call)
+          slug ||= self.send(sluggator, value) if sluggator
+          slug ||= to_slug(value)
           super(slug)
         end
 
@@ -82,8 +80,8 @@ module Sequel
         #
         # @param [String] String to be slugged
         # @return [String]
-        def to_slug(v)
-          v.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
+        def to_slug(value)
+          value.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
         end
 
       end # InstanceMethods

data/lib/version.rb

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

data/sequel_sluggable.gemspec

@@ -5,17 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sequel_sluggable}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   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.date = %q{2010-02-15}
   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"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
@@ -23,8 +22,6 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.rdoc",
      "Rakefile",
-     "TODO",
-     "VERSION",
      "lib/sequel_sluggable.rb",
      "lib/sluggable_rspec_helper.rb",
      "lib/version.rb",
@@ -48,18 +45,18 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<sequel>, [">= 3.0.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<sequel>, [">= 3.0.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<sequel>, [">= 3.0.0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])

data/spec/sequel_sluggable_spec.rb

@@ -122,6 +122,19 @@ describe "SequelSluggable" do
                   :sluggator => Proc.new {|value, model| value.chomp.downcase.gsub(/[^a-z0-9]+/,'_')}
       Item.create(:name => 'Pavel Kunc').slug.should eql 'pavel_kunc'
     end
+
+    it "should use only :sluggator Symbol if defined" do
+      Item.plugin :sluggable,
+                  :source    => :name,
+                  :target    => :slug,
+                  :sluggator => :my_custom_sluggator
+      Item.class_eval do
+        def my_custom_sluggator(v)
+           v.chomp.upcase.gsub(/[^a-zA-Z0-9]+/,'-')
+        end
+      end
+      Item.create(:name => 'Pavel Kunc').slug.should eql 'PAVEL-KUNC'
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sequel_sluggable
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Pavel Kunc
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-14 00:00:00 +00:00
+date: 2010-02-15 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
@@ -61,15 +61,12 @@ 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

data/TODO

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

data/VERSION

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