solidus_static_content 1.0.0 → 2.1.0

data/db/migrate/20090814113100_add_visible_to_pages.rb

@@ -1,13 +1,15 @@
-class AddVisibleToPages < ActiveRecord::Migration
-  class Page < ActiveRecord::Base
+# frozen_string_literal: true
+
+class AddVisibleToPages < SolidusSupport::Migration[4.2]
+  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 @@
-class AddDefaultTrueToVisibleForPage < ActiveRecord::Migration
+# 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,4 +1,6 @@
-class AddIndexForPage < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddIndexForPage < SolidusSupport::Migration[4.2]
   def self.up
     add_index(:spree_pages, :slug)
   end
@@ -7,4 +9,3 @@ class AddIndexForPage < ActiveRecord::Migration
     remove_index(:spree_pages, :slug)
   end
 end
-

data/db/migrate/20091219021134_add_meta_fields_to_pages.rb

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

data/db/migrate/20100204105222_add_layout_to_pages.rb

@@ -1,4 +1,6 @@
-class AddLayoutToPages < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddLayoutToPages < SolidusSupport::Migration[4.2]
   def self.up
     add_column :spree_pages, :layout, :string
   end
@@ -6,4 +8,4 @@ class AddLayoutToPages < ActiveRecord::Migration
   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 @@
-class AddShowInSidebarOptionToPages < ActiveRecord::Migration
+# 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,4 +1,6 @@
-class AddMetaTitleToPage < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddMetaTitleToPage < SolidusSupport::Migration[4.2]
   def self.up
     add_column :spree_pages, :meta_title, :string
   end

data/db/migrate/20120723144115_add_render_as_partial_for_layout_for_spree_pages.rb

@@ -1,13 +1,15 @@
-class AddRenderAsPartialForLayoutForSpreePages < ActiveRecord::Migration
+# 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 < ActiveRecord::Migration
+# 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 < ActiveRecord::Migration
 
     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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class UpdateSpreePagePosition < SolidusSupport::Migration[4.2]
+  def up
+    return unless column_exists?(:spree_pages, :position)
+
+    change_column :spree_pages, :position, :integer, default: 0
+  end
+
+  def down
+    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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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
+
+      def collection
+        super.ordered_by_position
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spree
+  class StaticContentController < Spree::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
+
+      @taxonomies = Spree::Taxonomy.includes(root: :children)
+    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
+end

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

@@ -1,22 +1,52 @@
+# frozen_string_literal: true
+
 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/spree_static_content\n", before: /\*\//, verbose: true
+        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 'bundle exec rake 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]')
+        run_migrations = options[:auto_run_migrations] || ["", "y", "Y"].include?(ask("Would you like to run the migrations now? [Y/n]"))
         if run_migrations
-          run 'bundle exec rake db:migrate'
+          run "bin/rails db:migrate"
         else
-          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+          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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "solidus_core"
+require "solidus_support"
+
+module SolidusStaticContent
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name "solidus_static_content"
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    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
+  end
+end

data/lib/solidus_static_content/route_matcher.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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)+}
+
+    def self.matches?(request)
+      path = request.path_info
+
+      return false if EXCLUDED_PATHS.match? path
+
+      Spree::Page.visible.where(slug: path).exists?
+    end
+  end
+end

data/lib/solidus_static_content/testing_support/factories.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :page, class: Spree::Page do
+    sequence(:title) { |n| "Page #{n}" }
+    body { "This is the body of the page" }
+
+    sequence(:slug) { |n| "/page#{n}" }
+
+    trait :with_foreign_link do
+      foreign_link do
+        "http://example.com"
+      end
+    end
+
+    stores { [build(:store)] }
+  end
+end

data/lib/solidus_static_content/version.rb

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

data/lib/solidus_static_content.rb

@@ -1,21 +1,6 @@
-require 'solidus_core'
-require 'solidus_frontend'
-require 'solidus_backend'
-require 'deface'
-require 'spree_static_content/engine'
-require 'coffee_script'
-require 'sass/rails'
+# frozen_string_literal: true
 
-module StaticPage
-  def self.remove_spree_mount_point(path)
-    regex = Regexp.new '\A' + Rails.application.routes.url_helpers.spree_path
-    path.sub( regex, '').split('?')[0]
-  end
-end
-
-class Spree::StaticPage
-  def self.matches?(request)
-    return false if request.path =~ /(^\/+(admin|account|cart|checkout|content|login|pg\/|orders|products|s\/|session|signup|shipments|states|t\/|tax_categories|user)+)/
-    !Spree::Page.visible.find_by_slug(request.path).nil?
-  end
-end
+require "solidus_static_content/version"
+require "solidus_static_content/route_matcher"
+require "solidus_static_content/engine"
+require "deface"

data/lib/views/backend/spree/admin/pages/_form.html.erb

@@ -0,0 +1,119 @@
+<div data-hook='admin_page_form_fields'>
+  <div class='row'>
+    <div class='col-12'>
+      <%= f.field_container :title do %>
+        <%= f.label :title, class: 'required' %>
+        <%= f.text_field :title, required: true, class: 'fullwidth title' %>
+        <%= f.error_message_on :title %>
+      <% end %>
+    </div>
+
+    <div class='col-12'>
+      <%= f.field_container :slug do %>
+        <%= f.label :slug, class: 'required' %>
+        <%= f.text_field :slug, required: true, class: 'fullwidth title' %>
+        <%= f.error_message_on :slug %>
+      <% end %>
+    </div>
+
+    <div class='col-12'>
+      <%= f.field_container :body do %>
+        <%= f.label :body, class: 'required' %>
+        <%= f.text_area :body, class: 'fullwidth', rows: 12 %>
+        <%= f.error_message_on :body %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='row'>
+    <div class='col-6'>
+      <%= f.field_container :layout do %>
+        <%= f.label :layout %>
+        <%= f.text_field :layout, class: 'fullwidth title' %>
+      <% end %>
+    </div>
+
+    <div class='col-6'>
+      <%= f.field_container :foreign_link do %>
+        <%= f.label :foreign_link %>
+        <%= f.text_field :foreign_link, class: 'fullwidth title' %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='row'>
+    <div class='col-2'>
+      <%= f.field_container :show_in_sidebar do %>
+        <%= f.check_box :show_in_sidebar %>
+        <%= f.label :show_in_sidebar %>
+      <% end %>
+    </div>
+
+    <div class='col-2'>
+      <%= f.field_container :show_in_header do %>
+        <%= f.check_box :show_in_header %>
+        <%= f.label :show_in_header %>
+      <% end %>
+    </div>
+
+    <div class='col-2'>
+      <%= f.field_container :show_in_footer do %>
+        <%= f.check_box :show_in_footer %>
+        <%= f.label :show_in_footer %>
+      <% end %>
+    </div>
+
+    <div class='col-2'>
+      <%= f.field_container :visible do %>
+        <%= f.check_box :visible %>
+        <%= f.label :visible %>
+      <% end %>
+    </div>
+
+    <div class='col-2'>
+      <%= f.field_container :render_layout_as_partial do %>
+        <%= f.check_box :render_layout_as_partial %>
+        <%= f.label :render_layout_as_partial %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='row'>
+    <div class='col-2'>
+      <%= f.field_container :stores do %>
+        <%= f.label :stores, t("spree.stores") %>
+        <br>
+        <% Spree::Store.all.each do |store| %>
+          <%= check_box_tag 'page[store_ids][]', store.id, @page.stores.include?(store) %>
+          <%= label_tag store.name %>
+        <% end %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='row'>
+    <div class='col-12'>
+      <%= f.field_container :meta_title do %>
+        <%= f.label :meta_title %>
+        <%= f.text_field :meta_title, class: 'fullwidth title' %>
+        <%= f.error_message_on :meta_title %>
+      <% end %>
+    </div>
+
+    <div class='col-12'>
+      <%= f.field_container :meta_keywords do %>
+        <%= f.label :meta_keywords %>
+        <%= f.text_field :meta_keywords, class: 'fullwidth title' %>
+        <%= f.error_message_on :meta_keywords %>
+      <% end %>
+    </div>
+
+    <div class='col-12'>
+      <%= f.field_container :meta_description do %>
+        <%= f.label :meta_description %>
+        <%= f.text_field :meta_description, class: 'fullwidth title' %>
+        <%= f.error_message_on :meta_description %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/lib/views/backend/spree/admin/pages/edit.html.erb

@@ -0,0 +1,32 @@
+<%= render 'spree/admin/shared/pages_tabs' %>
+
+<% admin_breadcrumb(link_to plural_resource_name(Spree::Page), spree.admin_pages_path) %>
+<% admin_breadcrumb(@page.title) %>
+
+<% content_for :page_title do %>
+  <%= t("spree.editing_page") %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_to t("spree.back_to_static_pages_list"), spree.admin_pages_path %>
+  </li>
+<% end %>
+
+<div data-hook='admin_page_edit_form_header'>
+  <%= render "spree/shared/error_messages", :target => @page %>
+</div>
+
+<%= form_for [:admin, @page], as: :page, url: admin_page_path(@page) do |f| %>
+  <fieldset class="no-border-top">
+    <%= render :partial => 'form', :locals => { :f => f } %>
+
+    <div class='clear'></div>
+
+    <div data-hook='admin_page_edit_form_buttons'>
+      <% if can?(:update, @page) %>
+        <%= render partial: 'spree/admin/shared/edit_resource_links' %>
+      <% end %>
+    </div>
+  </fieldset>
+<% end %>

data/lib/views/backend/spree/admin/pages/index.html.erb

@@ -0,0 +1,68 @@
+<%= render 'spree/admin/shared/pages_tabs' %>
+
+<% content_for :page_actions do %>
+  <% if can?(:create, Spree::Page) %>
+    <li>
+      <%= link_to t("spree.new_page"), new_object_url, icon: 'plus' %>
+    </li>
+  <% end %>
+<% end %>
+
+<% content_for :page_title do %>
+  <%= t("spree.static_pages") %>
+<% end %>
+
+<% if @pages.any? %>
+  <table class="index responsive sortable" id="listing_pages" data-hook data-sortable-link="<%= update_positions_admin_pages_url %>">
+    <colgroup>
+      <col style="width: 10%">
+      <col style="width: 40%">
+      <col style="width: 35%">
+      <col style="width: 10%">
+      <col style="width: 15%">
+    </colgroup>
+
+    <thead>
+      <tr data-hook="admin_pages_index_headers">
+        <th></th>
+        <th><%= Spree::Page.human_attribute_name(:title) %></th>
+        <th><%= t("spree.link") %></th>
+        <th><%= Spree::Page.human_attribute_name(:visible) %></th>
+        <th data-hook="admin_pages_index_header_actions" class="actions"></th>
+      </tr>
+    </thead>
+
+    <tbody class="ui-sortable">
+      <% @pages.each do |page| %>
+        <tr data-hook="admin_pages_index_rows" class="<%= cycle('odd', 'even') %>" id="<%= dom_id page %>">
+          <td>
+            <% if can?(:update_positions, Spree::StockLocation) %>
+              <span class='handle ui-sortable-handle'></span>
+            <% end %>
+          </td>
+          <td><%= page.title %></td>
+          <td><%= link_to page.link, page.link, :target => '_blank' %></td>
+          <td>
+            <span class='pill pill-<%= page.visible ? 'active' : 'inactive' %>'>
+              <%= t("spree.#{page.visible? ? :active : :inactive}") %>
+            </span>
+          </td>
+          <td data-hook="admin_pages_index_row_actions" class="actions" >
+            <% if can?(:update, page) %>
+              <%= link_to_edit page, no_text: true %>
+            <% end %>
+            <% if can?(:destroy, page) %>
+              <%= link_to_delete page, no_text: true %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="no-objects-found">
+    <%= render 'spree/admin/shared/no_objects_found',
+                resource: Spree::Page,
+                new_resource_url: new_object_url %>
+  </div>
+<% end %>