puffer_pages 0.0.6 → 0.0.7

data/README.md

@@ -1,10 +1,10 @@
-# Puffer pages is lightweight rails 3 CMS
+# Puffer_pages is lightweight rails 3 CMS
 
 Interface of pages based on [puffer](https://github.com/puffer/puffer)
 
 ## Keyfeatures
 
-* Full rails integration. Puffer pages is part of rails and you can different features related to pages in rails application directly
+* Full rails integration. Puffer_pages is part of rails and you can different features related to pages in rails application directly
 * Flexibility. Puffer designed to be as flexible as possible, so you can create your own functionality easily.
 * Layouts. You can use rails layouts for pages and you can use pages as action layouts!
 
@@ -16,7 +16,7 @@ Or in Gemfile:
 <pre>gem "puffer_pages"</pre>
 Next step is:
 <pre>rails g puffer_pages:install</pre>
-This will install puffer pages config file in your initializers, some css/js, controllers and migrations
+This will install puffer_pages config file in your initializers, some css/js, controllers and migrations
 <pre>rake db:migrate</pre>
 
 To start working with admin interface, you need to have some routes like:
@@ -35,22 +35,40 @@ Just put in your routes.rb:
 <pre>puffer_page "pages/(*path)" => 'whatever#show'</pre>
 Default pages route you can see with rake routes.
 
-Puffer pages is radiant-like cms, so it has layouts, snippets and pages.
-Puffer pages use liquid as template language.
+Puffer_pages is radiant-like cms, so it has layouts, snippets and pages.
+Puffer_pages use liquid as template language.
 
 ## Pages.
 Pages - tree-based structure of site.
 Every page has one or more page parts.
+Every page part must have main page part, named by default `body`. You can configure main page part name in config/initializers/puffer_pages.rb
 
 ## Layouts.
 Layout is page canvas, so you can draw page parts on it.
-In puffer pages you can use puffer pages layouts or applcation layouts.
+You can use layouts from database or applcation for pages.
 
-### Puffer pages layouts
-For puffer pages layouts page parts placeholder is liquid tag yield.
+### Application layouts.
+For application layout page part body will be inserted instead of SUDDENLY! <%= yield %>
+Rules are the same. If no page part name specified puffer will use page part with default name.
+See `yield` liquid tag reference
+
+So, main page part is action view and other are partials. So easy.
+
+## [Liquid](http://github.com/tobi/liquid/).
+
+### Variables.
+This variables accessible from every page:
+* self - current page reference.
+<pre>{{ self.name }}</pre>
+* root - root page reference.
+<pre>{{ root.name }}</pre>
+Both `self` and `root` are instances of page drop. View [this](https://github.com/puffer/puffer_pages/blob/master/lib/puffer_pages/liquid/page_drop.rb) to find list of possible page drop methods
+
+### yield
 <pre>{% yield [page_part_name] %}</pre>
+`yield` tag is page part or actionview `content_for` placeholder.
 
-If no page_part_name specified, puffer layout will use page part with default name ('body'). You can change defaul page part name in puffer pages setup initializer.
+If no page_part_name specified, puffer layout will use page part with default name ('body'). You can change defaul page part name in puffer_pages setup initializer.
 
 Ex.
 <pre>
@@ -60,21 +78,14 @@ Ex.
   {% yield sb %} # renders sidebar too
 </pre>
 
-### Application layouts.
-For application layout page part body will be inserted instead of SUDDENLY! <%= yield %>
-Rules are the same. If no page part name specified puffer will use page part with default name.
-
-So, main page part is action view and other are partials. So easy.
-
-## Liquid.
+### render_snippet
+<pre>{% render_snippet snippet_name %}</pre>
+Renders specified snippet`s content.
 
-The first tag was {% yield %}
-Also, you can acces current page and root page from puffer pages templates.
-Page named `self` in templates:
-<pre>{{ self.name }}</pre>
-And root page:
-<pre>{{ root.name }}</pre>
-
-Also you can do anything you can do with [liquid](http://github.com/tobi/liquid/)
+Ex.
+<pre>
+  {% render_snippet 'navigation' %}
+  {% assign nav = 'navigation' %}
+  {% render_snippet nav %}
+</pre>
 
-`self` and `root` are both instances of page drop. View [this](https://github.com/puffer/puffer_pages/blob/master/lib/puffer_pages/liquid/page_drop.rb) to find list of possible page drop methods

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/app/models/page_part.rb

@@ -4,8 +4,6 @@ class PagePart < ActiveRecord::Base
   validates_presence_of :name
   validates_uniqueness_of :name, :scope => :page_id
 
-  attr_accessor_with_default :additional, false
-
   def render(drops_or_context, wrap = false)
     template = Liquid::Template.parse(body)
     result = tracker.cleanup template.render(drops_or_context, :registers => {:tracker => tracker})

data/app/models/snippet.rb

@@ -1,4 +1,14 @@
 class Snippet < ActiveRecord::Base
   validates_presence_of :name
   validates_uniqueness_of :name
+
+  def render(drops_or_context)
+    template = Liquid::Template.parse(body)
+    tracker.cleanup template.render(drops_or_context, :registers => {:tracker => tracker})
+  end
+
+  def tracker
+    @tracker ||= PufferPages::Liquid::Tracker.new
+  end
+
 end

data/lib/puffer_pages/liquid/tags/render_snippet.rb

@@ -0,0 +1,33 @@
+module PufferPages
+  module Liquid
+    module Tags
+
+      class RenderSnippet < ::Liquid::Tag
+        Syntax = /(#{::Liquid::QuotedFragment}+)/
+
+        def initialize(tag_name, markup, tokens)
+          if markup =~ Syntax
+            @name = $1
+          else
+            raise SyntaxError.new("Syntax Error in 'render_snippet' - Valid syntax: render_snippet snipper_name")
+          end
+
+          super
+        end
+
+        def render(context)
+          name = context[@name]
+          snippet = Snippet.find_by_name(name)
+          if snippet
+            snippet.render(context)
+          else
+            raise ArgumentError.new("Argument error in 'render_snippet' - Can not find snippet named '#{name}'")
+          end
+        end
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('render_snippet', PufferPages::Liquid::Tags::RenderSnippet)

data/lib/puffer_pages/liquid/tags/yield.rb

@@ -16,7 +16,13 @@ module PufferPages
         end
 
         def render(context)
-          context.registers[:page].part(context[@name]).render(context)
+          name = context[@name]
+          part = context.registers[:page].part(name)
+          if part
+            part.render(context)
+          else
+            raise ArgumentError.new("Argument error in 'yield' - Can not find page part named '#{name}'")
+          end
         end
       end
 

data/lib/puffer_pages.rb

@@ -19,6 +19,7 @@ require 'puffer_pages/engine'
 require 'puffer_pages/extensions/core'
 require 'puffer_pages/extensions/mapper'
 require 'puffer_pages/liquid/tags/yield'
+require 'puffer_pages/liquid/tags/render_snippet'
 
 Puffer.setup do |config|
   config.javascripts += %w(right-dialog right-tabs puffer_pages)

data/puffer_pages.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{puffer_pages}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["pyromaniac"]
@@ -63,6 +63,7 @@ Gem::Specification.new do |s|
     "lib/puffer_pages/extensions/core.rb",
     "lib/puffer_pages/extensions/mapper.rb",
     "lib/puffer_pages/liquid/page_drop.rb",
+    "lib/puffer_pages/liquid/tags/render_snippet.rb",
     "lib/puffer_pages/liquid/tags/yield.rb",
     "lib/puffer_pages/liquid/tracker.rb",
     "puffer_pages.gemspec",
@@ -124,6 +125,7 @@ Gem::Specification.new do |s|
     "spec/fabricators/layouts_fabricator.rb",
     "spec/fabricators/page_parts_fabricator.rb",
     "spec/fabricators/pages_fabricator.rb",
+    "spec/fabricators/snippets_fabricator.rb",
     "spec/integration/navigation_spec.rb",
     "spec/models/page_spec.rb",
     "spec/models/tags_spec.rb",
@@ -164,6 +166,7 @@ Gem::Specification.new do |s|
     "spec/fabricators/layouts_fabricator.rb",
     "spec/fabricators/page_parts_fabricator.rb",
     "spec/fabricators/pages_fabricator.rb",
+    "spec/fabricators/snippets_fabricator.rb",
     "spec/integration/navigation_spec.rb",
     "spec/models/page_spec.rb",
     "spec/models/tags_spec.rb",

data/spec/fabricators/snippets_fabricator.rb

@@ -0,0 +1,4 @@
+Fabricator(:snippet) do
+  name { Forgery::LoremIpsum.word }
+  body { Forgery::LoremIpsum.sentence }
+end

data/spec/models/page_spec.rb

@@ -122,9 +122,9 @@ describe Page do
     end
 
     it 'should render layout' do
-      @layout = Fabricate :layout, :name => 'foo_layout', :body => "|{% yield %}|{% yield 'sidebar' %}|{% assign sb = 'sidebar' %}|{% yield sb %}|"
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% yield %} {% yield 'sidebar' %}"
       result = @root.render 'self' => PufferPages::Liquid::PageDrop.new(@root)
-      result.should == "|#{@root.title}|#{@root.name}||#{@root.name}|"
+      result.should == "#{@root.title} #{@root.name}"
     end
 
   end

data/spec/models/tags_spec.rb

@@ -2,8 +2,54 @@ require 'spec_helper'
 
 describe 'Tags' do
 
-  #describe 'yield' do
+  def render_page(page)
+    page.render 'self' => PufferPages::Liquid::PageDrop.new(page)
+  end
+
+  describe 'yield' do
+
+    before :each do
+      @page = Fabricate :page, :layout_name => 'foo_layout'
+      @main = Fabricate :page_part, :name => PufferPages.primary_page_part_name, :body => 'foo'
+      @sidebar = Fabricate :page_part, :name => 'sidebar', :body => 'bar'
+      @page.page_parts = [@main, @sidebar]
+    end
+
+    it 'should render yield without params' do
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% yield %}"
+      render_page(@page).should == @main.body
+    end
+
+    it 'should render yield with string param' do
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% yield 'sidebar' %}"
+      render_page(@page).should == @sidebar.body
+    end
+
+    it 'should render yield with variable param' do
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% assign sb = 'sidebar' %}{% yield sb %}"
+      render_page(@page).should == @sidebar.body
+    end
+
+  end
+
+  describe 'render_snippet' do
+
+    before :each do
+      @page = Fabricate :page, :layout_name => 'foo_layout'
+      @snippet = Fabricate :snippet, :name => 'snip', :body => 'snippet body'
+    end
+
+    it 'should render yield with string param' do
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% render_snippet 'snip' %}"
+      render_page(@page).should == @snippet.body
+    end
+
+    it 'should render yield with variable param' do
+      @layout = Fabricate :layout, :name => 'foo_layout', :body => "{% assign sn = 'snip' %}{% render_snippet sn %}"
+      render_page(@page).should == @snippet.body
+    end
+
+  end
 
-  #end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: puffer_pages
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - pyromaniac
@@ -250,6 +250,7 @@ files:
 - lib/puffer_pages/extensions/core.rb
 - lib/puffer_pages/extensions/mapper.rb
 - lib/puffer_pages/liquid/page_drop.rb
+- lib/puffer_pages/liquid/tags/render_snippet.rb
 - lib/puffer_pages/liquid/tags/yield.rb
 - lib/puffer_pages/liquid/tracker.rb
 - puffer_pages.gemspec
@@ -311,6 +312,7 @@ files:
 - spec/fabricators/layouts_fabricator.rb
 - spec/fabricators/page_parts_fabricator.rb
 - spec/fabricators/pages_fabricator.rb
+- spec/fabricators/snippets_fabricator.rb
 - spec/integration/navigation_spec.rb
 - spec/models/page_spec.rb
 - spec/models/tags_spec.rb
@@ -380,6 +382,7 @@ test_files:
 - spec/fabricators/layouts_fabricator.rb
 - spec/fabricators/page_parts_fabricator.rb
 - spec/fabricators/pages_fabricator.rb
+- spec/fabricators/snippets_fabricator.rb
 - spec/integration/navigation_spec.rb
 - spec/models/page_spec.rb
 - spec/models/tags_spec.rb