pages_core 3.5.1 → 3.6.0

data/lib/pages_core/attachment_embedder.rb

@@ -0,0 +1,38 @@
+module PagesCore
+  class AttachmentEmbedder
+    include ActionView::Helpers::AssetTagHelper
+
+    attr_reader :attachments
+
+    def initialize(attachments)
+      @attachments = Array(attachments)
+    end
+
+    def to_html
+      embed_attachments(attachments.map { |f| embed_attachment(f) })
+    end
+
+    def embed_attachments(embedded_attachments)
+      embedded_attachments.join(", ")
+    end
+
+    def embed_attachment(attachment)
+      content_tag(
+        :a,
+        attachment.name,
+        class: "file",
+        href: attachment_path(attachment)
+      )
+    end
+
+    private
+
+    def attachment_path(attachment)
+      Rails.application.routes.url_helpers.attachment_path(
+        attachment.digest,
+        attachment,
+        format: attachment.filename_extension
+      )
+    end
+  end
+end

data/lib/pages_core/cache_sweeper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module PagesCore
   class CacheSweeper
     class << self
@@ -20,15 +18,11 @@ module PagesCore
       # Returns the configuration. Accepts a block, ie:
       #
       #   PagesCore::CacheSweeper.config do |c|
-      #     c.observe  += [:store, :store_test]
       #     c.patterns += [/^\/arkiv(.*)$/, /^\/tests(.*)$/]
       #   end
       def config
         @configuration ||= default_config
-        if block_given?
-          yield @configuration
-          extend_observed_models!
-        end
+        yield @configuration if block_given?
         @configuration
       end
 
@@ -59,24 +53,14 @@ module PagesCore
       # Returns the default configuration.
       def default_config
         OpenStruct.new(cache_path: ActionController::Base.page_cache_directory,
-                       observe: [Page, PageComment, Image],
                        patterns: [%r{^/index\.[\w]+$},
                                   %r{^/sitemap\.[\w]+$},
                                   %r{^/pages/[\w]{2,3}[/\.](.*)$},
                                   %r{^/[\w]{2,3}/(.*)$}])
       end
 
-      def extend_observed_models!
-        config.observe.each do |klass|
-          if klass.is_a?(Symbol) || klass.is_a?(String)
-            klass = klass.to_s.camelize.constantize
-          end
-          klass.send(:include, PagesCore::Sweepable)
-        end
-      end
-
       def visible_dir?(dir)
-        !(dir =~ /^\./) && File.directory?(File.join(config.cache_path, dir))
+        dir !~ /^\./ && File.directory?(File.join(config.cache_path, dir))
       end
 
       def sweep_dir(cache_dir)
@@ -116,10 +100,17 @@ module PagesCore
         PagesCore.config.locales.keys.map(&:to_s)).uniq
     end
 
-    def page_path_files
-      @page_path_files ||= PagePath.all.flat_map do |p|
-        ["/#{p.path}.html"] +
-          locales.map { |l| "/#{l}/#{p.path}.html" }
+    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
 
@@ -133,7 +124,7 @@ module PagesCore
 
     def sweep_file?(path)
       relative = path.gsub(Regexp.new("^#{cache_dir}"), "")
-      pattern_match?(relative) || page_path_files.include?(relative)
+      pattern_match?(relative) || page_path?(relative)
     end
   end
 end

data/lib/pages_core/configuration.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "pages_core/configuration/base"
 require "pages_core/configuration/pages"
 

data/lib/pages_core/configuration/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module PagesCore
   module Configuration
     class Base

data/lib/pages_core/configuration/pages.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require "pages_core/file_embedder"
+require "pages_core/attachment_embedder"
 
 module PagesCore
   module Configuration
@@ -15,12 +13,8 @@ module PagesCore
       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 :error_404_layout,      :string
-      setting :file_embedder,         :object, PagesCore::FileEmbedder
+      setting :attachment_embedder,   :object, PagesCore::AttachmentEmbedder
     end
   end
 end

data/lib/pages_core/digest_verifier.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+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(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      l = a.unpack "C#{a.bytesize}"
+
+      res = 0
+      b.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,19 +1,9 @@
-# encoding: utf-8
-
 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 :active_job do |_config|
-      ActiveJob::Base.queue_adapter = if Rails.env.test?
-                                        :test
-                                      else
-                                        :delayed_job
-                                      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|
@@ -24,15 +14,18 @@ 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/*.gif
         pages/*.png
         pages/*.jpg
-      )
+      ]
+    end
+
+    initializer :enable_recursive_serialization do |_app|
+      ActiveModelSerializers.config.default_includes = "**"
     end
 
     initializer :handle_exceptions do |app|

data/lib/pages_core/extensions.rb

@@ -1,4 +1 @@
-# encoding: utf-8
-
-require "pages_core/extensions/hash_extensions"
 require "pages_core/extensions/string_extensions"

data/lib/pages_core/extensions/string_extensions.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module PagesCore
   module Extensions
     module StringExtensions

data/lib/pages_core/page_path_constraint.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module PagesCore
   class PagePathConstraint
     def matches?(request)

data/lib/pages_core/pages_plugin.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module PagesCore
   class PagesPlugin < Plugin
     class << self

data/lib/pages_core/plugin.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # module PagesGallery
 #  class Plugin < PagesCore::Plugin
 #    paths['db/migrate'] = 'template/db/migrate'

data/lib/pages_core/pub_sub.rb

@@ -0,0 +1,36 @@
+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/templates.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require "pages_core/templates/block_configuration"
 require "pages_core/templates/configuration_proxy"
 require "pages_core/templates/configuration_handler"

data/lib/pages_core/templates/block_configuration.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 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) ? true : false
+        @size == :small
       end
 
       def large?

data/lib/pages_core/templates/configuration.rb

@@ -1,7 +1,85 @@
-# encoding: utf-8
-
 module PagesCore
   module Templates
+    # = Template configuration
+    #
+    # Configuration DSL for the page templates. Can be accessed through
+    # +PagesCore::Templates.configure+.
+    #
+    #   PagesCore::Templates.configure do |config|
+    #     # Configuration goes here
+    #   end
+    #
+    # == Configuring templates
+    #
+    # Defaults for all templates can be configured with:
+    #
+    #   config.default do |default|
+    #     default.enabled_blocks %i[name headline body]
+    #     default.files :disabled
+    #   end
+    #
+    # Individual template configurations override the defaults.
+    #
+    #   config.template(:article, :article_alt) do |t|
+    #     t.enabled_blocks %i[name headline excerpt body boxout]
+    #     t.files :enabled
+    #   end
+    #
+    # == Options
+    #
+    # [blocks]
+    #   Yields the block configuration.
+    # [enabled_blocks]
+    #   List of enabled blocks. Default: +%i[headline excerpt body]+
+    # [template]
+    #   Template for all pages, unless overridden with +sub_template+.
+    #   It will attempt to guess based on the parent page if set to
+    #   +:autodetect+, which is the default value. Pass the +:root+
+    #   option to set template at root level.
+    # [image]
+    #   Enable images. Default: +:enabled+
+    # [files]
+    #   Enable file uploads. Default: +:disabled+
+    # [tags]
+    #   Enable tags. Default: +:disabled+
+    # [dates]
+    #   Enable dates. Default: +:disabled+
+    # [sub_template]
+    #   Children of the page will automatically have this template if
+    #   configured. Defaults to +nil+, which fall back to the behaviour
+    #   of +template+.
+    #
+    # == Block configuration
+    #
+    # Blocks can be configured at top level, or per template:
+    #
+    #   config.default do |default|
+    #     default.blocks do |block|
+    #       block.byline("Byline", size: :field)
+    #       block.embed("Video embed", size: :small, description: "Embed code")
+    #     end
+    #     default.enabled_blocks %i[headline byline body embed]
+    #   end
+    #
+    # Valid sizes for text blocks are +:field+ (single line), +:small+
+    # and +:large+.
+    #
+    # === Select blocks
+    #
+    # Blocks can also be selects:
+    #
+    #   block.foobar("Foobar", type: :select, options: %w[Foo Bar Baz])
+    #
+    # Pass a hash for multiple localizations:
+    #
+    #   block.foobar("Foobar", type: :select,
+    #                options: { en: %w[Foo Bar Baz],
+    #                           nb: %w[Fuu Baer Baez] })
+    #
+    # Options can be set at runtime using a Proc:
+    #
+    #   block.foobar("Foobar", type: :select,
+    #                options: -> { FooBar.template_options })
     class Configuration < PagesCore::Templates::ConfigurationHandler
       handle :default do |instance, name, *args|
         if name == :blocks
@@ -14,20 +92,20 @@ module PagesCore
       end
 
       def valid_template_options
-        [
-          :template, :image, :images, :files, :text_filter, :blocks,
-          :enabled_blocks, :sub_template, :comments, :comments_allowed, :tags
-        ]
+        %i[template image images files text_filter blocks
+           enabled_blocks sub_template tags dates]
       end
 
       def configure_block(tpl_name, block_name, title = false, options = {})
         block_name = block_name.to_sym
-        title ||= block_name.to_s.humanize
-        options[:title] = title
+        opts = {
+          title: title || block_name.to_s.humanize,
+          localized: true
+        }.merge(options)
         if tpl_name == :_defaults
-          set([:default, :blocks, block_name], options)
+          set([:default, :blocks, block_name], opts)
         else
-          set([:templates, tpl_name, :blocks, block_name], options)
+          set([:templates, tpl_name, :blocks, block_name], opts)
         end
       end