markerb 0.1.0 → 1.0.0

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    markerb (0.1.0)
-      redcarpet
+    markerb (1.0.0)
+      redcarpet (>= 2.0)
 
 GEM
   remote: http://rubygems.org/
@@ -65,7 +65,7 @@ GEM
       rake (>= 0.8.7)
       thor (~> 0.14.4)
     rake (0.8.7)
-    redcarpet (1.11.2)
+    redcarpet (2.1.0)
     thor (0.14.6)
     treetop (1.4.9)
       polyglot (>= 0.3.1)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2010 PlataformaTec (blog.plataformatec.com.br)
+Copyright 2011 PlataformaTec (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

@@ -0,0 +1,49 @@
+# Markerb
+
+**Markerb** allows you to render multipart e-mails from a single template. The template is written in Markdown, which is delivered as a text part, but also rendered and delivered as an HTML part.
+
+The usage is quite simple. Assuming you have a notifier as below:
+
+```ruby
+class Notifier < ActionMailer::Base
+  def contact(recipient)
+    @recipient = recipient
+    mail(:to => @recipient, :from => "john.doe@example.com") do |format|
+      format.text
+      format.html
+    end
+  end
+end
+```
+
+If you create a template at `app/views/notifier/contact.markerb`:
+
+```erb
+Multipart templates **rocks**, right <%= @recipient %>?!
+```
+
+It will generate two parts, one in text and another in html when delivered. Before we finish, here are a few things you might need to know:
+
+* The `contact.markerb` template should not have a format in its name. Adding a format would make it unavailable to be rendered in different formats;
+
+* The order of the parts matter. It is important for e-mail clients that you call `format.text` before you call `format.html`;
+
+* Notice you can normally use ERb inside the template.
+
+Enjoy!
+
+## Bug reports
+
+If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
+possible to help us fixing the possible bug. We also encourage you to help even more by forking and
+sending us a pull request.
+
+https://github.com/plataformatec/markerb/issues
+
+## Maintainers
+
+* José Valim (https://github.com/josevalim)
+
+## License
+
+MIT License. Copyright 2012 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/lib/markerb.rb

@@ -14,7 +14,7 @@ module Markerb
     def call(template)
       compiled_source = erb_handler.call(template)
       if template.formats.include?(:html)
-        "Redcarpet.new(begin;#{compiled_source};end, *Markerb.processing_options).to_html"
+        "Redcarpet::Markdown.new(Redcarpet::Render::HTML, *Markerb.processing_options).render(begin;#{compiled_source};end)"
       else
         compiled_source
       end
@@ -22,4 +22,4 @@ module Markerb
   end
 end
 
-ActionView::Template.register_template_handler :markerb, Markerb::Handler.new
+ActionView::Template.register_template_handler :markerb, Markerb::Handler.new

data/lib/markerb/version.rb

@@ -1,3 +1,3 @@
 module Markerb
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/markerb.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "redcarpet"
-end
+  s.add_dependency "redcarpet", ">= 2.0"
+end

data/test/markerb_test.rb

@@ -5,18 +5,38 @@ class Notifier < ActionMailer::Base
 
   layout false
 
-  def contact(recipient)
+  def contact(recipient, format_type)
     @recipient = recipient
     mail(:to => @recipient, :from => "john.doe@example.com") do |format|
-      format.text
-      format.html
+      format.send(format_type)
+    end
+  end
+
+  def multiple_format_contact(recipient)
+    @recipient = recipient
+    mail(:to => @recipient, :from => "john.doe@example.com", :template => "contact") do |format|
+      format.text  { render 'contact' }
+      format.html  { render 'contact' }
     end
   end
 end
 
 class MarkerbTest < ActiveSupport::TestCase
-  test 'dual template with .merb' do
-    email = Notifier.contact("you@example.com")
+
+  test "plain text should be sent as a plain text" do
+    email = Notifier.contact("you@example.com", :text)
+    assert_equal "text/plain", email.mime_type
+    assert_equal "Dual templates **rocks**!", email.body.encoded.strip
+  end
+
+  test "html should be sent as html" do
+    email = Notifier.contact("you@example.com", :html)
+    assert_equal "text/html", email.mime_type
+    assert_equal "<p>Dual templates <strong>rocks</strong>!</p>", email.body.encoded.strip
+  end
+
+  test 'dealing with multipart e-mails' do
+    email = Notifier.multiple_format_contact("you@example.com")
     assert_equal 2, email.parts.size
     assert_equal "multipart/alternative", email.mime_type
     assert_equal "text/plain", email.parts[0].mime_type

metadata

@@ -1,51 +1,38 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: markerb
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
-- "Jos\xC3\xA9 Valim"
+authors:
+- José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-26 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: redcarpet
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152594060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2152594060
 description: Multipart templates made easy with Markdown + ERb
 email: contact@plataformatec.com.br
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/generators/markerb/mailer/mailer_generator.rb
 - lib/generators/markerb/mailer/templates/view.markerb
@@ -57,41 +44,31 @@ files:
 - test/markerb_test.rb
 - test/test_helper.rb
 - test/views/notifier/contact.markerb
-has_rdoc: true
 homepage: http://github.com/plataformatec/markerb
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Multipart templates made easy with Markdown + ERb
-test_files: 
+test_files:
 - test/generator_test.rb
 - test/markerb_test.rb
 - test/test_helper.rb

data/README.rdoc

@@ -1,33 +0,0 @@
-= Markerb
-
-Markerb allows you to render multipart e-mails from a single template. The template is written in Markdown, which is delivered as a text part, but also rendered and delivered as an HTML part.
-
-The usage is quite simple. Assuming you have a notifier as below:
-
-    class Notifier < ActionMailer::Base
-      def contact(recipient)
-        @recipient = recipient
-        mail(:to => @recipient, :from => "john.doe@example.com") do |format|
-          format.text
-          format.html
-        end
-      end
-    end
-
-If you create a template at +app/views/notifier/contact.markerb+:
-
-    Multipart templates **rocks**, right <%= @recipient %>?!
-
-It will generate two parts, one in text and another in html when delivered. Before you go, here are a few things you might need to know:
-
-* The "contact.markerb" template should not have a format in its name. Adding a format would make it unavailable to be rendered in different formats;
-
-* The order of the parts matter. It is important you call +format.text+ before you call +format.html+;
-
-* Notice you can normally use ERb inside the template.
-
-Enjoy!
-
-== Copyright and License
-
-Created by the fine folks at PlataformaTec under the MIT-LICENSE (please check MIT-LICENSE file for more info).