pages_core 3.6.0 → 3.8.0

data/lib/pages_core/templates/template_configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Templates
     class TemplateConfiguration
@@ -5,8 +7,11 @@ module PagesCore
 
       class << self
         def all_blocks
-          (all_templates.map { |t| configured_block_names(t) } +
-           all_templates.map { |t| enabled_block_names(t) }).flatten.compact.uniq
+          (config.get(:default, :blocks).keys +
+           all_templates.map { |t| configured_block_names(t) } +
+           all_templates.map do |t|
+             enabled_block_names(t)
+           end).flatten.compact.uniq
         end
 
         def all_templates
@@ -93,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?
@@ -148,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"),

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/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
-  VERSION = "3.6.0".freeze unless PagesCore.const_defined?("VERSION")
+  VERSION = "3.8.0" unless PagesCore.const_defined?("VERSION")
 end

data/lib/pages_core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ruby Standard Library
 require "digest/sha1"
 require "fileutils"
@@ -15,25 +17,31 @@ require "action_mailer"
 
 # Gems
 require "actionpack/page_caching"
-require "active_model_serializers"
 require "acts_as_list"
+require "alba"
 require "bcrypt"
-require "coffee-script"
 require "country_select"
-require "delayed_job"
+require "delayed_job_active_record"
 require "dis"
 require "dynamic_image"
+require "healthcheck"
 require "localizable_model"
+require "lograge"
+require "nokogiri"
 require "json"
+require "pg_search"
+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"
-require "jquery/rails/engine"
 require "react-rails"
 
 # Pages

data/lib/rails/generators/pages_core/frontend/frontend_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Generators
     class FrontendGenerator < Rails::Generators::Base
@@ -49,13 +51,6 @@ module PagesCore
           File.join("app/assets/stylesheets/components/base.scss")
         )
       end
-
-      def create_application_js
-        template(
-          "application.js.erb",
-          File.join("app/assets/javascripts/application.js")
-        )
-      end
     end
   end
 end

data/lib/rails/generators/pages_core/install/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Generators
     class InstallGenerator < Rails::Generators::Base
@@ -57,7 +59,7 @@ module PagesCore
 
       def create_delayed_job_script
         template "delayed_job", File.join("script/delayed_job")
-        File.chmod(0o755, Rails.root.join("script", "delayed_job"))
+        File.chmod(0o755, Rails.root.join("script/delayed_job"))
       end
 
       def create_delayed_job_initializer
@@ -71,12 +73,6 @@ module PagesCore
                  File.join("config/initializers/pages.rb"))
       end
 
-      def create_cache_sweeper_initializer
-        read_configuration!
-        template("cache_sweeper_initializer.rb",
-                 File.join("config/initializers/cache_sweeper.rb"))
-      end
-
       def create_template_initializer
         read_configuration!
         template("page_templates_initializer.rb",

data/lib/rails/generators/pages_core/install/templates/active_job_initializer.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 ActiveJob::Base.queue_adapter = :delayed_job

data/lib/rails/generators/pages_core/install/templates/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ApplicationController < PagesCore::BaseController
   # Put frontend specific code in frontend_controller.rb
 

data/lib/rails/generators/pages_core/install/templates/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApplicationHelper
   include PagesCore::ApplicationHelper
 end

data/lib/rails/generators/pages_core/install/templates/delayed_job

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require File.expand_path(
   File.join(File.dirname(__FILE__), "..", "config", "environment")

data/lib/rails/generators/pages_core/install/templates/delayed_job_initializer.rb

@@ -1 +1,18 @@
+# frozen_string_literal: true
+
 Delayed::Worker.backend = :active_record
+
+if Object.const_defined?("Postmark")
+  class InvalidRecipientsPlugin < Delayed::Plugin
+    callbacks do |lifecycle|
+      lifecycle.around(:invoke_job) do |job, *args, &block|
+        # Forward the call to the next callback in the callback chain
+        block.call(job, *args)
+      rescue Postmark::InactiveRecipientError => e
+        Rails.logger.error "#{e.class}: #{e.message}"
+      end
+    end
+  end
+
+  Delayed::Worker.plugins << InvalidRecipientsPlugin
+end

data/lib/rails/generators/pages_core/install/templates/frontend_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Abstract controller for all frontend controllers.
 class FrontendController < PagesCore::FrontendController
   layout "application"

data/lib/rails/generators/pages_core/install/templates/frontend_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FrontendHelper
   include PagesCore::FrontendHelper
 end

data/lib/rails/generators/pages_core/install/templates/gitignore.erb

@@ -19,7 +19,18 @@
 
 # Ignore all logfiles and tempfiles.
 /log/*.log
-/log/error_reports
 /log/*.sphinx.pid
 /tmp
 /public/dynamic_images
+
+# Ignore uploaded files in development
+/storage/*
+
+/node_modules
+/yarn-error.log
+
+.byebug_history
+/coverage
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/lib/rails/generators/pages_core/install/templates/page_templates_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your web server when you modify this file.
 
 # Templates configuration
@@ -10,7 +12,7 @@ PagesCore::Templates.configure do |config|
         "Headline",
         size: :field,
         description: "The main statement, usually largest and boldest, " \
-          "describing the main story."
+                     "describing the main story."
       )
       block.excerpt(
         "Standfirst",
@@ -20,7 +22,7 @@ PagesCore::Templates.configure do |config|
       block.boxout(
         "Boxout",
         description: "Part of the page, usually background info or facts " \
-          "related to the article."
+                     "related to the article."
       )
     end
 

data/lib/rails/generators/pages_core/install/templates/pages_controller.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class PagesController < PagesCore::Frontend::PagesController
 end

data/lib/rails/generators/pages_core/install/templates/pages_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your web server when you modify this file.
 
 PagesCore.configure do |config|
@@ -11,12 +13,6 @@ PagesCore.configure do |config|
   # Locales and names
   # config.locales(nb: 'Norwegian', en: 'English')
 
-  # Page cache (default: enabled)
-  # config.page_cache :enabled
-
-  # Domain based page cache (default: disabled)
-  # config.domain_based_cache :disabled
-
   # Fulltext in RSS feeds (default: disabled)
   # config.rss_fulltext :disabled
 

data/lib/rails/generators/pages_core/rspec/rspec_generator.rb

@@ -1,34 +1,38 @@
+# frozen_string_literal: true
+
 module PagesCore
   module Generators
     class RspecGenerator < Rails::Generators::Base
       desc "RSpec setup"
       source_root File.expand_path("templates", __dir__)
 
-      def setup_development_gems
-        gem_group :development do
-          gem "spring-commands-rspec"
-        end
-      end
-
       def setup_test_gems
-        gem_group :test, :development do
-          gem "rspec-rails"
-          gem "shoulda-matchers", require: false
-          gem "json_spec"
+        gem_group :development, :test do
           gem "capybara"
-          gem "timecop"
           gem "factory_bot_rails"
+          gem "fuubar"
+          gem "json_spec"
+          gem "rspec-rails"
+          gem "rspec_junit_formatter"
+          gem "selenium-webdriver"
+          gem "shoulda-matchers", require: false
+          gem "simplecov", require: false
         end
       end
 
       def setup_rspec
-        create_file File.join(".rspec"), "--colour"
+        create_file File.join(".rspec"), "--format Fuubar\n--colour\n" \
+                                         "--require spec_helper"
         create_file File.join("spec/controllers/.keep")
-        create_file File.join("spec/factories/.keep")
+        create_file File.join("spec/mailers/preview/.keep")
         create_file File.join("spec/models/.keep")
+        create_file File.join("spec/system/.keep")
         template "spec_helper.rb", File.join("spec/spec_helper.rb")
-        template "factories.rb", File.join("spec/support/factories.rb")
+        template "rails_helper.rb", File.join("spec/rails_helper.rb")
+        template "factories.rb", File.join("spec/factories.rb")
         template "mailer_macros.rb", File.join("spec/support/mailer_macros.rb")
+        template("page_templates_spec.rb",
+                 File.join("spec/system/page_templates_spec.rb"))
       end
     end
   end

data/lib/rails/generators/pages_core/rspec/templates/factories.rb

@@ -1,9 +1,4 @@
-FactoryBot.define do
-  sequence :email do |n|
-    "person#{n}@example.com"
-  end
+# frozen_string_literal: true
 
-  sequence :sha1hash do |n|
-    Digest::SHA1.hexdigest(n.to_s)
-  end
-end
+# FactoryBot.define do
+# end

data/lib/rails/generators/pages_core/rspec/templates/mailer_macros.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MailerMacros
   def last_email
     ActionMailer::Base.deliveries.last

data/lib/rails/generators/pages_core/rspec/templates/page_templates_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Page templates", type: :system do
+  subject { page }
+
+  let(:page_model) do
+    create(:page,
+           template: template,
+           headline: "My headline",
+           body: "My body",
+           excerpt: "My excerpt")
+  end
+  let(:template) { "index" }
+  let(:locale) { I18n.default_locale }
+
+  before do
+    visit page_path(locale, page_model)
+  end
+
+  describe "default template" do
+    it { is_expected.to have_text(page_model.headline) }
+    it { is_expected.to have_text(page_model.body) }
+  end
+end

data/lib/rails/generators/pages_core/rspec/templates/rails_helper.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= "test"
+
+require "simplecov"
+SimpleCov.start "rails" if ARGV.grep(/spec\.rb/).empty?
+
+require File.expand_path("../config/environment", __dir__)
+
+# Prevent database truncation if the environment is production
+if Rails.env.production?
+  abort("The Rails environment is running in production mode!")
+end
+require "spec_helper"
+require "rspec/rails"
+# Add additional requires below this line. Rails is not loaded until this point!
+
+require "shoulda-matchers"
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each do |f|
+  require f
+end
+
+# Checks for pending migration and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+  config.include ActiveJob::TestHelper
+  config.include MailerMacros
+
+  # Use FactoryBot shorthand
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:each, type: :system) do
+    driven_by :rack_test
+  end
+
+  config.before(:each, js: true) do
+    driven_by :selenium_chrome_headless
+  end
+end
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/lib/rails/generators/pages_core/rspec/templates/spec_helper.rb

@@ -1,42 +1,95 @@
-ENV["RAILS_ENV"] = "test"
+# frozen_string_literal: true
 
-require "rubygems"
-require File.expand_path("../config/environment", __dir__)
-require "rspec/rails"
-require "rspec/autorun"
-require "shoulda-matchers"
+# This file was generated by the `rails generate rspec:install`
+# command. Conventionally, all specs live under a `spec` directory,
+# which RSpec adds to the `$LOAD_PATH`.  The generated `.rspec` file
+# contains `--require spec_helper` which will cause this file to
+# always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
 
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join("spec", "support", "**", "*.rb")].each { |f| load f }
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-RSpec.configure do |config|
-  # == Mock Framework
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
   #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
   #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-  config.mock_with :rspec
-
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # Use FactoryBot shorthand
-  config.include FactoryBot::Syntax::Methods
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
-
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
-
-  config.include JsonSpec::Helpers
-  config.include MailerMacros
-  config.before(:each) { reset_email }
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-\
+  #   #       expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-\
+  #   #       monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by
+  #   # providing the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed`
+  #   # value as the one that triggered the failure.
+  #   Kernel.srand config.seed
 end