mongoid-sleeping_king_studios 0.5.0 → 0.6.2

data/lib/mongoid/sleeping_king_studios/has_tree/metadata.rb

@@ -0,0 +1,64 @@
+# lib/mongoid/sleeping_king_studios/has_tree/metadata.rb
+
+require 'mongoid/sleeping_king_studios/concern/metadata'
+require 'mongoid/sleeping_king_studios/has_tree/cache_ancestry/metadata'
+require 'mongoid/sleeping_king_studios/has_tree/children/metadata'
+require 'mongoid/sleeping_king_studios/has_tree/parent/metadata'
+
+module Mongoid::SleepingKingStudios
+  module HasTree
+    # Stores information about a HasTree concern.
+    class Metadata < Mongoid::SleepingKingStudios::Concern::Metadata
+      # @param [Symbol, String] name The name of the concern or relation.
+      # @param [Hash] properties The properties of the concern or relation.
+      def initialize name, properties = {}
+        super
+
+        self[:parent]   = characterize :parent,   properties.fetch(:parent,   {}), HasTree::Parent::Metadata
+        self[:children] = characterize :children, properties.fetch(:children, {}), HasTree::Children::Metadata
+
+        if properties.fetch(:cache_ancestry, false)
+          properties[:cache_ancestry] = {} unless Hash === properties[:cache_ancestry]
+          properties[:cache_ancestry][:children_name] = children.relation_name
+          properties[:cache_ancestry][:parent_name]   = parent.relation_name
+          
+          self[:cache_ancestry] = characterize :cache_ancestry, properties[:cache_ancestry], HasTree::CacheAncestry::Metadata
+        end # unless
+      end # constructor
+
+      # The metadata associated with the :cache_ancestry option.
+      # 
+      # @return [Metadata] The :cache_ancestry metadata.
+      def cache_ancestry
+        self[:cache_ancestry]
+      end # method cache_ancestry
+
+      # @return [Boolean] True if the :cache_ancestry option is selected;
+      #   otherwise false.
+      def cache_ancestry?
+        !!self[:cache_ancestry]
+      end # method cache_ancestry?
+
+      # The metadata associated with the #children relation.
+      # 
+      # @return [Metadata] The children metadata.
+      def children
+        self[:children]
+      end # method children
+
+      # The foreign key for the parent relation.
+      # 
+      # @return [Symbol] The foreign key.
+      def foreign_key
+        self[:foreign_key] || :"#{parent.relation_name}_id"
+      end # method foreign_key
+
+      # The metadata associated with the #parent relation.
+      # 
+      # @return [Metadata] The parent metadata.
+      def parent
+        self[:parent]
+      end # method parent
+    end # class
+  end # module
+end # module

data/lib/mongoid/sleeping_king_studios/has_tree/parent/metadata.rb

@@ -0,0 +1,40 @@
+# lib/mongoid/sleeping_king_studios/has_tree/parent/metadata.rb
+
+require 'mongoid/sleeping_king_studios/concern/metadata'
+
+module Mongoid::SleepingKingStudios
+  module HasTree
+    module Parent
+      # Stores information about a HasTree concern's parent relation.
+      class Metadata < Mongoid::SleepingKingStudios::Concern::Metadata
+        # The name of the tree's children relation. If no relation name is set,
+        # defaults to :children.
+        # 
+        # @return [Symbol] The relation name.
+        def inverse_of
+          fetch(:inverse_of, :children)
+        end # method inverse_of
+
+        # @return [Boolean] True if a custom inverse relation name is set;
+        #   otherwise false.
+        def inverse_of?
+          !!self[:inverse_of]
+        end # method inverse_of?
+
+        # The name of the tree's parent relation. If no relation name is set,
+        # defaults to :parent.
+        # 
+        # @return [Symbol] The relation name.
+        def relation_name
+          fetch(:relation_name, :parent)
+        end # method relation_name
+
+        # @return [Boolean] True if a custom relation name is set; otherwise
+        #   false.
+        def relation_name?
+          !!self[:relation_name]
+        end # method relation_name?
+      end # class
+    end # module
+  end # module
+end # module

data/lib/mongoid/sleeping_king_studios/sluggable.rb

@@ -1,6 +1,7 @@
 # lib/mongoid/sleeping_king_studios/sluggable.rb
 
-require 'mongoid/sleeping_king_studios'
+require 'mongoid/sleeping_king_studios/concern'
+require 'mongoid/sleeping_king_studios/sluggable/metadata'
 
 module Mongoid::SleepingKingStudios
   # Adds a :slug field that stores a short, url-friendly reference string,
@@ -24,69 +25,147 @@ module Mongoid::SleepingKingStudios
   # @since 0.1.0
   module Sluggable
     extend ActiveSupport::Concern
+    extend Mongoid::SleepingKingStudios::Concern
+
+    # @api private
+    # 
+    # Sets up the sluggable relation, creating fields, accessors and
+    # validations.
+    # 
+    # @param [Class] base The base class into which the concern is mixed in.
+    # @param [String, Symbol] attribute The base field used to determine
+    #   the value of the slug. When this field is changed via its writer
+    #   method, the slug will be updated.
+    # @param [Hash] options The options for the relation.
+    # 
+    # @since 0.6.0
+    def self.apply base, attribute, options
+      name = :sluggable
+      validate_options    name, options
+      meta = characterize name, options, Metadata
+      meta[:attribute] = attribute
+
+      relate base, name, meta
+
+      define_fields      base, meta
+      define_accessors   base, meta
+      define_validations base, meta
+    end # module method apply
+
+    # @api private
+    # 
+    # Redefines the writer for the base attribute to overwrite the value of the
+    # slug field unless the slug is locked. If the Lockable option is selected,
+    # redefines the writer for the slug field to lock the slug when set
+    # manually; otherwise, makes the writer for the slug field private.
+    # 
+    # @param [Class] base The base class into which the concern is mixed in.
+    # @param [Metadata] metadata The metadata for the relation.
+    # 
+    # @since 0.6.0
+    def self.define_accessors base, metadata
+      base.re_define_method :"#{metadata.attribute}=" do |value|
+        self[metadata.attribute.to_s] = value
+        unless metadata.lockable? && self['slug_lock']
+          self['slug'] = metadata.value_to_slug value
+        end # unless
+      end # method
+
+      if metadata.lockable?
+        base.re_define_method :slug= do |value|
+          self['slug'] = value
+          self['slug_lock'] = true
+        end # method
+      else
+        base.send :private, :slug=
+      end # if
+    end # module method define_accessors
+
+    # @api private
+    # 
+    # Creates a slug field of type String on the base class. If the Lockable
+    # option is selected, also creates a slug_lock field of type Boolean.
+    # 
+    # @param [Class] base The base class into which the concern is mixed in.
+    # @param [Metadata] metadata The metadata for the relation.
+    # 
+    # @since 0.6.0
+    def self.define_fields base, metadata
+      base.send :field, :slug, :type => String
+
+      if metadata.lockable?
+        base.send :field, :slug_lock, :type => Boolean, :default => false
+      end # if
+    end # module method define_fields
+
+    # @api private
+    # 
+    # Sets a validation on the slug field that validates the presence of the
+    # slug, and that the value is of a valid format (lower-case characters a-z,
+    # digits 0-9, and hyphens "-").
+    # 
+    # @param [Class] base The base class into which the concern is mixed in.
+    # @param [Metadata] metadata The metadata for the relation.
+    # 
+    # @since 0.6.0
+    def self.define_validations base, metadata
+      base.validates :slug,
+        :presence => true,
+        :format => {
+          :with => /\A[a-z0-9\-]+\z/,
+          :message => 'must be lower-case characters a-z, digits 0-9, and hyphens "-"'
+        } # end format
+    end # module method define_validations
+
+    # Returns a list of options that are valid for this concern.
+    # 
+    # @return [Array<Symbol>] The list of valid options.
+    # 
+    # @since 0.6.0
+    def self.valid_options
+      super + %i(
+        lockable
+      ) # end array
+    end # module method valid options
 
     # @!attribute [r] slug
     #   A url-friendly short string version of the specified base attribute.
-    #   Read-only unless the :lockable option is selected.
+    #   
+    #   (Lockable) The slug value can be set directly using the #slug= method.
+    #   This will set the :slug_lock flag, preventing the slug from being
+    #   updated by a change to the base field until :slug_lock is cleared.
+    # 
+    #   @return [String] The value of the stored slug.
+
+    # @!attribute [rw] slug_lock
+    #   (Lockable) A flag that indicates whether or not the slug is locked.
+    #   If the flag is set, updating the base field will not change the value
+    #   of the slug.
     # 
-    #   @return [String] the slug value
+    #   @return [Boolean] True if the slug is locked; otherwise false.
 
     # Class methods added to the base class via #extend.
     module ClassMethods
-      # Returns the options passed into ::slugify, as well as an additional
-      # :attribute value for the attribute passed into ::slugify.
-      attr_reader :sluggable_options
-
       # @overload slugify attribute, options = {}
       #   Creates the :slug field and sets up the callback and validations.
       # 
-      #   @param [String, Symbol] attribute
+      #   @param [String, Symbol] attribute The base field used to determine
+      #     the value of the slug. When this field is changed via its writer
+      #     method, the slug will be updated.
+      #   @param [Hash] options The options for the relation.
       #   @option options [Boolean] :lockable
       #     The :lockable option allows the manual setting of the :slug field.
       #     To do so, it adds an additional :slug_lock field, which defaults to
       #     false but is set to true whenever #slug= is called. If the slug is
       #     locked, its value is not updated to track the base attribute. To
       #     resume tracking the base attribute, set :slug_lock to false.
+      # 
+      #   @raise [Mongoid::Errors::InvalidOptions] If any of the provided
+      #     options are invalid.
       def slugify attribute, **options
-        @sluggable_options = options.merge :attribute => attribute.to_s.intern
-
-        field :slug, :type => String
-
-        validates :slug,
-          :presence => true,
-          :format => {
-            :with => /\A[a-z0-9\-]+\z/,
-            :message => 'must be lower-case characters a-z, digits 0-9, and hyphens "-"'
-          } # end format
-
-        before_validation do
-          return if self.class.sluggable_options[:lockable] && self.slug_lock
-          self[:slug] = to_slug
-        end # before validation callback
-
-        # Lockable
-        if options.fetch(:lockable, false)
-          field :slug_lock, :type => Boolean, :default => false
-
-          self.class_eval do
-            def slug= value
-              super
-              self.slug_lock = true
-            end # method slug=
-          end # class eval
-        else
-          private :slug=
-        end # if
+        concern = Mongoid::SleepingKingStudios::Sluggable
+        concern.apply self, attribute, options
       end # class method slugify
     end # module
-
-    # Processes the specified base attribute and returns a valid slug value. By
-    # default, calls String#parameterize.
-    # 
-    # @return [String] the processed value
-    def to_slug
-      raw = (self.send self.class.sluggable_options[:attribute]) || ""
-      raw.parameterize
-    end # method to_slug
   end # module
 end # module

data/lib/mongoid/sleeping_king_studios/sluggable/metadata.rb

@@ -0,0 +1,42 @@
+# lib/mongoid/sleeping_king_studios/sluggable/metadata.rb
+
+require 'mongoid/sleeping_king_studios/concern/metadata'
+
+module Mongoid::SleepingKingStudios
+  module Sluggable
+    # Stores information about a Sluggable concern.
+    class Metadata < Mongoid::SleepingKingStudios::Concern::Metadata
+      # The base attribute used to determine the slug value.
+      # 
+      # @return [Symbol] The attribute name.
+      def attribute
+        self[:attribute].to_s.intern
+      end # method attribute
+
+      # @return [Boolean] True if the attribute is defined; otherwise false.
+      def attribute?
+        !!self[:attribute]
+      end # method attribute?
+
+      # If true, the slug can be "locked" by setting the slug value directly or
+      # by setting the value of the :slug_lock field to true. A locked slug is
+      # not overwritten when the base field is updated.
+      # 
+      # @return [Boolean] True if the slug is lockable; otherwise false.
+      def lockable?
+        !!self[:lockable]
+      end # method lockable?
+
+      # Converts the given value to a valid slug string. Refactoring this into
+      # the metadata will permit customization of the value -> slug mapping in
+      # the future.
+      # 
+      # @param [Object] value The value to convert into a slug.
+      # 
+      # @return [String] The converted value.
+      def value_to_slug value
+        value.to_s.parameterize
+      end # method value_to_slug
+    end # class Metadata
+  end # module
+end # module

data/lib/mongoid/sleeping_king_studios/version.rb

@@ -2,6 +2,7 @@
 
 module Mongoid
   module SleepingKingStudios
-    VERSION = '0.5.0'
+    # The current version of the gem.
+    VERSION = '0.6.2'
   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.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: rspec-sleeping_king_studios
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc.3
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -98,44 +112,16 @@ dependencies:
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 description: |2
       A collection of concerns and extensions to add functionality to Mongoid
       documents and collections. The features can be included individually or by
@@ -146,14 +132,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/mongoid/sleeping_king_studios/concern/metadata.rb
+- lib/mongoid/sleeping_king_studios/concern.rb
 - lib/mongoid/sleeping_king_studios/error.rb
+- lib/mongoid/sleeping_king_studios/ext/mongoid/document.rb
+- lib/mongoid/sleeping_king_studios/has_tree/cache_ancestry/metadata.rb
 - lib/mongoid/sleeping_king_studios/has_tree/cache_ancestry.rb
+- lib/mongoid/sleeping_king_studios/has_tree/children/metadata.rb
 - lib/mongoid/sleeping_king_studios/has_tree/errors.rb
+- lib/mongoid/sleeping_king_studios/has_tree/metadata.rb
+- lib/mongoid/sleeping_king_studios/has_tree/parent/metadata.rb
 - lib/mongoid/sleeping_king_studios/has_tree.rb
+- lib/mongoid/sleeping_king_studios/sluggable/metadata.rb
 - lib/mongoid/sleeping_king_studios/sluggable.rb
 - lib/mongoid/sleeping_king_studios/version.rb
 - lib/mongoid/sleeping_king_studios.rb
 - LICENSE
+- CHANGELOG.md
 - README.md
 homepage: http://sleepingkingstudios.com
 licenses: