mustdown 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Mustdown
+
+Mustdown provides helpers to ease the use markdown, mustache and both of them.
+
+## Installation
+
+Add the gem to your `Gemfile` :
+
+    gem 'mustdown'
+
+Then call `bundle install` to install it for your application.
+
+## Provided helpers
+
+### markdown
+
+This will render the given text through Markdown.
+
+``` html_rails
+<%= markdown "# Hello World" %>
+```
+
+Output:
+
+``` html
+<h1>Hello World</h1>
+```
+
+### mustache
+
+The `mustache` helper renders a mustache template with the given binding object.
+
+``` html_rails
+<%= mustache "Hello {{name}}", name: 'John' %>
+```
+
+Output:
+
+``` html
+Hello John
+```
+
+### mustdown
+
+This helper is more complex since it provides the two previous helpers in one.
+
+``` html_rails
+<%= mustdown "# {{title}}", title: 'Hello World' %>
+```
+
+Output:
+
+``` html
+<h1>Hello World</h1>
+```
+
+## Mustdown configuration
+
+You can generate a default initializer by calling:
+
+    bundle exec rails generate mustdown:install
+
+The markdown configuration is provided by Redcarpet. All Redcarpet options are
+available.
+
+### Overriding the configuration from the view
+
+The `markdown` and `mustdown` helpers accept additional parameters for markdown
+configuration. The settings you pass are merged with the default ones and take
+precedence.
+
+``` ruby
+<%= markdown "**Hello World**", { autolink: false }, { hard_wrap: true} %>
+```
+
+## Using with I18n
+
+A very useful technique is to use templates from I18n.
+
+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
+en:
+  companies:
+    show:
+      text: |
+        # {{name}}
+        
+        {{name}} is a great company ! Here are some of their projects:
+        
+        {{#projects}}
+        * [{{title}}]({{url}})
+        {{/projects}}
+```
+
+Now we can use it in our show template (located in
+`app/views/companies/show.html.erb`):
+
+``` html_rails
+<%= mustdown t('.text'), @company %>
+```
+
+Output:
+
+``` html
+<h1>Github</h1>
+
+<p>Github is a great company ! Here are some of their projects:</p>
+
+<ul>
+  <li><a href="https://github.com/github/hubot">Hubot</a></li>
+  <li><a href="https://github.com/github/gollum">Gollum</a></li>
+</ul>
+```

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mustdown'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/app/helpers/mustdown/mustdown_helper.rb

@@ -0,0 +1,21 @@
+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
+    end
+
+    def mustache(template, resource)
+      Mustache.render(template, resource).html_safe
+    end
+
+    def mustdown(template, resource, *markdown_args)
+      markdown mustache(template, resource), *markdown_args
+    end
+  end
+end

data/lib/mustdown/engine.rb

@@ -0,0 +1,13 @@
+module Mustdown
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, view_specs: false
+    end
+
+    initializer 'mustdown.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Mustdown::MustdownHelper
+      end
+    end
+  end
+end

data/lib/mustdown/version.rb

@@ -0,0 +1,3 @@
+module Mustdown
+  VERSION = "0.0.1"
+end

data/lib/mustdown.rb

@@ -0,0 +1,39 @@
+require 'bundler/setup'
+
+require 'redcarpet'
+require 'mustache'
+
+require 'mustdown/engine'
+
+module Mustdown
+  class << self
+    attr_accessor :markdown_extensions
+    attr_accessor :renderer_options
+    attr_accessor :renderer
+
+    def configure
+      yield self
+    end
+
+    def markdown_extensions
+      @markdown_extensions ||= {
+        no_intra_emphasis:  true,
+        tables:             true,
+        fenced_code_blocks: true,
+        autolink:           true,
+        strikethrough:      true
+      }
+    end
+
+    def renderer_options
+      @renderer_options ||= {
+        no_styles:        true,
+        safe_links_only:  true
+      }
+    end
+
+    def renderer
+      @renderer ||= Redcarpet::Render::HTML
+    end
+  end
+end

data/lib/tasks/mustdown_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mustdown do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: mustdown
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simon COURTOIS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: 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
+email:
+- scourtois+cubyx@cubyx.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/mustdown/mustdown_helper.rb
+- lib/mustdown/engine.rb
+- lib/mustdown/version.rb
+- lib/mustdown.rb
+- lib/tasks/mustdown_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/simonc/mustdown
+licenses: []
+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: -1835839034427795028
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1835839034427795028
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rails helpers to use Markdown and Mustache all together
+test_files: []