pages_core 3.4.3 → 3.7.0

data/lib/pages_core/configuration/pages.rb

@@ -1,23 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "pages_core/attachment_embedder"
+require "pages_core/static_cache"
 
 module PagesCore
   module Configuration
     class Pages < Base
-      setting :site_name,             :string,  "Pages Site"
+      setting :site_name,             :string, "Pages Site"
       setting :default_sender,        :string
       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 :comment_notifications, :array,   []
-      setting :close_comments_after,  :integer
-      setting :comment_honeypot,      :boolean, false
-      setting :recaptcha,             :boolean, false
-      setting :pages_path_scope,      :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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module PagesCore
+  # = Digest Verifier
+  #
+  # ==== Usage
+  #
+  #   verifier = PagesCore::DigestVerifier.new("super secret!")
+  #
+  #   digest = verifier.generate("foo")
+  #
+  #   digest.verify("foo", digest)
+  #   # => true
+  #   digest.verify("bar", digest)
+  #   # => raises PagesCore::Errors::InvalidSignature
+  #
+  # Credit where credit is due: adapted and simplified from
+  # +ActiveSupport::MessageVerifier+, since we don't need to handle
+  # arbitrary data structures and ship the serialized data to the client.
+  class DigestVerifier
+    class InvalidSignatureError < StandardError; end
+
+    def initialize(secret, options = {})
+      @secret = secret
+      @digest = options[:digest] || "SHA1"
+    end
+
+    # Generates a digest for a string.
+    def generate(data)
+      generate_digest(data)
+    end
+
+    # Verifies that <tt>digest</tt> is valid for <tt>data</tt>.
+    # Raises a +PagesCore::DigestVerifier::InvalidSignatureError+ error if not.
+    def verify(data, digest)
+      unless valid_digest?(data, digest)
+        raise PagesCore::DigestVerifier::InvalidSignatureError
+      end
+
+      true
+    end
+
+    private
+
+    def secure_compare(value, other)
+      return false unless value.bytesize == other.bytesize
+
+      l = value.unpack "C#{value.bytesize}"
+
+      res = 0
+      other.each_byte { |byte| res |= byte ^ l.shift }
+      res.zero?
+    end
+
+    def generate_digest(data)
+      require "openssl" unless defined?(OpenSSL)
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.const_get(@digest).new,
+        @secret,
+        data
+      )
+    end
+
+    def valid_digest?(data, digest)
+      data.present? &&
+        digest.present? &&
+        secure_compare(digest, generate_digest(data))
+    end
+  end
+end

data/lib/pages_core/engine.rb

@@ -1,9 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module PagesCore
   class Engine < Rails::Engine
-    initializer :active_job do |_config|
-      ActiveJob::Base.queue_adapter = :delayed_job
+    # 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|
@@ -16,12 +26,69 @@ module PagesCore
 
     # Enable asset precompilation
     initializer :assets do |_config|
-      Rails.application.config.assets.precompile += %w(
+      Rails.application.config.assets.precompile += %w[
         pages/admin.js
         pages/admin.css
-        pages/admin/print.css
         pages/errors.css
+        pages/favicon.gif
+        pages/admin/icon.png
+        pages/*.gif
+        pages/*.png
+        pages/*.jpg
+      ]
+    end
+
+    initializer :enable_recursive_serialization do |_app|
+      ActiveModelSerializers.config.default_includes = "**"
+    end
+
+    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
+    initializer :react do |app|
+      app.config.react.jsx_transform_options = {
+        harmony: true
+      }
+    end
   end
 end

data/lib/pages_core/extensions.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-load "pages_core/extensions/hash_extensions.rb"
-load "pages_core/extensions/string_extensions.rb"
+require "pages_core/extensions/string_extensions"

data/lib/pages_core/extensions/string_extensions.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module PagesCore
   module Extensions
@@ -14,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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PagesCore
+  class PagePathConstraint
+    def matches?(request)
+      locale?(request.path_parameters[:locale]) &&
+        exists?(
+          request.path_parameters[:locale],
+          request.path_parameters[:path]
+        )
+    end
+
+    private
+
+    def locale?(str)
+      str.to_s =~ /\A[a-z]{2}\z/
+    end
+
+    def exists?(locale, path)
+      PagePath.get(locale, path) ? true : false
+    end
+  end
+end

data/lib/pages_core/pages_plugin.rb

@@ -1,11 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module PagesCore
   class PagesPlugin < Plugin
+    class << self
+      def configure_localizations!
+        unless @localizations_added
+          I18n.load_path += Dir[
+            new.root.join("config", "locales", "**", "*.{rb,yml}")
+          ]
+        end
+        @localizations_added = true
+      end
+    end
+
     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,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # module PagesGallery
 #  class Plugin < PagesCore::Plugin
@@ -12,10 +12,7 @@ module PagesCore
       attr_accessor :called_from, :paths
 
       def inherited(plugin)
-        plugin.paths ||= {
-          "db/migrate"                    => "db/migrate",
-          "config/removed_migrations.yml" => "config/removed_migrations.yml"
-        }
+        plugin.paths ||= default_paths
         plugin.called_from = begin
           # Remove the line number from backtraces making sure we
           # don't leave anything behind
@@ -26,6 +23,7 @@ module PagesCore
             end
           )
         end
+        super
       end
 
       def admin_menu_item(label, path, group = :custom, options = {})
@@ -40,29 +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
+      private
 
-      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
+      def default_paths
+        { "db/migrate" => "db/migrate" }
       end
     end
 
@@ -74,42 +53,19 @@ 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)
       root_path = self.class.called_from
 
       while root_path && File.directory?(root_path) &&
-          !File.exist?("#{root_path}/#{subfolder}")
+            !File.exist?("#{root_path}/#{subfolder}")
         parent = File.dirname(root_path)
         root_path = parent != root_path && parent
       end
 
       unless File.exist?("#{root_path}/#{subfolder}")
-        fail "Could not find root path for #{self}"
+        raise "Could not find root path for #{self}"
       end
 
       Pathname.new(root_path).realpath

data/lib/pages_core/pub_sub.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PagesCore
+  module PubSub
+    class << self
+      def publish(name, payload = {})
+        payload_struct = OpenStruct.new(payload)
+        subscribers.select { |s| s.name == name }
+                   .each { |s| s.call(payload_struct) }
+      end
+
+      def subscribe(name, &block)
+        subscriber = PagesCore::PubSub::Subscriber.new(name, block)
+        subscribers << subscriber
+        subscriber
+      end
+
+      def subscribers
+        @subscribers ||= []
+      end
+
+      def unsubscribe(subscriber)
+        @subscribers = subscribers.reject { |s| s == subscriber }
+      end
+    end
+
+    class Subscriber
+      attr_reader :name, :callback
+
+      delegate :call, to: :callback
+
+      def initialize(name, callback)
+        @name = name
+        @callback = callback
+      end
+    end
+  end
+end

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