contentful_model 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 038d352d42cc8f428379d27b2db70bccb7661244
-  data.tar.gz: 1b370619c14aecd9ee170ff0f82b72315a9cef7c
+  metadata.gz: 015f709379b38dc9c97ea758d9f31b7af2f07c45
+  data.tar.gz: c89faf96e42c1280a8b5ef8576fee9081136c1e0
 SHA512:
-  metadata.gz: 0692c693706a5211fc011398e410dc79b70557cfd8f260950f56548a0136875da82f6d7aaf6cbecdf45f2a9f4d1e26419d7c0d24249db480b80d78ab004c6313
-  data.tar.gz: 3e20613dea10448a65e96a6f449389f6683dc967016ed26a9a0ba868247f8f90523709bbe5cffa6322da4cd7862d8871b9bfd38afdeaa2f1c1ff916d46565ce5
+  metadata.gz: 76cce2394531f2d80a9de03a8abf7aa93ce81f682f98b57374fdcb4d68ff38ad5092705ae97b736199db6b1befc81d98fa6a6cad6c922ff12bc7f275e5c6f660
+  data.tar.gz: c90aeaa083274dfcdf833ee5fa6927cffeb29ca1203a062ac845f23f64a71513b05dfecb37c0b45ff1d36fb31b0afc61ef12a219fe6b7461408e4c4c8ad8f314

data/lib/contentful_model/associations/belongs_to_many.rb

@@ -25,6 +25,7 @@ module ContentfulModel
             inverse_of: self.to_s.underscore.to_sym
           }
           options = default_options.merge(opts)
+
           # Set up the association name for the instance which loaded this object
           # This is useful in situations where, primarily, it's a 1:* relationship (i.e. belongs_to)
           # even though this isn't actually supported by Contentful
@@ -39,9 +40,14 @@ module ContentfulModel
 
           define_method "#{association_names.to_s.singularize}=" do |parent|
             instance_variable_set(:"@#{association_names.to_s.singularize}",parent)
+            instance_variable_set(:"@loaded_with_parent", true)
             return self
           end
 
+          define_method "loaded_with_parent?" do
+            instance_variable_get(:"@loaded_with_parent") ? true : false
+          end
+
           # Set up the association name (plural)
           if self.respond_to?(association_names)
             self.send(association_names)

data/lib/contentful_model/associations/has_many_nested.rb

@@ -13,7 +13,7 @@ module ContentfulModel
         # To set this up in contentful, add a multi-entry field validated to the same model
         # as the parent, and give it a name. For example, Page might have a field called childPages:
         #
-        # has_many_nested :child_pages
+        # has_many_nested :child_pages, root: -> { Page.find("some_id")}
         #
         # would setup up an instance attribute called parent_pages which lists all the direct
         # parents of this page. It would also create methods to find a page based on an array
@@ -21,9 +21,22 @@ module ContentfulModel
         # ancestors which called the object; because 'many' associations in Contentful are actually
         # 'belongs_to_many' from the child end, we might have several ancestors to a page. You will need
         # to write your own recursion for this, because it's probably an implementation-specific problem.
-        def has_many_nested(association_name)
+        def has_many_nested(association_name, options = {})
           has_many association_name, inverse_of: :"parent_#{self.to_s.underscore}"
           belongs_to_many :"parent_#{self.to_s.underscore.pluralize}", class_name: self.to_s, inverse_of: association_name
+          if options[:root].is_a?(Proc)
+            @root_method = options[:root]
+          end
+
+          # If there's a root method defined, set up a class method called root_[class name]. In our example this would be
+          # Page.root_page.
+          # @return [Object] the root entity returned from the proc defined in has_many_nested
+          if defined?(@root_method) && @root_method.is_a?(Proc)
+            # @return [Object] the root entity
+            define_singleton_method :"root_#{self.to_s.underscore}" do
+              @root_method.call
+            end
+          end
 
           # A utility method which returns the parent object; saves passing around interpolated strings
           define_method :parent do
@@ -73,6 +86,49 @@ module ContentfulModel
             self.send(association_name)
           end
 
+          # @return [Hash] a hash of nested child objects
+          define_method :nested_children do
+            self.children.inject({}) do |h,c|
+              children = c.has_children? ? c.nested_children : nil
+              h[c] = children
+              h
+            end
+          end
+
+          # Return a nested hash of children, returning the field specified
+          # @param field [Symbol] the field you want to return, nested for each child
+          # @return [Hash] of nested children, by that field
+          define_method :nested_children_by do |field|
+            self.children.inject({}) do |h,c|
+              children = c.has_children? ? c.nested_children_by(field) : nil
+              h[c.send(field)] = children
+              h
+            end
+          end
+
+          # Return a flattened hash of children by the specified field
+          define_method :all_child_paths_by do |field, opts = {}|
+            options = {prefix: nil}.merge!(opts)
+            flatten_hash(nested_children_by(field)).keys.collect do |path|
+              options[:prefix] ? path.unshift(options[:prefix]) : path
+            end
+          end
+
+          # Search for a child by a certain field. This is called on the parent(s).
+          # e.g. Page.root.find_child_path_by(:slug, "some-slug"). Accepts a prefix if you want to
+          # prefix the children with the parent
+          define_method :find_child_path_by do |field, value, opts = {}|
+            all_child_paths_by(field,opts).select {|child| child.include?(value)}
+          end
+
+          # Private method to flatten a hash. Courtesy Cary Swoveland http://stackoverflow.com/a/23861946
+          define_method :flatten_hash do |h,f=[],g={}|
+            return g.update({ f=>h }) unless h.is_a? Hash
+            h.each { |k,r| flatten_hash(r,f+[k],g) }
+            g
+          end
+          self.send(:private, :flatten_hash)
+
         end
       end
     end

data/lib/contentful_model/base.rb

@@ -2,6 +2,7 @@ module ContentfulModel
   class Base < Contentful::Entry
     include ContentfulModel::ChainableQueries
     include ContentfulModel::Associations
+    include ContentfulModel::Validations
 
     def initialize(*args)
       super
@@ -11,6 +12,20 @@ module ContentfulModel
     #use method_missing to call fields on the model
     def method_missing(method, *args, &block)
       result = fields[:"#{method.to_s.camelize(:lower)}"]
+      # we need to pull out any Contentful::Link references, and also things which don't have any fields at all
+      # because they're newly created (we think exposing these in the Contentful API is a bug, actually)
+      if result.is_a?(Array)
+        result.reject! {|r| r.is_a?(Contentful::Link) || r.invalid?}
+      elsif result.is_a?(Contentful::Link)
+        result = nil
+      elsif result.respond_to?(:fields) && result.send(:fields).empty?
+        result = nil
+      elsif result.respond_to?(:invalid?) && result.invalid?
+        result = nil
+      end
+
+
+
       if result.nil?
         # if self.class.rescue_from_no_attribute_fields.member?()
         # end
@@ -23,7 +38,6 @@ module ContentfulModel
         # if there's no coercion specified, return the result
         if self.class.coercions[method].nil?
           return result
-
         #if there's a coercion specified for the field and it's a proc, pass the result
         #to the proc
         elsif self.class.coercions[method].is_a?(Proc)

data/lib/contentful_model/query.rb

@@ -16,7 +16,8 @@ module ContentfulModel
 
     def execute
       query = @parameters.merge!(default_parameters)
-      return client.send(:entries,query)
+      result = client.send(:entries,query)
+      return result.to_a.reject {|entity| entity.is_a?(Contentful::Link) || entity.invalid?}
     end
 
     def client

data/lib/contentful_model/validations/validates_presence_of.rb

@@ -0,0 +1,18 @@
+module Contentful
+  module Validations
+    module PresenceOf
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def validates_presence_of(*args)
+          @validations ||= {}
+          @validations[:presence] ||= []
+          @validations[:presence].push(args)
+          @validations[:presence].flatten!
+        end
+      end
+    end
+  end
+end

data/lib/contentful_model/validations/validations.rb

@@ -0,0 +1,56 @@
+# A module to validate entries. A little like ActiveRecord. We don't think this should be necessary, really,
+# because Contentful should be doing the validating, but they expose invalid entries through the preview API.
+module ContentfulModel
+  module Validations
+    def self.included(base)
+      base.extend ClassMethods
+      base.include Contentful::Validations::PresenceOf
+      attr_reader :errors
+    end
+
+    def valid?
+      validate
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def validate
+      @errors ||= []
+      unless self.respond_to?(:fields)
+        @errors.push("Entity doesn't respond to the fields() method")
+        return false
+      end
+
+      validations = self.class.send(:validations)
+      unless validations.nil?
+        validations.each do |type, fields|
+          case type
+            # validates_presence_of
+            when :presence
+              fields.each do |field|
+                unless self.respond_to?(field)
+                  @errors << "#{field} is required"
+                end
+              end
+          end
+        end
+      end
+
+
+      if @errors.empty?
+        return true
+      else
+        return false
+      end
+
+    end
+
+    module ClassMethods
+      def validations
+        @validations
+      end
+    end
+  end
+end

data/lib/contentful_model/version.rb

@@ -1,3 +1,3 @@
 module ContentfulModel
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful_model
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Error Creative Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful
@@ -89,6 +89,8 @@ files:
 - lib/contentful_model/errors.rb
 - lib/contentful_model/queries.rb
 - lib/contentful_model/query.rb
+- lib/contentful_model/validations/validates_presence_of.rb
+- lib/contentful_model/validations/validations.rb
 - lib/contentful_model/version.rb
 - lib/tasks/contentful_rails_tasks.rake
 homepage: https://github.com/errorstudio/contentful_model