tb_cms 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c344bf641663acb745ec63487f3bc3991bdeff
-  data.tar.gz: 04187a4e8221bb57b592cb6cc164939267ab87ee
+  metadata.gz: 2989c1cf4dd02e1dd82aa3d0e44943ab0459bfd9
+  data.tar.gz: 488799900f0342b2fba67d8ccb87fb1f1dfeff4f
 SHA512:
-  metadata.gz: 3b375f04f8021e21612a92982a3d5fa2b6242b874fe3f8826959b9be29b4ac5d7684cac3c7a9b23feb771c5e107aa9d335cad324c8b05823e722c7c9776bd29f
-  data.tar.gz: faa30c0d60fbe576157f9f09f51aa10a709405c170d781e7bf4a902bd0c0168771b291ddddd9cb92a7b5dbc1a130644a52609e38bc045d163bd86f333e02b4ec
+  metadata.gz: e99c51f09cc14b669e335baee58243d602a514eec2ed15c83539bc672097559253012917722c478f3c36fe8556fcfec93231cfa4e78542b66404a0d31057fc1d
+  data.tar.gz: 176da5b738c8e3838609b50a336178c6e28fd3bf45296a67cd993bb9e569afc01a99bab9addfa5bd492c2ef5ad5f1609c7ca56aaa61c9e1a58444e07f47d691b

data/README.md

@@ -0,0 +1,107 @@
+# TB CMS
+
+TB CMS is a content managment engine intended for use with Rails and [Twice Baked](https://bitbucket.org/westlakedesign/tb_core/).
+
+## Installation
+
+First, it is recommended you run the steps listed in the "Installation/Usage" section of the [TB Core](https://bitbucket.org/westlakedesign/tb_core/) README file. Then, perform the following steps:
+
+1. Add the following to your Gemfile
+
+        gem 'tb_cms'
+
+2. Run bundle install
+3. Copy in database migrations to your new rails project
+
+        bundle exec rake railties:install:migrations
+        rake db:migrate
+
+4. Restart your application
+
+## Configuration
+
+TB CMS accepts the following configuration options.
+
+    Spud::Cms.configure do |config|
+      config.menus_enabled = true
+    end
+
+## Defining Layouts
+
+By default, CMS pages will use your standard `application.html.erb` layout. Chances are you will eventually want to specify different layouts for different pages. This is where page layouts come in handy.
+
+A page layout is essentially a plain old Rails layout file with a little bit of metadata inserted at the top. The following example defines a layout with two content blocks, Left and Right.
+
+    <%
+    #template_name: Two Column
+    #html: Left
+    #html: Right
+    %>
+    <div class="left">
+      <%= yield :left %>
+    </div>
+    <div class="right">
+      <%= yield :right %>
+    </div>
+
+You may also use the `spud:cms:layout` generator to quickly generate a layout file.
+
+    rails g spud:cms:layout two_column left right
+
+## Layout Actions
+
+Layout actions provide a mechanism for running custom Ruby code when a given layout is hit. For example, suppose you have an `About` layout that needs to show an array of `Employee` records. Let's also imagine you want to show a different list of employees for `get` and `post` requests.
+
+Create a controller concern at `app/controllers/concerns/spud_cms_layout_actions.rb` with the following code.
+
+    module SpudCmsLayoutActions
+      extend ActiveSupport::Concern
+
+      def about_action(method)
+        if method == :post
+          @employees = Employee.where(:secret_agent => true).order('first_name asc')
+        else
+          @employees = Employee.where(:is_cool => true).order('first_name asc')
+        end  
+      end
+
+    end
+
+If you ran the `spud:cms:layout` generator described earlier, the concern and empty action would have been created for you automatically.
+
+## Using Liquid Templates
+
+Pages use the [liquid](https://github.com/Shopify/liquid) template syntax engine created by Shopify. This allows you to easily inject variables into your pages in the page editor. Example:
+
+    <h2>{{page.name}}</h2>
+
+## Using Menus
+
+A lot of cms engines allow you to render your navigation links in a ul block by using your page tree structure. In a lot of cases this is insufficient as some sites have urls that redirect to pages outside of your cms. This is where menus come in. They can be built in the admin control panel.
+In your application layout file or any erb template you can render a ul block like so
+
+    <%= sp_list_menu({:id => "navigation",:name => "Main"}) %>
+
+This will output a <ul id="navigation"></ul> block for the menu you created in admin named "Main"
+
+## Testing
+
+TB CMS uses RSpec for testing. Get the tests running with a few short commands:
+
+1. Create and migrate the databases:
+
+        rake db:create
+        rake db:migrate
+
+2. Load the schema in to the test database:
+
+        rake app:db:test:prepare
+
+3. Run the tests with RSpec
+
+        rspec spec
+
+After the tests have completed the current code coverage stats is available by opening ```/coverage/index.html``` in a browser.
+
+
+

data/app/controllers/concerns/spud_cms_layout_actions.rb

@@ -0,0 +1,4 @@
+module SpudCmsLayoutActions
+  extend ActiveSupport::Concern
+
+end

data/app/controllers/pages_controller.rb

@@ -1,4 +1,5 @@
 class PagesController < ApplicationController
+	include SpudCmsLayoutActions
 
 	respond_to :html
 	before_filter :set_default_content_type
@@ -61,9 +62,12 @@ class PagesController < ApplicationController
 
 		layout = @page.layout || layout
 
+		action_name = "#{layout}_action"
+		if respond_to?(action_name)
+			send(action_name, request.method.downcase.to_sym)
+		end
 
 		render :layout => layout
-
 	end
 
 private

data/app/helpers/cms/application_helper.rb

@@ -82,6 +82,7 @@ module Cms::ApplicationHelper
 	end
 
   def sp_list_menu(options = {})
+    options[:path] = request.original_fullpath
 
     if !options.has_key?(:name)
       logger.debug 'sp_list_menu require a :name option'

data/lib/generators/spud/cms/layout_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/migration'
+
+class Spud::Cms::LayoutGenerator < ::Rails::Generators::Base
+  desc "This generator creates a new spud cms layout file"
+  argument :template_name, :type => :string
+  argument :attributes, :type => :array, :default => [], :banner => "content_block content_block"
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_layout
+    template "layout.html.erb", "app/views/layouts/#{template_name.downcase.underscore}.html.erb"
+  end
+
+  def create_layout_action
+    concern_path = 'app/controllers/concerns/spud_cms_layout_actions.rb'
+    if !File.exist?(File.join(Rails.root, concern_path))
+      template 'layout_actions.rb', 'app/controllers/concerns/spud_cms_layout_actions.rb'
+    end
+    inject_into_file concern_path, :after => "extend ActiveSupport::Concern\n" do <<-HEREDOC
+
+  def #{template_name.downcase.underscore}_action(method)
+    # this action is called when the #{template_name} cms layout is used
+  end
+HEREDOC
+    end
+  end
+
+private
+
+  def concern_content
+
+  end
+
+end

data/lib/generators/spud/cms/templates/layout.html.erb

@@ -0,0 +1,18 @@
+<%%
+#template_name: <%=template_name.humanize.titlecase%>
+<%-attributes.each do |attribute|-%>
+<%="#html: #{attribute.humanize.titlecase}\n"-%>
+<%-end-%>
+%>
+
+<%% content_for :body do %>
+  <div class="layout-<%= template_name.downcase.underscore %>">
+    <% attributes.each do |attribute| %>
+    <div class="content-<%= attribute.downcase %>">
+      <%%= yield :<%=attribute.downcase.underscore%> %>
+    </div>
+    <% end %>
+  </div>
+<%% end %>
+
+<%%= render :template => '/layouts/application' %>

data/lib/generators/spud/cms/templates/layout_actions.rb

@@ -0,0 +1,4 @@
+module SpudCmsLayoutActions
+  extend ActiveSupport::Concern
+
+end

data/lib/spud_cms/template_parser.rb

@@ -119,7 +119,7 @@ module Spud
       end
 
       def engines
-        Rails::Application::Railties.engines
+        ::Rails::Engine.subclasses.map(&:instance)
       end
     end
   end

data/lib/spud_cms/version.rb

@@ -1,5 +1,5 @@
 module Spud
 	module Cms
-		VERSION = "1.1.2"
+		VERSION = "1.1.3"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tb_cms
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Westlake Design
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -186,13 +186,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - app/assets/images/spud/admin/menus_thumb.png
-- app/assets/images/spud/admin/menus_thumb@2x.png
 - app/assets/images/spud/admin/pages_thumb.png
 - app/assets/images/spud/admin/snippets_thumb.png
-- app/assets/images/spud/admin/snippets_thumb@2x.png
 - app/assets/javascripts/admin/cms/application.js
 - app/assets/javascripts/admin/cms/menu_items.js
 - app/assets/javascripts/admin/cms/pages.js
@@ -202,6 +200,7 @@ files:
 - app/controllers/admin/pages_controller.rb
 - app/controllers/admin/snippets_controller.rb
 - app/controllers/cms/sitemaps_controller.rb
+- app/controllers/concerns/spud_cms_layout_actions.rb
 - app/controllers/pages_controller.rb
 - app/helpers/cms/application_helper.rb
 - app/models/spud_menu.rb
@@ -262,8 +261,9 @@ files:
 - db/migrate/20121119025608_create_spud_snippets.rb
 - db/migrate/20121119030136_change_liquid_tags_to_polymorphic.rb
 - db/migrate/20140110142037_drop_spud_page_liquid_tags.rb
-- lib/generators/spud/cms/template_generator.rb
-- lib/generators/spud/cms/templates/template.html.erb
+- lib/generators/spud/cms/layout_generator.rb
+- lib/generators/spud/cms/templates/layout.html.erb
+- lib/generators/spud/cms/templates/layout_actions.rb
 - lib/spud_cms/configuration.rb
 - lib/spud_cms/engine.rb
 - lib/spud_cms/liquid_snippet.rb

data/README.markdown

@@ -1,110 +0,0 @@
-Spud CMS
-========
-
-Spud CMS is a CMS Engine designed to be robust, easy to use, and light weight.
-
-
-Installation/Usage
-------------------
-
-1. In your Gemfile add the following
-
-		gem 'tb_cms'
-
-2. Run bundle install
-3. Copy in database migrations to your new rails project
-
-		bundle exec rake railties:install:migrations
-		rake db:migrate
-4. Change ApplicationController to inherit from Spud::ApplicationController instead of ActionController::Base
-
-		class ApplicationController < Spud::ApplicationController
-
-5. run a rails server instance and point your browser to /spud/admin
-
-Routing to the CMS Engine
---------------------------
-Routing your home page to the CMS engine is fairly straight forward.
-in your applications application.rb file add a configure block as such
-
-
-		Spud::Cms.configure do |config|
-			config.menus_enabled = true
-			config.root_page_name = "home"
-		end
-
-
-
-Where "home" is the page name you wish to use.
-
-Pages will default render to the 'application' layout of your application. You can change this by using templates to specify base layouts.
-
-Defining Templates / Layouts
-----------------------------
-Spud CMS has recently changed its template structure. The admin templates area is no longer with us. In Spud CMS templates are defined similar to how an asset pipeline manifest is defined. At the top of your layout files a series of comments can be used to define the name of the template, and the content_for blocks that are editable by the user.
-
-Example:
-
-    <%
-    #template_name: 2 Column Page
-    #html: Left
-    #html: Right
-    %>
-
-Optionally a description can be passed as well as a `site_name: default` for multisite mode.
-
-
-Using Liquid Template Engine
-----------------------------
-Spud CMS utilizes the liquid template syntax engine created by Shopify. This allows you to easily inject variables into your pages in the page editor. Example:
-
-    <h2>{{page.name}}</h2>
-
-Using Menus
------------
-A lot of cms engines allow you to render your navigation links in a ul block by using your page tree structure. In a lot of cases this is insufficient as some sites have urls that redirect to pages outside of your cms. This is where menus come in. They can be built in the spud admin control panel.
-In your application layout file or any erb template you can render a ul block like so
-
-    <%=sp_list_menu({:id => "navigation",:name => "Main"})%>
-
-This will output a <ul id="navigation"></ul> block for the menu you created in admin named "Main"
-
-Adding Your Own Engines
------------------------
-
-Creating a rails engine that ties into spud admin is fairly straight forward
-In your new engine add spud_admin as a dependency and create an initializer inside your engine class as such:
-
-		initializer :admin do
-			Spud::Core.configure do |config|
-			config.admin_applications += [{:name => "Pages",:thumbnail => "spud/admin/pages_thumb.png",:url => "/spud/admin/pages",:order => 0}]
-
-			end
-		end
-
-You can use the layouts provided with spud admin by using 'spud/admin/application' or 'spud/admin/detail' layouts
-
-When creating controllers for the admin panel create them in the Admin Namespace and have them extend Admin::ApplicationController for automatic user authentication restrictions.
-
-Testing
------------------
-
-Spud uses RSpec for testing. Get the tests running with a few short commands:
-
-1. Create and migrate the databases:
-
-        rake db:create
-        rake db:migrate
-
-2. Load the schema in to the test database:
-
-        rake app:db:test:prepare
-
-3. Run the tests with RSpec
-
-        rspec spec
-
-After the tests have completed the current code coverage stats is available by opening ```/coverage/index.html``` in a browser.
-
-
-

data/lib/generators/spud/cms/template_generator.rb

@@ -1,17 +0,0 @@
-require 'rails/generators/migration'
-
-class Spud::Cms::TemplateGenerator < ::Rails::Generators::Base
-  desc "This generator creates a new spud cms layout file"
-  argument :template_name, :type => :string
-  argument :attributes, :type => :array, :default => [], :banner => "content_block content_block"
-
-  source_root File.expand_path('../templates', __FILE__)
-
-  def create_module
-    template "template.html.erb", "app/views/layouts/#{template_name.downcase.underscore}.html.erb"
-  end
-
-private
-
-
-end

data/lib/generators/spud/cms/templates/template.html.erb

@@ -1,28 +0,0 @@
-<%%
-#template_name: <%=template_name.humanize.titlecase%>
-<%-attributes.each do |attribute|-%>
-<%="#html: #{attribute.humanize.titlecase}\n"-%>
-<%-end-%>
-%>
-
-<!DOCTYPE html>
-<html>
-<head>
-  <title><%%=content_for?(:title) ? yield(:title) : Spud::Core.site_name%></title>
-  <%%= stylesheet_link_tag    "application", :media => "all" %>
-  <%%= javascript_include_tag "application" %>
-  <%%= csrf_meta_tags %>
-  <%%= yield :head%>
-</head>
-<body>
-
-<%attributes.each do |attribute|%>
-  <%if(attribute.downcase == 'body')%>
-    <%%=yield%>
-  <%else%>
-    <%%=yield :<%=attribute.downcase.underscore%>%>
-  <%end%>
-<%end%>
-
-</body>
-</html>