pages_core 3.6.2 → 3.7.0

data/lib/pages_core/pages_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class PagesPlugin < Plugin
     class << self
@@ -14,7 +16,7 @@ module PagesCore
     paths["db/migrate"] = "db/migrate"
 
     admin_menu_item "News",  proc { news_admin_pages_path(@locale) }, :pages,
-                    if:      proc { Page.news_pages.any? },
+                    if: proc { Page.news_pages.any? },
                     current: proc { @page && @page.parent.try(&:news_page?) }
 
     admin_menu_item "Pages", proc { admin_pages_path(@locale) }, :pages

data/lib/pages_core/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # module PagesGallery
 #  class Plugin < PagesCore::Plugin
 #    paths['db/migrate'] = 'template/db/migrate'
@@ -21,6 +23,7 @@ module PagesCore
             end
           )
         end
+        super
       end
 
       def admin_menu_item(label, path, group = :custom, options = {})
@@ -35,38 +38,10 @@ module PagesCore
         end
       end
 
-      def migrations
-        plugins.map { |p| p.new.migrations }.flatten.compact
-      end
-
-      def removed_migrations
-        plugins.map { |p| p.new.removed_migrations }.flatten.compact
-      end
-
-      def existing_removed_migrations
-        removed_migrations
-          .select { |m| File.exist?(Rails.root.join("db", "migrate", m)) }
-      end
-
-      def existing_migrations
-        migrations
-          .map { |m| Rails.root.join("db", "migrate", m.basename) }
-          .select { |m| File.exist?(m) }
-      end
-
-      def remove_old_migrations!
-        (existing_removed_migrations + existing_migrations).each do |migration|
-          File.unlink Rails.root.join("db", "migrate", migration)
-        end
-      end
-
       private
 
       def default_paths
-        {
-          "db/migrate"                    => "db/migrate",
-          "config/removed_migrations.yml" => "config/removed_migrations.yml"
-        }
+        { "db/migrate" => "db/migrate" }
       end
     end
 
@@ -78,29 +53,6 @@ module PagesCore
       self.class.paths
     end
 
-    def migrations_path
-      root.join(paths["db/migrate"])
-    end
-
-    def removed_migrations_path
-      root.join(paths["config/removed_migrations.yml"])
-    end
-
-    def migrations?
-      File.exist?(migrations_path) && File.directory?(migrations_path)
-    end
-
-    def migrations
-      Dir.entries(migrations_path)
-         .select { |f| f =~ /\.rb$/ }
-         .map { |f| migrations_path.join(f) }
-    end
-
-    def removed_migrations
-      return unless File.exist?(removed_migrations_path)
-      YAML.load_file(removed_migrations_path)
-    end
-
     protected
 
     def find_root_with_subfolder(subfolder)

data/lib/pages_core/pub_sub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module PubSub
     class << self

data/lib/pages_core/static_cache.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "pages_core/static_cache/null_handler"
+require "pages_core/static_cache/page_cache_handler"
+require "pages_core/static_cache/varnish_handler"
+
+module PagesCore
+  module StaticCache
+    class << self
+      def handler
+        PagesCore.config.static_cache_handler || default_handler
+      end
+
+      private
+
+      def default_handler
+        if ENV["VARNISH_URL"]
+          return PagesCore::StaticCache::VarnishHandler.new(ENV["VARNISH_URL"])
+        end
+
+        # PagesCore::StaticCache::NullHandler.new
+        PagesCore::StaticCache::PageCacheHandler.new
+      end
+    end
+  end
+end

data/lib/pages_core/static_cache/null_handler.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module StaticCache
+    class NullHandler
+      def cache_page(_controller, _request, _response); end
+
+      def cache_page_permanently(_controller, _request, _response); end
+
+      def purge!; end
+
+      def sweep!; end
+
+      def sweep_now!; end
+    end
+  end
+end

data/lib/pages_core/static_cache/page_cache_handler.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module StaticCache
+    class PageCacheHandler
+      def cache_page(controller, _request, _response)
+        controller.class.page_cache_directory = page_cache_directory
+        controller.cache_page
+      end
+
+      def cache_page_permanently(controller, _request, _response)
+        controller.class.page_cache_directory = permanent_page_cache_directory
+        controller.cache_page
+      end
+
+      def purge!
+        return unless PagesCore::CacheSweeper.enabled
+
+        clear_directory(page_cache_directory)
+        clear_directory(permanent_page_cache_directory)
+      end
+
+      def sweep!
+        return unless PagesCore::CacheSweeper.enabled
+
+        PagesCore::SweepCacheJob.perform_later
+      end
+
+      def sweep_now!
+        return unless PagesCore::CacheSweeper.enabled
+
+        clear_directory(page_cache_directory)
+      end
+
+      private
+
+      def cache_root
+        Rails.root.join("public")
+      end
+
+      def clear_directory(path)
+        return unless File.exist?(path)
+
+        FileUtils.rm_rf(Dir.glob("#{path}/*"))
+      end
+
+      def page_cache_directory
+        cache_root.join("static_cache")
+      end
+
+      def permanent_page_cache_directory
+        cache_root.join("cache")
+      end
+    end
+  end
+end

data/lib/pages_core/static_cache/varnish_handler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module StaticCache
+    class VarnishHandler
+      attr_reader :varnish_url
+
+      def initialize(varnish_url)
+        @varnish_url = varnish_url
+      end
+
+      def cache_page(_controller, request, response)
+        response.set_header("X-Cache-Tags", "static")
+        request.session_options[:skip] = true
+        # controller.expires_in 1.hour, public: true
+      end
+
+      def cache_page_permanently(controller, request, response)
+        response.set_header("X-Cache-Tags", "permanent")
+        request.session_options[:skip] = true
+        controller.expires_in 1.year, public: true
+      end
+
+      def purge!
+        return unless PagesCore::CacheSweeper.enabled
+
+        hydra = Typhoeus::Hydra.hydra
+        hydra.queue(ban_request("static"))
+        hydra.queue(ban_request("permanent"))
+        hydra.run
+      end
+
+      def sweep!
+        return unless PagesCore::CacheSweeper.enabled
+
+        # PagesCore::SweepCacheJob.perform_later
+        sweep_now!
+      end
+
+      def sweep_now!
+        return unless PagesCore::CacheSweeper.enabled
+
+        ban_request("static").run
+      end
+
+      private
+
+      def ban_request(cache_tag)
+        Typhoeus::Request.new(varnish_url,
+                              method: :ban,
+                              headers: { "X-Cache-Tags": cache_tag })
+      end
+    end
+  end
+end

data/lib/pages_core/templates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pages_core/templates/block_configuration"
 require "pages_core/templates/configuration_proxy"
 require "pages_core/templates/configuration_handler"
@@ -16,8 +18,8 @@ module PagesCore
 
       def template_paths
         [
-          PagesCore.plugin_root.join("app", "views", "pages", "templates"),
-          Rails.root.join("app", "views", "pages", "templates")
+          PagesCore.plugin_root.join("app/views/pages/templates"),
+          Rails.root.join("app/views/pages/templates")
         ]
       end
 
@@ -28,7 +30,7 @@ module PagesCore
           .uniq
           .compact
           .sort
-          .map { |f| f.gsub(/\.[\w\.]+$/, "") }
+          .map { |f| f.gsub(/\.[\w.]+$/, "") }
       end
 
       def template_files_in_dir(dir)

data/lib/pages_core/templates/block_configuration.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     # Configuration for the blocks on an individual template
     class BlockConfiguration
       attr_reader :name, :title, :description, :optional, :enforced
+
       def small?
         @size == :small
       end

data/lib/pages_core/templates/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     # = Template configuration
@@ -96,7 +98,7 @@ module PagesCore
            enabled_blocks sub_template tags dates]
       end
 
-      def configure_block(tpl_name, block_name, title = false, options = {})
+      def configure_block(tpl_name, block_name, title = nil, options = {})
         block_name = block_name.to_sym
         opts = {
           title: title || block_name.to_s.humanize,
@@ -115,6 +117,7 @@ module PagesCore
         unless valid_template_options.include?(setting)
           raise "Invalid template configuration value: #{setting.inspect}"
         end
+
         set(
           template_path(template_name),
           template_config(setting, value, options)
@@ -151,6 +154,7 @@ module PagesCore
 
       def template_path(name)
         return [:default] if name == :_defaults
+
         [:templates, name]
       end
     end

data/lib/pages_core/templates/configuration_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     class ConfigurationHandler
@@ -33,7 +35,7 @@ module PagesCore
 
       def proxy(proxy_block = nil, &callback)
         proxy_object = PagesCore::Templates::ConfigurationProxy.new(callback)
-        proxy_block.call(proxy_object) if proxy_block
+        proxy_block&.call(proxy_object)
         proxy_object
       end
 
@@ -56,7 +58,7 @@ module PagesCore
       def get(*path)
         @configuration ||= {}
         path.inject(@configuration) do |value, key|
-          value && value.is_a?(Hash) && value.key?(key) ? value[key] : nil
+          value.is_a?(Hash) && value&.key?(key) ? value[key] : nil
         end
       end
     end

data/lib/pages_core/templates/configuration_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     class ConfigurationProxy

data/lib/pages_core/templates/controller_actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     module ControllerActions

data/lib/pages_core/templates/template_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     class TemplateConfiguration
@@ -7,7 +9,9 @@ module PagesCore
         def all_blocks
           (config.get(:default, :blocks).keys +
            all_templates.map { |t| configured_block_names(t) } +
-           all_templates.map { |t| enabled_block_names(t) }).flatten.compact.uniq
+           all_templates.map do |t|
+             enabled_block_names(t)
+           end).flatten.compact.uniq
         end
 
         def all_templates
@@ -94,18 +98,19 @@ module PagesCore
 
       def default_block_options(block_name)
         {
-          title:    block_name.to_s.humanize,
+          title: block_name.to_s.humanize,
           optional: true,
-          size:     :small
+          size: :small
         }
       end
     end
 
     class << self
       def configure(options = {}, &_block)
-        if options[:reset] == :defaults
+        case options[:reset]
+        when :defaults
           load_default_configuration
-        elsif options[:reset] == true
+        when true
           @configuration = PagesCore::Templates::Configuration.new
         end
         yield configuration if block_given?
@@ -149,26 +154,26 @@ module PagesCore
 
       def default_blocks
         {
-          name:     { size: :field, class: "page_title" },
-          body:     { size: :large },
+          name: { size: :field, class: "page_title" },
+          body: { size: :large },
           headline: { size: :field },
-          excerpt:  {},
-          boxout:   {}
+          excerpt: {},
+          boxout: {}
         }.merge(default_meta_blocks)
       end
 
       def default_meta_blocks
         {
-          meta_title:             { size: :field },
-          meta_description:       { size: :small },
-          open_graph_title:       { size: :field },
+          meta_title: { size: :field },
+          meta_description: { size: :small },
+          open_graph_title: { size: :field },
           open_graph_description: { size: :small }
         }
       end
 
       def default_block_configuration(default)
         default.blocks do |block|
-          default_blocks.keys.each do |name|
+          default_blocks.each_key do |name|
             block.send(
               name,
               template_block_localization("#{name}.name"),