mbrao 1.2.3 → 1.3.0

data/doc/method_list.html

@@ -48,32 +48,44 @@
         
 
   <li class="r1 ">
-    <span class='object_link'><a href="Mbrao/Content.html#author-instance_method" title="Mbrao::Content#author (method)">#author</a></span>
+    <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#as_json-instance_method" title="Mbrao::PublicInterface::ClassMethods#as_json (method)">#as_json</a></span>
+    <small>Mbrao::PublicInterface::ClassMethods</small>
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Mbrao/Author.html#as_json-instance_method" title="Mbrao::Author#as_json (method)">#as_json</a></span>
+    <small>Mbrao::Author</small>
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="Mbrao/Content.html#as_json-instance_method" title="Mbrao::Content#as_json (method)">#as_json</a></span>
     <small>Mbrao::Content</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/Content.html#body-instance_method" title="Mbrao::Content#body (method)">#body</a></span>
+    <span class='object_link'><a href="Mbrao/Content.html#author-instance_method" title="Mbrao::Content#author (method)">#author</a></span>
     <small>Mbrao::Content</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#call-instance_method" title="ActionView::Template::Handlers::MbraoTemplate#call (method)">#call</a></span>
-    <small>ActionView::Template::Handlers::MbraoTemplate</small>
+    <span class='object_link'><a href="Mbrao/Content.html#body-instance_method" title="Mbrao::Content#body (method)">#body</a></span>
+    <small>Mbrao::Content</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="HTML/Pipeline/KramdownFilter.html#call-instance_method" title="HTML::Pipeline::KramdownFilter#call (method)">#call</a></span>
-    <small>HTML::Pipeline::KramdownFilter</small>
+    <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#call-instance_method" title="ActionView::Template::Handlers::MbraoTemplate#call (method)">#call</a></span>
+    <small>ActionView::Template::Handlers::MbraoTemplate</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Mbrao/Content.html#create-class_method" title="Mbrao::Content.create (method)">create</a></span>
-    <small>Mbrao::Content</small>
+    <span class='object_link'><a href="HTML/Pipeline/KramdownFilter.html#call-instance_method" title="HTML::Pipeline::KramdownFilter#call (method)">#call</a></span>
+    <small>HTML::Pipeline::KramdownFilter</small>
   </li>
   
 
@@ -84,53 +96,53 @@
   
 
   <li class="r1 ">
+    <span class='object_link'><a href="Mbrao/Content.html#create-class_method" title="Mbrao::Content.create (method)">create</a></span>
+    <small>Mbrao::Content</small>
+  </li>
+  
+
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#create_engine-instance_method" title="Mbrao::PublicInterface::ClassMethods#create_engine (method)">#create_engine</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Content.html#created_at-instance_method" title="Mbrao::Content#created_at (method)">#created_at</a></span>
     <small>Mbrao::Content</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#default_locale-instance_method" title="Mbrao::PublicInterface::ClassMethods#default_locale (method)">#default_locale</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/RenderingEngines/HtmlPipeline.html#default_options-instance_method" title="Mbrao::RenderingEngines::HtmlPipeline#default_options (method)">#default_options</a></span>
     <small>Mbrao::RenderingEngines::HtmlPipeline</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/RenderingEngines/HtmlPipeline.html#default_pipeline-instance_method" title="Mbrao::RenderingEngines::HtmlPipeline#default_pipeline (method)">#default_pipeline</a></span>
     <small>Mbrao::RenderingEngines::HtmlPipeline</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Author.html#email-instance_method" title="Mbrao::Author#email (method)">#email</a></span>
     <small>Mbrao::Author</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#enabled_for_locales%3F-instance_method" title="Mbrao::ContentPublicInterface#enabled_for_locales? (method)">#enabled_for_locales?</a></span>
     <small>Mbrao::ContentPublicInterface</small>
   </li>
   
 
-  <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/ParsingEngines/PlainText.html#filter_content-instance_method" title="Mbrao::ParsingEngines::PlainText#filter_content (method)">#filter_content</a></span>
-    <small>Mbrao::ParsingEngines::PlainText</small>
-  </li>
-  
-
   <li class="r1 ">
     <span class='object_link'><a href="Mbrao/ParsingEngines/Base.html#filter_content-instance_method" title="Mbrao::ParsingEngines::Base#filter_content (method)">#filter_content</a></span>
     <small>Mbrao::ParsingEngines::Base</small>
@@ -138,44 +150,44 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_body-instance_method" title="Mbrao::ContentPublicInterface#get_body (method)">#get_body</a></span>
-    <small>Mbrao::ContentPublicInterface</small>
+    <span class='object_link'><a href="Mbrao/ParsingEngines/PlainText.html#filter_content-instance_method" title="Mbrao::ParsingEngines::PlainText#filter_content (method)">#filter_content</a></span>
+    <small>Mbrao::ParsingEngines::PlainText</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_more-instance_method" title="Mbrao::ContentPublicInterface#get_more (method)">#get_more</a></span>
+    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_body-instance_method" title="Mbrao::ContentPublicInterface#get_body (method)">#get_body</a></span>
     <small>Mbrao::ContentPublicInterface</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_tags-instance_method" title="Mbrao::ContentPublicInterface#get_tags (method)">#get_tags</a></span>
+    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_more-instance_method" title="Mbrao::ContentPublicInterface#get_more (method)">#get_more</a></span>
     <small>Mbrao::ContentPublicInterface</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_title-instance_method" title="Mbrao::ContentPublicInterface#get_title (method)">#get_title</a></span>
+    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_tags-instance_method" title="Mbrao::ContentPublicInterface#get_tags (method)">#get_tags</a></span>
     <small>Mbrao::ContentPublicInterface</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/Author.html#image-instance_method" title="Mbrao::Author#image (method)">#image</a></span>
-    <small>Mbrao::Author</small>
+    <span class='object_link'><a href="Mbrao/ContentPublicInterface.html#get_title-instance_method" title="Mbrao::ContentPublicInterface#get_title (method)">#get_title</a></span>
+    <small>Mbrao::ContentPublicInterface</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="HTML/Pipeline/KramdownFilter.html#initialize-instance_method" title="HTML::Pipeline::KramdownFilter#initialize (method)">#initialize</a></span>
-    <small>HTML::Pipeline::KramdownFilter</small>
+    <span class='object_link'><a href="Mbrao/Author.html#image-instance_method" title="Mbrao::Author#image (method)">#image</a></span>
+    <small>Mbrao::Author</small>
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/Author.html#initialize-instance_method" title="Mbrao::Author#initialize (method)">#initialize</a></span>
-    <small>Mbrao::Author</small>
+    <span class='object_link'><a href="HTML/Pipeline/KramdownFilter.html#initialize-instance_method" title="HTML::Pipeline::KramdownFilter#initialize (method)">#initialize</a></span>
+    <small>HTML::Pipeline::KramdownFilter</small>
   </li>
   
 
@@ -186,47 +198,47 @@
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="Mbrao/Author.html#initialize-instance_method" title="Mbrao::Author#initialize (method)">#initialize</a></span>
+    <small>Mbrao::Author</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#instance-instance_method" title="Mbrao::PublicInterface::ClassMethods#instance (method)">#instance</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#instance-class_method" title="ActionView::Template::Handlers::MbraoTemplate.instance (method)">instance</a></span>
     <small>ActionView::Template::Handlers::MbraoTemplate</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Validations/ClassMethods.html#is_email%3F-instance_method" title="Mbrao::Validations::ClassMethods#is_email? (method)">#is_email?</a></span>
     <small>Mbrao::Validations::ClassMethods</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/Validations/ClassMethods.html#is_url%3F-instance_method" title="Mbrao::Validations::ClassMethods#is_url? (method)">#is_url?</a></span>
     <small>Mbrao::Validations::ClassMethods</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#locale-instance_method" title="Mbrao::PublicInterface::ClassMethods#locale (method)">#locale</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/Content.html#locales-instance_method" title="Mbrao::Content#locales (method)">#locales</a></span>
     <small>Mbrao::Content</small>
   </li>
   
 
-  <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/Author.html#metadata-instance_method" title="Mbrao::Author#metadata (method)">#metadata</a></span>
-    <small>Mbrao::Author</small>
-  </li>
-  
-
   <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Content.html#metadata-instance_method" title="Mbrao::Content#metadata (method)">#metadata</a></span>
     <small>Mbrao::Content</small>
@@ -234,83 +246,95 @@
   
 
   <li class="r2 ">
+    <span class='object_link'><a href="Mbrao/Author.html#metadata-instance_method" title="Mbrao::Author#metadata (method)">#metadata</a></span>
+    <small>Mbrao::Author</small>
+  </li>
+  
+
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Content.html#more-instance_method" title="Mbrao::Content#more (method)">#more</a></span>
     <small>Mbrao::Content</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/Author.html#name-instance_method" title="Mbrao::Author#name (method)">#name</a></span>
     <small>Mbrao::Author</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#parse-instance_method" title="Mbrao::PublicInterface::ClassMethods#parse (method)">#parse</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/ParsingEngines/Base.html#parse-instance_method" title="Mbrao::ParsingEngines::Base#parse (method)">#parse</a></span>
     <small>Mbrao::ParsingEngines::Base</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/Parser.html#parse-instance_method" title="Mbrao::Parser#parse (method)">#parse</a></span>
     <small>Mbrao::Parser</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/ParsingEngines/PlainText.html#parse_metadata-instance_method" title="Mbrao::ParsingEngines::PlainText#parse_metadata (method)">#parse_metadata</a></span>
     <small>Mbrao::ParsingEngines::PlainText</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/ParsingEngines/Base.html#parse_metadata-instance_method" title="Mbrao::ParsingEngines::Base#parse_metadata (method)">#parse_metadata</a></span>
     <small>Mbrao::ParsingEngines::Base</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#parsing_engine-instance_method" title="Mbrao::PublicInterface::ClassMethods#parsing_engine (method)">#parsing_engine</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
-  <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/RenderingEngines/HtmlPipeline.html#render-instance_method" title="Mbrao::RenderingEngines::HtmlPipeline#render (method)">#render</a></span>
-    <small>Mbrao::RenderingEngines::HtmlPipeline</small>
+  <li class="r1 ">
+    <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#register-class_method" title="ActionView::Template::Handlers::MbraoTemplate.register (method)">register</a></span>
+    <small>ActionView::Template::Handlers::MbraoTemplate</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/Parser.html#render-instance_method" title="Mbrao::Parser#render (method)">#render</a></span>
     <small>Mbrao::Parser</small>
   </li>
   
 
-  <li class="r2 ">
-    <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#render-instance_method" title="ActionView::Template::Handlers::MbraoTemplate#render (method)">#render</a></span>
-    <small>ActionView::Template::Handlers::MbraoTemplate</small>
+  <li class="r1 ">
+    <span class='object_link'><a href="Mbrao/RenderingEngines/HtmlPipeline.html#render-instance_method" title="Mbrao::RenderingEngines::HtmlPipeline#render (method)">#render</a></span>
+    <small>Mbrao::RenderingEngines::HtmlPipeline</small>
   </li>
   
 
-  <li class="r1 ">
+  <li class="r2 ">
     <span class='object_link'><a href="Mbrao/RenderingEngines/Base.html#render-instance_method" title="Mbrao::RenderingEngines::Base#render (method)">#render</a></span>
     <small>Mbrao::RenderingEngines::Base</small>
   </li>
   
 
-  <li class="r2 ">
+  <li class="r1 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#render-instance_method" title="Mbrao::PublicInterface::ClassMethods#render (method)">#render</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
   </li>
   
 
+  <li class="r2 ">
+    <span class='object_link'><a href="ActionView/Template/Handlers/MbraoTemplate.html#render-instance_method" title="ActionView::Template::Handlers::MbraoTemplate#render (method)">#render</a></span>
+    <small>ActionView::Template::Handlers::MbraoTemplate</small>
+  </li>
+  
+
   <li class="r1 ">
     <span class='object_link'><a href="Mbrao/PublicInterface/ClassMethods.html#rendering_engine-instance_method" title="Mbrao::PublicInterface::ClassMethods#rendering_engine (method)">#rendering_engine</a></span>
     <small>Mbrao::PublicInterface::ClassMethods</small>
@@ -318,14 +342,14 @@
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Mbrao/ParsingEngines/PlainText.html#separate_components-instance_method" title="Mbrao::ParsingEngines::PlainText#separate_components (method)">#separate_components</a></span>
-    <small>Mbrao::ParsingEngines::PlainText</small>
+    <span class='object_link'><a href="Mbrao/ParsingEngines/Base.html#separate_components-instance_method" title="Mbrao::ParsingEngines::Base#separate_components (method)">#separate_components</a></span>
+    <small>Mbrao::ParsingEngines::Base</small>
   </li>
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Mbrao/ParsingEngines/Base.html#separate_components-instance_method" title="Mbrao::ParsingEngines::Base#separate_components (method)">#separate_components</a></span>
-    <small>Mbrao::ParsingEngines::Base</small>
+    <span class='object_link'><a href="Mbrao/ParsingEngines/PlainText.html#separate_components-instance_method" title="Mbrao::ParsingEngines::PlainText#separate_components (method)">#separate_components</a></span>
+    <small>Mbrao::ParsingEngines::PlainText</small>
   </li>
   
 

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Nov 23 13:44:01 2013 by
+  Generated on Sun Nov 24 14:07:03 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.0.0).
 </div>

data/lib/mbrao/author.rb

@@ -34,14 +34,25 @@ module Mbrao
     # @param website [String] The website of the author.
     # @param image [String] The URL of the avatar of the author.
     # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
-    # @param uid [String] A unique ID for this post. This is only for client uses.
-    def initialize(name, email = nil, website = nil, image = nil, metadata = nil, uid = nil)
+    def initialize(name, email = nil, website = nil, image = nil, metadata = nil)
       @name = name.ensure_string
       @email = Mbrao::Parser.is_email?(email) ? email : nil
       @website = Mbrao::Parser.is_url?(website) ? website : nil
       @image = Mbrao::Parser.is_url?(image) ? image : nil
       @metadata = metadata.ensure_hash(:indifferent)
-      @uid = uid
+    end
+
+    # Returns the author as an Hash.
+    #
+    # @param options [Hash] Options to modify behavior of the serialization.
+    #   The only supported value are:
+    #
+    #   * `:exclude`, an array of attributes to skip.
+    #   * `:exclude_empty`, if to exclude nil values. Default is `false`.
+    # @return [Hash] An hash with all attributes.
+    def as_json(options = {})
+      keys = [:uid, :name, :email, :website, :image, :metadata]
+      ::Mbrao::Parser.as_json(self, keys, options)
     end
 
     # Creates an author from a `Hash`.
@@ -52,7 +63,10 @@ module Mbrao
       if data.is_a?(Hash) then
         data = HashWithIndifferentAccess.new(data)
         uid = data.delete(:uid)
-        Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), data, uid)
+        metadata = data.delete(:metadata) || {}
+        author = Mbrao::Author.new(data.delete(:name), data.delete(:email), data.delete(:website), data.delete(:image), metadata.merge(data))
+        author.uid = uid
+        author
       else
         Mbrao::Author.new(data)
       end