emd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad888db5ed6ebd058f0109679ed0c254a8c16983
-  data.tar.gz: e34c2df334b51cc6428c99e68080b77d3b34f124
+SHA256:
+  metadata.gz: dd3ac910c3743f48445bbd54b724144707ff45b3e3058d8b4dcb3f755344fd18
+  data.tar.gz: feca68b0ce825d203f547c0da3a09d098065098016d117dcbbbcdced04198b2f
 SHA512:
-  metadata.gz: 337f029b28177e7302419b9731d9e6fa3356a0cad06f7f5931b2a9c737f3c9834208ba4e2393e97c5b01552b8f9f9f5ce8385fca7817038dfe0db4d6d5aa2be4
-  data.tar.gz: 602cf0d3b273df5fd10df3efbee9c50d44e6a993ef21a12db88a2dde77ca1fe21254baca67d201ce0951fc492ab2f0b3b9ebaa1bbdf5f943e629ec2eba0f0b88
+  metadata.gz: cef74a0aa74e565711dc88a9a7fc3f0a77471d4bf1050f89827b438e862df197f4a8fe01b68f534ca257c64ecf172be16e73e8b9024367c75023fda7cbaf2db0
+  data.tar.gz: 66561776e714513d4fdd161a8e909daa802d5d39456e56771c674d4e99b284a9a645268ab488e2c75d02c21e698de8bce4448d83852a8dcd2604fab8b018e87b

data/README.md

@@ -1,49 +1,106 @@
-# emd
+# Embedded Markdown [![Gem Version](https://badge.fury.io/rb/emd.svg)](https://badge.fury.io/rb/emd)
 
-Embedded Markdown is created so that I can use markdown within my own rails projects.
+Embedded Markdown uses a Rails engine and a simple initializer to initiate a markdown template handler with the help of Redcarpet and syntax highlighting from Coderay.
 
-Embedded Markdown uses a rails engine and a simple initializer to initiate a template handler for markdown using redcarpet.
+The motivation is to reuse Markdown file in several of my Rails projects.
 
-Special thanks to [these folks](http://stackoverflow.com/questions/4163560/how-can-i-automatically-render-partials-using-markdown-in-rails-3/10131299#10131299
-) for making emd possible
-
-## Example repo
-
-TODO
+- 😊 Reuse Markdown in Rails products
+- 📝 Allow copywriters & marketers to be involved in building your content easily 
+- 📝 Allows you to focus on the content instead of the webpage structure.  
+- 🙌 Supports syntax highlighting via Coderay
 
 ## Installation
 
 Add this two lines to your application's Gemfile:
 
 ```ruby
+gem 'coderay' #optional for Syntax Highlighting
 gem 'redcarpet'
 gem 'emd'
 ```
-> emd depends on redcarpet for markdown rendering
+> emd depends on Redcarpet for Markdown rendering
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install emd
+### A Markdown view
 
-## Usage
+1. Create a view called app/view/home/markdown.html.md and add the following sample Markdown. 
+
+    ```markdown
+        ## This is a sample Markdown code
+        - [google](http://google.com)
+        - [emd](https://github.com/ytbryan/emd/)
+    ```
+
+1. Generate a home controller using the following command `rails generate controller home`
 
-create a partial app/view/frontpages/`_component.html.md`
+1. At route.rb, add the following line: 
+    ```
+       get '/markdown', to: 'home#markdown'
+    ```
+1. Finally, visit the markdown view at [http://localhost:3000/markdown](http://localhost:3000/markdown)
 
-```markdown
-### This is a component
 
-- This is item 1
-- This is iiem 2
-- [This is a link to google] (http://google.com)
+### A Markdown partial
 
+1. Create a partial app/view/home/`_component.html.md`
+
+    ```markdown
+        ### This is a component
+
+        - This is item 1
+        - This is iiem 2
+        - [This is a link to google] (http://google.com)
+    ```
+
+1. Then,  use this partial using `<%= render "component" %>` within any view like index.html.erb
+
+### Syntax Highlighting
+
+To support syntax highlighting, add `coderay` to Gemfile as shown below: 
+
+```ruby
+gem 'coderay'
 ```
+Remember to run `bundle install`. 
 
-Then,  use this partial using <%= render "component" %> within any view like index.html.erb
+This will turn all the code block into:
 
+```ruby
+    ```ruby
+     puts "something"
+    ```
+```
+
+```ruby
+puts "something"
+```
+
+### Control which extensions Redcarpet uses
+
+`emd` assumes some sane redcarpet extension use (see redcarpets options [here](https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use) and [here](https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch)). If you need to overwrite these in your Rails app, create a file `config/initializers/markdown_template_handler.rb` to overwrite the defaults from [config/initializers/markdown_template_handler.rb](config/initializers/markdown_template_handler.rb) like this:
+
+```
+module MarkdownTemplateHandler
+  def self.call(template)
+    compiled_source = erb.call(template)
+    "Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+                             no_intra_emphasis: true,
+                             fenced_code_blocks: true,
+                             # I actually like that, so commented it out:
+                             # disable_indented_code_blocks: true,
+                             space_after_headers: true,
+                             prettify:                     true,
+                             tables:                       true,
+                             with_toc_data:                true,
+                             autolink: true).render(begin;#{compiled_source};end).html_safe"
+  end
+end
+```
 
 ## Development
 
@@ -53,9 +110,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ytbryan/emd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+Special thanks to [these folks](http://stackoverflow.com/questions/4163560/how-can-i-automatically-render-partials-using-markdown-in-rails-3/10131299#10131299
+) for making emd possible

data/app/helpers/emd_helper.rb

@@ -0,0 +1,5 @@
+module EmdHelper
+  def emd content
+    Markdown.new(content).to_html.html_safe
+  end
+end

data/config/initializers/markdown_template_handler.rb

@@ -1,20 +1,34 @@
-module MarkdownTemplateHandler
+class CodeRayify < Redcarpet::Render::HTML
+  def block_code(code, language)
+    if Gem.loaded_specs.has_key?('coderay')
+      CodeRay.scan(code, language).div 
+    else 
+      %(<pre>#{code}</pre>)
+    end
+  end
+end
+
+module MarkdownTemplateHandler  
   def self.erb
     @erb ||= ActionView::Template.registered_template_handler(:erb)
   end
 
   def self.call(template)
     compiled_source = erb.call(template)
-    "Redcarpet::Markdown.new(Redcarpet::Render::HTML,
-                             no_intra_emphasis: true,
-                             fenced_code_blocks: true,
-                             space_after_headers: true,
-                             smartypants:                  true,
-                             disable_indented_code_blocks: true,
-                             prettify:                     true,
-                             tables:                       true,
-                             with_toc_data:                true,
-                             autolink: true).render(begin;#{compiled_source};end).html_safe"
+    
+    %(Redcarpet::Markdown.new(CodeRayify.new(:filter_html => true, 
+                                            :hard_wrap => true),
+                            no_intra_emphasis:            true,
+                            fenced_code_blocks:           true,
+                            space_after_headers:          true,
+                            smartypants:                  true,
+                            disable_indented_code_blocks: true,
+                            prettify:                     true,
+                            tables:                       true,
+                            with_toc_data:                true,
+                            autolink:                     true
+                          ).render(begin;#{compiled_source};end).html_safe)
+                          
   end
 end
 

data/lib/emd.rb

@@ -1,22 +1,6 @@
 require "emd/version"
-require "thor"
 
 module Emd
-
   class Engine < ::Rails::Engine
   end
-
-  class Base < Thor
-
-    desc :test, 'test this'
-    # method_option :group, type: :boolean, aliases: '-g'
-    # method_option :load, type: :string, aliases: '-l'
-    # method_option :save, type: :string, aliases: '-s'
-    # method_option :force, type: :boolean, aliases: '-f'
-
-    def test(arg = nil)
-      puts "test"
-    end
-
-  end
 end

data/lib/emd/version.rb

@@ -1,3 +1,3 @@
 module Emd
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: emd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryan Lim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 description: mbedded markdown template for Ruby on Rails
 email:
 - ytbryan@gmail.com
@@ -60,11 +74,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- app/helpers/emd_helper.rb
 - config/initializers/markdown_template_handler.rb
 - lib/emd.rb
 - lib/emd/post_message.rb
 - lib/emd/version.rb
-homepage: ''
+homepage: https://github.com/ytbryan/emd
 licenses:
 - MIT
 metadata: {}
@@ -86,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Embedded markdown template for Ruby on Rails