spina 0.6.28 → 0.6.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d874847b9c8b761461f3b0ab3c4632a7ad2d854c
-  data.tar.gz: f4a026808aa8f6ef78c9575b4f141849a53e67d4
+  metadata.gz: 1eb435c25584cb0604129c081ad90635b107807e
+  data.tar.gz: 0420712f69aafc5cc1280af2971c82376e91522e
 SHA512:
-  metadata.gz: 3a8984dd77b376cf34685f69dc623ee83f62b3548d69bc779fc4b681bde81da24c5ee72277e5654bf799e05cc26bdb48250cecdb5800d24c7bb3c3f6514176f6
-  data.tar.gz: 50f03bbdff8d10a23fcc53c6b02ce66a96c6681ccb7b8889ca7301f7a71eaaf0ab0465b925b9f930c87d83c60d6469be05a3fba2fa3135180f860c68379f1154
+  metadata.gz: c2a4546a4e1ac102109fb191aaea1e5f13ed7243a75729596583c56a9f815e65ce2add8a877e1ea614f2d0af8f816c384a3184017fee56a58e525f8e2f28eb45
+  data.tar.gz: 63c995ab4946074262c1b41eb88651b622c52c824f34fe3897d716f9cb4df7e74f9104c2d1a38487fce8438261479a301d140aea852bc1a9bb26b721faebf92a

data/README.md

@@ -1,3 +1,164 @@
-# Spina CMS
+![Spina CMS](http://www.denkwebsite.nl/spinacms.png)
 
-[![Code Climate](https://codeclimate.com/github/denkGroot/Spina/badges/gpa.svg)](https://codeclimate.com/github/denkGroot/Spina)
+[Visit the website](http://www.spinacms.com)
+
+[![Code Climate](https://codeclimate.com/github/denkGroot/Spina/badges/gpa.svg)](https://codeclimate.com/github/denkGroot/Spina) [![Test Coverage](https://codeclimate.com/github/denkGroot/Spina/badges/coverage.svg)](https://codeclimate.com/github/denkGroot/Spina/coverage) [ ![Codeship Status for denkGroot/Spina](https://codeship.com/projects/e13debf0-e6af-0132-8abf-32d84f3372de/status?branch=master)](https://codeship.com/projects/82322)
+
+# Getting Started
+
+Spina is a CMS built upon the Rails framework. This guide is designed for developers with experience using Ruby on Rails.
+
+To start using Spina CMS simply add the following lines to your Gemfile:
+
+```ruby
+gem 'spina-template'
+gem 'spina'
+```
+
+Make sure you run the installer to get started.
+
+    rails g spina:install
+
+The installer will help you setup your first user.
+
+Then start `rails s` and access your admin panel at `/admin`.
+
+# Basics
+
+The installer generates a few initializers that contain necessary configuration for Spina.
+
+In the initializers folder there's a new folder named `themes`. Inside you will find a configuration file named `default.rb`. This file contains all of your theme-specific settings. You can define multiple Page parts, Layout parts, View templates and Custom pages.
+
+## Page parts
+
+A page in Spina has many Page parts. By default these page parts can be one of the following:
+
+- `Spina::Line`
+- `Spina::Text`
+- `Spina::Photo`
+- `Spina::PhotoCollection`
+- `Spina::Color`
+- `Spina::Structure`
+
+These are the building blocks of your view templates. You can have an unlimited number of page parts in a page. We prefer to keep the number of parts to a minimum so that managing your pages won't become too complex.
+
+Spina uses an initializer to create the basic building blocks of your page. There are three steps to add a new building block or page part to your app:
+
+1. Set up a new page part in the initializer
+2. Set the new initializer into a view template
+3. Add it to the view
+
+#### Create a new page part
+When you install Spina, you will see the following in `config/initializers/themes/default.rb`
+
+```ruby
+module Spina
+  module DefaultTheme
+    include ::ActiveSupport::Configurable
+
+    config_accessor :title, :page_parts, :view_templates, :layout_parts, :custom_pages, :plugins, :structures
+
+    self.title = "Default theme"
+
+    self.page_parts = [{
+      name: 'content',
+      title: 'Content',
+      page_partable_type: "Spina::Text"
+    }]
+
+    self.structures = []
+    self.layout_parts = []
+    self.custom_pages = []
+    self.plugins = []
+
+    self.view_templates = {
+      'homepage' => {
+        title: 'Homepage',
+        page_parts: ['content']
+      },
+      'show' => {
+        title: 'Default',
+        description: 'A simple page',
+        usage: 'Use for your content',
+        page_parts: ['content']
+      }
+    }
+
+    self.custom_pages = [
+      { name: 'homepage', title: 'Homepage', deletable: false, view_template: 'homepage' }
+    ]
+  end
+end
+```
+
+Right now, the default theme is applying a title to the page, with a simple text div below it. Go to `/admin` on your app and have a look. Edit the textbox and go to preview the page.
+
+Spina represents each building block of your page, called a 'page part,' as a hash inside the `page_parts` array. If we look at the default setup we can see there is one hash inside the array representing the one textbox we see on our page.
+
+Let's say I wanted to add another text box below this called `portfolio`. First I would add another hash to the `self.page_parts` array like so:
+
+```ruby
+self.page_parts = [
+  { name: 'content', title: 'Content', page_partable_type: "Spina::Text" },
+  { name: 'portfolio', title: 'Portfolio', page_partable_type: "Spina::Text" } # added this second hash
+]
+```
+
+#### Add it to the view template
+
+Now, we need to update the `self.view_templates` hash next. These view templates provide customization for the different views you might want. For example, you may have a 'blog' view or an 'about' view which add different page parts. For this example we will add the portfolio part into the 'Default' view template.
+
+```ruby
+self.view_templates = {
+  'homepage' => {
+    title: 'Homepage',
+    page_parts: ['content']
+  },
+  'show' => {
+    title: 'Default',
+    description: 'A simple page',
+    usage: 'Use for your content',
+    page_parts: ['content', 'portfolio'] # added 'portfolio' here.
+  }
+}
+```
+
+#### Add it to the view
+
+Finally, let's go to `views/default/pages/show.html.erb` and add the following:
+
+```ruby
+<h1><%= @page.title %></h1>
+
+<%= @page.content(:content).try(:html_safe) %>
+<%= @page.content(:portfolio).try(:html_safe) %> # added this line
+```
+
+We have successfully added another textbox! Restart your server and load up the admin section again. You should see another text box below the content box.
+
+## Layout parts
+
+Sometimes you need editable content that's not specific to a view template but to your theme as a whole. You can use the following parts in your layout.
+
+- `Spina::Line`
+- `Spina::Color`
+
+## View templates
+
+Each theme typically has a few different view templates which make up your website. By default Spina generates a *homepage* and *show* template.
+
+The views for these templates are stored in `app/views/default/pages`.
+
+## Custom pages
+
+You can define custom pages for your theme that will be generated when bootstrapping your website. You can define whether or not they're deletable. By default Spina creates a custom page named Homepage which is not deletable.
+
+# License
+
+Spina is released under the [MIT license](LICENSE.md).
+
+# Credits
+
+Some parts of Spina are heavily influenced by the wonderful Refinery CMS. Credits to [the Refinery  team](http://www.refinerycms.com/about).
+
+All icons in Spina were made by Brent Jackson [Geomicons](http://jxnblk.com/geomicons-wired/).

data/app/assets/javascripts/spina/admin/account.js.coffee

@@ -12,4 +12,5 @@ $(document).on 'change', '.account-theme select', ->
 show_layout_parts = (layout_parts) ->
   $('tr.layout-part').hide()
   for layout_part in layout_parts
-    $('tr.layout-part[data-name=' + layout_part + ']').show()
+    if layout_part
+      $('tr.layout-part[data-name=' + layout_part + ']').show()

data/app/assets/javascripts/spina/admin/aviary.js.coffee

@@ -1,26 +1,24 @@
-featherEditor = new Aviary.Feather
-  apiKey: 'e7a5e1c28334eb7a',
-  apiVersion: 3,
-  theme: 'light',
-  language: 'nl',
-  minimumStyling: true,
-  tools: 'crop,enhance,contrast,sharpness,text,whiten,effects,warmth,orientation,brightness,saturation,redeye,blemish',
-  appendTo: '',
-  onSave: (imageID, newURL) ->
-    img = $('#' + imageID)
-    img.attr('src', newURL)
-    $.post(img.attr('data-posturl'), { new_image: newURL })
-  ,
-  onError: (errorObj) ->
-    alert(errorObj.message)
+$(document).ready ->
+  featherEditor = new Aviary.Feather
+    apiKey: $('body').attr('aviary_api_key'),
+    theme: 'dark',
+    language: $('body').attr('aviary_language'),
+    tools: 'crop,enhance,contrast,sharpness,text,whiten,effects,warmth,orientation,brightness,saturation,redeye,blemish',
+    onSave: (imageID, newURL) ->
+      img = $('#' + imageID)
+      img.attr('src', newURL)
+      $.post(img.attr('data-posturl'), { new_image: newURL })
+    ,
+    onError: (errorObj) ->
+      alert(errorObj.message)
 
-launchEditor = (id, src) ->
-  featherEditor.launch
-    image: id,
-    url: src
-  return false
+  launchEditor = (id, src) ->
+    featherEditor.launch
+      image: id,
+      url: ($('body').attr('ngrok_address') + src)
+    return false
 
-$(document).on 'click', '[data-aviary]', (e) ->
-  e.preventDefault()
-  image = $(this).parents('.item').find('img')
-  return launchEditor(image.attr('id'), image.attr('data-image'))
+  $(document).on 'click', '[data-aviary]', (e) ->
+    e.preventDefault()
+    image = $(this).parents('.item').find('img')
+    return launchEditor(image.attr('id'), image.attr('data-image'))

data/app/assets/javascripts/spina/admin/{confirm_delete.js.coffee → confirm_delete.js.coffee.erb}

@@ -5,7 +5,7 @@ $.rails.allowAction = (element) ->
 
   $link = element.clone().removeAttr('data-confirm').removeAttr('data-icon').removeAttr('class')
   $link.addClass('primary')
-  $link.html('<i class="icon icon-check"></i> Ja, dat weet ik zeker')
+  $link.html("<i class='icon icon-check'></i> <%= I18n.t('spina.modal.agree') %>")
 
   modal_html = """
               <div id="modal" class="modal"><header class="big-header">
@@ -14,7 +14,7 @@ $.rails.allowAction = (element) ->
               </header>
 
               <footer>
-                <a href="#" data-dismiss="modal">Nee, annuleren</a>
+                <a href="#" data-dismiss="modal"><%= I18n.t('spina.modal.cancel') %></a>
               </footer></div>
                """
 

data/app/controllers/spina/admin/accounts_controller.rb

@@ -26,6 +26,10 @@ module Spina
         add_breadcrumb I18n.t('spina.preferences.social_media'), spina.social_admin_account_path
       end
 
+      def aviary
+        add_breadcrumb I18n.t('spina.preferences.aviary'), spina.aviary_admin_account_path
+      end
+
       def style
         add_breadcrumb I18n.t('spina.preferences.style'), spina.style_admin_account_path
         @themes = ::Spina.themes
@@ -38,6 +42,7 @@ module Spina
         params.require(:account).permit(:address, :city, :email, :logo, :name, :phone, 
                                         :postal_code, :preferences, :google_analytics, 
                                         :google_site_verification, :facebook, :twitter, :google_plus, 
+                                        :aviary_api_key, :aviary_language, :ngrok_address, 
                                         :kvk_identifier, :theme, :vat_identifier, :robots_allowed, 
                                         layout_parts_attributes: 
                                           [:id, :layout_partable_type, :layout_partable_id, 

data/app/controllers/spina/application_controller.rb

@@ -1,5 +1,7 @@
 module Spina
   class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+    
     include ApplicationHelper
 
     private

data/app/controllers/spina/inquiries_controller.rb

@@ -1,7 +1,7 @@
 module Spina
   class InquiriesController < ApplicationController
 
-    before_filter :setup_negative_captcha, :only => [:create]
+    before_filter :setup_negative_captcha, only: [:create]
 
     def create
       @inquiry = Inquiry.new(@captcha.values)

data/app/controllers/spina/pages_controller.rb

@@ -22,26 +22,26 @@ module Spina
 
     private
 
-    def page
-      @page ||= (action_name == 'homepage') ? Page.find_by(name: 'homepage') : Page.find(params[:id])
-    end
-    helper_method :page
+      def page
+        @page ||= (action_name == 'homepage') ? Page.find_by(name: 'homepage') : Page.find(params[:id])
+      end
+      helper_method :page
 
-    def current_user_can_view_page?
-      raise ActiveRecord::RecordNotFound unless page.live? || current_user.present?
-    end
+      def current_user_can_view_page?
+        raise ActiveRecord::RecordNotFound unless page.live? || current_user.present?
+      end
 
-    def should_skip_to_first_child?
-      page.skip_to_first_child && first_live_child
-    end
+      def should_skip_to_first_child?
+        page.skip_to_first_child && first_live_child
+      end
 
-    def first_live_child
-      page.children.sorted.live.first
-    end
+      def first_live_child
+        page.children.sorted.live.first
+      end
 
-    def render_with_template(page)
-      render layout: "#{current_theme.to_s.underscore}/application", template: "#{current_theme.to_s.underscore}/pages/#{page.view_template || 'show'}"
-    end
+      def render_with_template(page)
+        render layout: "#{current_theme.to_s.underscore}/application", template: "#{current_theme.to_s.underscore}/pages/#{page.view_template || 'show'}"
+      end
 
   end
 end

data/app/models/spina/account.rb

@@ -66,7 +66,7 @@ module Spina
       end
     end
 
-    serialized_attr_accessor :google_analytics, :google_site_verification, :facebook, :twitter, :google_plus, :theme
+    serialized_attr_accessor :google_analytics, :google_site_verification, :facebook, :twitter, :google_plus, :theme, :aviary_api_key, :aviary_language, :ngrok_address
 
   end
 end

data/app/uploaders/spina/file_uploader.rb

@@ -2,55 +2,13 @@
 module Spina
   class FileUploader < CarrierWave::Uploader::Base
 
-    # Include RMagick or MiniMagick support:
-    # include CarrierWave::RMagick
-    # include CarrierWave::MiniMagick
-
-    # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
-    # include Sprockets::Helpers::RailsHelper
-    # include Sprockets::Helpers::IsolatedHelper
-
-    # Choose what kind of storage to use for this uploader:
-    storage :file
-    # storage :fog
-
-    # Override the directory where uploaded files will be stored.
-    # This is a sensible default for uploaders that are meant to be mounted:
     def store_dir
-      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      if Engine.config.storage == :s3
+        "#{mounted_as}/#{model.id}"
+      else
+        "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      end
     end
 
-    # Provide a default URL as a default if there hasn't been a file uploaded:
-    # def default_url
-    #   # For Rails 3.1+ asset pipeline compatibility:
-    #   # asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
-    #
-    #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
-    # end
-
-    # Process files as they are uploaded:
-    # process :scale => [200, 300]
-    #
-    # def scale(width, height)
-    #   # do something
-    # end
-
-    # Create different versions of your uploaded files:
-    # version :thumb do
-    #   process :scale => [50, 50]
-    # end
-
-    # Add a white list of extensions which are allowed to be uploaded.
-    # For images you might use something like this:
-    # def extension_white_list
-    #   %w(jpg jpeg gif png)
-    # end
-
-    # Override the filename of the uploaded files:
-    # Avoid using model.id or version_name here, see uploader/store.rb for details.
-    # def filename
-    #   "something.jpg" if original_filename
-    # end
-
   end
 end

data/app/uploaders/spina/logo_uploader.rb

@@ -3,50 +3,21 @@
 module Spina
   class LogoUploader < CarrierWave::Uploader::Base
 
-    # Include RMagick or MiniMagick support:
-    # include CarrierWave::RMagick
     include CarrierWave::MiniMagick
 
-    # Choose what kind of storage to use for this uploader:
-    storage :file
-    # storage :fog
-
-    # Override the directory where uploaded files will be stored.
-    # This is a sensible default for uploaders that are meant to be mounted:
     def store_dir
-      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      if Engine.config.storage == :s3
+        "#{mounted_as}/#{model.id}"
+      else
+        "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      end
     end
 
-    # Provide a default URL as a default if there hasn't been a file uploaded:
-    # def default_url
-    #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
-    # end
-
-    # Process files as they are uploaded:
-    # process :scale => [200, 300]
-    #
-    # def scale(width, height)
-    #   # do something
-    # end
-
-    # Create different versions of your uploaded files:
-    # version :thumb do
-    #   process :scale => [50, 50]
-    # end
-
     process resize_to_fit: [300, 300]
 
-    # Add a white list of extensions which are allowed to be uploaded.
-    # For images you might use something like this:
     def extension_white_list
       %w(jpg jpeg gif png)
     end
 
-    # Override the filename of the uploaded files:
-    # Avoid using model.id or version_name here, see uploader/store.rb for details.
-    # def filename
-    #   "something.jpg" if original_filename
-    # end
-
   end
 end