markdown-rails 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jo Liss
+
+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,110 @@
+# markdown-rails
+
+This gem allows you to write static Rails views and partials using the
+[Markdown](http://daringfireball.net/projects/markdown/syntax) syntax. No more
+editing prose in HTML!
+
+## Usage
+
+Add the following to your Gemfile:
+
+```ruby
+gem 'markdown-rails'
+```
+
+Now add views or partials ending in `.md` or `.markdown`.
+
+## Examples
+
+### Static View
+
+In `app/views/home/about.html.md`:
+
+```markdown
+# About This Site
+
+*Markdown code goes here ...*
+```
+
+Keep in mind that unlike static files dropped in `public`, you still need a
+matching route, such as `get ':action', :controller => :home`, to route
+`/about` to `home#about`.
+
+### Static Partial
+
+In `app/views/posts/edit.html.erb`:
+
+```erb
+<form>... dynamic code goes here ...</form>
+<div class="help">
+  <%= render :partial => "posts/edit_help" %>
+</div>
+```
+
+In `app/views/posts/_edit_help.html.md`:
+
+```markdown
+## How To Edit
+
+This text is written in **Markdown**. :-)
+```
+
+## Configuration
+
+By default markdown-rails uses the
+[RDiscount](https://github.com/rtomayko/rdiscount) parser. You can change this
+by calling `config.render` like so:
+
+```ruby
+Markdown::Rails.configure do |config|
+  config.render do |markdown_source|
+    # Return compiled HTML here ...
+  end
+end
+```
+
+You might in particular want to use
+[Redcarpet](https://github.com/tanoku/redcarpet), which allows you to enable
+various aspects of [GitHub Flavored
+Markdown](http://github.github.com/github-flavored-markdown/) through its
+parser options. To do so, add the `redcarpet` gem to your Gemfile, and add the
+following into a `config/initializers/markdown.rb` file:
+
+```ruby
+Markdown::Rails.configure do |config|
+  markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+    :fenced_code_blocks => true,
+    :autolink => true,
+    ... etc ...)
+  config.render do |markdown_source|
+    markdown.render(markdown_source)
+  end
+end
+```
+
+## Security
+
+Despite Markdown being a static language, you should not use this gem to
+process untrusted Markdown views (or partials). In other words, do not add
+Markdown views from a source if you wouldn't trust Erb views from them.
+
+## Limitations
+
+*   It's not possible to embed Ruby code in the Markdown code. Unfortunately,
+    you cannot simply chain template handlers (`.md.erb`) like you can with
+    asset handlers. (This is reasonable if you consider that unlike assets,
+    templates are precompiled not into strings but into Ruby code, which is
+    then called every time the template is served.) Still, the performance of
+    modern Markdown parsers is good enough that you can reparse the Markdown on
+    every template view without precompiling, so this should be possible in
+    principle.
+
+    In the meantime, you can [use HAML's :markdown
+    filter](http://stackoverflow.com/a/4418389/525872) to the same effect.
+
+*   The only truly Markdown-specific code in the source is
+    `RDiscount.new(markdown_source).to_html` and the `.md`/`.markdown` file
+    name extensions. This gem can and should be generalized into a
+    general-purpose static template gem, so that you can easily use other
+    static templating languages in Rails. Perhaps
+    [tilt](https://github.com/rtomayko/tilt) will come in useful.

data/lib/markdown-rails.rb

@@ -0,0 +1 @@
+require 'markdown/rails/engine'

data/lib/markdown/rails/engine.rb

@@ -0,0 +1,38 @@
+require 'rdiscount'
+require 'action_view'
+
+module Markdown
+  module Rails
+    class Handler
+      def initialize
+      end
+
+      def call(template)
+        # Return Ruby code that returns the compiled template
+        Markdown::Rails.renderer.call(template.source).inspect + '.html_safe'
+      end
+    end
+
+    class <<self
+      def configure
+        yield self
+      end
+
+      attr_accessor :renderer
+
+      def render(&block)
+        self.renderer = block
+      end
+    end
+  end
+end
+
+Markdown::Rails.configure do |config|
+  config.render do |markdown_source|
+    RDiscount.new(markdown_source).to_html
+  end
+end
+
+handler = Markdown::Rails::Handler.new
+ActionView::Template.register_template_handler(:md, handler)
+ActionView::Template.register_template_handler(:markdown, handler)

data/lib/markdown/rails/version.rb

@@ -0,0 +1,5 @@
+module Markdown
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/markdown-rails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/markdown/rails/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "markdown-rails"
+  s.version     = Markdown::Rails::VERSION
+  s.authors     = ["Jo Liss"]
+  s.email       = ["joliss42@gmail.com"]
+  s.homepage    = "https://github.com/joliss/markdown-rails"
+  s.summary     = "Markdown as a Rails templating language"
+  s.description = "Markdown as a static templating language for Rails views and partials"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_dependency "rails", ">= 3.0.0"
+  s.add_dependency "rdiscount", [">= 1.6.8", "< 2.0"]
+
+  s.files        = `git ls-files`.split("\n").reject { |f| f =~ /^testapp/ }
+  s.executables  = `git ls-files`.split("\n").select { |f| f =~ /^bin/ }
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: markdown-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jo Liss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &17430280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17430280
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &17429740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17429740
+description: Markdown as a static templating language for Rails views and partials
+email:
+- joliss42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- License.txt
+- README.md
+- lib/markdown-rails.rb
+- lib/markdown/rails/engine.rb
+- lib/markdown/rails/version.rb
+- markdown-rails.gemspec
+homepage: https://github.com/joliss/markdown-rails
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Markdown as a Rails templating language
+test_files: []
+has_rdoc: