mongoid-sleeping_king_studios 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2778187b766f4fd07bf7f8ae56c723f27d2ec021
-  data.tar.gz: 8a1e1d93897f7b33437b59698a5130c9055c381a
+  metadata.gz: 2ed2311e927cfdbb0ce3dbf48993003c1a85dee3
+  data.tar.gz: d98b75d75cced592915a2501d4c3d4fded8e9499
 SHA512:
-  metadata.gz: 5004564b79d8842b2efb3eca985aa412438ee3d3d7a1b5506a5507ddb63dd58477a9a798c1fc1136ba91b0c627090e6ba2017c031efec0af17f95fa83b786429
-  data.tar.gz: cbb152f928cc5501fb97c327e0362517435cccf586644b750041967bebd2c7c64a21f063689fff300a2e1e8e029528df10c216dead5dbe884436723fd1471d73
+  metadata.gz: 89c269b96bc27a8c0896c352a97cc0719c0d2b4b9b53b55bf3ef20a06d037e0c68bcc928c06a17a6edeb30c64090cd2bedecd78b50a941eaa8a4865a5c3bce68
+  data.tar.gz: 307415e029fe67a4056bcbe19785cb467c8eed72524233e8368ff9040e407e00d8425ff8fd951a6786a2b1042fc5433687850bf82d7d2030ad2adf4a8cd38797

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.7.8
+
+### New Features
+
+* Added ::value_to_slug, #generate_slug! and #to_slug helpers to Sluggable 
+  concern.
+
 ## 0.7.7
 
 ### New Features

data/README.md

@@ -174,6 +174,12 @@ short, url-friendly version.
 
 #### Helpers
 
+##### #generate_slug!
+
+If the document's slug is blank, or if it does not match the base attribute
+value, calculates the value from the base attribute and assigns it atomically.
+Locked slugs (see the :lockable option) are unaffected.
+
 ##### ::slugify_all!
 
 (Class Method) Loops through all documents in the collection. If the document's
@@ -184,6 +190,15 @@ value from the base attribute and assigns it atomically. Locked slugs (see the
 Use this method to generate slugs when adding this concern to a model with
 existing documents.
 
+##### #to_slug
+
+Converts the current value of the base attribute to a slug value, but returns
+the converted value instead of changing the slug field.
+
+##### ::value_to_slug
+
+(Class Method) Converts the provided string to a slug value.
+
 #### Options
 
 ##### Lockable

data/ROADMAP.md

@@ -0,0 +1,19 @@
+# Roadmap
+
+The following updates are planned to be implemented in the near future:
+
+## HasTree
+
+* Refactor concern name to BelongsToTree.
+* Finish implementing support for using a custom field to determine the
+  ancestry identifiers, such as a title or slug.
+
+## Sluggable
+
+* Refactor concern method from ::slugify to ::generates_slug.
+* Add :as option to support custom slug field names, e.g.
+
+    generates_slug, :full_name, :as => :short_name
+
+* Rename helper methods using slug field name, e.g. #to_short_name.
+* Support multiple slug fields per model.

data/lib/mongoid/sleeping_king_studios/sluggable.rb

@@ -108,20 +108,36 @@ module Mongoid::SleepingKingStudios
     # 
     # @since 0.7.7
     def self.define_helpers base, metadata
+      instance_methods = Module.new
+
+      instance_methods.send :define_method, :generate_slug! do
+        value = metadata.value_to_slug(send metadata.attribute)
+        if slug.blank?
+          self[:slug] = value
+          self.set :slug => value if persisted?
+        elsif slug != value && !(metadata.lockable? && slug_lock)
+          self[:slug] = value
+          self.set :slug => value if persisted?
+        end # if
+      end # method generate_slug!
+
+      instance_methods.send :define_method, :to_slug do
+        metadata.value_to_slug(send metadata.attribute)
+      end # method to_slug
+
+      base.include instance_methods
+
       # Define class-level helpers.
       class_methods = Module.new
 
       class_methods.send :define_method, :slugify_all! do
-        all.each do |obj|
-          value = metadata.value_to_slug(obj.send metadata.attribute)
-          if obj.slug.blank?
-            obj.set :slug => value
-          elsif obj.slug != value && !(metadata.lockable? && obj.slug_lock)
-            obj.set :slug => value
-          end # if
-        end # each
+        all.map &:generate_slug!
       end # class method slugify_all!
 
+      class_methods.send :define_method, :value_to_slug do |value|
+        metadata.value_to_slug(value)
+      end # class method value_to_slug
+
       base.extend class_methods
     end # module method define_helpers
 
@@ -171,6 +187,22 @@ module Mongoid::SleepingKingStudios
     # 
     #   @return [Boolean] True if the slug is locked; otherwise false.
 
+    # @!method generate_slug!
+    #   If the document's slug is blank, or if it does not match the base
+    #   attribute value, calculates the value from the base attribute and
+    #   assigns it atomically. Locked slugs (see the :lockable option) are
+    #   unaffected.
+    #
+    #   @since 0.7.8
+
+    # @!method to_slug
+    #   Converts the current value of the base attribute to a slug value, but
+    #   returns the converted value instead of changing the slug field.
+    # 
+    #   @return [String] The converted string.
+    #
+    #   @since 0.7.8
+
     # Class methods added to the base class via #extend.
     module ClassMethods
       # @overload slugify attribute, options = {}
@@ -202,6 +234,19 @@ module Mongoid::SleepingKingStudios
       # 
       #   Use this method to generate slugs when adding this concern to a model
       #   with existing documents.
+      #
+      #   @since 0.7.7
+
+      # @!method value_to_slug(value)
+      #   Converts the provided string to a slug value. Delegates to
+      #   metadata.value_to_slug, so overriding this method will not change how
+      #   slugs are generated.
+      # 
+      #   @param [String] value The string to convert into a slug.
+      # 
+      #   @return [String] The converted string.
+      #
+      #   @since 0.7.8
     end # module
   end # module
 end # module

data/lib/mongoid/sleeping_king_studios/version.rb

@@ -3,6 +3,6 @@
 module Mongoid
   module SleepingKingStudios
     # The current version of the gem.
-    VERSION = '0.7.7'
+    VERSION = '0.7.8'
   end # module
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -135,6 +135,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- ROADMAP.md
 - lib/mongoid/sleeping_king_studios.rb
 - lib/mongoid/sleeping_king_studios/concern.rb
 - lib/mongoid/sleeping_king_studios/concern/metadata.rb