markerb 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3111a5755207d9dfb330521b7bea559108f5190
-  data.tar.gz: 614b823e13c5c9d345e08916d30604be92ac0a5b
+  metadata.gz: 9bd7b5190ebf252b9548185f66b1652ef1660e23
+  data.tar.gz: 5294a6472a029bbcf3494892dc8e2ff44ee8ead1
 SHA512:
-  metadata.gz: 34d1b7b2686139c9e9d9dbed0c957256dce2c7658413ca629d661f234f57adbae870687594ae37279cca15487571d9d086652ab9574ab42900aa97f408aff1b1
-  data.tar.gz: 4c0f822bdfa2a984f8dbe5ba0ce1cfd87c2af79642f1661307b3fedf39860151c1de4066be3cc0a6be3124eb63e5826b0c4206f3448e0b6e2f341d698219c5db
+  metadata.gz: ba587a666a3394d8ce656c9685ec12dba5eb7d791956ad4bc50ad0264746e2150e44689f5fcf4fe0e897a520df8839a630b52ec9870122fa684a7a696861e43d
+  data.tar.gz: 54d187b157c8df8fb3f19876e948c834264a65285556ef506c7057a91325c53c7dc3764bcefbfaa7cb1a99f87cc13e6dfff101f103638787cbc04055664e5fce

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2014 Plataformatec (http://blog.plataformatec.com.br)
+Copyright 2011-2015 Plataformatec (http://blog.plataformatec.com.br)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -34,6 +34,22 @@ It will generate two parts, one in text and another in html when delivered. Befo
 
 Enjoy!
 
+## Installation
+
+Add it to your Gemfile, with either the `redcarpet` or `kramdown` parser:
+
+```ruby
+gem 'markerb'
+gem 'redcarpet', '>= 2.0'
+# gem 'kramdown'
+```
+
+Run the following command to install it:
+
+```console
+bundle install
+```
+
 ## Bug reports
 
 If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
@@ -48,4 +64,4 @@ https://github.com/plataformatec/markerb/issues
 
 ## License
 
-MIT License. Copyright 2011-2014 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2011-2015 Plataformatec. http://plataformatec.com.br

data/lib/generators/markerb/mailer/templates/layout.markerb

@@ -0,0 +1 @@
+<%%= yield %>

data/lib/markerb.rb

@@ -1,13 +1,9 @@
 require "action_view"
 require "action_view/template"
-require "redcarpet"
+require "markerb/markdown"
 require "markerb/railtie"
 
 module Markerb
-  mattr_accessor :processing_options, :renderer
-  @@processing_options = {}
-  @@renderer = Redcarpet::Render::HTML
-
   class Handler
     def erb_handler
       @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
@@ -16,7 +12,7 @@ module Markerb
     def call(template)
       compiled_source = erb_handler.call(template)
       if template.formats.include?(:html)
-        "Redcarpet::Markdown.new(Markerb.renderer, Markerb.processing_options).render(begin;#{compiled_source};end).html_safe"
+        "Markerb::Markdown.to_html(begin;#{compiled_source};end).html_safe"
       else
         compiled_source
       end

data/lib/markerb/markdown.rb

@@ -0,0 +1,17 @@
+module Markerb
+  mattr_accessor :processing_options, :renderer
+  @@processing_options = {}
+
+  class Markdown
+    def self.to_html(compiled_source)
+      if defined?(Redcarpet)
+        Markerb.renderer ||= Redcarpet::Render::HTML
+        Redcarpet::Markdown.new(Markerb.renderer, Markerb.processing_options).render(compiled_source)
+      elsif defined?(Kramdown)
+        Kramdown::Document.new(compiled_source, Markerb.processing_options).to_html
+      else
+        raise StandardError, "Markdown processor unavailable, please add either Redcarpet or Kramdown to your project"
+      end
+    end
+  end
+end

data/lib/markerb/version.rb

@@ -1,3 +1,3 @@
 module Markerb
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/test/markdown_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class MarkdownTest < ActiveSupport::TestCase
+  setup do
+    @original_redcarpet = Redcarpet
+    @original_kramdown = Kramdown
+  end
+
+  teardown do
+    Object.const_set(:Redcarpet, @original_redcarpet) unless defined?(Redcarpet)
+    Object.const_set(:Kramdown, @original_kramdown) unless defined?(Kramdown)
+  end
+
+  test 'with Redcarpet markdown processor' do
+    Object.send(:remove_const, :Kramdown)
+    assert_equal "<p>Dual templates <strong>rocks</strong>!</p>", Markerb::Markdown.to_html("Dual templates **rocks**!").strip
+  end
+
+  test 'with Kramdown markdown processor' do
+    Object.send(:remove_const, :Redcarpet)
+    assert_equal "<p>Dual templates <strong>rocks</strong>!</p>", Markerb::Markdown.to_html("Dual templates **rocks**!").strip
+  end
+
+  test 'when there is no known markdown processor available' do
+    Object.send(:remove_const, :Redcarpet)
+    Object.send(:remove_const, :Kramdown)
+
+    assert_raise(StandardError) { Markerb::Markdown.to_html("Dual templates **rocks**!") }
+  end
+end

data/test/test_helper.rb

@@ -9,10 +9,14 @@ require "action_mailer"
 require "rails/railtie"
 require "rails/generators"
 require "rails/generators/test_case"
+require "redcarpet"
+require "kramdown"
 
 $:.unshift File.expand_path("../../lib", __FILE__)
 require "markerb"
 
+ActiveSupport::TestCase.test_order = :sorted if ActiveSupport::TestCase.respond_to? :test_order=
+
 # Avoid annoying warning from I18n.
 I18n.enforce_available_locales = false
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markerb
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -17,13 +17,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Multipart templates made easy with Markdown + ERb
 email: contact@plataformatec.com.br
 executables: []
@@ -33,11 +47,14 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/generators/markerb/mailer/mailer_generator.rb
+- lib/generators/markerb/mailer/templates/layout.markerb
 - lib/generators/markerb/mailer/templates/view.markerb
 - lib/markerb.rb
+- lib/markerb/markdown.rb
 - lib/markerb/railtie.rb
 - lib/markerb/version.rb
 - test/generator_test.rb
+- test/markdown_test.rb
 - test/markerb_test.rb
 - test/test_helper.rb
 homepage: http://github.com/plataformatec/markerb
@@ -60,11 +77,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Multipart templates made easy with Markdown + ERb
 test_files:
 - test/generator_test.rb
+- test/markdown_test.rb
 - test/markerb_test.rb
 - test/test_helper.rb