RubyGems - mark-don - Versions diffs - 0.1.0 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml +7 -0
data/Gemfile +3 -0
data/LICENSE +21 -0
data/README.md +88 -0
data/lib/mark/don.rb +1 -0
data/lib/mark_don/controller_helpers.rb +35 -0
data/lib/mark_don/converter.rb +16 -0
data/lib/mark_don/railtie.rb +40 -0
data/lib/mark_don/request_handler.rb +20 -0
data/lib/mark_don/version.rb +3 -0
data/lib/mark_don.rb +3 -0
data/mark-don.gemspec +25 -0
metadata +122 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec20e8729b15fd7da900cef5cf936a05d0ef8a9723c3c0eebf9da1e1d5871e83
+  data.tar.gz: 7df81eba5231a490d4c6ebf6997a37742f815020d66b8192ff3070023a8eda3c
+SHA512:
+  metadata.gz: 1790cf9de91540a29f4406472daf3f79d3611e96d9cf5f400a1d3d56e9facb1073f2b017226f545bad4b0fc8a3e134a989dce05f5a4dea073d87801f9e261858
+  data.tar.gz: 6a4b37c896b08a148e2a1316ed80dca1f350941813fddcd08e13192645bee3925e9626bca6ec84b7e4dd22169eb6484f2818bd2567330a03b7b90a3a75a32e16

data/Gemfile ADDED Viewed

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Paul Lahana
+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 ADDED Viewed

@@ -0,0 +1,88 @@
+# mark-don
+Serve any Rails HTML view as Markdown — no templates to write.
+When a client requests `text/markdown` (via `Accept` header or `.md` extension), mark-don intercepts the normal HTML render, converts the output on the fly, and returns it with `Content-Type: text/markdown`. Your existing `.html.erb` views are reused as-is.
+## Installation
+Add to your Gemfile:
+```ruby
+gem 'mark-don'
+```
+No initializer needed. The gem hooks into Rails automatically via a Railtie.
+## Usage
+### Per-action
+Add `format.markdown` to any `respond_to` block:
+```ruby
+class RoomsController < ApplicationController
+  def show
+    @room = Room.find(params[:id])
+    respond_to do |format|
+      format.html
+      format.markdown
+    end
+  end
+end
+```
+A request with `Accept: text/markdown` or the `.md` extension triggers the markdown response:
+```
+GET /rooms/1.md
+GET /rooms/1        # with Accept: text/markdown
+```
+> **Note:** the `.md` extension only works if your routes allow format suffixes. Rails disables them by default in newer apps. Either add `format: true` to the route, or use the `Accept` header instead.
+### Controller macro
+To enable markdown for multiple actions without repeating `format.markdown` everywhere:
+```ruby
+class RoomsController < ApplicationController
+  markdown_render                  # all actions
+  markdown_render only: :show
+  markdown_render except: :index
+end
+```
+## Output
+The gem converts the `<body>` content of the rendered HTML to GitHub Flavored Markdown using [reverse_markdown](https://github.com/xijo/reverse_markdown) under the hood. Only the body is converted — the layout's `<head>` and surrounding HTML are discarded. `<script>`, `<style>`, `<meta>`, and `<link>` tags are stripped. Inline styles and unknown elements are dropped; their text content is preserved.
+**Input:**
+```html
+<h1>My Room</h1>
+<p>This is a <strong>great</strong> room with a <a href="/view">nice view</a>.</p>
+<ul>
+  <li>WiFi included</li>
+  <li>Breakfast at 8am</li>
+</ul>
+```
+**Output:**
+```markdown
+# My Room
+This is a **great** room with a [nice view](/view).
+- WiFi included
+- Breakfast at 8am
+```
+## Requirements
+- Ruby >= 3.0
+- Rails >= 6.1
+## License
+MIT

data/lib/mark/don.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'mark_don'

data/lib/mark_don/controller_helpers.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module MarkDon
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+    included do
+      extend ClassMethods
+    end
+    module ClassMethods
+      # Declares that this controller supports markdown responses.
+      # With no arguments, this is a semantic label only — the global around_action
+      # already handles all markdown requests.
+      # Pass `only:` or `except:` to restrict markdown conversion to specific actions.
+      def markdown_render(only: nil, except: nil)
+        return unless only || except
+        skip_around_action :mark_don_handle_markdown_request
+        around_action(only: only, except: except) do |controller, action|
+          if MarkDon::MARKDOWN_FORMAT_SYMBOLS.include?(controller.request.format.symbol)
+            controller.request.format = :html
+            action.call
+            if controller.performed? && controller.response.successful?
+              html     = Array(controller.response_body).join
+              markdown = MarkDon::Converter.convert(html)
+              controller.response_body          = markdown
+              controller.response.content_type  = Mime[:markdown].to_s
+            end
+          else
+            action.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mark_don/converter.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'reverse_markdown'
+require 'nokogiri'
+module MarkDon
+  class Converter
+    STRIP_TAGS = %w[script style meta link].freeze
+    def self.convert(html)
+      doc = Nokogiri::HTML(html)
+      STRIP_TAGS.each { |tag| doc.css(tag).remove }
+      body = doc.at('body') || doc
+      ReverseMarkdown.convert(body.inner_html, unknown_tags: :bypass, github_flavored: true).strip
+    end
+  end
+end

data/lib/mark_don/railtie.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'rails'
+require 'mark_don/request_handler'
+require 'mark_don/controller_helpers'
+module MarkDon
+  class Railtie < Rails::Railtie
+    # Rails 8.1+ ships "text/markdown" as :md already.
+    # We skip re-registration if it's present, and explicitly define format.markdown
+    # on the Collector so that respond_to blocks can use it without hitting
+    # method_missing (which recurses infinitely when the MIME symbol is :md but
+    # the called method is :markdown).
+    initializer 'mark_don.mime_type' do
+      Mime::Type.register 'text/markdown', :markdown unless Mime[:md] || Mime[:markdown]
+      unless ActionController::MimeResponds::Collector.method_defined?(:markdown)
+        ActionController::MimeResponds::Collector.class_eval do
+          def markdown(...)
+            custom(Mime[:md] || Mime[:markdown], ...)
+          end
+        end
+      end
+    end
+    # Intercepts any markdown request before respond_to runs. Switches the format to
+    # :html so the action renders its HTML view normally, then converts the response.
+    # Checks both :md (Rails 8.1+ symbol) and :markdown (custom registration).
+    initializer 'mark_don.around_action' do
+      ActiveSupport.on_load(:action_controller) do
+        include MarkDon::RequestHandler
+        around_action :mark_don_handle_markdown_request
+      end
+    end
+    initializer 'mark_don.controller_helpers' do
+      ActiveSupport.on_load(:action_controller) do
+        include MarkDon::ControllerHelpers
+      end
+    end
+  end
+end

data/lib/mark_don/request_handler.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module MarkDon
+  MARKDOWN_FORMAT_SYMBOLS = %i[markdown md].freeze
+  module RequestHandler
+    def mark_don_handle_markdown_request(&action)
+      if MarkDon::MARKDOWN_FORMAT_SYMBOLS.include?(request.format.symbol)
+        request.format = :html
+        action.call
+        if performed? && response.successful?
+          html     = Array(response_body).join
+          markdown = MarkDon::Converter.convert(html)
+          self.response_body    = markdown
+          response.content_type = 'text/markdown'
+        end
+      else
+        action.call
+      end
+    end
+  end
+end

data/lib/mark_don/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module MarkDon
+  VERSION = '0.1.0'
+end

data/lib/mark_don.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'mark_don/version'
+require 'mark_don/converter'
+require 'mark_don/railtie'

data/mark-don.gemspec ADDED Viewed

@@ -0,0 +1,25 @@
+require_relative 'lib/mark_don/version'
+Gem::Specification.new do |spec|
+  spec.name    = 'mark-don'
+  spec.version = MarkDon::VERSION
+  spec.authors = ['Paul Lahana']
+  spec.email   = ['paul.lahana@gmail.com']
+  spec.summary     = 'Render Rails HTML views as Markdown'
+  spec.description = 'A Rails gem that converts HTML views to Markdown on-the-fly via format.markdown in respond_to blocks.'
+  spec.homepage    = 'https://github.com/paultursuru/mark-don'
+  spec.license     = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+  spec.files         = Dir['lib/**/*', '*.gemspec', 'Gemfile', 'README.md', 'LICENSE']
+  spec.require_paths = ['lib']
+  spec.add_dependency 'rails',            '>= 6.1'
+  spec.add_dependency 'reverse_markdown', '~> 2.1'
+  spec.add_dependency 'nokogiri',         '>= 1.13'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
+  spec.add_development_dependency 'capybara',    '~> 3.0'
+end

metadata ADDED Viewed

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: mark-don
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Lahana
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Rails gem that converts HTML views to Markdown on-the-fly via format.markdown
+  in respond_to blocks.
+email:
+- paul.lahana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/mark/don.rb
+- lib/mark_don.rb
+- lib/mark_don/controller_helpers.rb
+- lib/mark_don/converter.rb
+- lib/mark_don/railtie.rb
+- lib/mark_don/request_handler.rb
+- lib/mark_don/version.rb
+- mark-don.gemspec
+homepage: https://github.com/paultursuru/mark-don
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Render Rails HTML views as Markdown
+test_files: []

mark-don 0.1.0