blackrug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c15a638f66e78fa225f8edee0aa168d1c9ee5df8abbbf93358c4ca912aa123d
+  data.tar.gz: 2f02482cdc71c84ac5535c1ab04bd0064ad0c05e834ae33dc54324b0a9c8597e
+SHA512:
+  metadata.gz: ff50e4a31d61fdf19fec3084d939f6577be170d6c09ae44e6d7a7e4c97105d6d47bd5d25382fd4334382e78485642b5a423c88b2f325e023fd1d90cb9a105bb4
+  data.tar.gz: ff17ed8def0a3f6e3c169cad18bc17fa9d85fb573871365bfb0f19fefb59d79bb8561ccbcb1c62aac020386d0989aa37449e58ed67ea6aad8c966cfdb28fd5c0

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## V0.1.0
+First release. Everything is new

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Justin Léger
+
+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

@@ -0,0 +1,27 @@
+# Blackrug
+A Markdown preparser to sweep comments under the rug.
+
+Blackrug is this groundbreaking parser that allows you to sweep markdown under the rug by wrapping it by `<!---Blackrug--->`. Typical markdown parser will render the blackrugged elements.
+
+## Installation
+
+Install via: 
+
+```console
+gem install blackrug
+```
+
+Then start using it:
+
+```ruby
+require 'blackrug'
+```
+
+## Examples
+
+You can use `Blackrug.sweep` or `Blackrug.🧹` to sweep elements under the rug
+
+```
+Blackrug.sweep('wow this is <!---Blackrug--->so not <!---Blackrug--->cool!')
+=> "wow this is cool!"
+```

data/lib/blackrug.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+# Blackrug is this groundbreaking parser that allows you to sweep markdown under
+# the rug by wrapping it by <!---Blackrug--->
+# Typical markdown parser will render the blackrugged elements.
+# You need to pre-parse it via Blackrug
+module Blackrug
+  class << self
+    extend T::Sig
+
+    sig { params(text: String).returns(String) }
+    def sweep(text)
+      text.split(/(?<!`)<!---Blackrug--->(?!`)/).select.with_index { |_, i| i.even? }.join
+    end
+
+    alias_method(:🧹, :sweep)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: blackrug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Leger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Blackrug is this groundbreaking parser that allows you to sweep
+  markdown under the rug by wrapping it by \n    `<!---Blackrug--->`.\n"
+email: hey@justinleger.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/blackrug.rb
+homepage: https://github.com/jusleg/i-bought-from-a-bot/tree/master/gems/blackrug
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/jusleg/i-bought-from-a-bot/tree/master/gems/blackrug
+  changelog_uri: https://github.com/jusleg/i-bought-from-a-bot/tree/master/gems/blackrug/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Markdown preparser that hides commented blocks
+test_files: []