redrug 0.2.5 → 0.3.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a192f72a148e893964b4f18e16f06ce1978d0c855e4731f595a39d711499325f
+  data.tar.gz: e9679f402905af92c22febfb17ae4fbb5b6499fc05cfafec18a011419ac1d92d
+SHA512:
+  metadata.gz: 971627cba3397ed4a8f56f20f382c76369a9c3f481dc2ab438c48b56366230fedd5b4a71887310cd1034b4f58d2abf0fd4ba982d9837f20ea7b10d972140d27b
+  data.tar.gz: 70a0b3ac230822cb447e7f13bc2faa0d17589b1385162259e69173e4de54a9316bdc7b4eb89fe51b9cf3d99aa39d6efb7405e29bd8de3529934946009b6c3169

data/COPYING

@@ -1,12 +1,18 @@
-RedRug is distributed under the terms of the Open Works License.  The Open
-Works 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.
 
-See http://copyfree.org for more information about copyfree licensing.
+RedRug also depends on Versionize, which is distributed under the terms of the
+same licenses as RedRug.  That's awfully convenient.
 
-See https://github.com/vmg/redcarpet for more information about Redcarpet.
+See http://copyfree.org for more information about copyfree licensing in
+general, and about the COIL, DPL, and ISC License in particular.
 
-See http://owl.apotheon.org/ for more information about the Open Works License,
-and the `owl.txt` file for the text of the Open Works License.
+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 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

@@ -3,29 +3,37 @@ require 'optparse'
 require 'red_rug'
 
 help_text = {
-  :help         => 'Display this help text.',
-  :version      => 'Display version and license information.'
+  escape:   'Escape all embedded HTML before parsing markdown.',
+  help:     'Display this 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 Copyfree Open Innovation License
+  or the Detachable Public License, at your discretion.
 
 EOF
 
+options = Hash.new
+
 OptionParser.new do |opts|
   opts.banner = @usage
 
+  opts.on('--escape', '-e', help_text[:escape]) do
+    options[:escape_html] = true
+  end
+
   opts.on('--help', '-h', help_text[:help]) do
     puts opts
     puts
@@ -38,8 +46,8 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-@content = String.new
+content = String.new
 
-$<.each {|line| @content << line }
+$<.each {|line| content << line }
 
-puts RedRug.to_html @content
+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/dpl.txt

@@ -0,0 +1,22 @@
+Permission is hereby granted by the holder(s) of copyright or other legal
+privileges, author(s) or assembler(s), and contributor(s) of this work, to any
+person who obtains a copy of this work in any form, to reproduce, modify,
+distribute, publish, sell, sublicense, use, and/or otherwise deal in the
+licensed material without restriction, provided the following conditions are
+met.
+
+Redistributions, modified or unmodified, in whole or in part, must make
+applicable copyright and other legal privilege notices, the above license
+notice, these conditions, and the following disclaimer, freely available to
+recipients on distribution through one of the following means, in descending
+order of preferability: incorporated into the work, provided with the work,
+presented via the medium or method of distribution for the work, or upon
+request by recipients of the work while the work is offered for distribution.
+
+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

@@ -7,14 +7,18 @@ RedRug provides a simplified interface to the functionality of the Redcarpet
 gem for Markdown handling, intended to provide convenience in execution of
 common tasks.  At present, only HTML output is supported.
 
+To begin using RedRug in your code, require it.  Example:
+
+        require 'red_rug'
+
 =end
 
 module RedRug
   include Versionize
   @version = {
     :major      =>  0,
-    :minor      =>  2,
-    :revision   =>  5
+    :minor      =>  3,
+    :revision   =>  3
   }
 
 =begin rdoc
@@ -31,8 +35,12 @@ Example:
 
 =end
 
-  def self.to_html(markdown_string)
-    markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+  def self.to_html(markdown_string, options=Hash.new)
+    unless options.has_key? :escape_html
+      options[:escape_html] = false
+    end
+
+    markdown = Redcarpet::Markdown.new Redcarpet::Render::HTML.new(options)
     markdown.render(markdown_string)
   end
 

data/spec/red_rug_spec.rb

@@ -0,0 +1,34 @@
+require 'rspec'
+load '../lib/red_rug.rb'
+
+RSpec.describe RedRug do
+  describe 'to_html' do
+    it 'returns HTML equivalent of Markdown input' do
+      markdown_input = <<-END.gsub(/^ */, '')
+        # Heading Level One
+
+        This is a very short paragraph indeed.
+
+        ## Heading Level Two
+
+        Luckily, we have another paragraph, consisting of more than one line.
+        It also consists of more than one sentence, though of course RedRug is
+        not currently sentence-aware, so far as its developers are aware.
+      END
+
+      html_output = <<-END.gsub(/^ */, '')
+        <h1>Heading Level One</h1>
+
+        <p>This is a very short paragraph indeed.</p>
+
+        <h2>Heading Level Two</h2>
+
+        <p>Luckily, we have another paragraph, consisting of more than one line.
+        It also consists of more than one sentence, though of course RedRug is
+        not currently sentence-aware, so far as its developers are aware.</p>
+      END
+
+      expect(RedRug.to_html markdown_input).to eq html_output
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,34 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: redrug
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.3.3
 platform: ruby
 authors:
 - Chad Perrin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    RedRug is a wrapper for Redcarpet, intended to provide more convenient\n
-  \   interfaces for common Markdown parsing use cases.\n"
+- !ruby/object:Gem::Dependency
+  name: versionize
+  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'
+description: |2
+      RedRug is a wrapper for Redcarpet, intended to provide more convenient
+      interfaces for common Markdown parsing use cases.
 email: code@apotheon.net
 executables:
 - redrug
@@ -36,36 +48,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - COPYING
-- README
-- owl.txt
-- lib/red_rug.rb
+- README.md
 - bin/redrug
-homepage: http://redrug.fossrec.com
+- 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:
-- OWL
-post_install_message: ! "    Thank you for using RedRug.  Require \"red_rug\" to load
-  this library.\n    The \"redrug\" command line utility takes a filename argument
-  and outputs\n    the contents of the file translated from Markdown to HTML.  Usage
-  and\n    option help for it can be had via the \"-h\" option.\n"
+- COIL
+- DPL
+metadata: {}
+post_install_message: |2
+      Thank you for using RedRug.  Require "red_rug" to load this library.
+      The "redrug" command line utility takes a filename argument and outputs
+      the contents of the file translated from Markdown to HTML.  Usage and
+      option help for it can be had via the "-h" option.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 3.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RedRug - Simple Markdown Interface
 test_files: []

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`.

data/owl.txt

@@ -1,23 +0,0 @@
-# Open Works License
-
-This is version 0.9.2 of the Open Works License.
-
-## Terms
-
-Permission is hereby granted by the copyright holder(s), author(s), and
-contributor(s) of this work, to any person who obtains a copy of this work in
-any form, to reproduce, modify, distribute, publish, sell, use, or otherwise
-deal in the licensed material without restriction, provided the following
-conditions are met:
-
-Redistributions, modified or unmodified, in whole or in part, must retain
-applicable copyright notices, the above license notice, these conditions, and
-the following disclaimer.
-
-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 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
-WORK, OR THE USE OF OR OTHER DEALINGS IN THE WORK.