mongoid-sleeping_king_studios 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69ea55c009d98431ff13407f84c1b210fc5ac89d
+  data.tar.gz: cf358c4f2146e0b3bfcad4b92bb1697ecaa3e565
+SHA512:
+  metadata.gz: 2cf1a558a348b53842e181242b37368f2ee50f2fc3af52f8172a851d46f26841ac68f8801ef1350462ce751fba7c251cbbee65a1d9caf3d503ea6fe7d4c0e9bb
+  data.tar.gz: 8a67abe9b88d4ddd7879b3e5317adbc704bd7af0d603e44d53c5aae910c5099bc275b7b77cf5c98a2a8b573c95a8d0106329cedf074c5aa765de9080d270f833

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2013 Rob Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Mongoid::SleepingKingStudios
+
+A collection of concerns and extensions to add functionality to Mongoid
+documents and collections.
+
+## The Mixins
+
+### Sluggable
+
+    require 'mongoid/sleeping_king_studios/sluggable'
+
+Adds a slug field that automatically tracks a base attribute and stores a
+short, url-friendly version.
+
+**How To Use:**
+
+    class SluggableDocument
+      include Mongoid::Document
+      include Mongoid::SleepingKingStudios::Sluggable
+
+      field :title, :type => String
+
+      slugify :title
+    end # class
+
+#### Options
+
+##### Lockable
+
+    slugify :title, :lockable => true
+
+Allows the slug to be specified manually. Adds an additional slug_lock field
+that is automatically set to true when #slug= is called. To resume tracking the
+base attribute, set :slug_lock to false.
+
+### Tree
+
+    require 'mongoid/sleeping_king_studios/tree'
+
+Sets up a basic tree structure by adding belongs_to :parent and has_many
+:children relations, as well as some helper methods.
+
+**How To Use:**
+
+    class TreeDocument
+      include Mongoid::Document
+      include Mongoid::SleepingKingStudios::Tree
+    end # class
+
+## License
+
+RSpec::SleepingKingStudios is released under the
+[MIT License](http://www.opensource.org/licenses/MIT).

data/lib/mongoid/sleeping_king_studios.rb

@@ -0,0 +1,7 @@
+# lib/mongoid/sleeping_king_studios.rb
+
+require 'mongoid'
+
+module Mongoid
+  module SleepingKingStudios; end
+end # module

data/lib/mongoid/sleeping_king_studios/sluggable.rb

@@ -0,0 +1,92 @@
+# lib/mongoid/sleeping_king_studios/sluggable.rb
+
+require 'mongoid/sleeping_king_studios'
+
+module Mongoid::SleepingKingStudios
+  # Adds a :slug field that stores a short, url-friendly reference string,
+  # useful for human-readable urls. By default, the slug field is
+  # automatically overwritten from the specified base attribute before
+  # validation. To enable setting the slug manually, use the :lockable
+  # option; otherwise, the :slug= writer is set to private.
+  # 
+  # @example Setting up the slug:
+  #   class SluggableDocument
+  #     include Mongoid::Document
+  #     include Mongoid::SleepingKingStudios::Sluggable
+  #
+  #     field :title, :type => String
+  #
+  #     slugify :title
+  #   end # class
+  # 
+  # @see ClassMethods#slugify
+  # 
+  # @since 0.1.0
+  module Sluggable
+    extend ActiveSupport::Concern
+
+    # @!attribute [r] slug
+    #   A url-friendly short string version of the specified base attribute.
+    #   Read-only unless the :lockable option is selected.
+    # 
+    #   @return [String] the slug value
+
+    # 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
+      #   @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.
+      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
+      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/tree.rb

@@ -0,0 +1,66 @@
+# lib/mongoid/sleeping_king_studios/tree.rb
+
+require 'mongoid/sleeping_king_studios'
+
+module Mongoid::SleepingKingStudios
+  # Adds a belongs_to parent relation and a has_many children relation to set
+  # up a basic tree structure, as well as several helper methods.
+  # 
+  # @example Setting up the tree:
+  #   class SluggableDocument
+  #     include Mongoid::Document
+  #     include Mongoid::SleepingKingStudios::Tree
+  #   end # class
+  # 
+  # @since 0.2.0
+  module Tree
+    extend ActiveSupport::Concern
+
+    # @!method parent
+    #   Returns the parent object, or nil if the object is a root.
+    # 
+    #   @return [Tree, nil]
+
+    # @!method children
+    #   Returns the list of child objects.
+    # 
+    #   @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
+    end # included
+
+    # Class methods added to the base class via #extend.
+    module ClassMethods
+      # Returns a Criteria specifying all root objects, e.g. objects with no
+      # parent object.
+      # 
+      # @return [Mongoid::Criteria]
+      def roots
+        where({ :parent_id => nil })
+      end # scope routes
+    end # module
+
+    # Returns the root object of the current object's tree.
+    # 
+    # @return [Tree]
+    def root
+      parent ? parent.root : self
+    end # method root
+
+    # 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
+    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
+    def root?
+      parent.nil?
+    end # method root?
+  end # module
+end # module

data/lib/mongoid/sleeping_king_studios/version.rb

@@ -0,0 +1,7 @@
+# lib/mongoid/sleeping_king_studios/version.rb
+
+module Mongoid
+  module SleepingKingStudios
+    VERSION = '0.2.0'
+  end # module
+end # module

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-sleeping_king_studios
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rob "Merlin" Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-sleeping_king_studios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.2
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  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'
+description: |2
+      A collection of concerns and extensions to add functionality to Mongoid
+      documents and collections. The features can be included individually or by
+      category. For more information, check out the README.
+email:
+- merlin@sleepingkingstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongoid/sleeping_king_studios/sluggable.rb
+- lib/mongoid/sleeping_king_studios/tree.rb
+- lib/mongoid/sleeping_king_studios/version.rb
+- lib/mongoid/sleeping_king_studios.rb
+- LICENSE
+- README.md
+homepage: http://sleepingkingstudios.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A collection of Mongoid concerns and extensions.
+test_files: []
+has_rdoc: