mustdown 0.0.2 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc042b8580cec63abbbd16ce9e0294ba1400988f
+  data.tar.gz: 12afa86fffd4bf116c4d653f3114925572a4b11e
+SHA512:
+  metadata.gz: b544f888f2840b3c10fd6b8dae15a0c9fb7e308ab995e16c6af7e0cc0d6a0e63e03eb2e1ca21955b275d0acfdbb1581b61972b760c23b07fcd6127cec8505591
+  data.tar.gz: 57c76a80031a0fa9d1114aa6729f6df5358e9b368bae832158ab24953efb6a49140a2a5ef072cca4c39958da850ac505bf7c7e3897d30ec5fec52eadd0d499d4

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Simon Courtois
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,7 @@
-# Mustdown
+# Mustdown [![Build Status](https://secure.travis-ci.org/simonc/mustdown.png?branch=master)](http://travis-ci.org/simonc/mustdown) [![Code Climate](https://codeclimate.com/github/simonc/mustdown.png)](https://codeclimate.com/github/simonc/mustdown) [![Coverage Status](https://coveralls.io/repos/simonc/mustdown/badge.png?branch=master)](https://coveralls.io/r/simonc/mustdown?branch=master)
 
-Mustdown provides helpers to ease the use markdown, mustache and both of them.
+Mustdown provides helpers to ease the use of markdown, mustache and both of
+them.
 
 ## Installation
 
@@ -10,7 +11,7 @@ Add the gem to your `Gemfile` :
 
 Then call `bundle install` to install it for your application.
 
-## Provided helpers
+## Usage in Rails
 
 ### markdown
 
@@ -54,6 +55,37 @@ Output:
 <h1>Hello World</h1>
 ```
 
+## Usage outside of Rails
+
+If you're not using Rails, it's possible to use the Mustdown module directly.
+
+### markdown
+
+This will render the given text through Markdown.
+
+``` ruby
+Mustdown.markdown("# Hello World")
+# => "<h1>Hello World</h1>"
+```
+
+### mustache
+
+The `mustache` method renders a mustache template with the given binding object.
+
+``` ruby
+Mustdown.mustache("Hello {{name}}", name: 'John')
+# => "Hello John"
+```
+
+### mustdown
+
+This method is more complex since it provides the two previous methods in one.
+
+``` ruby
+Mustdown.mustdown("# {{title}}", title: 'Hello World')
+# => "<h1>Hello World</h1>"
+```
+
 ## Mustdown configuration
 
 You can generate a default initializer by calling:
@@ -81,7 +113,6 @@ Let's take an example. Given the following models in your app:
 
 ![Company(name) -> Project(title,url)](http://yuml.me/626df1f5)
 
-
 Define the following in `config/locales/en.yml`:
 
 ``` yaml

data/app/helpers/mustdown/mustdown_helper.rb

@@ -1,21 +1,28 @@
+# Public: Wrapper class for Mustdown.
+#
+# This module is a Rails helper that provides an easy access to the Mustdown
+# rendering methods.
 module Mustdown
   module MustdownHelper
-    def markdown(content, markdown_extensions = {}, renderer_options = {})
-      md_exts = Mustdown.markdown_extensions.merge(markdown_extensions)
-      renderer_opts = Mustdown.renderer_options.merge(renderer_options)
-
-      renderer = Mustdown.renderer.new(renderer_opts)
-      markdown = Redcarpet::Markdown.new(renderer, md_exts)
-
-      markdown.render(content).html_safe
+    # Public: Calls Mustdown.markdown.
+    #
+    # See Mustdown.markdown.
+    def markdown(*args)
+      Mustdown.markdown(*args).html_safe
     end
 
-    def mustache(template, resource)
-      Mustache.render(template, resource).html_safe
+    # Public: Calls Mustdown.mustache.
+    #
+    # See Mustdown.mustache.
+    def mustache(*args)
+      Mustdown.mustache(*args).html_safe
     end
 
-    def mustdown(template, resource, *markdown_args)
-      markdown mustache(template, resource), *markdown_args
+    # Public: Calls Mustdown.mustdown.
+    #
+    # See Mustdown.mustdown.
+    def mustdown(*args)
+      Mustdown.mustdown(*args).html_safe
     end
   end
 end

data/lib/generators/templates/mustdown.rb

@@ -22,4 +22,6 @@ Mustdown.configure do |config|
   #   safe_links_only:  true
   # }
 
+  # Markdown renderer class
+  # config.markdown_renderer = Redcarpet::Render::HTML
 end

data/lib/mustdown/engine.rb

@@ -1,9 +1,11 @@
 module Mustdown
   class Engine < ::Rails::Engine
+    # Disable specs generation
     config.generators do |g|
       g.test_framework :rspec, view_specs: false
     end
 
+    # Register MustdownHelper as a Rails helper
     initializer 'mustdown.action_controller' do |app|
       ActiveSupport.on_load :action_controller do
         helper Mustdown::MustdownHelper

data/lib/mustdown/version.rb

@@ -1,3 +1,3 @@
 module Mustdown
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/mustdown.rb

@@ -3,37 +3,206 @@ require 'bundler/setup'
 require 'redcarpet'
 require 'mustache'
 
-require 'mustdown/engine'
+require 'mustdown/engine' if defined?(Rails)
 
+# Public: Provides a simple way to render markdown, mustache and
+# mustache+markdown templates.
+#
+# Examples
+#
+#   # Rendering a markdown template.
+#   tpl = 'This is **bold** and this is *italic*'
+#   Mustdown.markdown(tpl)
+#   # => '<p>This is <strong>bold</strong> and this is <em>italic</em></p>'
+#
+#   # Rendering a mustache template.
+#   tpl = 'My name is {{name}} and I am {{age}}'
+#   Mustdown.mustache(tpl, name: 'Tom', age: 20)
+#   # => 'My name is Tom and I am 20'
+#
+#   # Rendering a mustache+markdown template.
+#   tpl = '# More about {{name}}'
+#   Mustdown.mustdown(tpl, name: 'Tom')
+#   # => '<h1>More about Tom</h1>'
 module Mustdown
-  class << self
-    attr_accessor :markdown_extensions
-    attr_accessor :renderer_options
-    attr_accessor :renderer
+  extend self
 
-    def configure
-      yield self
-    end
+  # Public: Sets the Hash of markdown extensions.
+  attr_writer :markdown_extensions
 
-    def markdown_extensions
-      @markdown_extensions ||= {
-        no_intra_emphasis:  true,
-        tables:             true,
-        fenced_code_blocks: true,
-        autolink:           true,
-        strikethrough:      true
-      }
-    end
+  # Public: Sets the Hash of markdown renderer options.
+  attr_writer :renderer_options
 
-    def renderer_options
-      @renderer_options ||= {
-        no_styles:        true,
-        safe_links_only:  true
-      }
-    end
+  # Public: Sets the markdown renderer (a Redcarpet compatible renderer).
+  #
+  # Note: It accepts a class or an instance.
+  attr_writer :markdown_renderer
+
+  # Public: Provides a way to configure Mustdown.
+  #
+  # Yields itself.
+  #
+  # Examples
+  #
+  #   # Configuring Mustdown
+  #   Mustdown.configure do |config|
+  #     config.markdown_renderer = MyCustomRenderer
+  #   end
+  #
+  # Returns nothing.
+  def configure
+    yield self
+  end
+
+  # Public: Returns the default markdown extensions
+  #
+  # Returns a Hash.
+  def markdown_extensions
+    @markdown_extensions ||= {
+      no_intra_emphasis:  true,
+      tables:             true,
+      fenced_code_blocks: true,
+      autolink:           true,
+      strikethrough:      true
+    }
+  end
+
+  # Public: Returns the default markdown renderer options
+  #
+  # Returns a Hash.
+  def renderer_options
+    @renderer_options ||= {
+      no_styles:        true,
+      safe_links_only:  true
+    }
+  end
+
+  # Public: Returns the markdown renderer.
+  #
+  # This can be a class or an object. When it's a class, a new instance will be
+  # created when rendering.
+  #
+  # Defaults to Redcarpet::Render::HTML
+  #
+  # Returns an Object.
+  def markdown_renderer
+    @markdown_renderer ||= Redcarpet::Render::HTML
+  end
+
+  # Deprecated:  Returns the markdown renderer.
+  #
+  # Use markdown_renderer instead.
+  #
+  # Returns an Object.
+  def renderer
+    warn "Mustdown.renderer is deprecated. Use Mustdown.markdown_renderer instead."
+    self.markdown_renderer
+  end
+
+  # Deprecated: Sets the markdown renderer
+  #
+  # Use markdown_renderer= instead.
+  #
+  # Returns nothing.
+  def renderer=(value)
+    warn "Mustdown.renderer= is deprecated. Use Mustdown.markdown_renderer= instead."
+    self.markdown_renderer = value
+  end
+
+  # Public: Renders a markdown template.
+  #
+  # template            - The String template containing markdown template.
+  # markdown_extensions - A Hash of additional extensions that will be merged
+  #                       with the default ones.
+  # renderer_options    - A Hash of additional markdown renderer options that
+  #                       will be merged with the default ones.
+  #
+  # Examples
+  #
+  #    tpl = '# Hello world'
+  #    Mustdown.markdown(tpl)
+  #    # => '<h1>Hello world</h1>'
+  #
+  #    tpl = 'http://example.com [example](http://example.com)'
+  #    Mustdown.markdown(tpl, autolink: false)
+  #    # => '<p>http://example.com <a href="http://example.com">example</a></p>'
+  #
+  #    tpl = 'http://example.com [example](http://example.com)'
+  #    Mustdown.markdown(tpl, { autolink: false }, { no_links: true })
+  #    # => '<p>http://example.com [example](http://example.com)</p>'
+  #
+  # Returns the rendered markdown String.
+  def markdown(template, markdown_extensions = {}, renderer_options = {})
+    exts = markdown_extensions.merge(markdown_extensions)
+    opts = renderer_options.merge(renderer_options)
+
+    renderer = markdown_renderer.new(opts)
+    markdown = Redcarpet::Markdown.new(renderer, exts)
+
+    markdown.render(template)
+  end
+
+  # Public: Renders a mustache template.
+  #
+  # template - The String template containing mustache template.
+  # resource - The Hash or Object used as binding for the template.
+  #
+  # Examples
+  #
+  #    tpl = 'Hello {{name}}'
+  #    Mustdown.mustache(tpl, name: 'Tom')
+  #    # => 'Hello Tom'
+  #
+  #    tpl = 'Hello {{name}}'
+  #    user = User.find(1) # A user named Tom
+  #    Mustdown.mustache(tpl, user)
+  #    # => 'Hello Tom'
+  #
+  # Returns the rendered mustache String.
+  def mustache(template, resource)
+    Mustache.render(template, resource)
+  end
+
+  # Public: Renders a mustache+markdown template.
+  #
+  # template      - The String template containing mustache+markdown template.
+  # resource      - The Hash or Object used as binding for the template.
+  # markdown_args - Zero, one or two Hash objects that will be passed to the
+  #                 markdown method.
+  #
+  # Examples
+  #
+  #    tpl = '# Hello {{name}}'
+  #    Mustdown.mustdown(tpl, name: 'Tom')
+  #    # => '<h1>Hello Tom</h1>'
+  #
+  #    tpl = '{{url}}'
+  #    website = { url: 'http://example.com' }
+  #    Mustdown.markdown(tpl, website, autolink: false)
+  #    # => '<p>http://example.com</p>'
+  #
+  #    tpl = '[{{title}}]({{url}})'
+  #    website = { title: 'Example', url: 'http://example.com' }
+  #    Mustdown.markdown(tpl, website, { autolink: false }, { no_links: true })
+  #    # => '<p>[Example](http://example.com)</p>'
+  #
+  # Returns the rendered mustache+arkdown String.
+  def mustdown(template, resource, *markdown_args)
+    markdown mustache(template, resource), *markdown_args
+  end
 
-    def renderer
-      @renderer ||= Redcarpet::Render::HTML
+  # Private: Outputs a warning message.
+  #
+  # In a Rails app uses Rails.logger, $stderr otherwise.
+  #
+  # message - The String message to display as a warning.
+  #
+  # Returns nothing.
+  def warn(message)
+    if defined?(Rails)
+      Rails.logger.warn message
+    else
+      $stderr.puts "WARNING: #{message}"
     end
   end
 end

metadata

@@ -1,94 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: mustdown
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Simon COURTOIS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.99.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.99.4
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Rails helpers to use Markdown and Mustache all together
@@ -108,33 +111,27 @@ files:
 - Rakefile
 - README.md
 homepage: http://github.com/simonc/mustdown
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3051764860609270774
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3051764860609270774
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Rails helpers to use Markdown and Mustache all together
 test_files: []