redcarpet-render-seeing_is_believing 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcc1c0f28a1ecc77cb296065f2eee3ee6fd61263
-  data.tar.gz: c0e118eb283f1c629c247ff3e4acfa52db02c0a9
+  metadata.gz: 994ea9eff8c6cc2193109d282d4750a1ba3d34d5
+  data.tar.gz: e8227910b3bb41cc607ca143b55d6e0787642e5f
 SHA512:
-  metadata.gz: 6f70e28b8a9fd891543d1aa5de894be380ac6e0a164415b09f0488e04d3d89415c5ec99ef67a6a6b513b418b8a2496c8ee02edcb9391c4fd837a0cf4491e0483
-  data.tar.gz: af66b1f4f0125202691aa9be088fdb550eab876f7624624cfcc388eafc363a592698b2c393c2edbaf33339d477bee8df1f28c1157305d236f596bbfcd4cd6667
+  metadata.gz: c1a1ec1a15f342fdf3d8a1b9bfd05a2927a525dbfc99a094690625925ecf093532808e87653607e3133bbe265c2a7c9cbeb73bb6be837de592ef93744247356f
+  data.tar.gz: dd58fba896fdee7426a91065e8e8152034e2ea6b75aa8d81e68369aa6ae0f258efd21a23cbf0b33aba84ae7fb8526b620f04076c6a965c4580e0717b2d0c4a6a

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
+  - 2.3
+  - 2.4
+  - 2.5
 before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changes
+
+## 0.2.0 (12th Jan, 2018)
+
+- Allow exceptions to be shown when the `ruby+e` option is specified
+
+## 0.1.0 (7th Jan, 2018)
+
+- Initial release

data/README.md

@@ -1,8 +1,10 @@
 # Redcarpet::Render::SeeingIsBelieving
 
+[![Build Status](https://travis-ci.org/odlp/redcarpet-render-seeing_is_believing.svg?branch=master)](https://travis-ci.org/odlp/redcarpet-render-seeing_is_believing)
+
 Powerup the Ruby examples in your markdown. Combines the excellent
 [Redcarpet][redcarpet] (a markdown parser) with [Seeing Is Believing][sib],
-which evaluates each line of code.
+which shows the evaluated result from each line of code.
 
 If your markdown includes a fenced code block with `ruby+` specified as the
 language:
@@ -23,11 +25,11 @@ require "redcarpet-render-seeing_is_believing"
 require "redcarpet"
 
 class MyCustomHtmlRenderer < Redcarpet::Render::HTML
+  prepend Redcarpet::Render::SeeingIsBelieving
+
   def block_code(code, language)
     "<pre><code>#{code}</code></pre>"
   end
-
-  prepend Redcarpet::Render::SeeingIsBelieving
 end
 
 Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
@@ -56,7 +58,15 @@ Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
 [redcarpet]: https://github.com/vmg/redcarpet
 [sib]: https://github.com/JoshCheek/seeing_is_believing
 
+## Options
+
+You can pass additional options after the `ruby+` language hint:
+
+- `ruby+e`: Hints exceptions are expected, and should be displayed. Exceptions
+  are hidden by default.
+
 ## TODO
 
-- Ignore exceptions / failed evaluations by default
 - Allow comments to be scoped to specific lines
+- Wrap comments to the following line when the overall length is greater than
+  80 chars

data/lib/redcarpet/render/seeing_is_believing.rb

@@ -1,12 +1,14 @@
 require "redcarpet/render/seeing_is_believing/enricher"
+require "redcarpet/render/seeing_is_believing/options"
 require "redcarpet/render/seeing_is_believing/version"
 
 module Redcarpet
   module Render
     module SeeingIsBelieving
       def block_code(code, language)
-        if language == "ruby+"
-          enriched_code = Enricher.new.process(code)
+        if language.start_with? "ruby+"
+          options = Options.parse(language)
+          enriched_code = Enricher.new(options).process(code)
           super(enriched_code, "ruby")
         else
           super(code, language)

data/lib/redcarpet/render/seeing_is_believing/enricher.rb

@@ -1,31 +1,59 @@
 require "seeing_is_believing"
+require_relative "options"
 
 module Redcarpet
   module Render
     module SeeingIsBelieving
       class Enricher
+        def initialize(options = Options.new)
+          @options = options
+        end
+
         def process(code)
           code.split("\n").
             zip(evaluate_code(code)).
-            map(&combine_code_and_eval_lines).
+            map(&combine_code_with_result).
             join("\n")
         end
 
         private
 
+        attr_reader :options
+
         def evaluate_code(code)
-          ::SeeingIsBelieving.call(code).result
+          eval_result = ::SeeingIsBelieving.call(code).result
+          combine_eval_lines_and_exceptions(eval_result)
         end
 
-        def combine_code_and_eval_lines
-          proc do |code_line, eval_lines|
+        def combine_eval_lines_and_exceptions(result)
+          (1..result.num_lines).map do |line_number|
+            eval_lines = result[line_number]
+            exception = exception_for_line(result.exceptions, line_number)
+
             if eval_lines.any?
-              code_line + " # => " + eval_lines.join("\n")
+              eval_lines.join(" ")
+            elsif exception
+              "#{exception.class_name}: #{exception.message}"
+            end
+          end
+        end
+
+        def exception_for_line(exceptions, line_number)
+          if options.show_exceptions
+            exceptions.detect { |ex| ex.line_number == line_number }
+          end
+        end
+
+        def combine_code_with_result
+          proc do |code_line, eval_line|
+            if eval_line
+              "#{code_line} # => #{eval_line}"
             else
               code_line
             end
           end
         end
+
       end
     end
   end

data/lib/redcarpet/render/seeing_is_believing/options.rb

@@ -0,0 +1,19 @@
+module Redcarpet
+  module Render
+    module SeeingIsBelieving
+      class Options
+        attr_reader :show_exceptions
+
+        def self.parse(language)
+          options = language.partition("+").last
+
+          new(show_exceptions: options.include?("e"))
+        end
+
+        def initialize(show_exceptions: false)
+          @show_exceptions = show_exceptions
+        end
+      end
+    end
+  end
+end

data/lib/redcarpet/render/seeing_is_believing/version.rb

@@ -1,7 +1,7 @@
 module Redcarpet
   module Render
     module SeeingIsBelieving
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redcarpet-render-seeing_is_believing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Oli Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -146,6 +146,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -153,6 +154,7 @@ files:
 - bin/setup
 - lib/redcarpet/render/seeing_is_believing.rb
 - lib/redcarpet/render/seeing_is_believing/enricher.rb
+- lib/redcarpet/render/seeing_is_believing/options.rb
 - lib/redcarpet/render/seeing_is_believing/version.rb
 - redcarpet-render-seeing_is_believing.gemspec
 homepage: https://github.com/odlp/redcarpet-render-seeing_is_believing