rooftop-rails 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f03f4480ef66da90df9283ee01437c7e24fb1f
-  data.tar.gz: 5d5bcfd4bbe1fc4d4d73ca638226bd35c04da30e
+  metadata.gz: d686ac1326055010ea5a1026d27d6d1b5fa7cfda
+  data.tar.gz: 62ddec40b4f47c843bc01976efa2dc28a0fa782c
 SHA512:
-  metadata.gz: 45f27bfd588ba45324abae25ee6d798faaf78a74f91237009ee838d9a2275ff37fbb4f123476d09adbe3c1e8cb7a920d407da8572d27183866995b0c15e12afc
-  data.tar.gz: a1263337fc73348789ed7f3ea001532ca0556ba706a22326f87f46f5bd03d62ff23f6daa0e90e9df312fc416a7bd5797de9474f5a6cbe0a9376882d8fda86b61
+  metadata.gz: 767379cba619e6a39b40c158043328f057119fe595ff215268ef92aace444541be2621197493f5946734d8c4508c5d6a75991ed95b3f06c47dd6eb5731cf7f23
+  data.tar.gz: 03298dae9b28386035440e077b6a07ed222b3b42a0eadcdee48eff2865d0b1a2eecb8997062fbc320a4505e1250d765dac5f47d7dd0efc6519121c6904211082

data/app/helpers/rooftop/rails/menu_helper.rb

@@ -24,6 +24,10 @@ module Rooftop
         end
       end
 
+      def path_matches?(path)
+        request.url =~ %r{#{path}}
+      end
+
 
     end
   end

data/app/models/concerns/rooftop/rails/nested_model.rb

@@ -22,7 +22,7 @@ module Rooftop
           path = CGI::unescape(path) if options[:unescape]
           delimiter = options[:delimiter]
           slug = "#{options[:prefix]}#{path}".gsub(/^\//, '').split(delimiter).last
-          entity = where(slug: slug).first
+          entity = where(slug: slug, per_page: 1).first
           if entity.nil?
             raise Rooftop::RecordNotFoundError, "Couldn't find #{self} with slug #{slug}"
           else
@@ -47,6 +47,3 @@ module Rooftop
     end
   end
 end
-
-
-

data/app/models/concerns/rooftop/rails/object_cache.rb

@@ -31,6 +31,7 @@ module Rooftop
               ::Rails.cache.read("#{cache_key_base}/#{id}")
             end
 
+            all_objects.each {|o| o.run_callbacks(:find)}
             all_objects.length == 1 ? all_objects.first : all_objects
           else
             super
@@ -38,59 +39,121 @@ module Rooftop
         end
 
         def where(args)
-          #Sort the arguments, and any keys which are arrays
-          args = Hash[args.sort.each {|k,v| v.sort! if v.is_a?(Array)}]
-          # Generate a hash for keying the cache of the results
-          args_hash = Digest::MD5.hexdigest(args.to_s)
-          cache_key = "#{cache_key_base}/collection_query/#{args_hash}"
-          # first see if we have a collection which matches the args
-          cached_collection = ::Rails.cache.read(cache_key)
-          # if it's present, then we can return it directly.
-          if cached_collection.present?
-            return cached_collection
+          if Rooftop::Rails.configuration.perform_object_caching
+            # Sort the arguments - reduces the number of different argument hashes.
+            # Note that 2 different arg hashes might actually be the same, with child arrays
+            # in a different order. But we won't mess with the order of the child arrays
+            # because sometimes that's important.
+            args = Hash[args.sort]
+            # Generate a hash for keying the cache of the results
+            args_hash = Digest::MD5.hexdigest(args.to_s)
+            cache_key = "#{cache_key_base}/collection_query/#{args_hash}"
+            # first see if we have a collection which matches the args
+            cached_collection = ::Rails.cache.read(cache_key)
+            # if it's present, then we can return it directly.
+            if cached_collection.present?
+              ::Rails.logger.debug("Returning cached collection for #{cache_key}")
+              cached_collection.each {|o| o.run_callbacks :find}
+              return cached_collection
+            else
+              # If not, then we need to call super() to get it from the API
+              collection = super(args)
+              # and write it into the cache
+              ::Rails.cache.write(cache_key,collection)
+              # We also iterate over the collection and cache each object, and cache the argument hash against each object
+              collection.each do |object|
+                # This is a bit funky and circular. We store an array of hashes for queries to which this object belongs.
+                # If the object cache needs to be removed, we can iterate through those hashes and clear the collection caches too.
+                collection_query_hash_key = "#{object.cache_key}/collection_hashes"
+                collection_hashes = ::Rails.cache.read(collection_query_hash_key) || []
+                collection_hashes << args_hash
+                ::Rails.cache.write(collection_query_hash_key, collection_hashes)
+                # this is the object cache - i.e. it'll respond with a cache lookup for Page.find(14) or whatever
+                ::Rails.cache.write(object.cache_key,object)
+                ::Rails.logger.debug("Written cached collection for #{object.cache_key}")
+              end
+              collection
+            end
           else
-            # If not, then we need to call super() to get it from the API
-            collection = super(args)
-            # and write it into the cache
-            ::Rails.cache.write(cache_key,collection)
-            # We also iterate over the collection and cache each object, and cache the argument hash against each object
-            collection.each do |object|
-              # This is a bit funky and circular. We store an array of hashes for queries to which this object belongs.
-              # If the object cache needs to be removed, we can iterate through those hashes and clear the collection caches too.
-              collection_query_hash_key = "#{object.cache_key}/collection_hashes"
-              collection_hashes = ::Rails.cache.read(collection_query_hash_key) || []
-              collection_hashes << args_hash
-              ::Rails.cache.write(collection_query_hash_key, collection_hashes)
-              # this is the object cache - i.e. it'll respond with a cache lookup for Page.find(14) or whatever
-              ::Rails.cache.write(object.cache_key,object)
+            super
+          end
+        end
+
+        alias_method :find_by, :where
+
+        def all(args = {})
+          #TODO this is identical to where, above, but the super() is different. Refactor out to DRY
+          if Rooftop::Rails.configuration.perform_object_caching
+            #Sort the arguments, and any keys which are arrays
+            args = Hash[args.sort]
+            # Generate a hash for keying the cache of the results
+            args_hash = Digest::MD5.hexdigest(args.to_s)
+            cache_key = "#{cache_key_base}/collection_query/#{args_hash}"
+            # first see if we have a collection which matches the args
+            cached_collection = ::Rails.cache.read(cache_key)
+            # if it's present, then we can return it directly.
+            if cached_collection.present?
+              ::Rails.logger.debug("Returning cached collection for #{cache_key}")
+              cached_collection.each {|o| o.run_callbacks :find}
+              return cached_collection
+            else
+              # If not, then we need to call super() to get it from the API
+              collection = super
+              # and write it into the cache
+              ::Rails.cache.write(cache_key,collection)
+              # We also iterate over the collection and cache each object, and cache the argument hash against each object
+              collection.each do |object|
+                # This is a bit funky and circular. We store an array of hashes for queries to which this object belongs.
+                # If the object cache needs to be removed, we can iterate through those hashes and clear the collection caches too.
+                collection_query_hash_key = "#{object.cache_key}/collection_hashes"
+                collection_hashes = ::Rails.cache.read(collection_query_hash_key) || []
+                collection_hashes << args_hash
+                ::Rails.cache.write(collection_query_hash_key, collection_hashes)
+                # this is the object cache - i.e. it'll respond with a cache lookup for Page.find(14) or whatever
+                ::Rails.cache.write(object.cache_key,object)
+                ::Rails.logger.debug("Written cached collection for #{object.cache_key}")
+              end
+              collection
             end
-            collection
+          else
+            super
           end
         end
 
         # A method to expire the relevant caches for a collection of objects or ids
         # @param args [Array] of either objects which respond to `.id`, or ids themselves
         def expire_cache_for(*args)
-          args = args.collect {|a| a.respond_to?(:id) ? a.id : a}
+          args = args.collect {|a| a.respond_to?(:id) ? a.id : a}.flatten
           # the caches we need to clear are:
           # - the object cache
           # - any collection caches which included this object
           args.each do |id|
             object_cache_key = "#{cache_key_base}/#{id}"
-            collection_keys = (::Rails.cache.read("#{object_cache_key}/collection_hashes") || []).collect do |hash|
-              "#{cache_key_base}/collection_query/#{hash}"
-            end
-            collection_keys << "#{object_cache_key}/collection_hashes"
-            [collection_keys + [object_cache_key]].flatten.each do |key|
-              ::Rails.cache.delete(key)
+            object_collections = ::Rails.cache.read("#{object_cache_key}/collection_hashes")
+            if object_collections.present?
+              # this object has a list of collection hashes, each of which we need to remove
+              object_collections.each do |hash|
+                ::Rails.cache.delete("#{cache_key_base}/collection_query/#{hash}")
+              end
+              # by implication, the cached object should also be present; clear that too
+              ::Rails.cache.delete(object_cache_key)
+            else
+              # the object isn't in any collections; unfortunately we can't be sure whether this is because the object is old
+              # and uncached, or new and therefore needs to be in collections which currently exist for this class.
+              # Because of that, we'll aggressively remove caches for collections
+              begin
+                ::Rails.cache.delete_matched("#{cache_key_base}/collection_query*")
+              rescue NotImplementedError
+                ::Rails.cache.clear # rescue to Rails.cache.clear for caching methods where delete_matched isn't supported
+              end
             end
-
-          end
+            # Always remove the object's cache. There's no risk of doing this for nonexistent things.
+            ::Rails.cache.delete(object_cache_key)
 
 
+          end
         end
-
       end
     end
   end
-end
+end

data/lib/generators/rooftop/rooftop_generator.rb

@@ -0,0 +1,13 @@
+class RooftopGenerator < ::Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  class_option :api_token, :type => :string, :aliases => "-t", :desc => "Your Rooftop API token", :default => "YOUR_TOKEN_HERE"
+  class_option :site_name, :type => :string, :aliases => "-s", :desc => "Your Rooftop subdomain / site name", :default => "YOUR_SITE_NAME_HERE"
+
+  def create_initializer
+    @api_token = options[:api_token]
+    @site_name = options[:site_name]
+
+    template "initializer.rb.erb", "config/initializers/rooftop.rb"
+  end
+end

data/lib/generators/rooftop/templates/initializer.rb.erb

@@ -0,0 +1,26 @@
+if defined?(Rooftop)
+  Rooftop::Rails.configure do |config|
+    config.api_token = '<%= @api_token %>'
+    config.site_name = '<%= @site_name %>'
+    config.perform_http_response_caching = false
+    config.perform_object_caching = Rails.configuration.action_controller.perform_caching
+    config.resource_route_map = {
+      page: ->(path, params) {Rails.application.routes.url_helpers.page_path(path, params)}
+    }
+    <% if defined?(Rooftop::Events) %>
+    config.post_type_mapping = {
+        menu: Rooftop::Menus::Menu,
+        event: Rooftop::Events::Event,
+        event_instance: Rooftop::Events::Instance,
+        event_price: Rooftop::Events::Price,
+        event_price_list: Rooftop::Events::PriceList,
+        event_ticket_type: Rooftop::Events::TicketType,
+        event_price_band: Rooftop::Events::PriceBand
+    }
+    <% else %>
+    config.post_type_mapping = {
+      menu: Rooftop::Menus::Menu
+    }
+    <% end %>
+  end
+end

data/lib/rooftop/rails.rb

@@ -31,9 +31,11 @@ module Rooftop
                     :perform_object_caching,
                     :cache_store,
                     :cache_logger,
+                    :logger,
                     :ssl_options,
                     :proxy,
-                    :resource_route_map
+                    :resource_route_map,
+                    :post_type_mapping
 
       def initialize
         @authenticate_webhooks = true
@@ -43,6 +45,7 @@ module Rooftop
         @cache_logger = ::Rails.logger
         @ssl_options = {}
         @resource_route_map = {}
+        @logger = nil
       end
     end
   end

data/lib/rooftop/rails/cache_expirer.rb

@@ -0,0 +1,20 @@
+module Rooftop
+  module Rails
+    class CacheExpirer
+      def self.expire(payload)
+        begin
+          content_type = payload[:type].to_sym
+          if Rooftop.configuration.post_type_mapping[content_type].present?
+            klass = Rooftop.configuration.post_type_mapping[content_type]
+          else
+            klass = content_type.to_s.classify.constantize
+          end
+          klass.send(:expire_cache_for, payload[:id])
+        rescue => e
+          raise Rooftop::Rails::UnknownObjectForExpiry, e
+        end
+
+      end
+    end
+  end
+end

data/lib/rooftop/rails/engine.rb

@@ -11,18 +11,22 @@ module Rooftop
       end
 
       initializer "configure_rooftop", before: :add_entry_mappings do
-        Rooftop.configure do |config|
-          config.api_token = Rooftop::Rails.configuration.api_token
-          config.site_name = Rooftop::Rails.configuration.site_name
-          config.extra_headers = Rooftop::Rails.configuration.extra_headers
-          config.advanced_options = Rooftop::Rails.configuration.advanced_options
-          config.api_path = Rooftop::Rails.configuration.api_path
-          config.url = Rooftop::Rails.configuration.url || "https://#{config.site_name}.rooftopcms.io"
-          config.perform_caching = Rooftop::Rails.configuration.perform_http_response_caching
-          config.cache_store = Rooftop::Rails.configuration.cache_store
-          config.cache_logger = Rooftop::Rails.configuration.cache_logger
-          config.ssl_options = Rooftop::Rails.configuration.ssl_options
-          config.proxy = Rooftop::Rails.configuration.proxy
+        if Rooftop::Rails.configuration.api_token.present?
+          Rooftop.configure do |config|
+            config.api_token = Rooftop::Rails.configuration.api_token
+            config.site_name = Rooftop::Rails.configuration.site_name
+            config.extra_headers = Rooftop::Rails.configuration.extra_headers
+            config.advanced_options = Rooftop::Rails.configuration.advanced_options
+            config.api_path = Rooftop::Rails.configuration.api_path
+            config.url = Rooftop::Rails.configuration.url || "https://#{config.site_name}.rooftopcms.io"
+            config.perform_caching = Rooftop::Rails.configuration.perform_http_response_caching
+            config.cache_store = Rooftop::Rails.configuration.cache_store
+            config.cache_logger = Rooftop::Rails.configuration.cache_logger
+            config.ssl_options = Rooftop::Rails.configuration.ssl_options
+            config.proxy = Rooftop::Rails.configuration.proxy
+            config.logger = Rooftop::Rails.configuration.logger
+            config.post_type_mapping = Rooftop::Rails.configuration.post_type_mapping
+          end
         end
       end
 
@@ -48,13 +52,7 @@ module Rooftop
 
       initializer "clear_caches_on_webhook_notification" do
         ActiveSupport::Notifications.subscribe(/rooftop.*/) do |name, start, finish, id, payload|
-          content_type = payload[:type]
-          if Rooftop.configuration.post_type_mapping[content_type].present?
-            klass = Rooftop.configuration.post_type_mapping[content_type]
-          else
-            klass = content_type.classify.constantize
-          end
-          klass.send(:expire_cache_for, payload[:id])
+          Rooftop::Rails::CacheExpirer.expire(payload)
         end
       end
     end

data/lib/rooftop/rails/errors.rb

@@ -1,5 +1,6 @@
 module Rooftop
   module Rails
     class AncestorMismatch < StandardError; end
+    class UnknownObjectForExpiry < NoMethodError; end
   end
 end

data/lib/rooftop/rails/preview.rb

@@ -8,11 +8,11 @@ module Rooftop::Rails
       helper_method :preview?
     end
     # Check whether the subdomain being presented is the preview domain.
-    # If so, set Rooftop to use the preview API, and request a username / password
+    # If so, set Rooftop to add the preview header
     def check_preview_domain
       # If enable_preview_domain is not enabled, explicitly set use_preview_api false and return
       unless Rooftop::Rails.configuration.enable_preview_domain
-        Rooftop.use_preview_api = false
+        Rooftop.preview = false
         return
       end
 
@@ -24,14 +24,14 @@ module Rooftop::Rails
         end
         # If user is authenticated, we're good to switch to the preview api
         if authenticated
-          Rooftop.use_preview_api = true
+          Rooftop.preview = true
         else
           #otherwise ask for user / pass
           request_http_basic_authentication
         end
       else
         #if the subdomain doesn't match the configured one, explicitly set to false
-        Rooftop.use_preview_api = false
+        Rooftop.preview = false
         return
       end
 
@@ -47,7 +47,7 @@ module Rooftop::Rails
     end
 
     def preview?
-      Rooftop.use_preview_api == true
+      Rooftop.preview == true
     end
   end
 end

data/lib/rooftop/rails/route_resolver.rb

@@ -12,16 +12,21 @@ module Rooftop
         @id = id
       end
 
-      def resolve
+      def resolve(params={})
         route_config = Rooftop::Rails.configuration.resource_route_map
         resource_key = @id.nil? ? @type.to_s.pluralize.to_sym : @type
         if route_config[resource_key]
-          return route_config[resource_key].try(:call,@id)
+          if route_config[resource_key].arity == 1
+            return route_config[resource_key].try(:call,@id)
+          elsif route_config[resource_key].arity == 2
+            return route_config[resource_key].try(:call,@id, params)
+          end
         else
           begin
             route_info = ::Rails.application.routes.named_routes[resource_key].defaults
-            route_info.reverse_merge!(id: @id) unless @id.nil?
-            ::Rails.application.routes.url_helpers.url_for(route_info.merge(only_path: true))
+            # once you've called the routes once, you'll have an id. We don't want the previously called one, and in the case of not passing an ID, we want the index method instead of the show method
+            route_info.merge!(id: @id) unless @id.nil?
+            ::Rails.application.routes.url_helpers.url_for(route_info.merge(only_path: true, params: params))
           rescue
             nil
           end

data/lib/rooftop/rails/version.rb

@@ -1,5 +1,5 @@
 module Rooftop
   module Rails
-    VERSION = "0.0.3"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rooftop-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Error Studio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7.4
 description: This gem provides utility methods and a mountable engine for Rails applications
   using the Rooftop gem
 email:
@@ -82,7 +82,10 @@ files:
 - app/models/concerns/rooftop/rails/nested_model.rb
 - app/models/concerns/rooftop/rails/object_cache.rb
 - config/routes.rb
+- lib/generators/rooftop/rooftop_generator.rb
+- lib/generators/rooftop/templates/initializer.rb.erb
 - lib/rooftop/rails.rb
+- lib/rooftop/rails/cache_expirer.rb
 - lib/rooftop/rails/development_constraint.rb
 - lib/rooftop/rails/engine.rb
 - lib/rooftop/rails/errors.rb