sequel_sluggable 0.0.4 → 0.0.5

data/CHANGELOG

@@ -0,0 +1,6 @@
+== 0.0.5, 2010-03-04
+* Allow to generate slug before the before_save + doc update
+* Slug is generated only before_create and when it's not set manually
+* Slug is not by default regenerated before_update
+* New :frozen option (true by default). When true slug is not regenerated
+  during update. When :frozen => false slug is regenerated during update.

data/README.rdoc

@@ -11,8 +11,7 @@ Install:
 == 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.
+Slug is created in ether the *before_create* or *before_update* hooks.
 
 To use plug-in you add plug-in to your model:
 
@@ -21,11 +20,60 @@ To use plug-in you add plug-in to your model:
   end
 
 You can use following options:
+*frozen*:: Should slug be frozen once it's generated? Default true.
+*sluggator*:: Proc or Symbol to call to create slug.
 *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.
+Options *frozen*, *sluggator* and *target* are optional.
+
+<b>Options are inherited when you use inheritance for your models</b>. However
+you can only set options via plugin method.
+
+You can access options for current model via reader <b>Model#sluggable_options</b>
+which is readonly.
+
+== When is slug generated?
+
+By default slug is generated *ONLY* when model is created and you 
+<strong>didn't set it</strong>. <strong>When you update model slug 
+is not updated by default</strong> but if you set :frozen => false, 
+slug will be regenerated on update. Some examples:
+
+  class Item < Sequel::Model
+    plugin :source => :name
+    ...
+  end
+  
+  Item.create(:name => 'X')      # Generates slug
+  
+  i = Item.new(:name => 'X')
+  i.slug = 'X Y'                 # Sets slug manualy
+  i.save                         # Slug is not regenerated but the set slug is used
+  i.slug                         # => x-y
+  i.update(:name => 'Y')         # Won't regenerate slug, because slug is frozen by default
+  i.slug                         # => x-y
+  
+  BUT:
+  
+  class Item < Sequel::Model
+    plugin :source => :name, :frozen => false
+    ...
+  end
+  
+  i = Item.create(:name => 'X')  # Generates slug
+  i.update(:name => 'Y')         # Will regenerate slug, because slug is now not frozen
+  i.slug                         # => y
+
+== Access/Set slug
+
+You can access slug via your normal Sequel reader. By default that will be 
+<b>Model#slug</b> method. If you customize this via :target option than you have
+<b>Model#:target</b>.
+
+Writer for the slug is generated depending on your :target option. Default will
+be <b>Model#slug=</b> otherwise <b>Model#:target=</b>. You can call setter
+to set the slug before the creating or updating model.
 
 == Algorithm customization
 
@@ -72,6 +120,11 @@ will use it's own default implementation which does following:
    bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== Contributors
+
+* Pavel Kunc
+* Jakub "Botanicus" Stastny
+
 == Copyright
 
 Copyright (c) 2009 Pavel Kunc. See LICENSE for details.

data/lib/sequel_sluggable.rb

@@ -12,6 +12,24 @@ module Sequel
       # Plugin configuration
       def self.configure(model, opts={})
         model.sluggable_options = opts
+        model.sluggable_options.freeze
+
+        model.class_eval do
+          # Sets the slug to the normalized URL friendly string
+          #
+          # Compute slug for the value
+          #
+          # @param [String] String to be slugged
+          # @return [String]
+          define_method("#{sluggable_options[:target]}=") do |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
+        end
+
       end
 
       module ClassMethods
@@ -43,9 +61,10 @@ module Sequel
         #
         # Options:
         # @param [Hash] plugin options
+        # @option frozen    [Boolean]      :Is slug frozen, default true
+        # @option sluggator [Proc, Symbol] :Algorithm to convert string to slug.
         # @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, Symbol] :Algorithm to convert string to slug.
         def sluggable_options=(options)
           raise ArgumentError, "You must provide :source column" unless options[:source]
           sluggator = options[:sluggator]
@@ -54,6 +73,7 @@ module Sequel
           end
           options[:source]    = options[:source].to_sym
           options[:target]    = options[:target] ? options[:target].to_sym : DEFAULT_TARGET_COLUMN
+          options[:frozen]    = options[:frozen].nil? ? true : !!options[:frozen]
           @sluggable_options  = options
         end
       end
@@ -61,29 +81,22 @@ module Sequel
       module InstanceMethods
 
         # Sets a slug column to the slugged value
-        def before_save
+        def before_create
           super
-          target = "#{self.class.sluggable_options[:target]}="
-          source = self.class.sluggable_options[:source]
-          self.send(target, self.send(source))
+          target = self.class.sluggable_options[:target]
+          set_target_column unless self.send(target)
+        end
+        
+        # Sets a slug column to the slugged value
+        def before_update
+          super
+          target = self.class.sluggable_options[:target]
+          frozen = self.class.sluggable_options[:frozen]
+          set_target_column if !self.send(target) || !frozen
         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=(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
-
         # Generate slug from the passed value
         #
         # @param [String] String to be slugged
@@ -92,6 +105,14 @@ module Sequel
           value.chomp.downcase.gsub(/[^a-z0-9]+/,'-')
         end
 
+        # Sets target column with source column which 
+        # effectively triggers slug generation
+        def set_target_column
+          target = self.class.sluggable_options[:target]
+          source = self.class.sluggable_options[:source]
+          self.send("#{target}=", self.send(source))
+        end
+
       end # InstanceMethods
     end # Sluggable
   end # Plugins

data/lib/version.rb

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

data/sequel_sluggable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sequel_sluggable}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pavel Kunc"]
-  s.date = %q{2010-02-16}
+  s.date = %q{2010-03-04}
   s.description = %q{Sequel plugin which provides Slug functionality for model.}
   s.email = %q{pavel.kunc@gmail.com}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -33,7 +34,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.6}
   s.summary = %q{Sequel plugin which provides Slug functionality for model.}
   s.test_files = [
     "spec/sequel_sluggable_spec.rb",

data/spec/sequel_sluggable_spec.rb

@@ -32,7 +32,8 @@ describe "SequelSluggable" do
       Item.plugin :sluggable,
                   :source    => :name,
                   :target    => :slug,
-                  :sluggator => @sluggator
+                  :sluggator => @sluggator,
+                  :frozen    => false
     end
 
     it "should accept source option" do
@@ -47,6 +48,16 @@ describe "SequelSluggable" do
       Item.sluggable_options[:sluggator].should eql @sluggator
     end
 
+    it "should accept frozen option" do
+      Item.sluggable_options[:frozen].should be_false
+    end
+
+    it "should have frozen true by default" do
+      class Item < Sequel::Model; end
+      Item.plugin :sluggable, :source => :name
+      Item.sluggable_options[:frozen].should be_true
+    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")
@@ -76,10 +87,32 @@ describe "SequelSluggable" do
 
     it "should not mess with parent settings when inherited" do
       class SubItem < Item; end
-      SubItem.sluggable_options[:source] = :test
+      SubItem.plugin :sluggable, :source => :test
       SubItem.sluggable_options[:source].should eql :test
       Item.sluggable_options[:source].should eql :name
     end
+
+    it "should not allow changing the options directly" do
+      lambda { Item.sluggable_options[:source] = 'xy' }.should raise_error
+    end
+  end
+
+  describe "#:target= method" do
+    before(:each) do
+      Item.plugin :sluggable,
+                  :source => :name,
+                  :target => :sluggie
+    end
+
+    it "should allow to set slug with Model#:target= method" do
+      i = Item.new(:name => 'Pavel Kunc')
+      i.sluggie = i.name
+      i.sluggie.should eql 'pavel-kunc'
+    end
+
+    it "should work with different Model#:target= method than default" do
+      Item.create(:name => 'Pavel Kunc').sluggie.should eql 'pavel-kunc'
+    end
   end
 
   describe "::find_by_pk_or_slug" do
@@ -155,4 +188,31 @@ describe "SequelSluggable" do
     end
   end
 
+  describe "slug generation and regeneration" do
+    it "should generate slug when creating model and slug is not set" do
+      Item.create(:name => 'Pavel Kunc').slug.should eql 'pavel-kunc'
+    end
+
+    it "should not regenerate slug when creating model and slug is set" do
+      i = Item.new(:name => 'Pavel Kunc')
+      i.slug = 'Kunc Pavel'
+      i.save
+      i.slug.should eql 'kunc-pavel'
+    end
+
+    it "should regenerate slug when updating model and slug is not frozen" do
+      class Item < Sequel::Model; end
+      Item.plugin :sluggable, :source => :name, :target => :slug, :frozen => false
+      i = Item.create(:name => 'Pavel Kunc')
+      i.update(:name => 'Kunc Pavel')
+      i.slug.should eql 'kunc-pavel'
+    end
+
+    it "should not regenerate slug when updating model" do
+      i = Item.create(:name => 'Pavel Kunc')
+      i.update(:name => 'Kunc Pavel')
+      i.slug.should eql 'pavel-kunc'
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ DB.create_table :items do
   primary_key :id
   String :name
   String :slug
+  String :sluggie
 end
 
 class Item < Sequel::Model; end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sequel_sluggable
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Pavel Kunc
@@ -9,49 +14,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-16 00:00:00 +00:00
+date: 2010-03-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sequel
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 description: Sequel plugin which provides Slug functionality for model.
 email: pavel.kunc@gmail.com
 executables: []
@@ -64,6 +79,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -87,18 +103,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Sequel plugin which provides Slug functionality for model.