pages_core 3.6.2 → 3.7.0

data/lib/pages_core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ruby Standard Library
 require "digest/sha1"
 require "fileutils"
@@ -23,13 +25,21 @@ require "country_select"
 require "delayed_job"
 require "dis"
 require "dynamic_image"
+require "healthcheck"
 require "localizable_model"
+require "lograge"
+require "nokogiri"
 require "json"
+require "progress_bar"
 require "rails_i18n"
 require "RedCloth"
 require "sass-rails"
+require "typhoeus"
 require "will_paginate"
 
+# Must be loaded so that PagesCore::LinkRender can resolve the constant.
+require "will_paginate/view_helpers/action_view"
+
 # Assets
 require "font-awesome-rails"
 require "jquery-ui-rails"

data/lib/pages_core/admin_menu_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class AdminMenuItem
     attr_reader :label, :path, :group, :options
@@ -5,6 +7,7 @@ module PagesCore
     class << self
       def items
         return [] unless @menu_items
+
         @menu_items.map { |_, v| v }
       end
 

data/lib/pages_core/archive_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class ArchiveFinder
     def initialize(relation, options = {})
@@ -9,6 +11,12 @@ module PagesCore
       filter_by_time(range_for_year(year))
     end
 
+    def by_year_and_maybe_month(year, month = nil)
+      return by_year(year) unless month
+
+      by_year_and_month(year, month)
+    end
+
     def by_year_and_month(year, month)
       filter_by_time(range_for_year_and_month(year, month))
     end
@@ -62,25 +70,17 @@ module PagesCore
     end
 
     def month_part
-      if mysql?
-        "MONTH(#{timestamp_attribute})"
-      else
-        "date_part('month', #{timestamp_attribute})::integer"
-      end
-    end
-
-    def mysql?
-      ActiveRecord::Base.connection.adapter_name.downcase.starts_with?("mysql")
+      "date_part('month', #{timestamp_attribute})::integer"
     end
 
     def range_for_year(year)
-      start_time = Time.new(year.to_i, 1, 1)
+      start_time = Time.zone.local(year.to_i, 1, 1)
       end_time = start_time.end_of_year
       (start_time.in_time_zone)..(end_time.in_time_zone)
     end
 
     def range_for_year_and_month(year, month)
-      start_time = Time.new(year.to_i, month, 1)
+      start_time = Time.zone.local(year.to_i, month, 1)
       end_time = start_time.end_of_month
       (start_time.in_time_zone)..(end_time.in_time_zone)
     end
@@ -98,11 +98,7 @@ module PagesCore
     end
 
     def year_part
-      if mysql?
-        "YEAR(#{timestamp_attribute})"
-      else
-        "date_part('year', #{timestamp_attribute})"
-      end
+      "date_part('year', #{timestamp_attribute})"
     end
   end
 end

data/lib/pages_core/attachment_embedder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class AttachmentEmbedder
     include ActionView::Helpers::AssetTagHelper
@@ -17,12 +19,8 @@ module PagesCore
     end
 
     def embed_attachment(attachment)
-      content_tag(
-        :a,
-        attachment.name,
-        class: "file",
-        href: attachment_path(attachment)
-      )
+      tag.a(attachment.name, class: "file",
+                             href: attachment_path(attachment))
     end
 
     private

data/lib/pages_core/cache_sweeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class CacheSweeper
     class << self
@@ -6,125 +8,25 @@ module PagesCore
       def disable(&_block)
         old_value = enabled
         self.enabled = false
-        yield
+        yield if block_given?
         self.enabled = old_value
       end
 
       def once(&block)
         disable(&block)
-        PagesCore::SweepCacheJob.perform_later
+        PagesCore::StaticCache.handler.sweep!
       end
 
-      # Returns the configuration. Accepts a block, ie:
-      #
-      #   PagesCore::CacheSweeper.config do |c|
-      #     c.patterns += [/^\/arkiv(.*)$/, /^\/tests(.*)$/]
-      #   end
       def config
-        @configuration ||= default_config
-        yield @configuration if block_given?
-        @configuration
-      end
-
-      # Purge the entire pages cache
-      def purge!
-        cache_dir = config.cache_path
-        FileUtils.rm_rf(Dir.glob("#{cache_dir}/*")) if File.exist?(cache_dir)
-      end
-
-      # Sweep all cached pages
-      def sweep!
-        return [] unless enabled
-        cache_dirs.flat_map { |d| sweep_dir(d) }
-      end
-
-      private
-
-      def cache_dirs
-        if PagesCore.config(:domain_based_cache)
-          Dir.entries(config.cache_path)
-             .select { |d| visible_dir?(d) }
-             .map { |d| File.join(config.cache_path, d).to_s }
-        else
-          [config.cache_path.to_s]
-        end
-      end
-
-      # Returns the default configuration.
-      def default_config
-        OpenStruct.new(cache_path: ActionController::Base.page_cache_directory,
-                       patterns: [%r{^/index\.[\w]+$},
-                                  %r{^/sitemap\.[\w]+$},
-                                  %r{^/pages/[\w]{2,3}[/\.](.*)$},
-                                  %r{^/[\w]{2,3}/(.*)$}])
-      end
-
-      def visible_dir?(dir)
-        dir !~ /^\./ && File.directory?(File.join(config.cache_path, dir))
-      end
-
-      def sweep_dir(cache_dir)
-        PagesCore::CacheSweeper.new(cache_dir).sweep!
+        ActiveSupport::Deprecation.warn(
+          "PagesCore::CacheSweeper.config is no longer used."
+        )
+        configuration = OpenStruct.new(patterns: [])
+        yield configuration if block_given?
+        configuration
       end
     end
 
-    attr_reader :cache_dir
-
     self.enabled ||= true
-
-    def initialize(cache_dir)
-      @cache_dir = cache_dir
-    end
-
-    def sweep!
-      return [] unless File.exist?(cache_dir)
-      swept_files = []
-
-      Find.find(cache_dir + "/") do |path|
-        Find.prune if skip_path?(path) || !File.exist?(path)
-
-        if sweep_file?(path)
-          swept_files << path
-          FileUtils.rm_rf(path)
-        end
-      end
-      swept_files
-    end
-
-    private
-
-    def locales
-      return [I18n.default_locale.to_s] unless PagesCore.config.locales
-
-      ([I18n.default_locale.to_s] +
-        PagesCore.config.locales.keys.map(&:to_s)).uniq
-    end
-
-    def page_path?(relative)
-      return false unless relative =~ /\.html$/
-      page_paths.each do |p|
-        return true if relative.start_with?(p)
-      end
-      false
-    end
-
-    def page_paths
-      @page_paths ||= PagePath.all.flat_map do |p|
-        ["/#{p.path}"] + locales.map { |l| "/#{l}/#{p.path}" }
-      end
-    end
-
-    def pattern_match?(path)
-      PagesCore::CacheSweeper.config.patterns.select { |p| p =~ path }.any?
-    end
-
-    def skip_path?(path)
-      path =~ Regexp.new("^#{cache_dir}/dynamic_image[s]?")
-    end
-
-    def sweep_file?(path)
-      relative = path.gsub(Regexp.new("^#{cache_dir}"), "")
-      pattern_match?(relative) || page_path?(relative)
-    end
   end
 end

data/lib/pages_core/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pages_core/configuration/base"
 require "pages_core/configuration/pages"
 

data/lib/pages_core/configuration/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Configuration
     class Base
@@ -25,6 +27,7 @@ module PagesCore
 
       def get(key)
         raise InvalidConfigurationKey unless setting?(key)
+
         if configuration.key?(key)
           configuration[key]
         else
@@ -34,6 +37,7 @@ module PagesCore
 
       def set(key, value)
         raise InvalidConfigurationKey unless setting?(key)
+
         value = parse_value(key, value)
         unless valid_type?(key, value)
           raise(
@@ -60,6 +64,7 @@ module PagesCore
 
       def valid_type?(key, value)
         return true if value.nil?
+
         if type_for(key) == :boolean
           value.is_a?(TrueClass) || value.is_a?(FalseClass)
         else

data/lib/pages_core/configuration/pages.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "pages_core/attachment_embedder"
+require "pages_core/static_cache"
 
 module PagesCore
   module Configuration
@@ -8,13 +11,12 @@ module PagesCore
       setting :localizations,         :boolean, false
       setting :locales,               :hash
       setting :text_filter,           :symbol, :textile
-      setting :page_cache,            :boolean, true
-      setting :domain_based_cache,    :boolean, false
       setting :rss_fulltext,          :boolean, true
       setting :image_fallback_url,    :string
       setting :default_author,        :string
       setting :error_404_layout,      :string
       setting :attachment_embedder,   :object, PagesCore::AttachmentEmbedder
+      setting :static_cache_handler,  :object
     end
   end
 end

data/lib/pages_core/digest_verifier.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module PagesCore
   # = Digest Verifier
@@ -42,13 +42,13 @@ module PagesCore
 
     private
 
-    def secure_compare(a, b)
-      return false unless a.bytesize == b.bytesize
+    def secure_compare(value, other)
+      return false unless value.bytesize == other.bytesize
 
-      l = a.unpack "C#{a.bytesize}"
+      l = value.unpack "C#{value.bytesize}"
 
       res = 0
-      b.each_byte { |byte| res |= byte ^ l.shift }
+      other.each_byte { |byte| res |= byte ^ l.shift }
       res.zero?
     end
 

data/lib/pages_core/engine.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 module PagesCore
   class Engine < Rails::Engine
     # config.autoload_paths += Dir["#{config.root}/lib/"]
     # config.autoload_paths += Dir["#{config.root}/lib/pages_core/**/"]
     # config.eager_load_paths += Dir["#{config.root}/lib/pages_core/**/"]
 
+    initializer :factory_bot_definitions do |app|
+      path = File.expand_path("../../spec/factories", __dir__)
+
+      if defined?(FactoryBotRails)
+        app.config.factory_bot.definition_file_paths << path
+        FactoryBot.definition_file_paths =
+          Rails.application.config.factory_bot.definition_file_paths
+      end
+    end
+
     initializer :append_migrations do |app|
       unless app.root.to_s.match root.to_s
         config.paths["db/migrate"].expanded.each do |expanded_path|
@@ -18,6 +30,8 @@ module PagesCore
         pages/admin.js
         pages/admin.css
         pages/errors.css
+        pages/favicon.gif
+        pages/admin/icon.png
         pages/*.gif
         pages/*.png
         pages/*.jpg
@@ -30,6 +44,44 @@ module PagesCore
 
     initializer :handle_exceptions do |app|
       app.config.exceptions_app = app.routes
+      ActionDispatch::ExceptionWrapper.rescue_responses.merge!(
+        "PagesCore::NotAuthorized" => :forbidden
+      )
+    end
+
+    initializer :healthcheck do |_app|
+      Healthcheck.configure do |config|
+        config.success = 200
+        config.error = 503
+        config.verbose = true
+        config.route = "/healthcheck"
+        config.method = :get
+
+        # -- Checks --
+        config.add_check :database, lambda {
+          ActiveRecord::Base.connection.execute("select 1")
+        }
+        # config.add_check :migrations, lambda {
+        #   ActiveRecord::Migration.check_pending!
+        # }
+        # config.add_check :cache, -> { Rails.cache.read("some_key") }
+      end
+    end
+
+    initializer :lograge do |app|
+      app.config.lograge.enabled = true if ENV["ENABLE_LOGRAGE"]
+      app.config.lograge.formatter = Lograge::Formatters::Json.new
+      app.config.lograge.ignore_actions =
+        ["Healthcheck::HealthchecksController#check"]
+
+      app.config.lograge.custom_options = lambda do |event|
+        exclude_params = %w[controller action format id]
+        { remote_ip: event.payload[:remote_ip],
+          user_id: event.payload[:user_id],
+          user_email: event.payload[:user_email],
+          params: event.payload[:params]
+                       .except(*exclude_params) }
+      end
     end
 
     # React configuration

data/lib/pages_core/extensions.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "pages_core/extensions/string_extensions"

data/lib/pages_core/extensions/string_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Extensions
     module StringExtensions
@@ -12,4 +14,4 @@ module PagesCore
   end
 end
 
-String.send(:include, PagesCore::Extensions::StringExtensions)
+String.include PagesCore::Extensions::StringExtensions

data/lib/pages_core/page_path_constraint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   class PagePathConstraint
     def matches?(request)