rooftop 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17838c2957390cba459e722b6b6c24e107db27c2
-  data.tar.gz: 7a2616214f7e5e5ac829e34c53d4d191a7fef6b6
+  metadata.gz: f7b51337bae47ac92f6fb41b5716bbe292f3f19b
+  data.tar.gz: c0ee1e20299e906b1fcf0358e820ddf05ae3d31a
 SHA512:
-  metadata.gz: 7e043daa4269c79ed27af44fc7e18b00d07f11227b88404807c018608b791510a1618fdc4f367eca7e0f98903b5922f4ac550c09d55ecaadf7b840476496059a
-  data.tar.gz: e2c2142efc855d53db5e9443bcaf9ec3877b86184cec3a3f7c013b7b379cbc8ca34083739685b4e2279971f84acb58a38d897fb0a409eee8d0e1f9656a146782
+  metadata.gz: 440657fbf5aa59c58464a661e57f04c7459f78b4efe4e7796c0180ed2c6e0064f83097e17cccbb397d5de151636ba128c1f45b06e2c8a443092faf3d3c65d62f
+  data.tar.gz: 2c0e502abd0d09977f803d6354a22b4ae3b762044513d7793847d46d225879e6a1ceb57136b98bbb288fb71fa8629e31bd40d1112bb29b41ac28602126afbf37

data/README.md

@@ -82,7 +82,7 @@ Sometimes you want to do something with a field after it's returned. for example
 To coerce one or more fields, call a class method in your class and pass a lambda which is called on the field.
 
 ```
-class mycustomposttype
+class MyCustomPostType
     include rooftop::post
     self.post_type = "my_custom_post_type"
     coerce_field date: ->(date) { datetime.parse(date)}
@@ -191,7 +191,36 @@ _(the cache headers plugin for rooftop is a work in progress)_
  If you want to cache responses, set `perform_caching` to true in your configuration block. you will need to provide a cache store and logger in the `cache_store` and `cache_logger` config options. by default, the cache store is set to `activesupport::cache.lookup_store(:memory_store)` which is a sensible default, but isn't shared across threads. any activesupport-compatible cache store (memcache, file, redis etc.) will do.
    
  The `cache_logger` option determines where cache debug messages (hits, misses etc.) get stored. by default it's `nil`, which switches logging off.
-
+ 
+ ## Menus
+ WordPress comes with quite a powerful way to build menus, rather than needing to traverse a tree of objects directly.
+ 
+ ### Accessing the menu you need
+ At the moment you have to know the ID of the menu you need - not ideal. Keep an eye on the following issues to get an update:
+ 
+ * https://github.com/rooftopcms/rooftop-custom-content-setup/issues/3
+ * https://github.com/rooftopcms/rooftop-custom-content-setup/issues/4
+ 
+ So for now, with that in mind, here's how you do it:
+ 
+ ```
+ r = Rooftop::Menus::Menu.find(2) #returns a menu with ID 2
+ r.items # a collection of Rooftop::Menus::Item
+ ```
+ 
+ ### Accessing the object to which a menu item refers
+ If a menu item refers to an object in Rooftop - a post or a page - you can access the original object by calling `object()`.
+  
+ ```
+r = Rooftop::Menus::Menu.find(2) #returns a menu with ID 2
+r.items # a collection of Rooftop::Menus::Item
+item = r.items.first # a Rooftop::Menus::Item
+item.object # an object derived from the post type and ID. 
+ ```
+ 
+ If you haven't defined a class for a post type, you'll get a `Rooftop::Menus::UnmappedObjectError`
+ 
+ 
 # Roadmap
 Lots! here's a flavour:
 
@@ -199,7 +228,6 @@ Lots! here's a flavour:
 
 * preview mode. rooftop supports passing a preview header to see content in draft. we'll expose that in the rooftop gem as a constant.
 * taxonomies will be supported and side-loaded against content
-* menus are exposed by rooftop. we need to create a rooftop::menu mixin 
 * media: media is exposed by the api, and should be accessible and downloadable.
 
 ## Writing

data/lib/rooftop.rb

@@ -25,7 +25,7 @@ module Rooftop
   end
 
   class Configuration
-    attr_accessor :api_token, :url, :site_name, :perform_caching, :cache_store, :cache_logger, :ssl_options, :proxy
+    attr_accessor :api_token, :url, :site_name, :perform_caching, :cache_store, :cache_logger, :ssl_options, :proxy, :post_type_mapping
     attr_reader :connection,
                 :connection_path,
                 :api_path, #actually writeable with custom setter
@@ -44,6 +44,7 @@ module Rooftop
       @cache_logger = nil
       @ssl_options = {}
       @proxy = nil
+      @post_type_mapping = {}
     end
 
     def api_path=(path)

data/lib/rooftop/base.rb

@@ -1,6 +1,8 @@
 module Rooftop
   module Base
     def self.included(base)
+      @included_classes ||= []
+      @included_classes << base unless @included_classes.include?(base)
       base.extend ClassMethods
       base.include Her::Model
 
@@ -37,6 +39,10 @@ module Rooftop
 
     end
 
+    def self.included_classes
+      @included_classes
+    end
+
     module ClassMethods
       attr_reader :api_namespace, :api_version, :api_endpoint
 
@@ -58,6 +64,7 @@ module Rooftop
       def setup_path!
         @api_endpoint ||= collection_path
         self.collection_path "#{@api_namespace}/v#{@api_version}/#{@api_endpoint}"
+
       end
 
       # Allow calling 'first'

data/lib/rooftop/errors/unmapped_object_error.rb

@@ -0,0 +1,5 @@
+module Rooftop
+  module Menus
+    class UnmappedObjectError < NoMethodError; end
+  end
+end

data/lib/rooftop/menus/item.rb

@@ -0,0 +1,28 @@
+module Rooftop
+  module Menus
+    class Item < OpenStruct
+      def initialize(args)
+        args[:object_type] = args[:object]
+        super
+        # If this menu item has children, create a MenuItem for each one
+        if self.children
+          self.children = children.collect do |child|
+            Item.new(child)
+          end
+        end
+
+      end
+
+      def object
+        if self.type == "post_type"
+          begin
+            klass = Rooftop.configuration.post_type_mapping[self.object_type] || self.object_type.classify.constantize
+            klass.find_by(slug: self.slug).first
+          rescue
+            raise UnmappedObjectError, "Couldn't find an mapping between the #{self.object_type} post type and a class in your code."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rooftop/menus/menu.rb

@@ -0,0 +1,10 @@
+module Rooftop
+  module Menus
+    class Menu
+      include Rooftop::Base
+      self.api_namespace = "wp-api-menus"
+      self.api_version = 2
+      coerce_field items: ->(items) { items.collect {|i| Item.new(i)} unless items.nil?}
+    end
+  end
+end

data/lib/rooftop/post.rb

@@ -8,6 +8,7 @@ module Rooftop
 
     module ClassMethods
       def post_type=(type)
+        Rooftop.configuration.post_type_mapping.merge!(type => self)
         self.api_endpoint = type.pluralize
       end
     end

data/lib/rooftop/queries/queries.rb

@@ -12,9 +12,28 @@ module Rooftop
         # the fact that 'slug' is referred to in the db as 'name' is irritating. Let's fix that
         # in queries so we can specify {slug: "foo"}
         if args.keys.collect(&:to_sym).include?(:slug)
-          args[:name] = args[:slug]
+          if args[:slug].is_a?(Array)
+            args[:post_name__in] ||= []
+            args[:slug].each do |slug|
+              args[:post_name__in] << slug
+            end
+          else
+            args[:name] = args[:slug]
+          end
           args.delete(:slug)
         end
+
+        if args.keys.collect(&:to_sym).include?(:id)
+          if args[:id].is_a?(Array)
+            args[:post__in] ||= []
+            args[:id].each do |id|
+              args[:post__in] << id
+            end
+          else
+            args[:page_id] = args[:id]
+          end
+          args.delete(:id)
+        end
         filters =  args.inject({}) {|hash,pair| hash["filter[#{pair.first}]"] = pair.last; hash}
         #Call the Her `where` method with our new filters
         super().where(filters)

data/lib/rooftop/version.rb

@@ -1,3 +1,3 @@
 module Rooftop
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooftop
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ed Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,13 +117,14 @@ files:
 - lib/rooftop/content/field.rb
 - lib/rooftop/errors/field_not_found_error.rb
 - lib/rooftop/errors/record_not_found_error.rb
+- lib/rooftop/errors/unmapped_object_error.rb
 - lib/rooftop/field_aliases.rb
 - lib/rooftop/headers.rb
 - lib/rooftop/hook_calls.rb
+- lib/rooftop/menus/item.rb
+- lib/rooftop/menus/menu.rb
 - lib/rooftop/models/author.rb
 - lib/rooftop/models/media_item.rb
-- lib/rooftop/models/menu.rb
-- lib/rooftop/models/menu_item.rb
 - lib/rooftop/models/taxonomy.rb
 - lib/rooftop/models/taxonomy_term.rb
 - lib/rooftop/nested.rb

data/lib/rooftop/models/menu.rb

@@ -1,9 +0,0 @@
-module Rooftop
-  class Menu
-    include Rooftop::Base
-    has_many :menu_items, class: "Rooftop::MenuItem"
-    self.api_namespace = "wp-api-menus"
-    self.api_version = 2
-    # coerce_field items: ->(items) { items.collect {|i| MenuItem.new(i)} unless items.nil?}
-  end
-end

data/lib/rooftop/models/menu_item.rb

@@ -1,18 +0,0 @@
-module Rooftop
-  class MenuItem
-    def initialize(args)
-      args.each do |k,v|
-        instance_variable_set("@#{k}", v)
-        self.class.send(:attr_accessor, k)
-      end
-    end
-
-    def id
-      self.instance_variable_get(:"@ID")
-    end
-
-    def ==(other)
-      other.class == self.class && other.respond_to?(:id) && other.id == id
-    end
-  end
-end