redcarpet-render-seeing_is_believing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcc1c0f28a1ecc77cb296065f2eee3ee6fd61263
+  data.tar.gz: c0e118eb283f1c629c247ff3e4acfa52db02c0a9
+SHA512:
+  metadata.gz: 6f70e28b8a9fd891543d1aa5de894be380ac6e0a164415b09f0488e04d3d89415c5ec99ef67a6a6b513b418b8a2496c8ee02edcb9391c4fd837a0cf4491e0483
+  data.tar.gz: af66b1f4f0125202691aa9be088fdb550eab876f7624624cfcc388eafc363a592698b2c393c2edbaf33339d477bee8df1f28c1157305d236f596bbfcd4cd6667

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redcarpet-render-seeing_is_believing.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# Redcarpet::Render::SeeingIsBelieving
+
+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.
+
+If your markdown includes a fenced code block with `ruby+` specified as the
+language:
+
+<pre><code>```ruby+
+  animals = ["Aardvark", "Butterfly", "Camel"]
+  animals.map(&:upcase)
+```</code></pre>
+
+Then you'll see the result of each line of code:
+
+![Example HTML](example_app/example.png)
+
+## Usage
+
+```ruby
+require "redcarpet-render-seeing_is_believing"
+require "redcarpet"
+
+class MyCustomHtmlRenderer < Redcarpet::Render::HTML
+  def block_code(code, language)
+    "<pre><code>#{code}</code></pre>"
+  end
+
+  prepend Redcarpet::Render::SeeingIsBelieving
+end
+
+Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
+  render("some markdown!")
+```
+
+or combine with [Rouge][rouge] syntax highlighter:
+
+[rouge]: https://github.com/jneen/rouge
+
+```ruby
+require "redcarpet-render-seeing_is_believing"
+require "redcarpet"
+require "rouge"
+require "rouge/plugins/redcarpet"
+
+class MyCustomHtmlRenderer < Redcarpet::Render::HTML
+  include Rouge::Plugins::Redcarpet
+  prepend Redcarpet::Render::SeeingIsBelieving
+end
+
+Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
+  render("some markdown!")
+```
+
+[redcarpet]: https://github.com/vmg/redcarpet
+[sib]: https://github.com/JoshCheek/seeing_is_believing
+
+## TODO
+
+- Ignore exceptions / failed evaluations by default
+- Allow comments to be scoped to specific lines

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redcarpet/render/seeing_is_believing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redcarpet/render/seeing_is_believing.rb

@@ -0,0 +1,17 @@
+require "redcarpet/render/seeing_is_believing/enricher"
+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)
+          super(enriched_code, "ruby")
+        else
+          super(code, language)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require "seeing_is_believing"
+
+module Redcarpet
+  module Render
+    module SeeingIsBelieving
+      class Enricher
+        def process(code)
+          code.split("\n").
+            zip(evaluate_code(code)).
+            map(&combine_code_and_eval_lines).
+            join("\n")
+        end
+
+        private
+
+        def evaluate_code(code)
+          ::SeeingIsBelieving.call(code).result
+        end
+
+        def combine_code_and_eval_lines
+          proc do |code_line, eval_lines|
+            if eval_lines.any?
+              code_line + " # => " + eval_lines.join("\n")
+            else
+              code_line
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/redcarpet-render-seeing_is_believing.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redcarpet/render/seeing_is_believing/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redcarpet-render-seeing_is_believing"
+  spec.version       = Redcarpet::Render::SeeingIsBelieving::VERSION
+  spec.authors       = ["Oli Peate"]
+  spec.email         = ["oliverp@gmail.com"]
+
+  spec.summary       = "Evaluates Ruby code in your markdown, for awesome examples."
+  spec.homepage      = "https://github.com/odlp/redcarpet-render-seeing_is_believing"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|example_app)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redcarpet"
+  spec.add_dependency "seeing_is_believing"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "nokogiri", "~> 1.8"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rouge"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "sinatra", "~> 2.0"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: redcarpet-render-seeing_is_believing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oli Peate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: seeing_is_believing
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- oliverp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redcarpet/render/seeing_is_believing.rb
+- lib/redcarpet/render/seeing_is_believing/enricher.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
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Evaluates Ruby code in your markdown, for awesome examples.
+test_files: []