markdown-rails 2.0.0.alpha4 → 2.0.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df9409534d893fd18f8ea4312fae865d4d228387217d83976a108c1eca3bcb4a
-  data.tar.gz: 943cae0bd4ef19becaa5e243d59982c073fd5a8a1f3f066a7da8ecb5d274cdc8
+  metadata.gz: a73a2cd07081bf36de70e5c18725718b4d327eb18f1db995099d9c564482f6ad
+  data.tar.gz: 856e66e13c5626612f7fdb5f316be468434a35d957091105385bc918736b18b6
 SHA512:
-  metadata.gz: 8c985143f8649306207650a0d3ae6eb4f0e317bbe1fb3592c94fc67b94f441d2b0ad08072ce0e45b32001f10e6164e9a04e54eafc1437a60d87ffc939d614cc2
-  data.tar.gz: f71fb88d71fc8ca3ea0eb443934c57724d8584a502a9786ccd8e2cfdef1f98de4eaf24cc72fe07dacb55a7ea8a3f13a38464c44fe6bf2be4b473fcc812d573d2
+  metadata.gz: 4eebf6fff67b29243d5614f7fe1549944e47dd5706cf7619d1379e04d9bd3fced54a2d95fad00608fc25eebe28393650b3ba6281365114fd6bc5c225dc5a1b08
+  data.tar.gz: 9bd2367ed850cea192c4e06cdd9f774af84b4d51fe066de1a760e597fecea3bc166f03931d6200b624daf443089ada93c76950270be6e358a27953397a6954fd

data/README.md

@@ -26,7 +26,7 @@ $ bundle add 'markdown-rails'
 Then from the root of your Rails project, run:
 
 ```sh
-$ bin/rails g markdown:install
+$ bin/rails g markdown_rails:install
 ```
 
 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`.
@@ -44,7 +44,7 @@ gem "markdown-rails", "~> 2.0.0"
 Then from the root of your Rails project, run:
 
 ```sh
-$ bin/rails g markdown:install
+$ bin/rails g markdown_rails:install
 ```
 
 If you have an existing file in `config/initializers/markdown.rb` you'll need to move those settings over. Note that 1.x used `RDiscount` as the default renderer, which was replaced by `Redcarpet` in 2.x.
@@ -58,11 +58,11 @@ Applications commonly need various markdown variants within one application. For
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-Markdown::Rails.handle :md do
+MarkdownRails.handle :md do
   ApplicationMarkdown.new
 end
 
-Markdown::Rails.handle :crazymd do
+MarkdownRails.handle :crazymd do
   MyCrazyMarkdown.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::Handler::Erb` handler.
+To enable Erb, you can tell Rails to render all view files ending with `.markerb` using the `MarkdownRails::Handler::Erb` handler.
 
 ```ruby
 # ./config/initializers/markdown.rb
-Markdown::Rails.handle :markerb, with: Markdown::Rails::Handler::Erb do
+MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
   ApplicationMarkdown.new
 end
 ```
@@ -87,11 +87,11 @@ You *could* change `:markerb` to `:md`, but I don't recommend it for all Markdow
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-Markdown::Rails.handle :md do
+MarkdownRails.handle :md do
   ApplicationMarkdown.new
 end
 
-Markdown::Rails.handle :markerb, with: Markdown::Rails::Handler::Erb do
+MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
   ApplicationMarkdown.new
 end
 ```

data/lib/generators/markdown_rails/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Installs MarkdownRails to your Rails project
+
+Example:
+    bin/rails generate markdown_rails:install
+
+    This will create:
+        config/initializers/markdown.rb
+        app/markdown/application_markdown.rb

data/lib/generators/{markdown → markdown_rails}/install/install_generator.rb

@@ -1,4 +1,4 @@
-class Markdown::InstallGenerator < Rails::Generators::Base
+class MarkdownRails::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 
   def copy_files

data/lib/generators/{markdown → markdown_rails}/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::Renderer::Rails
+class ApplicationMarkdown < MarkdownRails::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::Renderer::Rails`,
+  # and adding to the list below. Several are already included for you in the `MarkdownRails::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 → markdown_rails}/install/templates/config/initializers/markdown.rb

@@ -1,13 +1,13 @@
 # Restart the server to see changes made to this file.
 
 # Setup markdown stacks to work with different template handler in Rails.
-Markdown::Rails.handle :md, :markdown do
+MarkdownRails.handle :md, :markdown do
   ApplicationMarkdown.new
 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::Handler::Erb do
+MarkdownRails.handle :markerb, with: MarkdownRails::Handler::Erb do
   ApplicationMarkdown.new
 end

data/lib/markdown-rails/engine.rb

@@ -0,0 +1,4 @@
+module MarkdownRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/markdown-rails/handler/erb.rb

@@ -0,0 +1,22 @@
+module MarkdownRails
+  module Handler
+    class Erb < Markdown
+      def call(template, source = template.source)
+        compiled_source = compile_erb template, source
+        # TODO: This won't properly handle initializer blocks. Somehow
+        # I need to pass a reference to the block that's passed in.
+        "#{markdown.class.name}.new.renderer.render(begin;#{compiled_source};end).html_safe"
+      end
+
+      private
+
+      def compile_erb(template, source)
+        erb.call(template, source)
+      end
+
+      def erb
+        ActionView::Template.registered_template_handler(:erb)
+      end
+    end
+  end
+end

data/lib/markdown-rails/handler/markdown.rb

@@ -0,0 +1,37 @@
+module MarkdownRails
+  module Handler
+    # We cannot use MarkdownRails because it conflicts with RDiscount's Markdown class
+    class Markdown
+      def initialize(&block)
+        @markdown = block
+      end
+
+      def call(template, source = template.source)
+        renderer.render(source).inspect + '.html_safe'
+      end
+
+      def self.handle(*extensions, &block)
+        Array(extensions).each do |extension|
+          handler = new &block
+          ActionView::Template.register_template_handler extension, handler
+        end
+      end
+
+      private
+
+      def markdown
+        @cache = nil unless cache_enabled?
+        @cache ||= @markdown.call
+      end
+
+      def renderer
+        @renderer = nil unless cache_enabled?
+        @renderer ||= markdown.renderer
+      end
+
+      def cache_enabled?
+        ::Rails.configuration.cache_classes
+      end
+    end
+  end
+end

data/lib/markdown-rails/railtie.rb

@@ -0,0 +1,4 @@
+module MarkdownRails
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/markdown-rails/renderer/base.rb

@@ -0,0 +1,26 @@
+module MarkdownRails
+  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-renderer-for-lunch
+        [
+          :filter_html,
+          :no_images,
+          :no_links,
+          :no_styles,
+          :safe_links_only
+        ]
+      end
+
+      def renderer
+        ::Redcarpet::Markdown.new(self.class, **features)
+      end
+
+      private
+        def features
+          Hash[Array(enable).map{ |feature| [ feature, true ] }]
+        end
+    end
+  end
+end

data/lib/markdown-rails/renderer/rails.rb

@@ -0,0 +1,40 @@
+module MarkdownRails
+  module Renderer
+    class Rails < Base
+      include ::Rails.application.routes.url_helpers
+
+      delegate \
+        :asset_digest_path,
+        :asset_path,
+        :asset_url,
+        :audio_path,
+        :audio_tag,
+        :audio_url,
+        :font_path,
+        :font_url,
+        :image_path,
+        :image_tag,
+        :image_url,
+        :video_path,
+        :video_tag,
+        :video_url,
+        :tag,
+        :content_tag,
+        :render,
+        :request,
+        :turbo_frame_tag,
+        :controller,
+        :raw,
+      to: :helpers
+
+      def image(link, title, alt)
+        image_tag link, title: title, alt: alt
+      end
+
+      protected
+        def helpers
+          ::ActionController::Base.helpers
+        end
+    end
+  end
+end

data/lib/markdown-rails/version.rb

@@ -0,0 +1,3 @@
+module MarkdownRails
+  VERSION = "2.0.0.alpha6"
+end

data/lib/markdown-rails.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markdown-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha4
+  version: 2.0.0.alpha6
 platform: ruby
 authors:
 - Brad Gessler
@@ -50,19 +50,18 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/markdown_rails_manifest.js
-- lib/generators/markdown/install/USAGE
-- lib/generators/markdown/install/install_generator.rb
-- lib/generators/markdown/install/templates/app/markdown/application_markdown.rb
-- lib/generators/markdown/install/templates/config/initializers/markdown.rb
+- lib/generators/markdown_rails/install/USAGE
+- lib/generators/markdown_rails/install/install_generator.rb
+- lib/generators/markdown_rails/install/templates/app/markdown/application_markdown.rb
+- lib/generators/markdown_rails/install/templates/config/initializers/markdown.rb
 - lib/markdown-rails.rb
-- lib/markdown/rails.rb
-- lib/markdown/rails/engine.rb
-- lib/markdown/rails/handler/erb.rb
-- lib/markdown/rails/handler/markdown.rb
-- lib/markdown/rails/railtie.rb
-- lib/markdown/rails/renderer/base.rb
-- lib/markdown/rails/renderer/rails.rb
-- lib/markdown/rails/version.rb
+- lib/markdown-rails/engine.rb
+- lib/markdown-rails/handler/erb.rb
+- lib/markdown-rails/handler/markdown.rb
+- lib/markdown-rails/railtie.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
 licenses:

data/lib/generators/markdown/install/USAGE

@@ -1,8 +0,0 @@
-Description:
-    Explain the generator
-
-Example:
-    bin/rails generate install Thing
-
-    This will create:
-        what/will/it/create

data/lib/markdown/rails/engine.rb

@@ -1,6 +0,0 @@
-module Markdown
-  module Rails
-    class Engine < ::Rails::Engine
-    end
-  end
-end

data/lib/markdown/rails/handler/erb.rb

@@ -1,24 +0,0 @@
-module Markdown
-  module Rails
-    module Handler
-      class Erb < Markdown
-        def call(template, source = template.source)
-          compiled_source = compile_erb template, source
-          # TODO: This won't properly handle initializer blocks. Somehow
-          # I need to pass a reference to the block that's passed in.
-          "#{markdown.class.name}.new.renderer.render(begin;#{compiled_source};end).html_safe"
-        end
-
-        private
-
-        def compile_erb(template, source)
-          erb.call(template, source)
-        end
-
-        def erb
-          ActionView::Template.registered_template_handler(:erb)
-        end
-      end
-    end
-  end
-end

data/lib/markdown/rails/handler/markdown.rb

@@ -1,39 +0,0 @@
-module Markdown
-  module Rails
-    module Handler
-      # We cannot use Markdown::Rails because it conflicts with RDiscount's Markdown class
-      class Markdown
-        def initialize(&block)
-          @markdown = block
-        end
-
-        def call(template, source = template.source)
-          renderer.render(source).inspect + '.html_safe'
-        end
-
-        def self.handle(*extensions, &block)
-          Array(extensions).each do |extension|
-            handler = new &block
-            ActionView::Template.register_template_handler extension, handler
-          end
-        end
-
-        private
-
-        def markdown
-          @cache = nil unless cache_enabled?
-          @cache ||= @markdown.call
-        end
-
-        def renderer
-          @renderer = nil unless cache_enabled?
-          @renderer ||= markdown.renderer
-        end
-
-        def cache_enabled?
-          ::Rails.configuration.cache_classes
-        end
-      end
-    end
-  end
-end

data/lib/markdown/rails/railtie.rb

@@ -1,6 +0,0 @@
-module Markdown
-  module Rails
-    class Railtie < ::Rails::Railtie
-    end
-  end
-end

data/lib/markdown/rails/renderer/base.rb

@@ -1,28 +0,0 @@
-module Markdown
-  module Rails
-    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-renderer-for-lunch
-          [
-            :filter_html,
-            :no_images,
-            :no_links,
-            :no_styles,
-            :safe_links_only
-          ]
-        end
-
-        def renderer
-          ::Redcarpet::Markdown.new(self.class, **features)
-        end
-
-        private
-          def features
-            Hash[Array(enable).map{ |feature| [ feature, true ] }]
-          end
-      end
-    end
-  end
-end

data/lib/markdown/rails/renderer/rails.rb

@@ -1,42 +0,0 @@
-module Markdown
-  module Rails
-    module Renderer
-      class Rails < Base
-        include ::Rails.application.routes.url_helpers
-
-        delegate \
-          :asset_digest_path,
-          :asset_path,
-          :asset_url,
-          :audio_path,
-          :audio_tag,
-          :audio_url,
-          :font_path,
-          :font_url,
-          :image_path,
-          :image_tag,
-          :image_url,
-          :video_path,
-          :video_tag,
-          :video_url,
-          :tag,
-          :content_tag,
-          :render,
-          :request,
-          :turbo_frame_tag,
-          :controller,
-          :raw,
-        to: :helpers
-
-        def image(link, title, alt)
-          image_tag link, title: title, alt: alt
-        end
-
-        protected
-          def helpers
-            ::ActionController::Base.helpers
-          end
-      end
-    end
-  end
-end

data/lib/markdown/rails/version.rb

@@ -1,5 +0,0 @@
-module Markdown
-  module Rails
-    VERSION = "2.0.0.alpha4"
-  end
-end

data/lib/markdown/rails.rb

@@ -1,20 +0,0 @@
-require "markdown/rails/version"
-require "markdown/rails/engine"
-
-module Markdown
-  module Rails
-    def self.handle(*extensions, with: Handler::Markdown, &block)
-      with.handle *extensions, &block
-    end
-
-    module Handler
-      autoload :Markdown,   "markdown/rails/handler/markdown"
-      autoload :Erb,        "markdown/rails/handler/erb"
-    end
-
-    module Renderer
-      autoload :Base,       "markdown/rails/renderer/base"
-      autoload :Rails,      "markdown/rails/renderer/rails"
-    end
-  end
-end