leifcr-mm-sluggable 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0439b6953e9bd4955547a82bf49f95db4ff9c45
-  data.tar.gz: e8545cfc44cbc8113ae36693a567df7fb89d3297
+  metadata.gz: b3214ed53cacd3ac3ff12234b600e1d0d7b76b70
+  data.tar.gz: 555ba0cfcbad7320ff2b91f8a7711c3f0dccbedc
 SHA512:
-  metadata.gz: d4317af6e30d2221f82c0bcb2b73a001089bea89ee65f7e5726ed714c084d6618e58e64059321b37a20cadf88bcd4e32b7ffd8343a3862ddff278309dacd18aa
-  data.tar.gz: 9b8245013c6dc43c5f72b91444c8caa906e6d28e8d7e05a40dec156220e64af0be0febbd838c358519f2e79d861d340afff664348f2b46c320241223fe702511
+  metadata.gz: f891fcd5e7c63be967b905c2b6273db21fd8d0765d65ff659c1f23238681cf406bb19543772242e27b0864457f5400c86430a7341f6b9c00056c9cd3e8501d3c
+  data.tar.gz: c3af64097217c705afb25a1ad0e8d79b1bbb5f7fe1d82db854837a2cb81f26c566e32328dd38f7655da1be538a868afe98a0bf718b73596575aa6c6800e80d55

data/Gemfile

@@ -14,6 +14,6 @@ group :development, :test do
   gem 'simplecov', :require => false
 end
 
-gem 'activemodel', "~> 3.2"
+gem 'activemodel', "> 3.2"
 
 gem 'mongo_mapper', '~> 0.13.0'

data/README.md

@@ -45,18 +45,21 @@ Easiest is to add db/indexes.rb to your app, then add this to that file:
 
 ## Options
 
-Available options are:
+Available options:
 
 * :scope - scope to a specific field (default - nil)
 * :key - what the slug key is called (default - :slug) - NOTE, don't change this one
 * :method - what method to call on the field to sluggify it (default - :parameterize)
-* :callback - when to trigger the slugging (default - :before_validation_on_create)
+* :callback - when to trigger the slugging (default - :before_validation)
 * :always_update - Always update the slug on update/save/create etc.
+* :start - Which value the slugs should start with (default: 1)
+* :max_length - The maxiumum length of the slug (default: 256)
+* :disallowed\_bare\_slugs - Array of words that shouldn't be allowed as bare slugs. (default: ["new", "edit", "update", "create", "destroy"])
 
 Eg.
 
 ```ruby
-  sluggable :title, scope: :account_id, key: :title_slug, method: :to_url, always_update: true
+  sluggable :title, scope: :account_id, key: :title_slug, method: :to_url, always_update: true, disallowed_bare_slugs: ["dragon", "unicorn", "dog"]
 ```
 
 This will slug the title to the title_slug key, scoped to the account, will use String#to_url to slug it and won't add an index to the key

data/lib/mm-sluggable.rb

@@ -11,20 +11,24 @@ module MongoMapper
           class_attribute :slug_options
 
           self.slug_options = {
-            to_slug:          to_slug,
-            key:              :slug,
-            method:           :parameterize,
-            scope:            nil,
-            max_length:       256,
-            start:            1,
-            always_update:    true, # allow always updating slug...
-            callback:         :before_validation,
-            callback_on:      nil,
+            to_slug:                to_slug,
+            key:                    :slug,
+            method:                 :parameterize,
+            scope:                  nil,
+            max_length:             256,
+            start:                  1,
+            always_update:          true, # allow always updating slug...
+            callback:               :before_validation,
+            callback_on:            nil,
+            disallowed_bare_slugs:  []
           }.merge(options)
+
+          # Always dissallow new,edit,update,create,destroy as those are usually commands/routes
+          self.slug_options[:disallowed_bare_slugs].push(*["new", "edit", "update", "create", "destroy"])
           key slug_options[:key], String
 
           #before_validation :set_slug
-          self.send(slug_options[:callback], :set_slug, {:on => slug_options[:callback_on]}) if slug_options[:callback] && slug_options[:callback_on]
+          self.send(slug_options[:callback], :set_slug, {on: slug_options[:callback_on]}) if slug_options[:callback] && slug_options[:callback_on]
           self.send(slug_options[:callback], :set_slug) if slug_options[:callback] && slug_options[:callback_on].nil?
         end
       end
@@ -51,53 +55,66 @@ module MongoMapper
 
         # previous_slug = self[:key]
 
-        the_slug = raw_slug = to_slug.send(options[:method]).to_s[0...options[:max_length]]
+        raw_slug = to_slug.send(options[:method]).to_s[0...options[:max_length]]
+        if options[:disallowed_bare_slugs].include?(raw_slug)
+          the_slug = "#{raw_slug}-1"
+        else
+          the_slug = raw_slug
+        end
 
         # no need to set, so return
         return if (self.send(options[:key]) == the_slug)
         # also do a regexp check,
         # verify if the previous slug is "almost" the same as we want without digits/extras
         return if (/(#{the_slug}-\d+)/.match(self.send(options[:key])) != nil)
-
         conds = {}
         conds[options[:key]]   = the_slug
         conds[options[:scope]] = self.send(options[:scope]) if options[:scope]
 
         # first see if there is a equal slug
         used_slugs = klass.where(conds).fields(options[:key])
-        if (used_slugs.count > 0)
-          last_digit = 0 # zero for last one...
-          # if we are updating, check if the current slug is same as the one we want
-          conds[options[:key]] = /(#{the_slug}-\d+)/
-          used_slugs = klass.where(conds).fields(options[:key])
-          used_slugs_array = Array.new
-          used_slugs.each do |used_slug|
-            used_slugs_array << used_slug.send(options[:key])[/(\d+)$/].to_i
-          end
-          used_slugs_array.sort!
+        # Then get the first available slug
+        the_slug = get_unused_slug(used_slugs, options, raw_slug, klass) if (used_slugs.count > 0)
 
-          if used_slugs_array.length <= 0
-            next_digit = options[:start]
+        self.send(:"#{options[:key]}=", the_slug)
+      end
+
+    private
+
+      def get_unused_slug(used_slugs, options, raw_slug, klass)
+        last_digit = 0 # zero for last one...
+        # if we are updating, check if the current slug is same as the one we want
+        conds = {}
+        conds[options[:key]] = /(#{raw_slug}-\d+)/
+        conds[options[:scope]] = self.send(options[:scope]) if options[:scope]
+
+        used_slugs = klass.where(conds).fields(options[:key])
+        used_slugs_array = Array.new
+        used_slugs.each do |used_slug|
+          used_slugs_array << used_slug.send(options[:key])[/(\d+)$/].to_i
+        end
+        used_slugs_array.sort!
+
+        if used_slugs_array.length <= 0
+          next_digit = options[:start]
+        else
+          prev_num = used_slugs_array.shift
+          if used_slugs_array.length == 0
+            next_digit = prev_num + 1
           else
-            prev_num = used_slugs_array.shift
-            if used_slugs_array.length == 0
-              next_digit = prev_num + 1
-            else
-              used_slugs_array.each do |slug_num|
-                if ((slug_num - prev_num) > 1)
-                  next_digit = prev_num + 1
-                  break
-                end
-                next_digit = slug_num + 1
-                prev_num = slug_num
+            used_slugs_array.each do |slug_num|
+              if ((slug_num - prev_num) > 1)
+                next_digit = prev_num + 1
+                break
               end
+              next_digit = slug_num + 1
+              prev_num = slug_num
             end
           end
-          the_slug = "#{raw_slug}-#{next_digit}"
         end
-
-        self.send(:"#{options[:key]}=", the_slug)
+        "#{raw_slug}-#{next_digit}"
       end
-    end
-  end
-end
+
+    end #module Sluggable
+  end # module Plugins
+end # module MongoMapper

data/lib/sluggable/version.rb

@@ -1,3 +1,3 @@
 module Sluggable
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leifcr-mm-sluggable
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Leif Ringstad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo_mapper