redrug 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b28a70768420e25e2504fc03468bff2dda20eb02
-  data.tar.gz: f58513ae5ec0d9975be0582f2b9d48c7aa255348
+SHA256:
+  metadata.gz: 8c57240ac79baf96c9a4e16630e30f215bb632aad7abd9859c7bee23fde191ab
+  data.tar.gz: a712d3e065bfd6d01108dfeaa0fba0150649c726f82c26b597269756b8906da1
 SHA512:
-  metadata.gz: c927e151019a06056f4f641e7d0f07bac755c242d81fc81bd935fafa7d01285ce756aac7b8e8d5799e4a53664e8c56377ae57d04ad5b88378986079b6c089144
-  data.tar.gz: a325d5b66ef979be5da8cde63d3785203ca6a795a4c7bb4d322548e577481c88f3a5fbbdef3de1fb6f09d306ae0037e0ffe74957e5ecf1d45170da56a12fe801
+  metadata.gz: 6ce34f4060254d32df5411b05a2750942a24f2da4e379c72ed3a69a5931f8c9dacb31d9470615715ca77e9926c9c9806f87fc3e76a83e6b2ff90e650ae880644
+  data.tar.gz: 002757ab7f297c5ed8e4470052850c1ccfba069f6cbb3f4655fd6104fda26f31bcc15ea9c238091461613cd0653d26a842cb28ccfca0621e0414eb99d4c67610

data/COPYING

@@ -1,17 +1,18 @@
-RedRug is distributed under the terms of the Detachable Public License.  The
-Detachable Public License is a copyfree license.
+RedRug is distributed under the terms of the Copyfree Open Innovation License
+(COIL) or the Detachable Public License (DPL), at the recipient's discretion.
+The COIL and DPL are copyfree licenses.
 
 RedRug depends on Redcarpet, which is distributed under the terms of the ISC
 License.  The ISC License is a copyfree license.
 
 RedRug also depends on Versionize, which is distributed under the terms of the
-same license as RedRug.  That's awfully convenient.
+same licenses as RedRug.  That's awfully convenient.
 
 See http://copyfree.org for more information about copyfree licensing in
-general, and about the Detachable Public License and ISC License in particular.
+general, and about the COIL, DPL, and ISC License in particular.
 
 See https://github.com/vmg/redcarpet for more information about Redcarpet.  See
 http://fossrec.com/u/apotheon/versionize for more information about Versionize.
 See http://fossrec.com/u/apotheon/redrug for more information about RedRug.
 
-See the LICENSE file for the text of the Detachable Public License.
+See coil.txt for the text of the COIL and dpl.txt for the text of the DPL.

data/README.md

@@ -0,0 +1,167 @@
+# redrug
+
+The redcarpet library can be a bit cumbersome to use, and redrug aims to
+rectify this problem by wrapping it with simpler interfaces for common use
+cases.  Three places to get information about RedRug include:
+
+* [Fossil Repository](https://fossrec.com/u/apotheon/redrug)
+* [GitHub Mirror](https://github.com/apotheon/redrug)
+* [Ruby Gem Page](https://rubygems.org/gems/redrug)
+
+## Installation
+
+The simple way to install redrug is to use the gem command:
+
+      $ gem install redrug
+
+You can also build from source and install it the "hard" way.  To do this,
+first clone the sources to your local system using Fossil SCM:
+
+      $ fossil clone http://redrug.fossrec.com redrug.fossil
+
+Then, open the repository in an appropriate directory:
+
+      $ mkdir redrug
+      $ cd redrug
+      $ fossil open ../redrug.fossil
+
+Finally, build and install, where in this example the N.N.N sequence is a
+series of numbers indicating the current version number of the gem.
+
+      $ gem build red_rug.gemspec
+      $ gem install redrug-N.N.N.gem
+
+## Rails Usage
+
+The most convenient use of RedRug with Rails is probably as an application
+helper.  The following example assumes that approach.
+
+First, stick it in your Gemfile:
+
+      gem 'redrug'
+
+Next, make sure you install it:
+
+      $ bundle install
+
+Finally (and this is the "hard" part, of course), set up a helper in your
+project's `app/helpers/application_helper.rb` (though if you are only going to
+use it in very limited contexts, you may want to stick it in some other helper
+within `app/helpers/`):
+
+      # whatever other requires you need
+      require 'red_rug'
+    
+      module ApplicationHelper
+        # whatever other helper methods you've defined
+    
+        def markdown text
+          RedRug.to_html(text).html_safe
+        end
+      end
+
+You can then use it wherever you need to parse Markdown by executing the
+`markdown` method, most likely in views.  For instance, there's always this
+common pattern, in (for instance) your `app/views/profiles/show.html.erb` view:
+
+      <h2><%= @article.title %></h2>
+    
+      <%= markdown @article.body %>
+
+Voila: Markdown enhanced blogging.
+
+### HTML Safety
+
+Alas, the simplistic approach above may expose you to the dangers of unescaped
+HTML input from users.  The following rewrite of the `markdown` helper method
+as two methods provides both a way to escape any HTML in the input Markdown
+text and a way to leave HTML unescaped when you trust the source of the
+Markdown text and want to allow HTML to pass through unmolested:
+
+      module ApplicationHelper
+        # whatever other helper methods you've defined
+    
+        # use this for input you do not trust
+        def markdown text
+          RedRug.to_html(h text).html_safe
+        end
+    
+        # use this for input you trust, if you really really must
+        def septic_markdown text
+          RedRug.to_html(text).html_safe
+        end
+      end
+
+Since RedRug version 0.3.0, you have another alternative that relies on
+Redcarpet's own HTML escaping capabilities.  If you wish to use that instead of
+the Rails `h` helper, you can do this with the HTML-escaped version of your
+RedRug-based Markdown helper:
+
+      module ApplicationHelper
+        # . . .
+    
+        def markdown text
+          RedRug.to_html(text, escape_html: true).html_safe
+        end
+      
+        # . . .
+      end
+
+## Library Usage
+
+At this time, the RedRug module provides a very simple API for translating
+Markdown into HTML.  The basic use case examples are as follows:
+
+      require 'red_rug'
+    
+      RedRug.from_file '/path/to/filename.md'
+    
+      RedRug.to_html <<END
+        # This Is A Markdown Heading
+    
+        This is how paragraphs look in Markdown.
+      END
+
+## Command Line Usage
+
+The redrug gem provides a `redrug` command line utility that takes a Markdown
+formatted file as input and translates it into HTML, dumping the results to
+standard output.  The usual approach would be to use a redirect to send the
+output to a persistent file instead:
+
+      $ redrug filename.md > filename.html
+
+This translates the contents of a Markdown formatted file, `filename.md`, into
+HTML, then writes that HTML into a file called `filename.html`.
+
+It can also accept Markdown from standard input, so commands such as the
+following examples should also work:
+
+      $ cat file1.md file2.md file3.md | redrug > filename.html
+      $ redrug < filename.md > filename.html
+
+The usual Unix pipeline rules apply.
+
+As of RedRug version 0.3.0, the `redrug` utility also accepts a command line
+option for escaping HTML before parsing Markdown:
+
+      $ redrug -e filename.md
+
+Simply put, `-e` employs Redcarpet's `:html_escape` parsing option to escape
+HTML before parsing any Markdown.  Otherwise, the behavior of the `redrug`
+utility has not changed.
+
+## Bugs And Feature Requests
+
+To file a bug report, feature request, or other issue, please log in as
+"anonymous" using the temporary password provided on the login page, then click
+the Tickets link and select New Ticket.  Select the appropriate issue type
+before submitting.
+
+## Other
+
+For more information, see either the [redrug project page][redrug] or the
+[redrug Rubygems page][rubygem].
+
+[redrug]: http://fossrec.com/u/apotheon/redrug
+[rubygem]: http://rubygems.org/gems/redrug

data/bin/redrug

@@ -8,19 +8,19 @@ help_text = {
   version:  'Display version and license information.'
 }
 
-@usage = <<EOF
+@usage = <<-EOF
 
-USAGE: #{File.basename $0} [options] FILE
+  USAGE: #{File.basename $0} [options] FILE
 
-This utility reads the contents of a Markdown formatted FILE, translates them
-to HTML, and prints the translated text to standard output.
+  This utility reads the contents of a Markdown formatted FILE, translates them
+  to HTML, and prints the translated text to standard output.
 
 EOF
 
-version_help = <<EOF
+version_help = <<-EOF
 
-RedRug #{RedRug.version}, Copyright 2012 Chad Perrin
-May be distributed under the terms of the Open Works License.
+  RedRug #{RedRug.version}, Copyright 2012 Chad Perrin
+  It may be distributed under the terms of the Open Works License.
 
 EOF
 
@@ -49,4 +49,4 @@ content = String.new
 
 $<.each {|line| content << line }
 
-puts RedRug.to_html(content, options)
+puts RedRug.to_html content, options

data/coil.txt

@@ -0,0 +1,30 @@
+# Copyfree Open Innovation License
+
+This is version 0.6 of the Copyfree Open Innovation License.
+
+## Terms and Conditions
+
+Redistributions, modified or unmodified, in whole or in part, must retain
+applicable notices of copyright or other legal privilege, these conditions, and
+the following license terms and disclaimer.  Subject to these conditions, each
+holder of copyright or other legal privileges, author or assembler, and
+contributor of this work, henceforth "licensor", hereby grants to any person
+who obtains a copy of this work in any form:
+
+1. Permission to reproduce, modify, distribute, publish, sell, sublicense, use,
+and/or otherwise deal in the licensed material without restriction.
+
+2. A perpetual, worldwide, non-exclusive, royalty-free, gratis, irrevocable
+patent license to make, have made, provide, transfer, import, use, and/or
+otherwise deal in the licensed material without restriction, for any and all
+patents held by such licensor and necessarily infringed by the form of the work
+upon distribution of that licensor's contribution to the work under the terms
+of this license.
+
+NO WARRANTY OF ANY KIND IS IMPLIED BY, OR SHOULD BE INFERRED FROM, THIS LICENSE
+OR THE ACT OF DISTRIBUTION UNDER THE TERMS OF THIS LICENSE, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS, ASSEMBLERS, OR HOLDERS OF
+COPYRIGHT OR OTHER LEGAL PRIVILEGE BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN ACTION OF CONTRACT, TORT, OR OTHERWISE ARISING FROM, OUT
+OF, OR IN CONNECTION WITH THE WORK OR THE USE OF OR OTHER DEALINGS IN THE WORK.

data/lib/red_rug.rb

@@ -18,7 +18,7 @@ module RedRug
   @version = {
     :major      =>  0,
     :minor      =>  3,
-    :revision   =>  0
+    :revision   =>  2
   }
 
 =begin rdoc

data/spec/red_rug_spec.rb

@@ -1,4 +1,6 @@
+require 'rspec'
 load '../lib/red_rug.rb'
+
 RSpec.describe RedRug do
   describe 'to_html' do
     it 'returns HTML equivalent of Markdown input' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redrug
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Chad Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -48,14 +48,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - COPYING
-- LICENSE
-- README
+- README.md
 - bin/redrug
+- coil.txt
+- dpl.txt
 - lib/red_rug.rb
 - spec/red_rug_spec.rb
 - spec/spec_helper.rb
 homepage: http://fossrec.com/u/apotheon/redrug
 licenses:
+- COIL
 - DPL
 metadata: {}
 post_install_message: |2
@@ -77,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: RedRug - Simple Markdown Interface

data/README

@@ -1,17 +0,0 @@
-# redrug
-
-The redcarpet library can be a bit cumbersome to use, and redrug aims to
-rectify this problem by wrapping it with simpler interfaces for common use
-cases.
-
-## Command Line Usage
-
-The redrug gem provides a `redrug` command line utility that takes a Markdown
-formatted file as input and translates it into HTML, dumping the results to
-standard output.  The usual approach would be to use a redirect to send the
-output to a persistent file instead:
-
-    $ redrug filename.md > filename.html
-
-This translates the contents of a Markdown formatted file, `filename.md`, into
-HTML, then writes that HTML into a file called `filename.html`.