mbrao 1.0.0

data/spec/mbrao/parsing_engines/plain_text_spec.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Mbrao::ParsingEngines::PlainText do
+  let(:reference) { Mbrao::ParsingEngines::PlainText.new }
+
+  let(:sample_metadata) {
+    <<EOM
+title: "OK"
+locales:
+  - it
+  - en
+more:
+  it: "Continua"
+  en: "Continue"
+other:
+  status: "OK"
+EOM
+  }
+
+  let(:sample_content){
+    <<EOC
+This is a content.
+
+{{content: en}}
+Optionally I'm filtered only for English.
+{{/content}}
+EOC
+  }
+
+  let(:sample_valid) {
+    <<EOS1
+
+
+{{metadata}}
+#{sample_metadata}
+{{/metadata}}
+
+#{sample_content}
+
+EOS1
+  }
+
+  let(:sample_invalid) {
+    <<EOS2
+{{metadata}}
+#{sample_content}
+EOS2
+  }
+
+  let(:sample_no_metadata) {
+    <<EOS3
+#{sample_content}
+EOS3
+  }
+
+  let(:sample_nested_content) {
+    <<EOS4
+START
+{{content: it, en}}IT, EN{{/content}}
+{{content: *, !en, !it, !es, !fr}}MIDDLE{{/content}}
+{{content: !it}}
+  {{content: !es}}!IT and !ES{{/content}}
+  {{content: en}}EN in !IT{{/content}}
+
+  !IT
+{{/content}}
+{{content: !*}}END{{/content}}
+EOS4
+  }
+
+  describe "#separate_components" do
+    it "should return correct metadata and contents" do
+      expect(reference.separate_components(sample_valid)).to eq([sample_metadata.strip, sample_content.strip])
+    end
+
+    it "should return the whole content if metadata are either incorrectly tagged or not present" do
+      expect(reference.separate_components(sample_invalid)).to eq(["", sample_invalid.strip])
+      expect(reference.separate_components(sample_no_metadata)).to eq(["", sample_no_metadata.strip])
+    end
+
+    it "should use different tags" do
+      expect(reference.separate_components("[meta]{{metadata}}OK\n[/meta] REST", {meta_tags: ["[meta]", "[/meta]"]})).to eq(["{{metadata}}OK", "REST"])
+    end
+  end
+
+  describe "#parse_metadata" do
+    it "should correctly parse YAML formatted metadata" do
+      expect(reference.parse_metadata("---\nyaml:\n  :a: 'b'")).to eq({"yaml" => {a: "b"}})
+    end
+
+    it "should return a default value if parsing failed" do
+      expect(reference.parse_metadata("---\n\"yaml:", {default: "DEFAULT"})).to eq("DEFAULT")
+    end
+
+    it "should raise an exception if parsing failed and no default is available" do
+      expect { reference.parse_metadata("---\n\"yaml:") }.to raise_error(::Mbrao::Exceptions::InvalidMetadata)
+    end
+  end
+
+  describe "#filter_content" do
+    def parse_content(content)
+      content.split("\n").collect(&:strip).select {|l| l.present? }
+    end
+
+    it "should return the original content if locales contains *" do
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), "*"))).to eq(["START", "IT, EN", "MIDDLE", "!IT and !ES", "EN in !IT", "!IT", "END"])
+    end
+
+    it "should use default locale if nothing is specified" do
+      ::Mbrao::Parser.locale = :it
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content)))).to eq(["START", "IT, EN", "MIDDLE", "END"])
+    end
+
+    it "should ignore unclosed tag, trying to close the leftmost start tag" do
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, "{{content: it}}\n{{content: en}}NO{{/content}}")))).to eq(["{{content: en}}NO"])
+    end
+
+    it "should correctly filter by tag" do
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), "en"))).to eq(["START", "IT, EN", "MIDDLE", "!IT and !ES", "EN in !IT", "!IT", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), "it"))).to eq(["START", "IT, EN", "MIDDLE", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), "es"))).to eq(["START", "MIDDLE", "!IT", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), "fr"))).to eq(["START", "MIDDLE", "!IT and !ES", "!IT", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), ["it", "en"]))).to eq(["START", "IT, EN", "MIDDLE", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), ["es", "en"]))).to eq(["START", "IT, EN", "MIDDLE", "EN in !IT", "!IT", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), ["fr", "en"]))).to eq(["START", "IT, EN", "MIDDLE", "!IT and !ES", "EN in !IT", "!IT", "END"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample_nested_content), ["fr", "es", "en"]))).to eq(["START", "IT, EN", "MIDDLE", "EN in !IT", "!IT", "END"])
+    end
+
+    it "should use different tags" do
+      sample = "[content-it]{{content: !it}}IT[/content]\nOK"
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample), "it", {content_tags: ["[content-%ARGS%]", "[/content]"]}))).to eq(["{{content: !it}}IT", "OK"])
+      expect(parse_content(reference.filter_content(::Mbrao::Content.create(nil, sample), "en", {content_tags: ["[content-%ARGS%]", "[/content]"]}))).to eq(["OK"])
+    end
+  end
+end

data/spec/mbrao/rendering_engines/base_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Mbrao::RenderingEngines::Base do
+  let(:reference) { Mbrao::RenderingEngines::Base.new }
+
+  describe "#render" do
+    it "should raise an exception" do
+      expect { reference.render("CONTENT", {}, {}) }.to raise_error(Mbrao::Exceptions::Unimplemented)
+    end
+  end
+end

data/spec/mbrao/rendering_engines/html_pipeline_spec.rb

@@ -0,0 +1,128 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "spec_helper"
+
+describe Mbrao::RenderingEngines::HtmlPipeline do
+  let(:reference) { Mbrao::RenderingEngines::HtmlPipeline.new }
+
+  describe "#render" do
+    it "should forward everything to the html-pipeline" do
+      pipeline = Object.new
+      pipeline.should_receive(:call).with("CONTENT").and_return({output: ""})
+      ::HTML::Pipeline.should_receive(:new).with(an_instance_of(Array), an_instance_of(Hash)).and_return(pipeline)
+      reference.render("CONTENT")
+    end
+
+    it "should raise a specific exception if a locale is not available" do
+
+      expect { reference.render(::Mbrao::Content.create({locales: ["en"]}, "BODY"), {locales: ["it"]}) }.to raise_error(::Mbrao::Exceptions::UnavailableLocalization)
+    end
+
+      it "should raise an exception if anything goes wrong" do
+      ::HTML::Pipeline.stub(:new).and_raise(ArgumentError.new("ERROR"))
+      expect { reference.render("CONTENT") }.to raise_error(::Mbrao::Exceptions::Rendering)
+    end
+
+    it "should have default options" do
+      filters = [:kramdown, :table_of_contents, :autolink, :emoji, :image_max_width].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, {gfm: true, asset_root: "/"}).and_call_original
+      reference.render("CONTENT")
+    end
+
+    it "should merge context to options" do
+      ::HTML::Pipeline.should_receive(:new).with(an_instance_of(Array), {gfm: true, asset_root: "/", additional: true}).and_call_original
+      reference.render("CONTENT", {}, {additional: true})
+    end
+
+    it "should restrict filter used" do
+      filters = [:table_of_contents, :autolink, :emoji, :image_max_width].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, an_instance_of(Hash)).and_call_original
+      reference.render("CONTENT", {kramdown: false})
+
+      filters = [:kramdown, :autolink, :emoji, :image_max_width].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, an_instance_of(Hash)).and_call_original
+      reference.render("CONTENT", {toc: false})
+
+      filters = [:kramdown, :table_of_contents, :emoji, :image_max_width].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, an_instance_of(Hash)).and_call_original
+      reference.render("CONTENT", {links: false})
+
+      filters = [:kramdown, :table_of_contents, :autolink, :image_max_width].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, an_instance_of(Hash)).and_call_original
+      reference.render("CONTENT", {emoji: false})
+
+      filters = [:kramdown, :table_of_contents, :autolink, :emoji].collect {|f| ::Mbrao::Parser.find_class(f, "::HTML::Pipeline::%CLASS%Filter", true) }
+      ::HTML::Pipeline.should_receive(:new).with(filters, an_instance_of(Hash)).and_call_original
+      reference.render("CONTENT", {image_max_width: false})
+    end
+  end
+
+  describe "#default_pipeline" do
+    it "should return a default pipeline" do
+      expect(reference.default_pipeline).to eq([[:kramdown], [:table_of_contents, :toc], [:autolink, :links], [:emoji], [:image_max_width]])
+    end
+  end
+
+  describe "#default_pipeline=" do
+    it "should set a correct pipeline" do
+      reference.default_pipeline = nil
+      expect(reference.default_pipeline).to eq([[]])
+
+      reference.default_pipeline = "A"
+      expect(reference.default_pipeline).to eq([[:A]])
+
+      reference.default_pipeline = ["A", "B"]
+      expect(reference.default_pipeline).to eq([[:A], [:B]])
+
+      reference.default_pipeline = ["1", [["B", ["C"]]]]
+      expect(reference.default_pipeline).to eq([[:"1"], [:B, :C]])
+    end
+  end
+
+  describe "#default_options" do
+    it "should return a default hash" do
+      expect(reference.default_options).to eq({gfm: true, asset_root: "/"})
+    end
+
+    it "should return the set hash" do
+      reference.instance_variable_set(:@default_options, {})
+      expect(reference.default_options).to eq({})
+    end
+  end
+
+  describe "#default_options=" do
+    it "should only assign if the value is an Hash" do
+      reference.default_options = {a: "b"}
+      expect(reference.default_options).to eq({a: "b"})
+      reference.default_options = 1
+      expect(reference.default_options).to eq({})
+      reference.default_options = nil
+      expect(reference.default_options).to eq({})
+    end
+  end
+end
+
+describe HTML::Pipeline::KramdownFilter do
+  describe "#initialize" do
+    it "should call the parent constructor" do
+      HTML::Pipeline::TextFilter.should_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
+      reference = HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"})
+      expect(reference.instance_variable_get(:@text)).to eq("CONTENT")
+    end
+
+    it "should use Kramdown with given options for building the result" do
+      object = Object.new
+      Kramdown::Document.should_receive(:new).with("CONTENT", {a: "b"}).and_return(object)
+      object.should_receive(:to_html)
+      HTML::Pipeline::KramdownFilter.new("\rCONTENT\r", {a: "b"}, {c: "d"}).call
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+# This file is part of the mbrao gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
+require "rubygems"
+require "bundler/setup"
+require "mbrao"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: mbrao
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Shogun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lazier
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: html-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+description: A content parser and renderer with embedded metadata support.
+email:
+- shogun_panda@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis-gemfile
+- .travis.yml
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- doc/ActionView/Template/Handlers.html
+- doc/ActionView/Template/Handlers/MbraoTemplate.html
+- doc/HTML.html
+- doc/HTML/Pipeline.html
+- doc/HTML/Pipeline/KramdownFilter.html
+- doc/Mbrao.html
+- doc/Mbrao/Author.html
+- doc/Mbrao/Content.html
+- doc/Mbrao/ContentPublicInterface.html
+- doc/Mbrao/Exceptions.html
+- doc/Mbrao/Exceptions/InvalidDate.html
+- doc/Mbrao/Exceptions/InvalidMetadata.html
+- doc/Mbrao/Exceptions/Parsing.html
+- doc/Mbrao/Exceptions/Rendering.html
+- doc/Mbrao/Exceptions/UnavailableLocalization.html
+- doc/Mbrao/Exceptions/Unimplemented.html
+- doc/Mbrao/Exceptions/UnknownEngine.html
+- doc/Mbrao/Parser.html
+- doc/Mbrao/ParsingEngines.html
+- doc/Mbrao/ParsingEngines/Base.html
+- doc/Mbrao/ParsingEngines/PlainText.html
+- doc/Mbrao/PublicInterface.html
+- doc/Mbrao/PublicInterface/ClassMethods.html
+- doc/Mbrao/RenderingEngines.html
+- doc/Mbrao/RenderingEngines/Base.html
+- doc/Mbrao/RenderingEngines/HtmlPipeline.html
+- doc/Mbrao/Validations.html
+- doc/Mbrao/Validations/ClassMethods.html
+- doc/Mbrao/Version.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/mbrao.rb
+- lib/mbrao/author.rb
+- lib/mbrao/content.rb
+- lib/mbrao/exceptions.rb
+- lib/mbrao/integrations/rails.rb
+- lib/mbrao/parser.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/version.rb
+- mbrao.gemspec
+- spec/coverage_helper.rb
+- spec/mbrao/author_spec.rb
+- spec/mbrao/content_spec.rb
+- spec/mbrao/integrations/rails_spec.rb
+- spec/mbrao/parser_spec.rb
+- 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_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ShogunPanda/mbrao
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 488107274440574524
+requirements: []
+rubyforge_project: mbrao
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A content parser and renderer with embedded metadata support.
+test_files:
+- spec/coverage_helper.rb
+- spec/mbrao/author_spec.rb
+- spec/mbrao/content_spec.rb
+- spec/mbrao/integrations/rails_spec.rb
+- spec/mbrao/parser_spec.rb
+- 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_spec.rb
+- spec/spec_helper.rb
+has_rdoc: