benschwarz-smoke 0.4.2 → 0.5.0

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+require 'spec'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "smoke"
+    gem.summary = %Q{smoke is a DSL that allows you to take data from YQL, RSS / Atom}
+    gem.email = "ben.schwarz@gmail.com"
+    gem.homepage = "http://github.com/benschwarz/smoke"
+    gem.authors = ["Ben Schwarz"]
+    gem.files = FileList['lib/**/*.rb', 'rdoc/**/*', '[A-Z]*', 'spec/**/*', 'vendor/**/*'].to_a
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  gem 'mislav-hanna', '>= 0.2.7'
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'smoke'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:test) do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :test
+task :default => :test

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
+:patch: 0
 :major: 0
-:minor: 4
+:minor: 5

data/lib/core_ext/string.rb

@@ -0,0 +1,6 @@
+class String
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+end

data/lib/smoke/cache.rb

@@ -4,40 +4,55 @@ require 'digest/md5'
 module Smoke
   class Cache
     class << self
-      def configure!
-        require "moneta/#{Smoke.config[:cache][:store].to_s}" if enabled?
-      rescue LoadError
-        Smoke.log.fatal "Cache store not found. Smoke uses moneta for cache stores, ensure that you've chosen a moneta supported store"
-      end
-  
-      def fetch(name, &block)
-        key = generate_key(name)
-        output = (enabled?) ? cache[key] : block.call
-        if output
-          return output
-        else
-          output = block.call
-          persist(key, output)
+      def fetch(uri, options)  
+        output = (enabled?) ? read(uri) : query(uri, options)
+        
+        unless output.keys.any?
+          Smoke.log.info "Cache miss"
+          output = query(uri, options)
         end
-    
-        return output
+        
+        output
+      rescue
+        query(uri, options)
       end
-  
+
       def enabled?
         Smoke.config[:cache][:enabled]
       end
   
-      private
+      protected
       def cache
-        Moneta.const_get(Smoke.config[:cache][:store]).send(:new, Smoke.config[:cache][:options]) 
+        Moneta.autoload(klass_name.to_sym, file_name)
+        @@cache ||= Moneta.const_get(klass_name).new(Smoke.config[:cache][:options])
       end
-        
-      def persist(key, store)
-        cache.store(key, store, :expire_in => Smoke.config[:config][:cache][:expiry])
+            
+      def file_name
+        "moneta/#{Smoke.config[:cache][:store].to_s}"
+      end
+      
+      def klass_name
+        Smoke.config[:cache][:store].to_s.camel_case
+      end
+      
+      def query(uri, options)
+        request = RestClient.get(uri, options)
+        write(uri, request, request.headers[:content_type]) if enabled?
+        {:body => request, :content_type => request.headers[:content_type]}
+      end
+      
+      def read(uri)
+        key = generate_key(uri)
+        return cache[key]
+      end
+      
+      def write(uri, body, content_type)
+        store = {:body => body, :content_type => content_type}
+        self.cache.store(generate_key(uri), store, :expire_in => Smoke.config[:cache][:expiry])
       end
   
       def generate_key(key)
-        Digest::MD5.hexdigest(key)
+        Digest::MD5.hexdigest(key.to_s)
       end
     end
   end

data/lib/smoke/request.rb

@@ -23,14 +23,10 @@ module Smoke
     end
     
     private
-    def dispatch  
-      Smoke::Cache.fetch @uri do
-        Thread.new {
-          request = RestClient.get(@uri, @@request_options)
-          @content_type = request.headers[:content_type]
-          @body = request
-        }.join
-      end
+    def dispatch
+      get = Smoke::Cache.fetch @uri, @@request_options
+      @body = get[:body]
+      @content_type = get[:content_type]
       
       present! unless @options[:raw_response]
       

data/lib/smoke.rb

@@ -1,3 +1,9 @@
+begin
+  require "vendor/dependencies/lib/dependencies"
+rescue LoadError
+  require "dependencies"
+end
+
 require 'restclient'
 require 'logger'
 require 'crack'
@@ -71,7 +77,6 @@ module Smoke
     #
     def configure(&block)
       yield @@config
-      Smoke::Cache.configure!
     end
     
     # Access configuration options
@@ -96,7 +101,7 @@ module Smoke
   end
 end
 
-%w(core_ext/hash smoke/cache smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
+%w(core_ext/hash core_ext/string smoke/cache smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
 
 class Object # :nodoc: 
   include Smoke

data/rdoc/classes/Smoke/Origin.html

@@ -0,0 +1,340 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>: Smoke::Origin [smoke]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+        
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Class</span>
+          Smoke::Origin
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../../files/lib/smoke/origin_rb.html">lib/smoke/origin.rb</a>
+          </li>
+        </ol>
+        <div class='parent'>
+          Parent:
+          <strong>Object</strong>
+        </div>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='method-list'>
+            <h2>Methods</h2>
+            <h3>public class</h3>
+            <ol>
+              <li><a href="#M000020">new</a></li>
+            </ol>
+            <h3>public instance</h3>
+            <ol>
+              <li><a href="#M000028">discard</a></li>
+              <li><a href="#M000023">emit</a></li>
+              <li><a href="#M000027">keep</a></li>
+              <li><a href="#M000025">method_missing</a></li>
+              <li><a href="#M000021">output</a></li>
+              <li><a href="#M000022">path</a></li>
+              <li><a href="#M000024">prepare</a></li>
+              <li><a href="#M000029">rename</a></li>
+              <li><a href="#M000026">sort</a></li>
+              <li><a href="#M000030">truncate</a></li>
+            </ol>
+          </div>
+          <div id='section'>
+            <div id='attribute-list'>
+              <h2 class='section-bar'>Attributes</h2>
+              <div class='name-list'>
+                <table>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>items</td>
+                    <td class='context-item-value'>[R]</td>
+                    <td class='context-item-desc'></td>
+                  </tr>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>name</td>
+                    <td class='context-item-value'>[RW]</td>
+                    <td class='context-item-desc'></td>
+                  </tr>
+                </table>
+              </div>
+            </div>
+            <div id='methods'>
+              <h2>Public class methods</h2>
+              <div class='public-class method' id='method-M000020'>
+                <a name='M000020'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>new</span>
+                  <span class='arguments'>(name, &amp;block)</span>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000020-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000020-source'>    <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 6</span>&#x000A; 6:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A; 7:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-value str">&quot;Sources must have a name&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">name</span>&#x000A; 8:       <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>&#x000A; 9:       <span class="ruby-ivar">@items</span>, <span class="ruby-ivar">@prepare</span>, <span class="ruby-ivar">@transformation</span> = [], [], []&#x000A;10: &#x000A;11:       <span class="ruby-identifier">activate!</span>&#x000A;12:       <span class="ruby-identifier">instance_eval</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>&#x000A;13:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <h2>Public instance methods</h2>
+              <div class='public-instance method' id='method-M000028'>
+                <a name='M000028'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>discard</span>
+                  <span class='arguments'>(key, matcher)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Discard items that do not match the regex
+                  </p>
+                  <p>
+                  Usage (chained):
+                  </p>
+                  <pre>Smoke[:ruby].discard(:title, /tuesday/i)</pre>
+                  <p>
+                  Usage (block, during initialization):
+                  </p>
+                  <pre>Smoke.yql(:ruby) do&#x000A;  ...&#x000A;  discard(:title, /tuesday/i)&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000028-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000028-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 140</span>&#x000A;140:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">discard</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">matcher</span>)&#x000A;141:       <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">reject!</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> (<span class="ruby-identifier">i</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">=~</span> <span class="ruby-identifier">matcher</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">false</span> }&#x000A;142:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;143:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000023'>
+                <a name='M000023'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>emit</span>
+                  <span class='arguments'>(&amp;block)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Transform each item
+                  </p>
+                  <p>
+                  Usage:
+                  </p>
+                  <pre>emit do&#x000A;  rename(:href =&gt; :link)&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000023-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000023-source'>    <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 72</span>&#x000A;72:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">emit</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A;73:       <span class="ruby-ivar">@transformation</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">block</span>&#x000A;74:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000027'>
+                <a name='M000027'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>keep</span>
+                  <span class='arguments'>(key, matcher)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Keep items that match the regex
+                  </p>
+                  <p>
+                  Usage (chained):
+                  </p>
+                  <pre>Smoke[:ruby].keep(:title, /tuesday/i)</pre>
+                  <p>
+                  Usage (block, during initialization):
+                  </p>
+                  <pre>Smoke.yql(:ruby) do&#x000A;  ...&#x000A;  keep(:title, /tuesday/i)&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000027-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000027-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 126</span>&#x000A;126:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">keep</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">matcher</span>)&#x000A;127:       <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">reject!</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> (<span class="ruby-identifier">i</span>[<span class="ruby-identifier">key</span>] <span class="ruby-operator">=~</span> <span class="ruby-identifier">matcher</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword kw">false</span> <span class="ruby-operator">:</span> <span class="ruby-keyword kw">true</span> }&#x000A;128:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;129:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000025'>
+                <a name='M000025'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>method_missing</span>
+                  <span class='arguments'>(symbol, *args, &amp;block)</span>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000025-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000025-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 96</span>&#x000A; 96:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">symbol</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A; 97:       <span class="ruby-identifier">ivar</span> = <span class="ruby-node">&quot;@#{symbol}&quot;</span>&#x000A; 98:       &#x000A; 99:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>&#x000A;100:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">ivar</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword kw">super</span>  &#x000A;101:       <span class="ruby-keyword kw">else</span>&#x000A;102:         <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-identifier">ivar</span>, <span class="ruby-identifier">args</span>.<span class="ruby-identifier">pop</span>)&#x000A;103:       <span class="ruby-keyword kw">end</span>&#x000A;104: &#x000A;105:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;106:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000021'>
+                <a name='M000021'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>output</span>
+                  <span class='arguments'>(type = :ruby)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Output your items in a range of formats (:ruby, :json and :yaml currently)
+                  Ruby is the default format and will automagically yielded from your source
+                  </p>
+                  <p>
+                  Usage
+                  </p>
+                  <pre>output(:json)&#x000A;=&gt; &quot;[{title: \&quot;Ray\&quot;}, {title: \&quot;Peace\&quot;}]&quot;</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000021-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000021-source'>    <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 22</span>&#x000A;22:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">output</span>(<span class="ruby-identifier">type</span> = <span class="ruby-identifier">:ruby</span>)&#x000A;23:       <span class="ruby-identifier">prepare!</span>&#x000A;24:       <span class="ruby-identifier">dispatch</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">:dispatch</span>&#x000A;25:       <span class="ruby-identifier">output</span> = (<span class="ruby-ivar">@items</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>) <span class="ruby-operator">?</span> <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">first</span> <span class="ruby-operator">:</span> <span class="ruby-ivar">@items</span>&#x000A;26:       &#x000A;27:       <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">type</span>&#x000A;28:       <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:json</span>&#x000A;29:         <span class="ruby-keyword kw">return</span> <span class="ruby-operator">::</span><span class="ruby-constant">JSON</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">output</span>)&#x000A;30:       <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:yaml</span>&#x000A;31:         <span class="ruby-keyword kw">return</span> <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">output</span>)&#x000A;32:       <span class="ruby-keyword kw">else</span>&#x000A;33:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">output</span>&#x000A;34:       <span class="ruby-keyword kw">end</span>      &#x000A;35:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000022'>
+                <a name='M000022'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>path</span>
+                  <span class='arguments'>(*path)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Path allows you to traverse the tree of a the items returned to only give
+                  you access to what you&#8217;re interested in.
+                  </p>
+                  <p>
+                  Usage: path :down, :to, :the, :data
+                  </p>
+                  <p>
+                  Will traverse through a tree as follows:
+                  </p>
+                  <pre>{&#x000A;  :down =&gt; {&#x000A;    :to =&gt; {&#x000A;      :the =&gt; {&#x000A;        :data =&gt; []&#x000A;      }&#x000A;    }&#x000A;  }&#x000A;}</pre>
+                  <p>
+                  You will need to help smoke find an array of items that you&#8217;re
+                  interested in.
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000022-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000022-source'>    <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 62</span>&#x000A;62:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">path</span>)&#x000A;63:       <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span>&#x000A;64:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000024'>
+                <a name='M000024'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>prepare</span>
+                  <span class='arguments'>(&amp;block)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Prepare is used when you&#8217;d like to provision for arguments /
+                  variables to be set after the source definition. Eg, create a source
+                  definition for twitter, omitting the &#8220;username&#8221;. Set the
+                  username using chaining later.
+                  </p>
+                  <p>
+                  Usage:
+                  </p>
+                  <pre># Definition&#x000A;Smoke.feed :twitter do&#x000A;  prepare do&#x000A;    url &quot;http://twitter.com/#{username}/rss&quot;&#x000A;  end&#x000A;end&#x000A;&#x000A;# End use&#x000A;Smoke[:twitter].username(:benschwarz).output</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000024-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000024-source'>    <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 91</span>&#x000A;91:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">prepare</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A;92:       <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;requires a block&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>&#x000A;93:       <span class="ruby-ivar">@prepare</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">block</span>&#x000A;94:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000029'>
+                <a name='M000029'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>rename</span>
+                  <span class='arguments'>(*args)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Rename one or many keys at a time Suggested that you run it within an each
+                  block, but it makes no difference other than readability
+                  </p>
+                  <p>
+                  Usage
+                  </p>
+                  <pre># Renames all items with a key of href to link&#x000A;rename(:href =&gt; :link)</pre>
+                  <p>
+                  or
+                  </p>
+                  <pre>rename(:href =&gt; :link, :description =&gt; :excerpt)</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000029-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000029-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 154</span>&#x000A;154:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rename</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)&#x000A;155:       <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span> <span class="ruby-identifier">item</span>.<span class="ruby-identifier">rename</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>) }&#x000A;156:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;157:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000026'>
+                <a name='M000026'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>sort</span>
+                  <span class='arguments'>(key)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Re-sort items by a particular key
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000026-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000026-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 109</span>&#x000A;109:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sort</span>(<span class="ruby-identifier">key</span>)&#x000A;110:       <span class="ruby-ivar">@items</span> = <span class="ruby-ivar">@items</span>.<span class="ruby-identifier">sort_by</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>[<span class="ruby-identifier">key</span>] }&#x000A;111:     <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NoMethodError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>&#x000A;112:       <span class="ruby-constant">Smoke</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">&quot;You're trying to sort by \&quot;#{key}\&quot; but it does not exist in your item set&quot;</span>&#x000A;113:     <span class="ruby-keyword kw">ensure</span>&#x000A;114:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;115:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-instance method' id='method-M000030'>
+                <a name='M000030'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>truncate</span>
+                  <span class='arguments'>(length)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Truncate your result set to this many objects
+                  </p>
+                  <p>
+                  Usage
+                  </p>
+                  <pre>truncate(3).output&#x000A;=&gt; [{title =&gt; &quot;Canon&quot;}, {:title =&gt; &quot;Nikon&quot;}, {:title =&gt; &quot;Pentax&quot;}]</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000030-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000030-source'>     <span class="ruby-comment cmt"># File lib/smoke/origin.rb, line 165</span>&#x000A;165:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">truncate</span>(<span class="ruby-identifier">length</span>)&#x000A;166:       <span class="ruby-ivar">@items</span> = <span class="ruby-ivar">@items</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span>(<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)]&#x000A;167:       <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>&#x000A;168:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
+    </div>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>