mongoid-sleeping_king_studios 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ea55c009d98431ff13407f84c1b210fc5ac89d
-  data.tar.gz: cf358c4f2146e0b3bfcad4b92bb1697ecaa3e565
+  metadata.gz: 9872d41d59ce51e97ead17d8219802dd80df2069
+  data.tar.gz: 008ca4394448aa380c101d1aad7b719ca80d7416
 SHA512:
-  metadata.gz: 2cf1a558a348b53842e181242b37368f2ee50f2fc3af52f8172a851d46f26841ac68f8801ef1350462ce751fba7c251cbbee65a1d9caf3d503ea6fe7d4c0e9bb
-  data.tar.gz: 8a67abe9b88d4ddd7879b3e5317adbc704bd7af0d603e44d53c5aae910c5099bc275b7b77cf5c98a2a8b573c95a8d0106329cedf074c5aa765de9080d270f833
+  metadata.gz: 3a8324ecbcdc29f818bf8e2b83b82b48b1df78e1c0ad45938000acf86b388e35fb0eefb8816dfe956b6f63ae8af482aad997f61e352e1a27842060a1c1032c2c
+  data.tar.gz: 67391ada74283759fd019872dbcb2ca97817c72f2e39c35ff52f226fd157529c4917bf436b0165f2b87bd4eabd80ebb90a6a0a5e8904c793d06494f25424e86a

data/README.md

@@ -47,6 +47,36 @@ Sets up a basic tree structure by adding belongs_to :parent and has_many
       include Mongoid::SleepingKingStudios::Tree
     end # class
 
+#### Options
+
+To customise the created #parent and #children relations, you can define
+::options_for_parent and ::options_for_children class methods before including
+the Tree concern. These methods must return a hash if defined.
+
+As of 0.3.1, you can change the name of the class methods used to find the
+customised options by setting Tree.options_for_parent_name and
+Tree.options_for_children_name.
+
+    class EvilEmployee
+      include Mongoid::Document
+
+      def self.options_for_parent
+        { :relation_name => :overlord }
+      end # class method options_for_parent
+
+      def self.options_for_children
+        { :relation_name => :minions, :dependent => :destroy }
+      end # class method options_for_children
+
+      include Mongoid::SleepingKingStudios::Tree
+    end # class
+
+Available options include the default Mongoid options for a :belongs_to and a
+:has_many relationship, respectively. In addition, you can set a :relation_name
+option to change the name of the created relation (see example above). The
+concern will automatically update the respective :inverse_of options to match
+the updated relation names.
+
 ## License
 
 RSpec::SleepingKingStudios is released under the

data/lib/mongoid/sleeping_king_studios/tree.rb

@@ -12,10 +12,61 @@ module Mongoid::SleepingKingStudios
   #     include Mongoid::SleepingKingStudios::Tree
   #   end # class
   # 
+  # Since 0.3.0, you can customise the generated :parent and :children
+  # relations by defining optional class methods ::options_for_parent and
+  # ::options_for_children, which must return hashes of valid options. These
+  # must be defined prior to including this mixin, or the default options will
+  # be applied instead.
+  # 
+  # In addition, you can customise the names of the relations by adding a
+  # :relation_name key to either ::options_for hash. The concern will
+  # automatically update the respective :inverse_of options to match the
+  # updated relation names.
+  # 
+  # Since 0.3.1, you can additionally customise the name of the class methods
+  # used to determine the customised options by changing the value of
+  # Tree.options_for_parent_name and Tree.options_for_children_name.
+  # 
+  # @example Setting up the tree with alternate relation names:
+  #   class EvilEmployee
+  #     include Mongoid::Document
+  # 
+  #     def self.options_for_parent
+  #       { :relation_name => "overlord" }
+  #     end # class method options_for_parent
+  # 
+  #     def self.options_for_children
+  #       { :relation_name => "minions", :dependent => :destroy }
+  #     end # class method options_for_children
+  # 
+  #     include Mongoid::SleepingKingStudios::Tree
+  #   end # class
+  # 
   # @since 0.2.0
   module Tree
     extend ActiveSupport::Concern
 
+    class << self
+      # Gets the name of the method on the base module that is used to find
+      # customisation options for the :parent relation.
+      # 
+      # @return [Symbol] By default, returns :options_for_parent.
+      # 
+      # @since 0.3.1
+      attr_accessor :options_for_parent_name
+
+      # Gets the name of the method on the base module that is used to find
+      # customisation options for the :children relation.
+      # 
+      # @return [Symbol] By default, returns :options_for_children.
+      # 
+      # @since 0.3.1
+      attr_accessor :options_for_children_name
+    end # class << self
+
+    self.options_for_parent_name   = :options_for_parent
+    self.options_for_children_name = :options_for_children
+
     # @!method parent
     #   Returns the parent object, or nil if the object is a root.
     # 
@@ -27,8 +78,17 @@ module Mongoid::SleepingKingStudios
     #   @return [Array<Tree>]
 
     included do |base|
-      belongs_to :parent,   :class_name => base.name, :inverse_of => :children
-      has_many   :children, :class_name => base.name, :inverse_of => :parent
+      p_opts = { :relation_name => :parent,   :class_name => base.name }
+      c_opts = { :relation_name => :children, :class_name => base.name }
+      
+      p_opts.update(send Tree.options_for_parent_name)   if respond_to?(Tree.options_for_parent_name)
+      c_opts.update(send Tree.options_for_children_name) if respond_to?(Tree.options_for_children_name)
+
+      p_opts.update :inverse_of => c_opts[:relation_name]
+      c_opts.update :inverse_of => p_opts[:relation_name]
+      
+      belongs_to p_opts.delete(:relation_name), p_opts
+      has_many   c_opts.delete(:relation_name), c_opts
     end # included
 
     # Class methods added to the base class via #extend.
@@ -51,14 +111,14 @@ module Mongoid::SleepingKingStudios
 
     # Returns true if the object is a leaf object, e.g. has no child objects.
     # 
-    # @return [Boolean] true if the object is a leaf; otherwise false
+    # @return [Boolean] True if the object has no children; otherwise false.
     def leaf?
       children.empty?
     end # method leaf?
 
     # Returns true if the object is a root object, e.g. has no parent object.
     # 
-    # @return [Boolean] true if the object is a root; otherwise false
+    # @return [Boolean] True if the object has no parent; otherwise false.
     def root?
       parent.nil?
     end # method root?

data/lib/mongoid/sleeping_king_studios/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module SleepingKingStudios
-    VERSION = '0.2.0'
+    VERSION = '0.3.1'
   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.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Rob "Merlin" Smith
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc.2
+        version: 1.0.0.rc.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc.2
+        version: 1.0.0.rc.3
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: |2
       A collection of concerns and extensions to add functionality to Mongoid
       documents and collections. The features can be included individually or by
@@ -158,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: A collection of Mongoid concerns and extensions.