mbrao 1.4.4 → 1.5.0

data/doc/top-level-namespace.html

@@ -85,7 +85,7 @@
 <p class="children">
   
     
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="HTML.html" title="HTML (module)">HTML</a></span>, <span class='object_link'><a href="Mbrao.html" title="Mbrao (module)">Mbrao</a></span>
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="ActionView.html" title="ActionView (module)">ActionView</a></span>, <span class='object_link'><a href="HTML.html" title="HTML (module)">HTML</a></span>, <span class='object_link'><a href="Mbrao.html" title="Mbrao (module)">Mbrao</a></span>
     
   
     
@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Wed Apr  9 21:36:00 2014 by
+  Generated on Sun May 11 18:17:16 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.4 (ruby-2.1.0).
 </div>

data/lib/mbrao.rb

@@ -9,16 +9,21 @@ require "html/pipeline"
 require "slim"
 require "kramdown"
 require "yaml"
+require "active_support/json/encoding"
 
-require "mbrao/version" if !defined?(Mbrao::Version)
+require "mbrao/version" unless defined?(Mbrao::Version)
 require "mbrao/exceptions"
+require "mbrao/content_interface"
 require "mbrao/content"
 require "mbrao/author"
+require "mbrao/parser_interface"
+require "mbrao/parser_validations"
 require "mbrao/parser"
 require "mbrao/parsing_engines/base"
 require "mbrao/parsing_engines/plain_text"
+require "mbrao/rendering_engines/html_pipeline/kramdown_filter"
 require "mbrao/rendering_engines/base"
 require "mbrao/rendering_engines/html_pipeline"
 require "mbrao/integrations/rails" if defined?(ActionView)
 
-Lazier.load!(:object, :hash)
+Lazier.load!(:object, :hash, :boolean)

data/lib/mbrao/author.rb

@@ -36,9 +36,9 @@ module Mbrao
     # @param metadata [HashWithIndifferentAccess] The full list of metadata of this author.
     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
+      @email = Mbrao::Parser.email?(email) ? email : nil
+      @website = Mbrao::Parser.url?(website) ? website : nil
+      @image = Mbrao::Parser.url?(image) ? image : nil
       @metadata = metadata.ensure_hash(:indifferent)
     end
 
@@ -60,7 +60,7 @@ module Mbrao
     # @param data [Hash] The data of the author
     # @return [Author] A new author.
     def self.create(data)
-      if data.is_a?(Hash) then
+      if data.is_a?(Hash)
         data = HashWithIndifferentAccess.new(data)
         uid = data.delete(:uid)
         metadata = data.delete(:metadata) || {}
@@ -72,4 +72,4 @@ module Mbrao
       end
     end
   end
-end
+end

data/lib/mbrao/content.rb

@@ -5,89 +5,6 @@
 #
 
 module Mbrao
-  # Setter methods for the {Content Content} class.
-  module ContentPublicInterface
-    # Checks if the content is available for at least one of the provided locales.
-    #
-    # @param locales [Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-    # @return [Boolean] `true` if the content is available for at least one of the desired locales, `false` otherwise.
-    def enabled_for_locales?(*locales)
-      locales = locales.flatten.ensure_array(nil, false, false, true) {|l| l.ensure_string.strip }.reject {|l| l == "*" }
-      @locales.blank? || locales.blank? || (@locales & locales).present?
-    end
-
-    # Gets the title of the content in the desired locales.
-    #
-    # @param locales [String|Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-    # @return [String|HashWithIndifferentAccess] Return the title of the content in the desired locales. If only one locale is required, then a `String`
-    #   is returned, else a `HashWithIndifferentAccess` with locales as keys.
-    def get_title(locales = [])
-      filter_attribute_for_locales(@title, locales)
-    end
-
-    # Gets the body returning only the portion which are available for the given locales.
-    #
-    # @param locales [String|Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-    # @param engine [String|Symbol|Object] The engine to use to filter contents.
-    # @return [String|HashWithIndifferentAccess] Return the body of the content in the desired locales. If only one locale is required, then a `String`
-    #   is returned, else a `HashWithIndifferentAccess` with locales as keys.
-    def get_body(locales = [], engine = :plain_text)
-      Mbrao::Parser.create_engine(engine).filter_content(self, locales)
-    end
-
-    # Gets the tags of the content in the desired locales.
-    #
-    # @param locales [String|Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-    # @return [Array|HashWithIndifferentAccess] Return the title of the content in the desired locales. If only one locale is required, then a `Array`
-    #   is returned, else a `HashWithIndifferentAccess` with locales as keys.
-    def get_tags(locales = [])
-      filter_attribute_for_locales(@tags, locales)
-    end
-
-    # Gets the "more link" text of the content in the desired locales.
-    #
-    # @param locales [String|Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-    # @return [String|HashWithIndifferentAccess] Return the label of the "more link" of the content in the desired locales. If only one locale is required,
-    #   then a `String` is returned, else a `HashWithIndifferentAccess` with locales as keys.
-    def get_more(locales = [])
-      filter_attribute_for_locales(@more, locales)
-    end
-
-    private
-      # Filters an attribute basing a set of locales.
-      #
-      # @param attribute [Object|HashWithIndifferentAccess] The desired attribute.
-      # @param locales [String|Array] The desired locales. Can include `*` to match all. If none are specified, the default mbrao locale will be used.
-      # @return [String|HashWithIndifferentAccess] Return the object for desired locales. If only one locale is available, then only a object is returned,
-      #   else a `HashWithIndifferentAccess` with locales as keys.
-      def filter_attribute_for_locales(attribute, locales)
-        locales = ::Mbrao::Content.validate_locales(locales, self)
-
-        if attribute.is_a?(HashWithIndifferentAccess) then
-          rv = attribute.reduce(HashWithIndifferentAccess.new) { |hash, pair| append_value_for_locale(hash, pair[0], locales, pair[1]) }
-          rv.keys.length == 1 ? rv.values.first : rv
-        else
-          attribute
-        end
-      end
-
-      # Adds an value on a hash if enable for requested locales.
-      #
-      # @param hash [Hash] The hash to handle.
-      # @param locale [String] The list of locale (separated by commas) for which the value is available.
-      # @param locales [Array] The list of locale for which this value is requested. Can include `*` to match all. If none are specified, the default mbrao
-      #   locale will be used.
-      # @param value [Object] The value to add.
-      # @return [Hash] Return the original hash.
-      def append_value_for_locale(hash, locale, locales, value)
-        locale.split(/\s*,\s*/).map(&:strip).each do |l|
-          hash[l] = value if locales.include?("*") || locales.include?(l)
-        end
-
-        hash
-      end
-  end
-
   # Represents a parsed content, with its metadata.
   #
   # @attribute uid
@@ -117,31 +34,9 @@ module Mbrao
   # @attribute metadata
   #   @return [Hash] The full list of metadata of this content.
   class Content
-    include Mbrao::ContentPublicInterface
-
-    attr_accessor :uid
-    attr_accessor :locales
-    attr_accessor :title
-    attr_accessor :summary
-    attr_accessor :body
-    attr_accessor :tags
-    attr_accessor :more
-    attr_accessor :author
-    attr_accessor :created_at
-    attr_accessor :updated_at
-    attr_accessor :metadata
+    attr_accessor :uid, :locales, :title, :summary, :body, :tags, :more, :author, :created_at, :updated_at, :metadata
 
-    # The allowed string format for a datetime.
-    ALLOWED_DATETIME_FORMATS = [
-      "%Y%m%dT%H%M%S%z", "%Y%m%dT%H%M%S%Z",
-      "%FT%T.%L%z", "%FT%T.%L%Z",
-      "%FT%T%z", "%FT%T%Z",
-      "%F %T %z", "%F %T %Z",
-      "%F %T.%L %z", "%F %T.%L %Z",
-
-      "%F %T.%L", "%F %T", "%F %H:%M", "%F",
-      "%d/%m/%Y %T.%L", "%d/%m/%Y %T", "%d/%m/%Y %H:%M", "%d/%m/%Y"
-    ]
+    include Mbrao::ContentInterface
 
     # Creates a new content.
     #
@@ -150,11 +45,18 @@ module Mbrao
       @uid = uid
     end
 
+    # Gets metadata attribute.
+    #
+    # @return The metadata attribute.
+    def metadata
+      @metadata ||= HashWithIndifferentAccess.new
+    end
+
     # Sets the `locales` attribute.
     #
     # @param value [Array] The new value for the attribute. A empty or "*" will be the default value.
     def locales=(value)
-      @locales = value.ensure_array(nil, true, true, true) {|l| l.ensure_string.strip }
+      @locales = value.ensure_array(nil, true, true, true) { |l| l.ensure_string.strip }
     end
 
     # Sets the `title` attribute.
@@ -162,7 +64,7 @@ module Mbrao
     # @param new_title [String|Hash] The new value for the attribute. If an Hash, keys must be a string with one or locale separated by commas.
     #   A empty or "*" will be the default value.
     def title=(new_title)
-      @title = is_hash?(new_title) ? new_title.ensure_hash(:indifferent, nil, :ensure_string) : new_title.ensure_string
+      @title = hash?(new_title) ? new_title.ensure_hash(:indifferent, nil, :ensure_string) : new_title.ensure_string
     end
 
     # Sets the `summary` attribute.
@@ -170,7 +72,7 @@ module Mbrao
     # @param new_summary [String|Hash] The new value for the attribute. If an Hash, keys must be a string with one or locale separated by commas.
     #   A empty or "*" will be the default value.
     def summary=(new_summary)
-      @summary = is_hash?(new_summary) ? new_summary.ensure_hash(:indifferent, nil, :ensure_string) : new_summary.ensure_string
+      @summary = hash?(new_summary) ? new_summary.ensure_hash(:indifferent, nil, :ensure_string) : new_summary.ensure_string
     end
 
     # Sets the `body` attribute.
@@ -185,11 +87,7 @@ module Mbrao
     # @param new_tags [Array|Hash] The new value for the attribute. If an Hash, keys must be a string with one or locale separated by commas.
     #   A empty or "*" will be the default value. Tags can also be comma-separated.
     def tags=(new_tags)
-      @tags = if is_hash?(new_tags) then
-        new_tags.ensure_hash(:indifferent) { |v| parse_tags(v) }
-      else
-        parse_tags(new_tags)
-      end
+      @tags = hash?(new_tags) ? new_tags.ensure_hash(:indifferent) { |v| parse_tags(v) } : parse_tags(new_tags)
     end
 
     # Sets the `more` attribute.
@@ -197,21 +95,21 @@ module Mbrao
     # @param new_more [String|Hash] The new value for the attribute. If an Hash, keys must be a string with one or locale separated by commas.
     #   A empty or "*" will be the default value.
     def more=(new_more)
-      @more = is_hash?(new_more) ? new_more.ensure_hash(:indifferent, nil, :ensure_string) : new_more.ensure_string
+      @more = hash?(new_more) ? new_more.ensure_hash(:indifferent, nil, :ensure_string) : new_more.ensure_string
     end
 
     # Sets the `author` attribute.
     #
     # @param new_author [Author|Hash|Object|NilClass] The new value for the attribute.
     def author=(new_author)
-      if new_author.is_a?(Mbrao::Author) then
-        @author = new_author
-      elsif is_hash?(new_author) then
-        new_author = new_author.ensure_hash(:indifferent)
-        @author = Mbrao::Author.create(new_author)
-      else
-        @author = new_author ? Mbrao::Author.new(new_author.ensure_string) : nil
-      end
+      @author =
+        if new_author.is_a?(Mbrao::Author)
+          new_author
+        elsif hash?(new_author) then
+          Mbrao::Author.create(new_author.ensure_hash(:indifferent))
+        else
+          new_author ? Mbrao::Author.new(new_author.ensure_string) : nil
+        end
     end
 
     # Sets the `created_at` attribute.
@@ -225,163 +123,119 @@ module Mbrao
     #
     # @param value [String|DateTime|Fixnum] The new value for the attribute.
     def updated_at=(value)
-      @updated_at = extract_datetime(value)
-      @updated_at = @created_at if !@updated_at
-    end
-
-    # Gets metadata attribute.
-    #
-    # @return The metadata attribute.
-    def metadata
-      @metadata ||= HashWithIndifferentAccess.new
+      @updated_at = extract_datetime(value) || @created_at
     end
 
     # Sets the `metadata` attribute.
     #
     # @param new_metadata [Hash] The new value for the attribute.
     def metadata=(new_metadata)
-      if is_hash?(new_metadata) then
-        @metadata = new_metadata.ensure_hash(:indifferent)
-      else
-        @metadata = HashWithIndifferentAccess.new({raw: new_metadata})
-      end
+      @metadata = hash?(new_metadata) ? new_metadata.ensure_hash(:indifferent) : @metadata = HashWithIndifferentAccess.new({raw: new_metadata})
     end
 
-    # Returns the content 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, :locales, :title, :summary, :body, :tags, :more, :author, :created_at, :updated_at, :metadata]
-      ::Mbrao::Parser.as_json(self, keys, options)
-    end
+    private
 
-    # Validates locales for attribute retrieval.
+    # Extracts a date and time from a value.
     #
-    # @param locales [Array] A list of desired locales for an attribute. Can include `*` to match all. If none are specified, the default mbrao locale will be
-    #   used.
-    # @param content [Content|nil] An optional content to check for availability
-    # @return [Array] The validated list of locales.
-    def self.validate_locales(locales, content = nil)
-      locales = locales.ensure_array(nil, true, true, true) {|l| l.ensure_string.strip }
-      locales = (locales.empty? ? [Mbrao::Parser.locale] : locales)
-      raise Mbrao::Exceptions::UnavailableLocalization.new if content && !content.enabled_for_locales?(locales)
-      locales
+    # @param value [String|DateTime|Fixnum] The value to parse.
+    # @return [DateTime] The extracted value.
+    def extract_datetime(value)
+      value = parse_datetime(value) if value
+      value ? value.utc : nil
+    rescue ArgumentError
+      raise Mbrao::Exceptions::InvalidDate
     end
 
-    # Creates a content with metadata and body.
+    # Parses a datetime.
     #
-    # @param metadata [Hash] The metadata.
-    # @param body [String] The body of the content.
-    # @return [Content] A new content.
-    def self.create(metadata, body)
-      rv = Mbrao::Content.new
-      rv.body = body.ensure_string.strip
-      assign_metadata(rv, metadata.symbolize_keys) if metadata.is_a?(Hash)
+    # @param value [String|DateTime|Fixnum] The value to parse.
+    # @return [DateTime] The extracted value.
+    def parse_datetime(value)
+      rv =
+        case value.class.to_s
+        when "DateTime" then value
+        when "Date", "Time" then value.to_datetime
+        when "Float", "Fixnum" then parse_datetime_number(value)
+        else parse_datetime_string(value)
+        end
+
+      raise ArgumentError unless rv
       rv
     end
 
-    private
-      # Assigns metadata to a content
-      #
-      # @param content [Content] The content to manipulate.
-      # @param metadata [Hash] The metadata to assign.
-      # @return [Content] The content with metadata.
-      def self.assign_metadata(content, metadata)
-        content.uid = metadata.delete(:uid)
-        content.title = metadata.delete(:title)
-        content.summary = metadata.delete(:summary)
-        content.author = Mbrao::Author.create(metadata.delete(:author))
-        content.tags = metadata.delete(:tags)
-        content.more = metadata.delete(:more)
-        content.created_at = metadata.delete(:created_at)
-        content.updated_at = metadata.delete(:updated_at)
-        content.locales = extract_locales(metadata)
-        content.metadata = metadata
-
-        content
-      end
-
-      # Extracts locales from metadata.
-      #
-      # @param metadata [Hash] The metadata that contains the locales.
-      # @return [Array] The locales.
-      def self.extract_locales(metadata)
-        locales = metadata.delete(:locales)
-        locales = locales.ensure_string.split(/\s*,\s*/) if !locales.is_a?(::Array)
-        normalize_locales(locales)
-      end
-
-      # Normalizes locales for further usage.
-      #
-      # @param locales [Array] The locales to normalize.
-      # @return [Array] The normalized locales.
-      def self.normalize_locales(locales)
-        locales.flatten.map(&:ensure_string).map(&:strip).uniq
-      end
+    # Parses a datetime from a number.
+    #
+    # @param value [String] The value to parse.
+    # @return [Float|Fixnum] The extracted value.
+    def parse_datetime_number(value)
+      number = value.to_float
+      number > 0 ? Time.at(number).to_datetime : nil
+    end
 
-      # Extracts a date and time from a value.
-      #
-      # @param value [String|DateTime|Fixnum] The value to parse.
-      # @return [DateTime] The extracted value.
-      def extract_datetime(value)
-        begin
-          value = parse_datetime(value) if value
-          value ? value.utc : nil
-        rescue ArgumentError
-          raise Mbrao::Exceptions::InvalidDate.new
-        end
-      end
+    # Parses a datetime from a string.
+    #
+    # @param value [String] The value to parse.
+    # @return [DateTime] The extracted value.
+    def parse_datetime_string(value)
+      value = value.ensure_string
 
-      # Parses a datetime.
-      #
-      # @param value [String|DateTime|Fixnum] The value to parse.
-      # @return [DateTime] The extracted value.
-      def parse_datetime(value)
-        case value.class.to_s
-          when "DateTime" then value
-          when "Date", "Time" then value.to_datetime
-          when "Float", "Fixnum" then
-            value.to_float > 0 ? Time.at(value.to_float).to_datetime : raise(ArgumentError.new)
-          else parse_datetime_string(value)
+      catch(:parsed) do
+        ALLOWED_DATETIME_FORMATS.find do |format|
+          begin
+            throw(:parsed, DateTime.strptime(value, format))
+          rescue
+            nil
+          end
         end
       end
+    end
 
-      # Parses a datetime string.
-      #
-      # @param value [String] The value to parse.
-      # @return [DateTime] The extracted value.
-      def parse_datetime_string(value)
-        value = value.ensure_string
+    # Extracts tags from an array, making sure all the comma separated strings are evaluated.
+    #
+    # @param value [String|Array] The string or array to parse.
+    # @return [Array] The list of tags.
+    def parse_tags(value)
+      value.ensure_array(nil, true, true, true) { |v| v.ensure_string.split(/\s*,\s*/) }
+    end
 
-        catch(:parsed) do
-          ALLOWED_DATETIME_FORMATS.each do |format|
-            rv = DateTime.strptime(value, format) rescue nil
-            throw(:parsed, rv) if rv
-          end
+    # Check if value is an Hash.
+    #
+    # @param value [Object] The object to check.
+    # @return [Boolean] `true` if value is an Hash, `false` otherwise
+    def hash?(value)
+      value.is_a?(Hash)
+    end
 
-          raise(ArgumentError.new)
-        end
+    # Assigns metadata to a content
+    #
+    # @param content [Content] The content to manipulate.
+    # @param metadata [Hash] The metadata to assign.
+    # @return [Content] The content with metadata.
+    def self.assign_metadata(content, metadata)
+      [:uid, :title, :summary, :tags, :more, :created_at, :updated_at].each do |field|
+        content.send("#{field}=", metadata.delete(field))
       end
 
-      # Extracts tags from an array, making sure all the comma separated strings are evaluated.
-      #
-      # @param value [String|Array] The string or array to parse.
-      # @return [Array] The list of tags.
-      def parse_tags(value)
-        value.ensure_array(nil, true, true, true) { |v| v.ensure_string.split(/\s*,\s*/) }
-      end
+      content.author = Mbrao::Author.create(metadata.delete(:author))
+      content.locales = extract_locales(metadata.delete(:locales))
+      content.metadata = metadata
+    end
 
-      # Check if value is an Hash.
-      #
-      # @param value [Object] The object to check.
-      # @return [Boolean] `true` if value is an Hash, `false` otherwise
-      def is_hash?(value)
-        value.is_a?(Hash)
-      end
+    # Extracts locales from metadata.
+    #
+    # @param locales [String] The list of locales.
+    # @return [Array] The locales.
+    def self.extract_locales(locales)
+      locales = locales.ensure_string.split(/\s*,\s*/) unless locales.is_a?(::Array)
+      normalize_locales(locales)
+    end
+
+    # Normalizes locales for further usage.
+    #
+    # @param locales [Array] The locales to normalize.
+    # @return [Array] The normalized locales.
+    def self.normalize_locales(locales)
+      locales.flatten.map(&:ensure_string).map(&:strip).uniq
+    end
   end
 end