solidus_static_content 2.0.0 → 2.1.0

data/db/migrate/20090625125735_extend_pages.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 class ExtendPages < SolidusSupport::Migration[4.2]
-  class Page < ActiveRecord::Base
+  class Page < ApplicationRecord
   end
 
   def self.up
     change_table :spree_pages do |t|
-      t.boolean :show_in_header, :default => false, :null => false
-      t.boolean :show_in_footer, :default => false, :null => false
-      t.string  :foreign_link
-      t.integer :position, :default => 1, :null => false
+      t.boolean :show_in_header, default: false, null: false
+      t.boolean :show_in_footer, default: false, null: false
+      t.string :foreign_link
+      t.integer :position, default: 1, null: false
       if Page.table_exists?
-        Page.order(:updated_at).each_with_index{|page,x| page.update_attribute(:position, x+1)}
+        Page.order(:updated_at).each_with_index { |page, x| page.update_attribute(:position, x + 1) }
       else
-        Spree::Page.order(:updated_at).each_with_index{|page,x| page.update_attribute(:position, x+1)}
+        Spree::Page.order(:updated_at).each_with_index { |page, x| page.update_attribute(:position, x + 1) }
       end
-
     end
   end
 

data/db/migrate/20090814113100_add_visible_to_pages.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 class AddVisibleToPages < SolidusSupport::Migration[4.2]
-  class Page < ActiveRecord::Base
+  class Page < ApplicationRecord
   end
 
   def self.up
     add_column :spree_pages, :visible, :boolean
     if Page.table_exists?
-      Page.update_all :visible => true
+      Page.update_all visible: true
     else
-      Spree::Page.update_all :visible => true
+      Spree::Page.update_all visible: true
     end
   end
 

data/db/migrate/20090814142845_add_default_true_to_visible_for_page.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 class AddDefaultTrueToVisibleForPage < SolidusSupport::Migration[4.2]
   def self.up
-    change_column :spree_pages, :visible, :boolean, :default=> true
+    change_column :spree_pages, :visible, :boolean, default: true
   end
 
   def self.down
   end
-end
+end

data/db/migrate/20090829000527_add_index_for_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddIndexForPage < SolidusSupport::Migration[4.2]
   def self.up
     add_index(:spree_pages, :slug)
@@ -7,4 +9,3 @@ class AddIndexForPage < SolidusSupport::Migration[4.2]
     remove_index(:spree_pages, :slug)
   end
 end
-

data/db/migrate/20091219021134_add_meta_fields_to_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddMetaFieldsToPages < SolidusSupport::Migration[4.2]
   def self.up
     add_column :spree_pages, :meta_keywords, :string

data/db/migrate/20100204105222_add_layout_to_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddLayoutToPages < SolidusSupport::Migration[4.2]
   def self.up
     add_column :spree_pages, :layout, :string
@@ -6,4 +8,4 @@ class AddLayoutToPages < SolidusSupport::Migration[4.2]
   def self.down
     remove_column :spree_pages, :layout
   end
-end
+end

data/db/migrate/20100323085528_add_show_in_sidebar_option_to_pages.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 class AddShowInSidebarOptionToPages < SolidusSupport::Migration[4.2]
   def self.up
-    add_column :spree_pages, :show_in_sidebar, :boolean, :default=> false, :null=>false
+    add_column :spree_pages, :show_in_sidebar, :boolean, default: false, null: false
   end
 
   def self.down
     remove_column :spree_pages, :show_in_sidebar
   end
-end
+end

data/db/migrate/20110717103112_add_meta_title_to_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddMetaTitleToPage < SolidusSupport::Migration[4.2]
   def self.up
     add_column :spree_pages, :meta_title, :string

data/db/migrate/20120723144115_add_render_as_partial_for_layout_for_spree_pages.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 class AddRenderAsPartialForLayoutForSpreePages < SolidusSupport::Migration[4.2]
   def up
-    unless column_exists? :spree_pages, :render_layout_as_partial
-      add_column :spree_pages, :render_layout_as_partial, :boolean, :default => false
-    end
+    return if column_exists? :spree_pages, :render_layout_as_partial
+
+    add_column :spree_pages, :render_layout_as_partial, :boolean, default: false
   end
 
   def down
-    if column_exists? :spree_pages, :render_layout_as_partial
-      remove_column :spree_pages, :render_layout_as_partial
-    end
+    return unless column_exists? :spree_pages, :render_layout_as_partial
+
+    remove_column :spree_pages, :render_layout_as_partial
   end
 end

data/db/migrate/20140926121757_add_pages_stores.rb

@@ -1,7 +1,8 @@
-class AddPagesStores < SolidusSupport::Migration[4.2]
+# frozen_string_literal: true
 
+class AddPagesStores < SolidusSupport::Migration[4.2]
   def change
-    create_table :spree_pages_stores, :id => false do |t|
+    create_table :spree_pages_stores, id: false do |t|
       t.integer :store_id
       t.integer :page_id
       t.timestamps
@@ -9,6 +10,5 @@ class AddPagesStores < SolidusSupport::Migration[4.2]
 
     add_index :spree_pages_stores, :store_id
     add_index :spree_pages_stores, :page_id
-
   end
 end

data/db/migrate/20180305193240_update_spree_page_position.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 class UpdateSpreePagePosition < SolidusSupport::Migration[4.2]
   def up
-    if column_exists?(:spree_pages, :position)
-      change_column :spree_pages, :position, :integer, default: 0
-    end
+    return unless column_exists?(:spree_pages, :position)
+
+    change_column :spree_pages, :position, :integer, default: 0
   end
 
   def down
-    if column_exists?(:spree_pages, :position)
-      change_column :spree_pages, :position, :boolean, default: false
-    end
+    return unless column_exists?(:spree_pages, :position)
+
+    change_column :spree_pages, :position, :boolean, default: false
   end
 end

data/lib/controllers/backend/spree/admin/pages_controller.rb

@@ -1,16 +1,22 @@
-class Spree::Admin::PagesController < Spree::Admin::ResourceController
-  private
+# frozen_string_literal: true
 
-  # Set some default attributes
-  def build_resource
-    super.tap do |resource|
-      if resource.stores.blank?
-        resource.stores << Spree::Store.default
+module Spree
+  module Admin
+    class PagesController < Spree::Admin::ResourceController
+      private
+
+      # Set some default attributes
+      def build_resource
+        super.tap do |resource|
+          if resource.stores.blank?
+            resource.stores << Spree::Store.default
+          end
+        end
       end
-    end
-  end
 
-  def collection
-    super.ordered_by_position
+      def collection
+        super.ordered_by_position
+      end
+    end
   end
 end

data/lib/controllers/frontend/spree/static_content_controller.rb

@@ -1,24 +1,32 @@
-class Spree::StaticContentController < Spree::StoreController
-  helper 'spree/products'
-  layout :determine_layout
+# frozen_string_literal: true
 
-  def show
-    @page = Spree::Page.by_store(current_store).visible.find_by_slug!(request.path_info)
+module Spree
+  class StaticContentController < Spree::StoreController
+    helper "spree/products"
+    layout :determine_layout
 
-    # Assign static_content to let solidus recognize it as the current
-    # controller resource, this is used by meta tags and in other places.
-    @static_content = @page
+    def show
+      @page = Spree::Page.by_store(current_store).visible.find_by!(slug: request.path_info)
 
-    @taxonomies = Spree::Taxonomy.includes(root: :children)
-  end
+      # Assign static_content to let solidus recognize it as the current
+      # controller resource, this is used by meta tags and in other places.
+      @static_content = @page
+
+      @taxonomies = Spree::Taxonomy.includes(root: :children)
+    end
+
+    private
 
-  private
     def determine_layout
-      return @page.layout if @page and @page.layout.present? and not @page.render_layout_as_partial?
+      return @page.layout if @page && @page.layout.present? && !@page.render_layout_as_partial?
+
       Spree::Config.layout
     end
 
     def accurate_title
-      @page ? (@page.meta_title.present? ? @page.meta_title : @page.title) : nil
+      return unless @page
+
+      @page.meta_title.presence || @page.title
     end
+  end
 end

data/lib/generators/solidus_static_content/install/install_generator.rb

@@ -3,22 +3,50 @@
 module SolidusStaticContent
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
       class_option :auto_run_migrations, type: :boolean, default: false
+      # Either 'starter' or 'classic'
+      class_option :frontend, type: :string, default: "classic"
 
       def add_stylesheets
-        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_static_content\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
+        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_static_content\n", before: %r{\*/}, verbose: true
       end
 
       def add_migrations
-        run 'bin/rails railties:install:migrations FROM=solidus_static_content'
+        run "bin/rails railties:install:migrations FROM=solidus_static_content"
+      end
+
+      def add_javascripts
+        empty_directory "app/assets/javascripts"
+      end
+
+      def copy_starter_frontend_files
+        return if options[:frontend] != "starter"
+
+        copy_file "app/controllers/static_content_controller.rb"
+        copy_file "app/views/static_content/show.html.erb"
+
+        insert_into_file "config/initializers/spree.rb", after: "Spree.config do |config|\n" do
+          <<~RUBY.indent(2)
+            config.layout = 'layouts/storefront'
+
+          RUBY
+        end
+        route <<~ROUTES
+          if Spree::Config.layout == 'layouts/storefront'
+            constraints(SolidusStaticContent::RouteMatcher) do
+              get '/(*path)', to: 'static_content#show', as: 'static'
+            end
+          end
+        ROUTES
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        run_migrations = options[:auto_run_migrations] || ["", "y", "Y"].include?(ask("Would you like to run the migrations now? [Y/n]"))
         if run_migrations
-          run 'bin/rails db:migrate'
+          run "bin/rails db:migrate"
         else
-          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+          puts "Skipping bin/rails db:migrate, don't forget to run it!"
         end
       end
     end

data/lib/generators/solidus_static_content/install/templates/app/controllers/static_content_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class StaticContentController < StoreController
+  helper "spree/products"
+  layout :determine_layout
+
+  def show
+    @page = Spree::Page.by_store(current_store).visible.find_by!(slug: request.path_info)
+
+    # Assign static_content to let solidus recognize it as the current
+    # controller resource, this is used by meta tags and in other places.
+    @static_content = @page
+  end
+
+  private
+
+  def determine_layout
+    return @page.layout if @page && @page.layout.present? && !@page.render_layout_as_partial?
+
+    Spree::Config.layout
+  end
+
+  def accurate_title
+    return unless @page
+
+    @page.meta_title.presence || @page.title
+  end
+end

data/lib/generators/solidus_static_content/install/templates/app/views/static_content/show.html.erb

@@ -0,0 +1,28 @@
+<% if @page.layout.present? and @page.render_layout_as_partial? %>
+  <%= render partial: @page.layout %>
+<% else %>
+  <% content_for :head do -%>
+    <%- if @page.meta_title.present? -%>
+      <meta name="title" content="<%= @page.meta_title %>">
+    <%- else -%>
+      <meta name="title" content="<%= @page.title %>">
+    <%- end -%>
+    <meta name="keywords" content="<%= @page.meta_keywords %>">
+    <meta name="description" content="<%= @page.meta_description %>">
+  <% end -%>
+
+  <% content_for :sidebar do %>
+    <% if (defined?(@products) && @products) && (defined?(@taxon) && @taxon) %>
+      <%= render partial: 'spree/shared/filters' %>
+    <% elsif defined?(@taxonomies) && @taxonomies %>
+      <%= render partial: 'spree/shared/taxonomies' %>
+    <% end %>
+  <% end %>
+
+  <div class="container" id="page_content">
+    <h1 class="wrapper mt-4 font-serif text-h3 lg:text-h2"><%= @page.title %></h1>
+    <div class="pt-4 pb-4">
+      <%= raw @page.body %>
+    </div>
+  </div>
+<% end %>

data/lib/solidus_static_content/engine.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core'
-require 'solidus_static_content'
+require "solidus_core"
+require "solidus_support"
 
 module SolidusStaticContent
   class Engine < Rails::Engine
@@ -9,27 +9,35 @@ module SolidusStaticContent
 
     isolate_namespace ::Spree
 
-    engine_name 'solidus_static_content'
+    engine_name "solidus_static_content"
 
     # use rspec for tests
     config.generators do |g|
       g.test_framework :rspec
     end
 
-    def self.menu_item
-      @menu_item ||= Spree::Backend::Config.class::MenuItem.new(
-        [:pages],
-        'file-text',
-        condition: -> { can?(:admin, Spree::Page) },
-      )
+    initializer "solidus_subscriptions.configure_backend" do
+      next unless ::Spree::Backend::Config.respond_to?(:menu_items)
+
+      ::Spree::Backend::Config.configure do |config|
+        config.menu_items << if Spree.solidus_gem_version >= Gem::Version.new("4.2.0")
+          config.class::MenuItem.new(
+            label: :pages,
+            icon: "ri-file-text-line",
+            url: :admin_pages_path,
+            condition: -> { can?(:admin, Spree::Page) },
+            match_path: "/pages"
+          )
+        else
+          config.class::MenuItem.new(
+            [:pages],
+            "file-text",
+            url: :admin_pages_path,
+            condition: -> { can?(:admin, Spree::Page) },
+            match_path: "/pages"
+          )
+        end
+      end
     end
-
-    def self.activate_menu_items
-      return if Spree::Backend::Config.menu_items.include?(menu_item)
-
-      Spree::Backend::Config.menu_items << menu_item
-    end
-
-    config.to_prepare(&method(:activate_menu_items))
   end
 end

data/lib/solidus_static_content/route_matcher.rb

@@ -1,11 +1,15 @@
-module SolidusStaticContent::RouteMatcher
-  EXCLUDED_PATHS = /^\/+(admin|account|cart|checkout|content|login|pg\/|orders|products|s\/|session|signup|shipments|states|t\/|tax_categories|user)+/
+# frozen_string_literal: true
 
-  def self.matches?(request)
-    path = request.path_info
+module SolidusStaticContent
+  module RouteMatcher
+    EXCLUDED_PATHS = %r{^/+(admin|account|cart|checkout|content|login|pg/|orders|products|s/|session|signup|shipments|states|t/|tax_categories|user)+}
 
-    return false if EXCLUDED_PATHS.match? path
+    def self.matches?(request)
+      path = request.path_info
 
-    Spree::Page.visible.where(slug: path).exists?
+      return false if EXCLUDED_PATHS.match? path
+
+      Spree::Page.visible.where(slug: path).exists?
+    end
   end
 end

data/lib/solidus_static_content/{factories.rb → testing_support/factories.rb}

@@ -3,7 +3,7 @@
 FactoryBot.define do
   factory :page, class: Spree::Page do
     sequence(:title) { |n| "Page #{n}" }
-    body { 'This is the body of the page' }
+    body { "This is the body of the page" }
 
     sequence(:slug) { |n| "/page#{n}" }
 

data/lib/solidus_static_content/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusStaticContent
-  VERSION = '2.0.0'
+  VERSION = "2.1.0"
 end

data/lib/solidus_static_content.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'solidus_core'
-require 'solidus_support'
-require 'deface'
-
-require 'solidus_static_content/version'
-require 'solidus_static_content/route_matcher'
-require 'solidus_static_content/engine'
+require "solidus_static_content/version"
+require "solidus_static_content/route_matcher"
+require "solidus_static_content/engine"
+require "deface"

data/solidus_static_content.gemspec

@@ -1,37 +1,36 @@
 # frozen_string_literal: true
 
-require_relative 'lib/solidus_static_content/version'
+require_relative "lib/solidus_static_content/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'solidus_static_content'
+  spec.name = "solidus_static_content"
   spec.version = SolidusStaticContent::VERSION
-  spec.authors = ['Peter Berkenbosch', 'Roman Smirnov']
-  spec.email = 'peter@pero-ict.nl'
+  spec.authors = ["Peter Berkenbosch", "Roman Smirnov"]
+  spec.email = "peter@pero-ict.nl"
 
-  spec.summary = 'Extension to manage the static pages for your Solidus store.'
-  spec.description = 'Manage the static pages of your Solidus store or replace existing pages with a static version'
-  spec.homepage = 'https://github.com/solidusio-contrib/solidus_static_content#readme'
-  spec.license = 'BSD-3-Clause'
+  spec.summary = "Extension to manage the static pages for your Solidus store."
+  spec.description = "Manage the static pages of your Solidus store or replace existing pages with a static version"
+  spec.homepage = "https://github.com/solidusio-contrib/solidus_static_content#readme"
+  spec.license = "BSD-3-Clause"
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_static_content#readme'
-  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_static_content/releases'
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/solidusio-contrib/solidus_static_content#readme"
+  spec.metadata["changelog_uri"] = "https://github.com/solidusio-contrib/solidus_static_content/releases"
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
 
   spec.files = files.grep_v(%r{^(test|spec|features)/})
-  spec.test_files = files.grep(%r{^(test|spec|features)/})
   spec.bindir = "exe"
   spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'deface', '~> 1.0'
-  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
-  spec.add_dependency 'solidus_support', '~> 0.5'
+  spec.add_dependency "deface", "~> 1.0"
+  spec.add_dependency "solidus_core", [">= 2.0.0", "< 5"]
+  spec.add_dependency "solidus_support", "~> 0.8"
 
-  spec.add_development_dependency 'solidus_dev_support'
+  spec.add_development_dependency "solidus_dev_support", "~> 2.7"
 end