stringex 2.2.2 → 2.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDFjMTk3NzM4MjA3YjNjYWYzNzVlYTNhMmU5M2IyNDM1YTAxZDY0OQ==
+    NjA4ZGNmOGZiZGNiY2VkNTIwYTg2NGY1MjVmNGIwN2NmZDRhNTRkNg==
   data.tar.gz: !binary |-
-    OTNhMjhlZmYwYTFjN2E3MmI3ZmQyZDIxNmYwZGQ0NTU3ZjhmNTVmZg==
+    NDQ5NTlmMTU2MTgxYTA1OTRkMmRmMGE5YTllOTI1NGQwMDNiODYyYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjE0YjM3ZDI5NzA1ZWQ4YmI1ZDAwNTMzYWY0MzlhMjFlNWVkYmQ4YzViOWUw
-    MjRjOTQ5ODBmNzE1YTZmYjg2NGZlMDg5MDg0MDgwOWFhZjcxYTNlNDdmMTE1
-    OGIyN2VjN2UyODk2N2IxNzM1YjdiZjYwOWZhZjUzYWYyM2Y2NTY=
+    YjNjMDc2N2QxODJhODJhZWVlNDBiMjkwODBhNWMwODlhNTEwODM4ODVlMWEy
+    MGI4OTU4NzhiY2EyYTM3OTE4Y2E5YzQwZTFmYzc5NGE1Nzk0YzYxYmFjOGIw
+    Y2NlODI0Njg2NzQ3NWUzZGNiYWQwN2EzOGI5ZDc3Y2UxODk3MzE=
   data.tar.gz: !binary |-
-    MDZmYTE4OTIzZGIyYTQ1ZTEwNzY5MTIyZTVkNTY0YmY3YmM3ZWNmMTQ1MzEw
-    MzQ5NzM1MTBlMzAyYmM4N2ViNTQwMzFmNGIwNTEzZGE3MzQyYzEyOTlmNDI5
-    ZDFlNmU4ODRhNzQ5ZWVjNTFjM2JkMjYxM2UzOWI2MmRlYTQxMzA=
+    NTUxYjg0NDExOTk5OTk4OGE0NmZmZmE4NDY0OTM1MDkzYjZlMWUwOTY1Njhl
+    ZGI1M2QxM2I0MDAwMzdlNzNhNjJiNjY4NGNiNGNmZTc2MGNhZGI5Y2E3NTIz
+    NTVjZGM3MzUwOTU1MmZkYWFlNTIwOWY1MDg5MmZkNDM2MTc0YzE=

data/README.rdoc

@@ -13,7 +13,8 @@ This library is designed to create URI-friendly representations of an attribute,
   # Inside your model
   acts_as_url :title
 
-which will populate the <tt>url</tt> attribute on the object with the converted contents of the <tt>title</tt> attribute. This behavior can be customized by adding the following options to the arguments of the <tt>acts_as_url</tt> method:
+which will populate the <tt>url</tt> attribute on the object with the converted contents of the <tt>title</tt> attribute.
+<tt>acts_as_url</tt> takes the following options:
 
 <tt>:url_attribute</tt>:: The name of the attribute to use for storing the generated url string.
                           Default is <tt>:url</tt>
@@ -30,6 +31,11 @@ which will populate the <tt>url</tt> attribute on the object with the converted
 <tt>:limit</tt>:: If set, will limit length of url generated. Default is nil.
 <tt>:truncate_words</tt>:: Used with :limit. If set to false, the url will be truncated to the last
                            whole word before the limit was reached. Default is true.
+<tt>:blacklist</tt>:: List of urls that should not be allowed. Default is <tt>%w{new}</tt> [which avoids confusion
+                      on urls like <tt>/documents/new</tt>].
+<tt>:blacklist_policy</tt>:: Proc or lambda defining new naming behavior when blacklisted urls are encountered.
+                             Default converts <tt>/documents/new</tt> to </tt>/documents/new-document</tt>.
+
 
 In order to use the generated url attribute, you will probably want to override <tt>to_param</tt> like so, in your Model:
 

data/VERSION

@@ -1 +1 @@
-2.2.2
+2.3.0

data/lib/stringex/acts_as_url/adapter/base.rb

@@ -22,6 +22,7 @@ module Stringex
           self.instance = instance
 
           handle_url!
+          handle_blacklisted_url!
           handle_duplicate_url! unless settings.allow_duplicates
         end
 
@@ -132,6 +133,12 @@ module Stringex
           write_url_attribute base_url
         end
 
+        def handle_blacklisted_url!
+          return unless settings.blacklist.to_set.include?(base_url)
+          self.base_url = settings.blacklist_policy.call(instance, base_url)
+          write_url_attribute base_url
+        end
+
         def instance_from_db
           instance.class.find(instance.id)
         end

data/lib/stringex/configuration/acts_as_url.rb

@@ -15,7 +15,7 @@ module Stringex
           :force_downcase,
           :limit,
           :replace_whitespace_with,
-          :truncate_words,
+          :truncate_words
         ].inject(Hash.new){|m, x| m[x] = settings.send(x); m}
       end
 
@@ -39,8 +39,12 @@ module Stringex
           :scope_for_url => nil,
           :sync_url => false,
           :url_attribute => "url",
+          :blacklist => %w[new],
+          :blacklist_policy => lambda { |instance, url|
+            "#{url}-#{instance.class.to_s.downcase}"
+          }
         }.merge(Stringex::Configuration::StringExtensions.new.default_settings)
       end
     end
   end
-end
+end

data/stringex.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "stringex"
-  s.version = "2.2.2"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Russell Norris"]
-  s.date = "2014-03-10"
+  s.date = "2014-03-11"
   s.description = "Some [hopefully] useful extensions to Ruby's String class. Stringex is made up of three libraries: ActsAsUrl [permalink solution with better character translation], Unidecoder [Unicode to ASCII transliteration], and StringExtensions [miscellaneous helper methods for the String class]."
   s.email = "rsl@luckysneaks.com"
   s.extra_rdoc_files = [

data/test/unit/acts_as_url_integration_test.rb

@@ -20,6 +20,38 @@ class ActsAsUrlIntegrationTest < Test::Unit::TestCase
     assert_equal "unique-1", @other_doc.url
   end
 
+  def test_should_avoid_blacklist
+    @doc = Document.create(:title => "New")
+    @other_doc = Document.create(:title => "new")
+    assert_equal "new-document", @doc.url
+    assert_equal "new-document-1", @other_doc.url
+  end
+
+  def test_should_allow_customizing_blacklist
+    Document.class_eval do
+      # Un-blacklisting 'new' isn't advisable
+      acts_as_url :title, :blacklist => %w{special}
+    end
+
+    @doc = Document.create(:title => "New")
+    @other_doc = Document.create(:title => "Special")
+    assert_equal 'new', @doc.url
+    assert_equal 'special-document', @other_doc.url
+  end
+
+  def test_should_allow_customizing_blacklist_policy
+    Document.class_eval do
+      acts_as_url :title, :blacklist_policy => Proc.new(){|instance, url|
+        "#{url}-customized"
+      }
+    end
+
+    @doc = Document.create(:title => "New")
+    @other_doc = Document.create(:title => "New")
+    assert_equal 'new-customized', @doc.url
+    assert_equal 'new-customized-1', @other_doc.url
+  end
+
   def test_should_create_unique_url_when_partial_url_already_exists
     @doc = Document.create(:title => "House Farms")
     @other_doc = Document.create(:title => "House Farm")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stringex
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Russell Norris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler