solidus_static_content 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4fb012c97e50d28d83c4efce564265f2fdb538f7
+  data.tar.gz: d159565b4f4ea4a7a883ce4378fa1a4b35f6d21f
+SHA512:
+  metadata.gz: a814032d5eab0fab3c699c1169864a59c8d48a8438d21eaa1115d6064444adc59ca8c103990f81002cb638ddeb8b7f37b37652a7ba814e9b68cbd2b8f5f70af8
+  data.tar.gz: 3624ace3e06d964c27007cce8e50527c29e50e1ae7069fef94b10151538adb6e76614a3881a0c05d5b44a1e46b730637b402466797a4f27374787b42a244c2ba

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+nbproject
+**.gem
+Gemfile.lock
+spec/dummy/
+.rvmrc
+tmp
+coverage
+.bundle

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format
+progress

data/.travis.yml

@@ -0,0 +1,21 @@
+before_script:
+  - "bundle exec rake test_app"
+script: "bundle exec rspec spec"
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=master DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql
+    - SOLIDUS_BRANCH=master DB=mysql

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org/'
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+end
+
+gem 'pg'
+gem 'mysql2'
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard "rspec", cmd: "bundle exec rspec" do
+  watch("spec/spec_helper.rb")                        { "spec" }
+  watch("config/routes.rb")                           { "spec/controllers" }
+  watch("app/controllers/application_controller.rb")  { "spec/controllers" }
+  watch(%r{^spec/(.+)_spec\.rb$})                     { |m| "spec/#{m[1]}_spec.rb"}
+  watch(%r{^app/(.+)_decorator\.rb$})                 { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^(app|lib)/(.+)(\.rb|\.erb)$})             { |m| "spec/#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Peter Berkenbosch and contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,105 @@
+# Solidus Static Content
+
+[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_static_content.svg)](https://travis-ci.org/solidusio-contrib/solidus_static_content)
+
+A fork of the [Spree extension][1] for compatibility with [Solidus][7].
+
+Good, clean content management of pages for Spree. You can use this to:
+
+- Add and manage static pages such as an 'About' page.
+- Show a static page instead of existing dynamic pages such as the home page,
+  products pages, and taxon pages.
+
+## Basic Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'solidus_static_content', github: 'solidusio-contrib/solidus_static_content'
+```
+
+Run:
+
+```
+$ bundle install
+$ bundle exec rails g solidus_static_content:install
+```
+
+That's all!
+
+
+## HowTo
+
+Using the 'Pages' option in the admin tab, you can add static pages to your
+Spree install. The page content can be pulled directly from the database, be a
+separate layout file or rendered as a partial.
+
+In the admin tab, use the 'New page' option to create a new static page.
+
+The title, slug, body, and meta fields will replace their respective page
+elements on load. The title, slug and body element are all required fields.
+
+Body text provided without a layout / partial being specified will be loaded in
+the spree_application layout after it is pulled from the database.
+
+
+### Layout and Partial Rendering
+
+To render an entire page without the spree_application layout, specify a
+relative path to the layout file (eg.  `spree/layouts/layout_file_name`). This
+file will not be prefixed with an underscore as it is a layout, not a partial.
+
+To render a partial, specify the path in the layout file name and check the
+'Render layout as partial' option. The path specified in the layout area will
+not have an underscore, but it will be required in the filename.
+
+Also note the availability of the render_snippet helper which finds a page by
+its slug and renders the raw page body anywhere in your view.
+
+### Options
+
+Use the 'Show in' checkboxes to specify whether to display the page links in the
+header, footer or sidebar. The position setting alters the order in which they
+appear.
+
+Finally, toggle the visibility using the 'Visible' checkbox. If it is unchecked,
+the page will not be available.
+
+
+## Contributing
+
+In the spirit of [free software][2], **everyone** is encouraged to help improve
+this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][3]
+* by suggesting new features
+* by writing translations
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][3]
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+Copyright (c) 2014 [Peter Berkenbosch][4] and [contributors][5], released under the [New BSD License][6]
+
+[1]: https://github.com/spree-contrib/spree_static_content/
+[2]: http://www.fsf.org/licensing/essays/free-sw.html
+[3]: https://github.com/solidusio-contrib/solidus_static_content/issues
+[4]: https://github.com/peterberkenbosch
+[5]: https://github.com/solidusio-contrib/solidus_static_content/graphs/contributors
+[6]: ./LICENSE.md
+[7]: https://solidus.io/

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_static_content'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_static_content.js

@@ -0,0 +1 @@
+//= require spree/backend

data/app/assets/javascripts/spree/frontend/spree_static_content.js

@@ -0,0 +1 @@
+//= require spree/frontend

data/app/assets/stylesheets/spree/backend/spree_static_content.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/backend
+*/

data/app/assets/stylesheets/spree/frontend/spree_static_content.css

@@ -0,0 +1,7 @@
+/* Sidebar */
+nav#pages .pages-root {
+  text-transform: uppercase;
+  border-bottom: 1px solid rgb(217, 217, 219);
+  margin-bottom: 5px;
+  font-size: 14px;
+}

data/app/controllers/spree/admin/pages_controller.rb

@@ -0,0 +1,3 @@
+class Spree::Admin::PagesController < Spree::Admin::ResourceController
+  
+end

data/app/controllers/spree/static_content_controller.rb

@@ -0,0 +1,20 @@
+class Spree::StaticContentController < Spree::StoreController
+  rescue_from ActiveRecord::RecordNotFound, :with => :render_404
+
+  helper 'spree/products'
+  layout :determine_layout
+
+  def show
+    @page = Spree::Page.by_store(current_store).visible.find_by_slug!(request.path)
+  end
+
+  private
+    def determine_layout
+      return @page.layout if @page and @page.layout.present? and not @page.render_layout_as_partial?
+      Spree::Config.layout
+    end
+
+    def accurate_title
+      @page ? (@page.meta_title.present? ? @page.meta_title : @page.title) : nil
+    end
+end

data/app/helpers/spree/pages_helper.rb

@@ -0,0 +1,6 @@
+module Spree::PagesHelper
+  def render_snippet(slug)
+    page = Spree::Page.find_by_slug(slug)
+    raw page.body if page
+  end
+end

data/app/models/spree/page.rb

@@ -0,0 +1,54 @@
+class Spree::Page < ActiveRecord::Base
+  default_scope -> { order("position ASC") }
+
+  has_and_belongs_to_many :stores, :join_table => 'spree_pages_stores'
+
+  validates_presence_of :title
+  validates_presence_of [:slug, :body], :if => :not_using_foreign_link?
+  validates_presence_of :layout, :if => :render_layout_as_partial?
+
+  validates :slug, :uniqueness => true, :if => :not_using_foreign_link?
+  validates :foreign_link, :uniqueness => true, :allow_blank => true
+
+  scope :visible, -> { where(:visible => true) }
+  scope :header_links, -> { where(:show_in_header => true).visible }
+  scope :footer_links, -> { where(:show_in_footer => true).visible }
+  scope :sidebar_links, -> { where(:show_in_sidebar => true).visible }
+
+  scope :by_store, lambda { |store| joins(:stores).where("spree_pages_stores.store_id = ?", store) }
+
+  before_save :update_positions_and_slug
+
+  def initialize(*args)
+    super(*args)
+
+    last_page = Spree::Page.last
+    self.position = last_page ? last_page.position + 1 : 0
+  end
+
+  def link
+    foreign_link.blank? ? slug : foreign_link
+  end
+
+private
+
+  def update_positions_and_slug
+    # ensure that all slugs start with a slash
+    slug.prepend('/') if not_using_foreign_link? and not slug.start_with? '/'
+
+    unless new_record?
+      return unless prev_position = Spree::Page.find(self.id).position
+      if prev_position > self.position
+        Spree::Page.where("? <= position AND position < ?", self.position, prev_position).update_all("position = position + 1")
+      elsif prev_position < self.position
+        Spree::Page.where("? < position AND position <= ?", prev_position,  self.position).update_all("position = position - 1")
+      end
+    end
+
+    true
+  end
+
+  def not_using_foreign_link?
+    foreign_link.blank?
+  end
+end

data/app/overrides/pages_in_footer.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/shared/_footer",
+                     :name => "pages_in_footer",
+                     :insert_bottom => "#footer-right",
+                     :partial => "spree/static_content/static_content_footer",
+                     :disabled => false)

data/app/overrides/pages_in_header.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/shared/_main_nav_bar",
+                     :name => "pages_in_header",
+                     :insert_bottom => "#main-nav-bar",
+                     :partial => "spree/static_content/static_content_header",
+                     :disabled => false)

data/app/overrides/pages_in_menu.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_menu",
+                     :name => "static_content_pages_admin_tab",
+                     :insert_bottom => "[data-hook='admin_tabs']",
+                     :text => "<%= tab(:pages, label: 'Pages', icon: 'file-text') %>",
+                     :disabled => false)

data/app/overrides/pages_in_sidebar.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/shared/_sidebar",
+                     :name => "pages_in_sidebar",
+                     :insert_bottom => "#sidebar",
+                     :partial => "spree/static_content/static_content_sidebar",
+                     :disabled => false)

data/app/views/spree/admin/pages/_form.html.erb

@@ -0,0 +1,98 @@
+<div data-hook="admin_page_form_fields">
+  <div class="left eight columns alpha" data-hook="admin_page_form_left">
+
+    <%= f.field_container :title do %>
+      <%= f.label :title %> <span class="required">*</span><br />
+      <%= f.text_field :title, :class => 'fullwidth title' %>
+      <%= f.error_message_on :title %>
+    <% end %>
+
+    <%= f.field_container :slug do %>
+      <%= f.label :slug %> <span class="required">*</span><br />
+      <%= f.text_field :slug, :class => 'fullwidth title' %>
+      <%= f.error_message_on :slug %>
+    <% end %>
+
+    <%= f.field_container :body do %>
+      <%= f.label :body %> <span class="required">*</span><br />
+      <%= f.text_area :body, {rows: 12, :class => 'fullwidth'} %>
+      <%= f.error_message_on :body %>
+    <% end %>
+
+  </div>
+  <div class="right four columns omega" data-hook="admin_page_form_right">
+
+    <%= f.field_container :layout do %>
+      <%= f.label :layout %><br />
+      <%= f.text_field :layout, :class => 'fullwidth title' %>
+    <% end %>
+
+    <%= f.field_container :foreign_link do %>
+      <%= f.label :foreign_link %><br />
+      <%= f.text_field :foreign_link, :class => 'fullwidth title' %>
+    <% end %>
+
+    <%= f.field_container :position do %>
+      <%= f.label :position %><br />
+      <%= f.number_field :position, :min => 0, :class => 'fullwidth title' %>
+    <% end %>
+
+    <%= f.field_container :show_in_sidebar do %>
+      <%= f.check_box :show_in_sidebar %>
+      <%= f.label :show_in_sidebar %>
+    <% end %>
+
+    <%= f.field_container :show_in_heade do %>
+      <%= f.check_box :show_in_header %>
+      <%= f.label :show_in_header %>
+    <% end %>
+
+    <%= f.field_container :show_in_footer do %>
+      <%= f.check_box :show_in_footer %>
+      <%= f.label :show_in_footer %>
+    <% end %>
+
+    <%= f.field_container :visible do %>
+      <%= f.check_box :visible %>
+      <%= f.label :visible %>
+    <% end %>
+
+    <%= f.field_container :render_layout_as_partial do %>
+      <%= f.check_box :render_layout_as_partial %>
+      <%= f.label :render_layout_as_partial %>
+    <% end %>
+
+    <%= f.field_container :stores do %>
+      <%= f.label :stores, Spree.t(:stores)%><br />
+      <% Spree::Store.all.each do |store| %>
+        <%= check_box_tag "page[store_ids][]", store.id, @page.stores.include?(store) %> <%= store.name %>
+      <% end %>
+    <% end %>
+    
+  </div>
+
+  <div data-hook="admin_page_form_meta" class="alpha omega twelve columns">
+
+    <%= f.field_container :meta_title do %>
+      <%= f.label :meta_title %><br />
+      <%= f.text_field :meta_title, :class => 'fullwidth title' %>
+      <%= f.error_message_on :meta_title %>
+    <% end %>
+
+    <%= f.field_container :meta_keywords do %>
+      <%= f.label :meta_keywords %><br />
+      <%= f.text_field :meta_keywords, :class => 'fullwidth title' %>
+      <%= f.error_message_on :meta_keywords %>
+    <% end %>
+
+    <%= f.field_container :meta_description do %>
+      <%= f.label :meta_description %><br />
+      <%= f.text_field :meta_description, :class => 'fullwidth title' %>
+      <%= f.error_message_on :meta_description %>
+    <% end %>
+
+  </div>
+  <div class="clear"></div>
+  <div data-hook="admin_page_form_additional_fields"></div>
+  <div class="clear"></div>
+</div>