orthor 0.1.4 → 0.2.0

data/README.md

@@ -77,7 +77,7 @@ If you don't want to use the with_orthor_* helpers you can use named templates:
         </div>)
       template :blog_entry_brief, %(
         <div class="blog-entry">
-          <h2><a href="{{url}}">{{title}}</a></h2>
+          <h2><a href="{{orthor_url}}">{{title}}</a></h2>
           <p>{{published_on}}</p>
           <div class="blog-content">{{wysiwyg.blurb}}</div>
         </div>)
@@ -121,7 +121,7 @@ These tags are available to all content:
     {{author}}       - a hash of the original authors details
     {{updater}}      - a hash of the updater details
     {{published_on}} - the date your content was published
-    {{url}}          - the URL for your content as defined in Orthor, or auto generated as /:template-prefix/category-id/content-id
+    {{orthor_url}}   - the URL for your content as defined in Orthor, or auto generated as /:template-prefix/category-id/content-id
     {{template}}     - the name of the template this content was created from
     {{category}}     - a hash of this items category details
 

data/lib/orthor.rb

@@ -13,6 +13,23 @@ class Orthor
     attr_accessor :cache, :cache_expiry, :site_id
   end
 
+  def self.content(id, options = {})
+    Templates.render(get(:content_items, id), options[:template])
+  end
+
+  def self.query(id, options = {})
+    Templates.render(get(:queries, id), options[:template])
+  end
+
+  def self.category(id, options = {})
+    id = options[:page] && options[:page].to_i > 1 ? "#{id}-#{options[:page]}" : id
+    Templates.render(get(:categories, id), options[:template])
+  end
+
+  def self.feed(id)
+    get(:feeds, id)
+  end
+
   def self.load_content
     raise "No point loading content when you don't have a cache setup" unless cache
 
@@ -31,22 +48,6 @@ class Orthor
     end
   end
 
-  def self.content(id, template = nil)
-    Templates.render(get(:content_items, id), template)
-  end
-
-  def self.query(id, template = nil)
-    Templates.render(get(:queries, id), template)
-  end
-
-  def self.category(id, template = nil)
-    Templates.render(get(:categories, id), template)
-  end
-
-  def self.feed(id)
-    get(:feeds, id)
-  end
-
   def self.render(items, template)
     Templates.render(items, template)
   end
@@ -65,7 +66,7 @@ class Orthor
   end
 
   def self.setup(&block)
-    raise ArgumentError unless block_given?
+    raise ArgumentError, "Block required" unless block_given?
     self.cache = false # default
 
     class_eval &block
@@ -77,10 +78,10 @@ private
 
     begin
       suffix = type == :feeds ? "rss" : "json"
-      key = "#{id}-#{type}"
+      cache_key = "#{id}-#{type}"
       path = "/#{site_id}/#{type}/#{id}.#{suffix}"
 
-      resp = cache ? get_cached_content(key, path) : get_response(path)
+      resp = cache ? get_cached_content(cache_key, path) : get_response(path)
 
       return resp unless suffix == "json"
 
@@ -119,8 +120,7 @@ private
           response_content = r.body
           break
         end
-      rescue => e
-        break
+      rescue
       end
     end
     response_content

data/lib/orthor/templates.rb

@@ -37,32 +37,25 @@ class Orthor
     def self.parse(item, template_name_or_mapping)
       return "" if item == ""
 
-      # ensure we're dealing with an array
-      unless item.is_a?(Array)
-        if item["type"] == "category"
-          item = item["content"]
-        else
-          item = [item]
-        end
-      end
+      content_items = content_items_from(item)
 
-      item.collect do |c|
-        markup = template_for(c, template_name_or_mapping)
+      content_items.collect do |content|
+        markup = template_for(content, template_name_or_mapping)
 
-        c.inject(markup) do |html, (key, val)|
+        content.inject(markup) do |html, (key, val)|
           if val.is_a?(String) && html.include?("{{#{key}.blurb}}")
             val = "#{val.to_s.gsub(/<\/?[^>]*>/, "")[0..150]}..."
             key = "#{key}.blurb"
 
             html = html.gsub("{{#{key}}}", val.to_s)
           elsif val.is_a?(Hash) && html.include?("{{#{key}.")
-            # we've got something like Author.Email
+            # we've got something like author.email
             html = val.inject(html) { |h, (k, v)| h = h.gsub("{{#{key}.#{k}}}", v.to_s) }
           else
             html = html.gsub("{{#{key}}}", val.to_s)
           end
         end
-      end.join("")
+      end.join("") 
     rescue Orthor::Templates::Unknown => e
       raise e
     rescue => e
@@ -89,6 +82,15 @@ class Orthor
       markup
     end
 
-    private_class_method :parse, :template_for
+    def self.content_items_from(item)
+      if item.is_a?(Array)
+        content_items = item # content queries return an array
+      elsif item["type"] == "category"
+        content_items = item["content"]
+      else
+        content_items = [item]
+      end
+    end
+    private_class_method :parse, :template_for, :content_items_from
   end
 end

data/lib/orthor_helper.rb

@@ -4,9 +4,9 @@ module OrthorHelper
     render_orthor_result(:content, id, &blk)
   end
   
-  def with_orthor_category(id, &blk)
+  def with_orthor_category(id, page = nil, &blk)
     return unless block_given?
-    render_orthor_result(:category, id, &blk)
+    render_orthor_result(:category, id, page, &blk)
   end
 
   def with_orthor_query(id, &blk)
@@ -14,12 +14,53 @@ module OrthorHelper
     render_orthor_result(:query, id, &blk)
   end
 
+  def orthor_pagination(category_id, options = {})
+    return unless defined?(request) && defined?(params)
+
+    current_page = params[:page] ? params[:page].to_i : 1
+    category = Orthor.category(category_id, :page => current_page)
+    return if category == "" || category["total_pages"] == 1 # no pagination required
+
+    options[:prev_label] ||= "←"
+    options[:next_label] ||= "→"
+
+    if params[:page] && params[:page].to_i > 0
+      href = request.url
+    else
+      href = request.url + (request.url.include?("?") ? "&" : "?") + "page=#{current_page}"
+    end
+
+    previous_link = if current_page > 1 
+      %!<a class="previous" href="#{href.gsub("page=#{current_page}", "page=#{current_page - 1}")}">#{options[:prev_label]}</a>!
+    else
+      %!<span class="previous disabled">#{options[:prev_label]}</span>!
+    end
+    next_link = if current_page < category["total_pages"] 
+      %!<a class="next" href="#{href.gsub("page=#{current_page}", "page=#{current_page + 1}")}">#{options[:next_label]}</a>!
+    else
+      %!<span class="next disabled">#{options[:next_label]}</span>!
+    end
+
+    html = <<-HTML
+      <div class="orthor-pagination">
+        #{previous_link}
+        #{next_link}
+      </div>
+    HTML
+
+    make_safe(html)
+  end
+
 private
-  def render_orthor_result(method, id, &blk)
+  def render_orthor_result(method, id, page = nil, &blk)
     html = defined?(capture) ? capture(&blk) : yield
-    parsed_html = Orthor.send(method, id, html)
+    parsed_html = make_safe(Orthor.send(method, id, :page => page, :template => html))
     defined?(concat) ? concat(parsed_html) : parsed_html
   end
+
+  def make_safe(html)
+    html.respond_to?(:html_safe) ? html.html_safe : html
+  end
 end
 
 ActionView::Base.send(:include, OrthorHelper) if defined?(ActionView::Base)

data/spec/orthor/templates_spec.rb

@@ -8,6 +8,8 @@ describe Orthor::Templates do
                          :body => File.join(SPEC_DIR, 'resources', 'query.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/category.json",
                          :body => File.join(SPEC_DIR, 'resources', 'category.json'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/category-2.json",
+                         :body => File.join(SPEC_DIR, 'resources', 'category-2.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/queries/varied.json",
                          :body => File.join(SPEC_DIR, 'resources', 'varied_content.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/feeds/feed.rss",
@@ -33,7 +35,7 @@ describe Orthor::Templates do
 
   describe "utf8" do
     it "should be able to parse utf8" do
-      Orthor.content("utf8", :brief).should == "<h2>Q&A with Tobias Lütke of Shopify - (37signals)</h2>"
+      Orthor.content("utf8", :template => :brief).should == "<h2>Q&A with Tobias Lütke of Shopify - (37signals)</h2>"
     end
   end
 
@@ -55,22 +57,22 @@ describe Orthor::Templates do
 
   describe "nested attributes" do
     it "should support User.Email, User.First name, User.Last name" do
-      Orthor.content("content", :user).should == "<div>demo@orthor.com</div><div>Bob Demo</div>"
+      Orthor.content("content", :template => :user).should == "<div>demo@orthor.com</div><div>Bob Demo</div>"
     end
   end
 
   describe "a content item" do
     it "should display content using the named template" do
-      Orthor.content("content", :basic).should == %!<h2>What is Orthor</h2><div class="content"><h2>So what is Orthor really??</h2></div>!
+      Orthor.content("content", :template => :basic).should == %!<h2>What is Orthor</h2><div class="content"><h2>So what is Orthor really??</h2></div>!
     end
 
     it "should respect given template name" do
-      Orthor.content("content", :brief).should == %!<h2>What is Orthor</h2>!
+      Orthor.content("content", :template => :brief).should == %!<h2>What is Orthor</h2>!
     end
 
     describe "blurb" do
       it "should truncate some of the text, strip html and add ..." do
-        Orthor.content("content", :blurb).should == "<div>So what is Orthor really??...</div>"
+        Orthor.content("content", :template => :blurb).should == "<div>So what is Orthor really??...</div>"
       end
     end
   end
@@ -83,13 +85,13 @@ describe Orthor::Templates do
 
   describe "a content query" do
     it "should render the template for each item" do
-      Orthor.query("query", :brief).should == %!<h2>User Manual updated</h2><h2>Account event tracking</h2><h2>Tutorials have been updated</h2>!
+      Orthor.query("query", :template => :brief).should == %!<h2>User Manual updated</h2><h2>Account event tracking</h2><h2>Tutorials have been updated</h2>!
     end
   end
 
   describe "a category" do
     it "should render the template for each item" do
-      Orthor.category("category", :brief).should == %!<h2>User Manual updated</h2><h2>Account event tracking</h2><h2>Tutorials have been updated</h2><h2>Content Queries have landed in Orthor</h2>!
+      Orthor.category("category", :template => :brief).should == %!<h2>User Manual updated</h2><h2>Account event tracking</h2><h2>Tutorials have been updated</h2><h2>Content Queries have landed in Orthor</h2>!
     end
   end
 
@@ -109,7 +111,7 @@ describe Orthor::Templates do
 
   describe "with a non-existant template" do
     it "should raise an error" do
-      lambda { Orthor.category("category", :blah) }.should raise_error(Orthor::Templates::Unknown)
+      lambda { Orthor.category("category", :template => :blah) }.should raise_error(Orthor::Templates::Unknown)
     end
   end
 
@@ -124,7 +126,7 @@ describe Orthor::Templates do
 
     describe "with a named map" do
       it "should find the template from the map" do
-        Orthor.content("content", :listing).should == "<h2>What is Orthor</h2>"
+        Orthor.content("content", :template => :listing).should == "<h2>What is Orthor</h2>"
       end
     end
 

data/spec/orthor_spec.rb

@@ -8,6 +8,8 @@ describe Orthor do
                          :body => File.join(SPEC_DIR, 'resources', 'query.json'))
     FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/category.json",
                          :body => File.join(SPEC_DIR, 'resources', 'category.json'))
+    FakeWeb.register_uri(:get, "http://content.orthor.com/orthor/categories/category-2.json",
+                         :body => File.join(SPEC_DIR, 'resources', 'category-2.json'))
 
     # account and cache loading resources
     [ "top-level", "second-level" ].each do |name|
@@ -84,6 +86,14 @@ describe Orthor do
     it 'should be able to fetch categories' do
       Orthor.category("category").to_s.should include("The User Manual has recently had a big overhaul")
     end
+
+    describe "category pages" do
+      it "should support optional page argument" do
+        Orthor.category("category", :page => 2)["content"].length.should == 1
+        Orthor.category("category", :page => 1)["content"].length.should == 4
+        Orthor.category("category", :page => nil)["content"].length.should == 4
+      end
+    end
   end
 
   describe "loading cache" do
@@ -191,6 +201,7 @@ describe Orthor do
     it "should use www.orthor.com if content.orthor.com is down" do
       # initial request will go to content.orthor.com and return an empty string
       Orthor.content("missing").should_not == ""
+      Orthor.content("missing")["title"].should == "What is Orthor"
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'spec'
 require 'fake_web'
+require 'rr'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'orthor')
 
 SPEC_DIR = File.dirname(__FILE__) unless defined? SPEC_DIR

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: orthor
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Anthony Langhorne
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-10 00:00:00 +10:00
+date: 2011-03-20 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency