marble_markdown 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e054f641aae366f4b79f6fdbb2fdd5806ec3dce82b1218873887723c42f37c9
+  data.tar.gz: 878fc70ddeca19a7590f8d79879a47a4e565b20d1fca9e05b3b5dd77ac0419cb
+SHA512:
+  metadata.gz: 63b99e4feab505fdd58ebb1634813ecc7ab8a84ca87916fcddde89a27c73ab74ea484bd9e6e0f6946f08ad7b952b28250723a42560e436978b0a77cde8443222
+  data.tar.gz: fd1d19b166fbf3abc153ff344c9cd8019404f337186455862a9c4cc8bfb55beb4692247df0b14626a1a015b5cb29fe9a82098c08ec9256a9c0cb1d9bd95b1c4a

data/lib/marble.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+#
+# Copyright (C) 2021 biqqles.
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+# The Marble Markdown formatter.
+module Marble
+  VERSION = '0.1'
+
+  # build a hash of characters that must be escaped and their escaped forms,
+  # and a regex to detect the former.
+  # not using Array#to_h to maintain compatibility below Ruby 2.6
+  ESCAPED = %w{! # ( ) * [ \\ ] _ ` | ~}.map { |c| [c, "\\#{c}"] }.to_h
+  TO_ESCAPE = Regexp.union(ESCAPED.keys)
+
+  module_function
+
+  # Return a string with all Markdown syntax escaped.
+  # @param text [String]
+  def escape(text)
+    text.gsub(TO_ESCAPE, ESCAPED)
+  end
+
+  # Create bolded Markdown text.
+  # @param text [String]
+  # @return [String]
+  def bold(text)
+    "**#{text}**"
+  end
+
+  # Create a code block. If `language` is not `nil`, the code block will be "fenced".
+  # If you want a fenced code block with no syntax highlighting, set `language` to an empty string.
+  # @param text [String]
+  # @param language [String, nil]
+  def code(text, language: nil)
+    if language.nil?
+      "`#{text}`"
+    else
+      "```#{language}\n#{text}\n```"
+    end
+  end
+
+  # Create italicised Markdown text.
+  # @param text [String]
+  # @return [String]
+  def italic(text)
+    "*#{text}*"
+  end
+
+  # Create struck-through Markdown text.
+  # @param text [String]
+  def strikethrough(text)
+    "~~#{text}~~"
+  end
+
+  # Create a block quote.
+  def quote(text)
+    "> #{text}"
+  end
+
+  # Create a Markdown link.
+  # @param text [String]
+  # @param url [String]
+  def link(text, url)
+    "[#{text}](#{url})"
+  end
+
+  # Create a Markdown image.
+  # @param alt_text [String]
+  # @param url [String]
+  def image(alt_text, url)
+    "![#{alt_text}](#{url})"
+  end
+
+  # Create an ordered list.
+  # @param items [Array<String>]
+  # @param start [Integer]
+  def ordered_list(items, start: 1)
+    items.each.with_index(start).map { |item, n| "#{n}.   #{item}\n" }.join
+  end
+
+  # Create an unordered list.
+  # @param items [Enumerable<String>]
+  def unordered_list(items)
+    items.map { |item| "-   #{item}\n" }.join
+  end
+
+  # Create a horizontal rule.
+  def horizontal_rule
+    '---'
+  end
+
+  # Create headers of various levels.
+  def h1(title)
+    "# #{title}"
+  end
+
+  def h2(title)
+    "## #{title}"
+  end
+
+  def h3(title)
+    "### #{title}"
+  end
+
+  def h4(title)
+    "#### #{title}"
+  end
+
+  def h5(title)
+    "##### #{title}"
+  end
+
+  def h6(title)
+    "###### #{title}"
+  end
+
+  # define aliases
+  class << self
+    alias hr horizontal_rule
+    alias ol ordered_list
+    alias ul unordered_list
+    alias italics italic
+    alias strike strikethrough
+  end
+end
+
+# The most common formatting operations are added to String as extension methods.
+class String
+  # This string with all Markdown syntax escaped.
+  def escape
+    Marble.escape self
+  end
+
+  # Embolden this string.
+  def bold
+    Marble.bold self
+  end
+
+  # Display this string as code.
+  def code
+    Marble.code self
+  end
+
+  # Italicise this string.
+  def italic
+    Marble.italic self
+  end
+
+  # Strike-out this string.
+  def strikethrough
+    Marble.strikethrough self
+  end
+
+  # Create a link using this string as the text.
+  def link(url)
+    Marble.link self, url
+  end
+
+  alias italics italic
+  alias strike strikethrough
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: marble_markdown
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- biqqles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- biqqles@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/marble.rb
+homepage: https://github.com/biqqles/marble
+licenses:
+- MPL-2.0
+metadata:
+  homepage_uri: https://github.com/biqqles/marble
+  source_code_uri: https://github.com/biqqles/marble
+  changelog_uri: https://github.com/biqqles/marble/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: The Ruby Markdown formatter
+test_files: []