mbrao 1.4.4 → 1.5.0

data/lib/mbrao/rendering_engines/base.rb

@@ -15,8 +15,8 @@ module Mbrao
       # @param _options [Hash] A list of options for renderer.
       # @param _context [Hash] A context for rendering.
       def render(_content, _options = {}, _context = {})
-        raise Mbrao::Exceptions::Unimplemented.new
+        raise Mbrao::Exceptions::Unimplemented
       end
     end
   end
-end
+end

data/lib/mbrao/rendering_engines/html_pipeline.rb

@@ -4,32 +4,6 @@
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
-# Main module of the [html-pipeline](https://github.com/jch/html-pipeline) gem.
-module HTML
-  # A [html-pipeline](https://github.com/jch/html-pipeline) gem Pipeline.
-  class Pipeline
-    # A filter to compile Markdown contents.
-    class KramdownFilter < TextFilter
-      # Creates a new filter.
-      #
-      # @param text [String] The string to convert.
-      # @param context [Hash] The context of the conversion.
-      # @param result [Hash] A result hash.
-      def initialize(text, context = nil, result = nil)
-        super(text, context, result)
-        @text = @text.gsub("\r", "")
-      end
-
-      # Converts Markdown to HTML using Kramdown and converts into a DocumentFragment.
-      #
-      # @return [DocumentFragment] The converted fragment.
-      def call
-        Kramdown::Document.new(@text, @context).to_html
-      end
-    end
-  end
-end
-
 module Mbrao
   # Engines used to render contents with metadata.
   module RenderingEngines
@@ -59,7 +33,7 @@ module Mbrao
         rescue Mbrao::Exceptions::UnavailableLocalization => le
           raise le
         rescue => e
-          raise ::Mbrao::Exceptions::Rendering.new(e.to_s)
+          raise ::Mbrao::Exceptions::Rendering, e.to_s
         end
       end
 
@@ -74,7 +48,7 @@ module Mbrao
       #
       # @return [Array] The default pipeline.
       def default_pipeline=(value)
-        @default_pipeline = value.ensure_array(nil, false, false) {|v| v.ensure_array(nil, true, true, true) { |p| p.ensure_string.to_sym } }
+        @default_pipeline = value.ensure_array(nil, false, false) { |v| v.ensure_array(nil, true, true, true) { |p| p.ensure_string.to_sym } }
       end
 
       # Gets the default options.
@@ -92,61 +66,62 @@ module Mbrao
       end
 
       private
-        # Sanitizes options.
-        #
-        # @param options [Hash] The options to sanitize.
-        # @return [Hash] The sanitized options.
-        def sanitize_options(options)
-          options = options.ensure_hash(:symbols)
-          options = filter_filters(options)
-          options[:pipeline_options] = self.default_options.merge(options[:pipeline_options].ensure_hash(:symbols))
-
-          options
-        end
 
-        # Get body of a content.
-        #
-        # @param content [Content|String] The content to sanitize.
-        # @param options [Hash] A list of options for renderer.
-        # @return [Array] The body to parse.
-        def get_body(content, options)
-          content = ::Mbrao::Content.create(nil, content.ensure_string) if !content.is_a?(::Mbrao::Content)
-          content.get_body(options.fetch(:locales, ::Mbrao::Parser.locale).ensure_string)
-        end
+      # Sanitizes options.
+      #
+      # @param options [Hash] The options to sanitize.
+      # @return [Hash] The sanitized options.
+      def sanitize_options(options)
+        options = options.ensure_hash(:symbols)
+        options = filter_filters(options)
+        options[:pipeline_options] = default_options.merge(options[:pipeline_options].ensure_hash(:symbols))
+
+        options
+      end
 
-        # Creates the pipeline for rendering.
-        #
-        # @param options [Hash] A list of options for renderer.
-        # @param context [Hash] A context for rendering.
-        # @return [HTML::Pipeline] The pipeline
-        def create_pipeline(options, context)
-          ::HTML::Pipeline.new(
-            options[:pipeline].map {|f| ::Lazier.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) },
-            options[:pipeline_options].merge(context)
-          )
-        end
+      # Get body of a content.
+      #
+      # @param content [Content|String] The content to sanitize.
+      # @param options [Hash] A list of options for renderer.
+      # @return [Array] The body to parse.
+      def get_body(content, options)
+        content = ::Mbrao::Content.create(nil, content.ensure_string) unless content.is_a?(::Mbrao::Content)
+        content.get_body(options.fetch(:locales, ::Mbrao::Parser.locale).ensure_string)
+      end
 
-        # Filters pipeline filters basing on the options provided.
-        #
-        # @param options [Hash] The original options.
-        # @return [Hash] The options with the new set of filters.
-        def filter_filters(options)
-          options[:pipeline] = get_pipeline(options)
+      # Creates the pipeline for rendering.
+      #
+      # @param options [Hash] A list of options for renderer.
+      # @param context [Hash] A context for rendering.
+      # @return [HTML::Pipeline] The pipeline
+      def create_pipeline(options, context)
+        ::HTML::Pipeline.new(
+          options[:pipeline].map { |f| ::Lazier.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) },
+          options[:pipeline_options].merge(context)
+        )
+      end
 
-          self.default_pipeline.each do |f|
-            options[:pipeline].delete(f.first) if !options.fetch(f.last, true)
-          end
+      # Filters pipeline filters basing on the options provided.
+      #
+      # @param options [Hash] The original options.
+      # @return [Hash] The options with the new set of filters.
+      def filter_filters(options)
+        options[:pipeline] = get_pipeline(options)
 
-          options
+        default_pipeline.each do |f|
+          options[:pipeline].delete(f.first) unless options.fetch(f.last, true)
         end
 
-        # Gets the pipeline for the current options.
-        #
-        # @param options [Hash] The options to parse.
-        # @return [Array] The pipeline to process.
-        def get_pipeline(options)
-          options.fetch(:pipeline, self.default_pipeline.map(&:first)).map(&:to_sym)
-        end
+        options
+      end
+
+      # Gets the pipeline for the current options.
+      #
+      # @param options [Hash] The options to parse.
+      # @return [Array] The pipeline to process.
+      def get_pipeline(options)
+        options.fetch(:pipeline, default_pipeline.map(&:first)).map(&:to_sym)
+      end
     end
   end
-end
+end

data/lib/mbrao/rendering_engines/html_pipeline/kramdown_filter.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+# Main module of the [html-pipeline](https://github.com/jch/html-pipeline) gem.
+module HTML
+  # A [html-pipeline](https://github.com/jch/html-pipeline) gem Pipeline.
+  class Pipeline
+    # A filter to compile Markdown contents.
+    class KramdownFilter < TextFilter
+      # Creates a new filter.
+      #
+      # @param text [String] The string to convert.
+      # @param context [Hash] The context of the conversion.
+      # @param result [Hash] A result hash.
+      def initialize(text, context = nil, result = nil)
+        super(text, context, result)
+        @text = @text.gsub("\r", "")
+      end
+
+      # Converts Markdown to HTML using Kramdown and converts into a DocumentFragment.
+      #
+      # @return [DocumentFragment] The converted fragment.
+      def call
+        Kramdown::Document.new(@text, @context).to_html
+      end
+    end
+  end
+end

data/lib/mbrao/version.rb

@@ -14,10 +14,10 @@ module Mbrao
     MAJOR = 1
 
     # The minor version.
-    MINOR = 4
+    MINOR = 5
 
     # The patch version.
-    PATCH = 4
+    PATCH = 0
 
     # The current version of mbrao.
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

data/mbrao.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 1.9.3"
 
-  gem.add_dependency("lazier", "~> 3.5.1")
-  gem.add_dependency("html-pipeline", "~> 1.6.0")
+  gem.add_dependency("lazier", "~> 3.5.5")
+  gem.add_dependency("html-pipeline", "~> 1.8.0")
   gem.add_dependency("slim", "~> 2.0.2")
-  gem.add_dependency("kramdown", "~> 1.3.2")
+  gem.add_dependency("kramdown", "~> 1.3.3")
   gem.add_dependency("rinku", "~> 1.7.3")
   gem.add_dependency("gemoji", "~> 1.5.0")
 end

data/spec/mbrao/author_spec.rb

@@ -68,7 +68,7 @@ describe Mbrao::Author do
       expect(subject.as_json).to eq({
         "email" => "name@example.com",
         "image" => "http://example.com/image.jpg",
-        "metadata" => {"a" => {"b" => :c}},
+        "metadata" => {"a" => {"b" => "c"}},
         "name" => "NAME",
         "uid" => nil,
         "website" => "http://example.com"

data/spec/mbrao/content_spec.rb

@@ -315,7 +315,7 @@ describe Mbrao::Content do
   describe "#as_json" do
     subject {
       @created_at = DateTime.civil(1984, 7, 7, 11, 30, 0)
-      @created_at_s = @created_at.strftime("%FT%T.%L%Z")
+      @created_at_s = @created_at.as_json
       metadata = {"uid" => "UID", "title" => {it: "IT", en: "EN"}, "summary" => "SUMMARY", "author" => "AUTHOR", "tags" => {it: "IT", en: "EN"}, "more" => "MORE", created_at: @created_at, locales: ["it", ["en"]], other: ["OTHER"]}
       ::Mbrao::Content.create(metadata, "BODY")
     }

data/spec/mbrao/parser_spec.rb

@@ -100,27 +100,27 @@ describe Mbrao::Parser do
     end
   end
 
-  describe ".is_email?" do
+  describe ".email?" do
     it "should check for valid emails" do
-      expect(Mbrao::Parser.is_email?("valid@email.com")).to be_true
-      expect(Mbrao::Parser.is_email?("valid@localhost")).to be_false
-      expect(Mbrao::Parser.is_email?("this.is.9@email.com")).to be_true
-      expect(Mbrao::Parser.is_email?("INVALID")).to be_false
-      expect(Mbrao::Parser.is_email?(nil)).to be_false
-      expect(Mbrao::Parser.is_email?([])).to be_false
-      expect(Mbrao::Parser.is_email?("this.is.9@email.com.uk")).to be_true
+      expect(Mbrao::Parser.email?("valid@email.com")).to be_true
+      expect(Mbrao::Parser.email?("valid@localhost")).to be_false
+      expect(Mbrao::Parser.email?("this.is.9@email.com")).to be_true
+      expect(Mbrao::Parser.email?("INVALID")).to be_false
+      expect(Mbrao::Parser.email?(nil)).to be_false
+      expect(Mbrao::Parser.email?([])).to be_false
+      expect(Mbrao::Parser.email?("this.is.9@email.com.uk")).to be_true
     end
   end
 
-  describe ".is_url?" do
+  describe ".url?" do
     it "should check for valid URLs" do
-      expect(Mbrao::Parser.is_url?("http://google.it")).to be_true
-      expect(Mbrao::Parser.is_url?("ftp://ftp.google.com")).to be_true
-      expect(Mbrao::Parser.is_url?("http://google.it/?q=FOO+BAR")).to be_true
-      expect(Mbrao::Parser.is_url?("INVALID")).to be_false
-      expect(Mbrao::Parser.is_url?([])).to be_false
-      expect(Mbrao::Parser.is_url?(nil)).to be_false
-      expect(Mbrao::Parser.is_url?({})).to be_false
+      expect(Mbrao::Parser.url?("http://google.it")).to be_true
+      expect(Mbrao::Parser.url?("ftp://ftp.google.com")).to be_true
+      expect(Mbrao::Parser.url?("http://google.it/?q=FOO+BAR")).to be_true
+      expect(Mbrao::Parser.url?("INVALID")).to be_false
+      expect(Mbrao::Parser.url?([])).to be_false
+      expect(Mbrao::Parser.url?(nil)).to be_false
+      expect(Mbrao::Parser.url?({})).to be_false
     end
   end
 

data/spec/mbrao/rendering_engines/html_pipeline/kramdown_filter_spec.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe HTML::Pipeline::KramdownFilter do
+  describe "#initialize" do
+    it "should call the parent constructor" do
+      expect(HTML::Pipeline::TextFilter).to receive(:new).with("\rCONTENT\r", {a: "b"}, {c: "d"})
+      HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"})
+    end
+
+    it "should remove \r from the text" do
+      subject = HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"})
+      expect(subject.instance_variable_get(:@text)).to eq("CONTENT")
+    end
+
+    it "should use Kramdown with given options for building the result" do
+      object = Object.new
+      expect(Kramdown::Document).to receive(:new).with("CONTENT", {a: "b"}).and_return(object)
+      expect(object).to receive(:to_html)
+      HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"}).call
+    end
+  end
+end

data/spec/mbrao/rendering_engines/html_pipeline_spec.rb

@@ -103,25 +103,4 @@ describe Mbrao::RenderingEngines::HtmlPipeline do
       expect(subject.default_options).to eq({})
     end
   end
-end
-
-describe HTML::Pipeline::KramdownFilter do
-  describe "#initialize" do
-    it "should call the parent constructor" do
-      expect(HTML::Pipeline::TextFilter).to receive(:new).with("\rCONTENT\r", {a: "b"}, {c: "d"})
-      HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"})
-    end
-
-    it "should remove \r from the text" do
-      subject = HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"})
-      expect(subject.instance_variable_get(:@text)).to eq("CONTENT")
-    end
-
-    it "should use Kramdown with given options for building the result" do
-      object = Object.new
-      expect(Kramdown::Document).to receive(:new).with("CONTENT", {a: "b"}).and_return(object)
-      expect(object).to receive(:to_html)
-      HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"}).call
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mbrao
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Shogun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lazier
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.5.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 3.5.5
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: rinku
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis-gemfile"
 - ".travis.yml"
 - ".yardopts"
@@ -109,6 +110,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- doc/ActionView.html
+- doc/ActionView/Template.html
 - doc/ActionView/Template/Handlers.html
 - doc/ActionView/Template/Handlers/MbraoTemplate.html
 - doc/HTML.html
@@ -117,6 +120,8 @@ files:
 - doc/Mbrao.html
 - doc/Mbrao/Author.html
 - doc/Mbrao/Content.html
+- doc/Mbrao/ContentInterface.html
+- doc/Mbrao/ContentInterface/ClassMethods.html
 - doc/Mbrao/ContentPublicInterface.html
 - doc/Mbrao/Exceptions.html
 - doc/Mbrao/Exceptions/InvalidDate.html
@@ -127,6 +132,10 @@ files:
 - doc/Mbrao/Exceptions/Unimplemented.html
 - doc/Mbrao/Exceptions/UnknownEngine.html
 - doc/Mbrao/Parser.html
+- doc/Mbrao/ParserInterface.html
+- doc/Mbrao/ParserInterface/ClassMethods.html
+- doc/Mbrao/ParserValidations.html
+- doc/Mbrao/ParserValidations/ClassMethods.html
 - doc/Mbrao/ParsingEngines.html
 - doc/Mbrao/ParsingEngines/Base.html
 - doc/Mbrao/ParsingEngines/PlainText.html
@@ -155,13 +164,17 @@ files:
 - lib/mbrao.rb
 - lib/mbrao/author.rb
 - lib/mbrao/content.rb
+- lib/mbrao/content_interface.rb
 - lib/mbrao/exceptions.rb
 - lib/mbrao/integrations/rails.rb
 - lib/mbrao/parser.rb
+- lib/mbrao/parser_interface.rb
+- lib/mbrao/parser_validations.rb
 - lib/mbrao/parsing_engines/base.rb
 - lib/mbrao/parsing_engines/plain_text.rb
 - lib/mbrao/rendering_engines/base.rb
 - lib/mbrao/rendering_engines/html_pipeline.rb
+- lib/mbrao/rendering_engines/html_pipeline/kramdown_filter.rb
 - lib/mbrao/version.rb
 - mbrao.gemspec
 - spec/coverage_helper.rb
@@ -172,6 +185,7 @@ files:
 - spec/mbrao/parsing_engines/base_spec.rb
 - spec/mbrao/parsing_engines/plain_text_spec.rb
 - spec/mbrao/rendering_engines/base_spec.rb
+- spec/mbrao/rendering_engines/html_pipeline/kramdown_filter_spec.rb
 - spec/mbrao/rendering_engines/html_pipeline_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ShogunPanda/mbrao
@@ -207,6 +221,7 @@ test_files:
 - spec/mbrao/parsing_engines/base_spec.rb
 - spec/mbrao/parsing_engines/plain_text_spec.rb
 - spec/mbrao/rendering_engines/base_spec.rb
+- spec/mbrao/rendering_engines/html_pipeline/kramdown_filter_spec.rb
 - spec/mbrao/rendering_engines/html_pipeline_spec.rb
 - spec/spec_helper.rb
 has_rdoc: