slugable 0.0.2 → 0.0.3

data/README.md

@@ -3,6 +3,7 @@
 * adds support for seo friendly url
 * one helper method has_slug
 * support for ancestry models 'https://github.com/stefankroes/ancestry'
+* be default cache ancestry models url, can be changed
 
 ## Installation
 
@@ -22,11 +23,10 @@ Or install it yourself as:
 
 in model use method has_slug
 
-
     class Item < ActiveRecord::Base
       attr_accessor :name, :slug
 
-      has_slug # default :from => :name, :to => :slug
+      has_slug # default :from => :name, :to => :slug, :formatter => :parameterize, :cache_tree => true
     end
 
     # then in code
@@ -35,13 +35,25 @@ in model use method has_slug
 
     item.to_slug # => "my-name-is"
 
+    item.slug = "new-slug
+
+    item.to_slug_was  # => "my-name-is"
+    item.to_slug_will # => "new-slug"
+    item.to_slug      # => "new-slug"
+
 you can override defaults by passing hash
 
 
     class Page < ActiveRecord::Base
       attr_accessor :title, :seo_url
 
-      has_slug :from => :title, :to => :seo_url
+      has_slug :from => :title, :to => :seo_url, :formatter => :my_style
+    end
+
+    class String
+      def my_style
+        self.parameterize
+      end
     end
 
     # then in code
@@ -71,6 +83,30 @@ if you have model with ancestry gem 'https://github.com/stefankroes/ancestry'
     child.slug # => "child"
     child.to_slug # => ["root", "child"]
 
+    branch = Category.create!(:name => "branch", :slug => "branch")
+    child.parent = branch
+    child.slug = "renamed"
+
+    child.to_slug_was # => ["root", "child"]
+    child.to_slug_will # => ["branch", "renamed"]
+
+    child.to_slug # => ["root", "child"]
+    child.save!
+    child.to_slug # => ["branch", "renamed"]
+
+## configuration
+
+  By default all ancestry structure are cached to prevent useless calls to fetch same record from database just for slug values.
+  You can pass :cache_tree option to disable it like this.
+
+
+    class Category < ActiveRecord::Base
+      attr_accessor :name, :slug
+
+      has_ancestry
+      has_slug :cache_tree => false
+    end
+
 ## Contributing
 
 1. Fork it

data/changelog.md

@@ -1,4 +1,18 @@
-# 0.0.2
+# 0.0.3 (March 04, 2013)
+## added
+* config for allowing or disabling caching
+* `to_slug_was` for getting old values of object `to_slug`
+* `to_slug_will` for getting future values of object `to_slug`
+* options for specifying string formatting method
+* options for enabling or disabling cacing slugs for tree
+
+# 0.0.3.beta (December 27, 2012)
+## changed
+* skip cache in tree
+## fixed
+* tests and schema for appropriate testing
+
+# 0.0.2 (December 5, 2012)
 ## fixed
 * fill in slug from name parameter if slug.parameterize is blank
 

data/db/schema.rb

@@ -10,7 +10,7 @@ ActiveRecord::Schema.define do
 
   create_table "pages", :force => true do |t|
     t.string "title"
-    t.string "seo_path"
+    t.string "seo_url"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end
@@ -22,4 +22,19 @@ ActiveRecord::Schema.define do
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end
+
+  create_table "products", :force => true do |t|
+    t.string "name"
+    t.string "slug"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "tree_items", :force => true do |t|
+    t.string "name"
+    t.string "ancestry"
+    t.string "slug"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
 end

data/lib/slugable/has_slug.rb

@@ -13,10 +13,12 @@ module Slugable
     # has_slug :from => :name, :to => :slug   # generate to_slug
     #
     def has_slug(options={})
-      defaults = {:from => :name, :to => :slug}
+      defaults = {:from => :name, :to => :slug, :formatter => :parameterize, :cache_tree => true}
       options.reverse_merge!(defaults)
       from = options.delete(:from)
       to = options.delete(:to)
+      formatter = options.delete(:formatter)
+      cache_tree = options.delete(:cache_tree)
       before_save :"fill_slug_from_#{from}_to_#{to}", :"format_slug_from_#{from}_to_#{to}"
       after_save :"update_my_#{to}_cache"
 
@@ -39,7 +41,7 @@ module Slugable
       # end
       code =<<-method
         def format_slug_from_#{from}_to_#{to}
-          self.#{to} = #{to}.parameterize
+          self.#{to} = #{to}.send(:#{formatter})
         end
       method
       class_eval(code)
@@ -98,12 +100,12 @@ module Slugable
       #
       # def to_slug
       #  if respond_to?(:path_ids)
-      #    slugs = path_ids.map{|id| self.class.cached_slug(id)}.select{|i| i.size > 0 }
-      #    if slugs.empty?
-      #      ""
+      #    slugs = if true
+      #      path_ids.map{|id| self.class.cached_slug(id)}.select{|i| i.size > 0 }
       #    else
-      #      slug
+      #      path.map{|record| record.send(:"slug")}.select{|i| i.size > 0 }
       #    end
+      #    slugs.empty? ? "" : slugs
       #  else
       #    send(:slug)
       #  end
@@ -111,19 +113,79 @@ module Slugable
       code =<<-method
         def to_#{to}
           if respond_to?(:path_ids)
-            slugs = path_ids.map{|id| self.class.cached_#{to}(id)}.select{|i| i.size > 0 }
-            if slugs.empty?
-              ""
+            slugs = if #{cache_tree}
+              path_ids.map{|id| self.class.cached_#{to}(id)}.select{|i| i.size > 0 }
             else
-              slugs
+              path.map{|record| record.send(:"#{to}")}.select{|i| i.size > 0 }
             end
+            slugs.empty? ? "" : slugs
           else
             send(:#{to})
           end
         end
       method
       class_eval(code)
-    end
 
+
+      # generate this
+      #
+      # def to_slug_was
+      #  if respond_to?(:ancestry_was)
+      #    old_slugs = if true
+      #      ancestry_was.to_s.split("/").map { |ancestor_id| self.class.cached_slug(ancestor_id.to_i) }
+      #    else
+      #      ancestry_was.to_s.split("/").map { |ancestor_id| self.class.find(ancestor_id).send(:slug) }
+      #    end
+      #    old_slugs << send(:slug_was)
+      #  else
+      #    send(:slug_was)
+      #  end
+      # end
+      code =<<-method
+        def to_#{to}_was
+          if respond_to?(:ancestry_was)
+            old_slugs = if #{cache_tree}
+              ancestry_was.to_s.split("/").map { |ancestor_id| self.class.cached_#{to}(ancestor_id.to_i) }
+            else
+              ancestry_was.to_s.split("/").map { |ancestor_id| self.class.find(ancestor_id).send(:#{to}) }
+            end
+            old_slugs << send(:#{to}_was)
+          else
+            send(:#{to}_was)
+          end
+        end
+      method
+      class_eval(code)
+
+      # generate this
+      #
+      # def to_slug_will
+      #  if respond_to?(:ancestry)
+      #    old_slugs = if true
+      #      ancestry.to_s.split("/").map { |ancestor_id| self.class.cached_slug(ancestor_id.to_i) }
+      #    else
+      #      ancestry.to_s.split("/").map { |ancestor_id| self.class.find(ancestor_id).send(:slug) }
+      #    end
+      #    old_slugs << send(:slug)
+      #  else
+      #    send(:slug_was)
+      #  end
+      # end
+      code =<<-method
+          def to_#{to}_will
+            if respond_to?(:ancestry)
+              new_slugs = if #{cache_tree}
+                ancestry.to_s.split("/").map { |ancestor_id| self.class.cached_#{to}(ancestor_id.to_i) }
+              else
+                ancestry.to_s.split("/").map { |ancestor_id| self.class.find(ancestor_id).send(:#{to}) }
+              end
+              new_slugs << send(:#{to}).send(:#{formatter})
+            else
+              send(:#{to}).send(:#{formatter})
+            end
+          end
+      method
+      class_eval(code)
+    end
   end
 end

data/lib/slugable/version.rb

@@ -1,3 +1,3 @@
 module Slugable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/slugable/has_slug_spec.rb

@@ -3,24 +3,37 @@ require "spec_helper"
 ActiveRecord::Base.send :extend, Slugable::HasSlug
 
 class Item < ActiveRecord::Base
-  attr_accessor :name, :slug
+  attr_accessible :name, :slug
 
   has_slug
 end
 
 class Page < ActiveRecord::Base
-  attr_accessor :title, :seo_url
+  attr_accessible :title, :seo_url
 
   has_slug :from => :title, :to => :seo_url
 end
 
 class Category < ActiveRecord::Base
-  attr_accessor :name, :slug
+  attr_accessible :name, :slug
 
   has_ancestry
   has_slug
 end
 
+class TreeItem < ActiveRecord::Base
+  attr_accessible :name, :slug
+
+  has_ancestry
+  has_slug :cache_tree => false
+end
+
+class Product < ActiveRecord::Base
+  attr_accessible :name, :slug
+
+  has_slug :formatter => :my_formatter
+end
+
 
 describe Slugable::HasSlug do
   before(:each) do
@@ -37,11 +50,14 @@ describe Slugable::HasSlug do
     end
 
     it "should fill in slug parameter from attribute name and parametrize it" do
-      item = Item.create!(:name => "my name is")
+      name = "my name is"
+      name.should_receive(:parameterize).and_return("my-name-is")
+
+      item = Item.create!(:name => name)
       item.slug.should eq "my-name-is"
     end
 
-    it "should fill in slug from attribute name if parameterize version of slug is blank", :focus => true do
+    it "should fill in slug from attribute name if parameterize version of slug is blank" do
       item = Item.create!(:name => "my name is", :slug => "/")
       item.slug.should eq "my-name-is"
     end
@@ -75,6 +91,25 @@ describe Slugable::HasSlug do
       page = Page.create!(:title => "my name is", :seo_url => "my url")
       page.seo_url.should eq "my-url"
     end
+
+    it "should be able to change parameterize method" do
+      name = "product"
+      name.should_receive(:my_formatter).and_return("hello")
+      product = Product.create!(:name => "my name is", :slug => name)
+      product.slug.should eq "hello"
+    end
+
+    it "should be able to disable tree caching" do
+      tree_item = TreeItem.create!(:name => "my name is", :parent => TreeItem.create!(:name => "root"))
+      tree_item.should_receive(:path).and_return([])
+      tree_item.to_slug
+      tree_item.should_receive(:path).and_return([])
+      tree_item.to_slug
+
+      tree_item = Category.create!(:name => "my name is", :parent => Category.create!(:name => "root"))
+      tree_item.should_not_receive(:path)
+      tree_item.to_slug
+    end
   end
 
   describe "to_slug" do
@@ -112,6 +147,82 @@ describe Slugable::HasSlug do
     end
   end
 
+  describe "to_slug_was" do
+    context "default options" do
+      it "should define method to_slug_was" do
+        Item.new.should respond_to :to_slug_was
+      end
+
+      it "should return old slug in string" do
+        item = Item.create!(:name => "my name is", :slug => "my-url")
+        item.slug = "new-slug"
+        item.to_slug_was.should eq "my-url"
+      end
+    end
+
+    context "given options" do
+      it "should define method to_seo_url_was" do
+        Page.new.should respond_to :to_seo_url_was
+      end
+
+      it "should return future slug in string" do
+        page = Page.create!(:title => "my name is", :seo_url => "my-url")
+        page.seo_url = "hello-world"
+        page.to_seo_url_was.should eq "my-url"
+      end
+    end
+
+    context "ancestry model" do
+      it "should return array of old slugs" do
+        root = Category.create!(:name => "root", :slug => "root")
+        child = Category.new(:name => "child", :slug => "child")
+        child.save!
+
+        child.parent = root
+        child.slug = "moved"
+        child.to_slug_was.should eq ["child"]
+      end
+    end
+  end
+
+  describe "to_slug_will" do
+    context "default options" do
+      it "should define method to_slug_will" do
+        Item.new.should respond_to :to_slug_will
+      end
+
+      it "should return future slug in string" do
+        item = Item.create!(:name => "my name is", :slug => "my-url")
+        item.slug = "new slug"
+        item.to_slug_will.should eq "new-slug"
+      end
+    end
+
+    context "given options" do
+      it "should define method to_seo_url_will" do
+        Page.new.should respond_to :to_seo_url_will
+      end
+
+      it "should return slug in string" do
+        page = Page.create!(:title => "my name is", :seo_url => "my-url")
+        page.seo_url = "hello world"
+        page.to_seo_url_will.should eq "hello-world"
+      end
+    end
+
+    context "ancestry model" do
+      it "should return array of slugs" do
+        root = Category.create!(:name => "root", :slug => "root")
+        child = Category.new(:name => "child", :slug => "child")
+        child.save!
+
+        child.parent = root
+        child.slug = "move d"
+        child.to_slug_will.should eq ["root", "move-d"]
+      end
+    end
+  end
+
   describe "ancestry methods" do
     describe "all_slugs" do
       it "ancestry model class should respond to all_slugs" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slugable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-05 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,12 +157,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2198894308197098802
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2198894308197098802
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24