markdown-rails 2.0.0.alpha2 → 2.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff3573eb380c93787dd4df94e7244809402da5a8bd59482aa2b6606b6294f154
-  data.tar.gz: 7de29bab934217a0a8f38ff868d6fe7d0fa87d8c9a3b2de8c93a27d5f61496d8
+  metadata.gz: 9028694bb249a0368da3f54c2c14f2d73df7409ca7440dd6fdd7b9b3ff2241cb
+  data.tar.gz: 82eb901cbf4a4a1f378bcbc5631ea054c4ec2b0bbc9af605ef1298aa09cfd0b6
 SHA512:
-  metadata.gz: b4f738f2f721f7d542f8986d0c63a7f1ac27f266d46091d938afa086b1c08ed967a8e77ebd9a4c8964787d3bddf396ba9eb86e9dd78bf511b937c182f9ce7127
-  data.tar.gz: 85496233bed31fabcc2585f9e9ef30f92a295b456058bce2d35228ac4e284bc276804570cedddbbfb399cac8f7594d3f69f40d0f1332e8c35d2afa1f39a67762
+  metadata.gz: ff5d28ec913cec33a99cd5475652af7528599c649ccb2fed0922b9e25ed7bad40b5eac0fdb57e2db8415533ac18f6442612d8a22a872420bd0b66193db986fe0
+  data.tar.gz: 43ffda25ea19dca4acabb9a1a7dcdd7e83a4e3aa5fbe08a035466031ac5e7a63566ba938edbd7bcfbc96f2c0deddaa37baacb7078db9862880cae8a6424e21b3

data/README.md

@@ -1,7 +1,7 @@
 # markdown-rails
 
 > **Note**
-> **Everything below is implemented in 2.0.0.alpha1.** . You can start using this by adding to `gem "markdown-rails", version: "2.0.0.alpha"` to your Gemfile or by looking at it being used in the https://github.com/bradgessler/view-playground repo.
+> **Everything below is implemented in 2.0.0.alpha.** . You can start using this by adding to `gem "markdown-rails", version: "2.0.0.alpha"` to your Gemfile or by looking at it being used in the https://github.com/bradgessler/view-playground repo.
 
 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!
 
@@ -29,7 +29,7 @@ Then from the root of your Rails project, run:
 $ bin/rails g markdown:install
 ```
 
-This adds a `config/initializers/markdown.rb` file where you can register template handlers for your Markdown renders that are located in `./app/markdown/*.rb`.
+This adds a `config/initializers/markdown.rb` file where you can register template handler for your Markdown renders that are located in `./app/markdown/*.rb`.
 
 Now add views or partials ending in `.md` in your `./app/views/**/**` directories and behold!
 
@@ -57,7 +57,7 @@ Applications commonly need various markdown variants within one application. For
 # ./config/initializers/markdown.rb
 # Restart the server to see changes made to this file.
 
-# Setup markdown stacks to work with different template handlers in Rails.
+# Setup markdown stacks to work with different template handler in Rails.
 Markdown::Rails.handle :md do
   ApplicationMarkdown.new
 end
@@ -71,11 +71,11 @@ end
 
 Only enable Erb in Markdown if you trust the source of the file. Do not enable it for markdown provided by users or they will be able to execute arbitrary Ruby code.
 
-To enable Erb, you can tell Rails to render all view files ending with `.markerb` using the `Markdown::Rails::Handlers::Erb` handler.
+To enable Erb, you can tell Rails to render all view files ending with `.markerb` using the `Markdown::Rails::Handler::Erb` handler.
 
 ```ruby
 # ./config/initializers/markdown.rb
-Markdown::Rails.handle :markerb, with: Markdown::Rails::Handlers::Erb do
+Markdown::Rails.handle :markerb, with: Markdown::Rails::Handler::Erb do
   ApplicationMarkdown.new
 end
 ```
@@ -86,19 +86,19 @@ You *could* change `:markerb` to `:md`, but I don't recommend it for all Markdow
 # ./config/initializers/markdown.rb
 # Restart the server to see changes made to this file.
 
-# Setup markdown stacks to work with different template handlers in Rails.
+# Setup markdown stacks to work with different template handler in Rails.
 Markdown::Rails.handle :md do
   ApplicationMarkdown.new
 end
 
-Markdown::Rails.handle :markerb, with: Markdown::Rails::Handlers::Erb do
+Markdown::Rails.handle :markerb, with: Markdown::Rails::Handler::Erb do
   ApplicationMarkdown.new
 end
 ```
 
-## Customizing renderers
+## Customizing renderer
 
-You might want to customize your Markdown handlers to do things like syntax code highlighting, etc.
+You might want to customize your Markdown handler to do things like syntax code highlighting, etc.
 
 ```ruby
 # ./app/markdown/application_markdown.rb

data/lib/generators/markdown/install/templates/app/markdown/application_markdown.rb

@@ -1,13 +1,13 @@
 # You should read the docs at https://github.com/vmg/redcarpet and probably
 # delete a bunch of stuff below if you don't need it.
 
-class ApplicationMarkdown < Markdown::Rails::Renderers::Rails
+class ApplicationMarkdown < Markdown::Rails::Renderer::Rails
   # Reformats your boring punctation like " and " into “ and ” so you can look
   # and feel smarter. Read the docs at https://github.com/vmg/redcarpet#also-now-our-pants-are-much-smarter
   include Redcarpet::Render::SmartyPants
 
   # If you need access to ActionController::Base.helpers, you can delegate by uncommenting
-  # and adding to the list below. Several are already included for you in the `Markdown::Rails::Renderers::Rails`,
+  # and adding to the list below. Several are already included for you in the `Markdown::Rails::Renderer::Rails`,
   # but you can add more here.
   #
   # To see a list of methods available run `bin/rails runner "puts ActionController::Base.helpers.public_methods.sort"`

data/lib/generators/markdown/install/templates/config/initializers/markdown.rb

@@ -1,6 +1,6 @@
 # Restart the server to see changes made to this file.
 
-# Setup markdown stacks to work with different template handlers in Rails.
+# Setup markdown stacks to work with different template handler in Rails.
 Markdown::Rails.handle :md, :markdown do
   ApplicationMarkdown.new
 end
@@ -8,6 +8,6 @@ end
 # Don't use Erb for untrusted markdown content created by users; otherwise they
 # can execute arbitrary code on your server. This should only be used for input you
 # trust, like content files from your code repo.
-Markdown::Rails.handle :markerb, with: Markdown::Rails::Handlers::Erb do
+Markdown::Rails.handle :markerb, with: Markdown::Rails::Handler::Erb do
   ApplicationMarkdown.new
 end

data/lib/markdown/rails/{handlers → handler}/erb.rb

@@ -1,6 +1,6 @@
 module Markdown
   module Rails
-    module Handlers
+    module Handler
       class Erb < Markdown
         def call(template, source = template.source)
           compiled_source = compile_erb template, source

data/lib/markdown/rails/{handlers → handler}/markdown.rb

@@ -1,6 +1,6 @@
 module Markdown
   module Rails
-    module Handlers
+    module Handler
       # We cannot use Markdown::Rails because it conflicts with RDiscount's Markdown class
       class Markdown
         def initialize(&block)

data/lib/markdown/rails/{renderers → renderer}/base.rb

@@ -1,10 +1,10 @@
 module Markdown
   module Rails
-    module Renderers
+    module Renderer
       class Base < Redcarpet::Render::HTML
         def enable
           # This is a very restrictive Markdown renderer that errs on the side of safety.
-          # For more details read the docs at https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch
+          # For more details read the docs at https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderer-for-lunch
           [
             :filter_html,
             :no_images,

data/lib/markdown/rails/{renderers → renderer}/rails.rb

@@ -1,6 +1,6 @@
 module Markdown
   module Rails
-    module Renderers
+    module Renderer
       class Rails < Base
         include ::Rails.application.routes.url_helpers
 

data/lib/markdown/rails/version.rb

@@ -1,5 +1,5 @@
 module Markdown
   module Rails
-    VERSION = "2.0.0.alpha2"
+    VERSION = "2.0.0.alpha3"
   end
 end

data/lib/markdown/rails.rb

@@ -3,18 +3,18 @@ require "markdown/rails/engine"
 
 module Markdown
   module Rails
-    def self.handle(*extensions, with: Handlers::Markdown, &block)
+    def self.handle(*extensions, with: Handler::Markdown, &block)
       with.handle *extensions, &block
     end
 
-    module Handlers
-      autoload :Markdown,   "markdown/rails/handlers/markdown"
-      autoload :Erb,        "markdown/rails/handlers/erb"
+    module Handler
+      autoload :Markdown,   "markdown/rails/handler/markdown"
+      autoload :Erb,        "markdown/rails/handler/erb"
     end
 
-    module Renderers
-      autoload :Base,       "markdown/rails/renderers/base"
-      autoload :Rails,      "markdown/rails/renderers/rails"
+    module Renderer
+      autoload :Base,       "markdown/rails/renderer/base"
+      autoload :Rails,      "markdown/rails/renderer/rails"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha2
+  version: 2.0.0.alpha3
 platform: ruby
 authors:
 - Brad Gessler
@@ -57,11 +57,11 @@ files:
 - lib/markdown-rails.rb
 - lib/markdown/rails.rb
 - lib/markdown/rails/engine.rb
-- lib/markdown/rails/handlers/erb.rb
-- lib/markdown/rails/handlers/markdown.rb
+- lib/markdown/rails/handler/erb.rb
+- lib/markdown/rails/handler/markdown.rb
 - lib/markdown/rails/railtie.rb
-- lib/markdown/rails/renderers/base.rb
-- lib/markdown/rails/renderers/rails.rb
+- lib/markdown/rails/renderer/base.rb
+- lib/markdown/rails/renderer/rails.rb
 - lib/markdown/rails/version.rb
 - lib/tasks/markdown/rails_tasks.rake
 homepage: https://github.com/sitepress/markdown-rails