redcarpet-render-seeing_is_believing 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +13 -0
- data/.rspec +3 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/README.md +62 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/redcarpet/render/seeing_is_believing.rb +17 -0
- data/lib/redcarpet/render/seeing_is_believing/enricher.rb +32 -0
- data/lib/redcarpet/render/seeing_is_believing/version.rb +7 -0
- data/redcarpet-render-seeing_is_believing.gemspec +31 -0
- metadata +181 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: bcc1c0f28a1ecc77cb296065f2eee3ee6fd61263
|
4
|
+
data.tar.gz: c0e118eb283f1c629c247ff3e4acfa52db02c0a9
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 6f70e28b8a9fd891543d1aa5de894be380ac6e0a164415b09f0488e04d3d89415c5ec99ef67a6a6b513b418b8a2496c8ee02edcb9391c4fd837a0cf4491e0483
|
7
|
+
data.tar.gz: af66b1f4f0125202691aa9be088fdb550eab876f7624624cfcc388eafc363a592698b2c393c2edbaf33339d477bee8df1f28c1157305d236f596bbfcd4cd6667
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
# Redcarpet::Render::SeeingIsBelieving
|
2
|
+
|
3
|
+
Powerup the Ruby examples in your markdown. Combines the excellent
|
4
|
+
[Redcarpet][redcarpet] (a markdown parser) with [Seeing Is Believing][sib],
|
5
|
+
which evaluates each line of code.
|
6
|
+
|
7
|
+
If your markdown includes a fenced code block with `ruby+` specified as the
|
8
|
+
language:
|
9
|
+
|
10
|
+
<pre><code>```ruby+
|
11
|
+
animals = ["Aardvark", "Butterfly", "Camel"]
|
12
|
+
animals.map(&:upcase)
|
13
|
+
```</code></pre>
|
14
|
+
|
15
|
+
Then you'll see the result of each line of code:
|
16
|
+
|
17
|
+
![Example HTML](example_app/example.png)
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require "redcarpet-render-seeing_is_believing"
|
23
|
+
require "redcarpet"
|
24
|
+
|
25
|
+
class MyCustomHtmlRenderer < Redcarpet::Render::HTML
|
26
|
+
def block_code(code, language)
|
27
|
+
"<pre><code>#{code}</code></pre>"
|
28
|
+
end
|
29
|
+
|
30
|
+
prepend Redcarpet::Render::SeeingIsBelieving
|
31
|
+
end
|
32
|
+
|
33
|
+
Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
|
34
|
+
render("some markdown!")
|
35
|
+
```
|
36
|
+
|
37
|
+
or combine with [Rouge][rouge] syntax highlighter:
|
38
|
+
|
39
|
+
[rouge]: https://github.com/jneen/rouge
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
require "redcarpet-render-seeing_is_believing"
|
43
|
+
require "redcarpet"
|
44
|
+
require "rouge"
|
45
|
+
require "rouge/plugins/redcarpet"
|
46
|
+
|
47
|
+
class MyCustomHtmlRenderer < Redcarpet::Render::HTML
|
48
|
+
include Rouge::Plugins::Redcarpet
|
49
|
+
prepend Redcarpet::Render::SeeingIsBelieving
|
50
|
+
end
|
51
|
+
|
52
|
+
Redcarpet::Markdown.new(MyCustomHtmlRenderer, fenced_code_blocks: true).
|
53
|
+
render("some markdown!")
|
54
|
+
```
|
55
|
+
|
56
|
+
[redcarpet]: https://github.com/vmg/redcarpet
|
57
|
+
[sib]: https://github.com/JoshCheek/seeing_is_believing
|
58
|
+
|
59
|
+
## TODO
|
60
|
+
|
61
|
+
- Ignore exceptions / failed evaluations by default
|
62
|
+
- Allow comments to be scoped to specific lines
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "redcarpet/render/seeing_is_believing"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
require "redcarpet/render/seeing_is_believing/enricher"
|
2
|
+
require "redcarpet/render/seeing_is_believing/version"
|
3
|
+
|
4
|
+
module Redcarpet
|
5
|
+
module Render
|
6
|
+
module SeeingIsBelieving
|
7
|
+
def block_code(code, language)
|
8
|
+
if language == "ruby+"
|
9
|
+
enriched_code = Enricher.new.process(code)
|
10
|
+
super(enriched_code, "ruby")
|
11
|
+
else
|
12
|
+
super(code, language)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
require "seeing_is_believing"
|
2
|
+
|
3
|
+
module Redcarpet
|
4
|
+
module Render
|
5
|
+
module SeeingIsBelieving
|
6
|
+
class Enricher
|
7
|
+
def process(code)
|
8
|
+
code.split("\n").
|
9
|
+
zip(evaluate_code(code)).
|
10
|
+
map(&combine_code_and_eval_lines).
|
11
|
+
join("\n")
|
12
|
+
end
|
13
|
+
|
14
|
+
private
|
15
|
+
|
16
|
+
def evaluate_code(code)
|
17
|
+
::SeeingIsBelieving.call(code).result
|
18
|
+
end
|
19
|
+
|
20
|
+
def combine_code_and_eval_lines
|
21
|
+
proc do |code_line, eval_lines|
|
22
|
+
if eval_lines.any?
|
23
|
+
code_line + " # => " + eval_lines.join("\n")
|
24
|
+
else
|
25
|
+
code_line
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require "redcarpet/render/seeing_is_believing/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "redcarpet-render-seeing_is_believing"
|
7
|
+
spec.version = Redcarpet::Render::SeeingIsBelieving::VERSION
|
8
|
+
spec.authors = ["Oli Peate"]
|
9
|
+
spec.email = ["oliverp@gmail.com"]
|
10
|
+
|
11
|
+
spec.summary = "Evaluates Ruby code in your markdown, for awesome examples."
|
12
|
+
spec.homepage = "https://github.com/odlp/redcarpet-render-seeing_is_believing"
|
13
|
+
|
14
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
15
|
+
f.match(%r{^(test|spec|features|example_app)/})
|
16
|
+
end
|
17
|
+
spec.bindir = "exe"
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "redcarpet"
|
22
|
+
spec.add_dependency "seeing_is_believing"
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.16"
|
25
|
+
spec.add_development_dependency "nokogiri", "~> 1.8"
|
26
|
+
spec.add_development_dependency "pry"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rouge"
|
29
|
+
spec.add_development_dependency "rspec", "~> 3.7"
|
30
|
+
spec.add_development_dependency "sinatra", "~> 2.0"
|
31
|
+
end
|
metadata
ADDED
@@ -0,0 +1,181 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: redcarpet-render-seeing_is_believing
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Oli Peate
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-01-07 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: redcarpet
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: seeing_is_believing
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.16'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.16'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: nokogiri
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.8'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.8'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rake
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '10.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '10.0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rouge
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: rspec
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '3.7'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '3.7'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: sinatra
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '2.0'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '2.0'
|
139
|
+
description:
|
140
|
+
email:
|
141
|
+
- oliverp@gmail.com
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".gitignore"
|
147
|
+
- ".rspec"
|
148
|
+
- ".travis.yml"
|
149
|
+
- Gemfile
|
150
|
+
- README.md
|
151
|
+
- Rakefile
|
152
|
+
- bin/console
|
153
|
+
- bin/setup
|
154
|
+
- lib/redcarpet/render/seeing_is_believing.rb
|
155
|
+
- lib/redcarpet/render/seeing_is_believing/enricher.rb
|
156
|
+
- lib/redcarpet/render/seeing_is_believing/version.rb
|
157
|
+
- redcarpet-render-seeing_is_believing.gemspec
|
158
|
+
homepage: https://github.com/odlp/redcarpet-render-seeing_is_believing
|
159
|
+
licenses: []
|
160
|
+
metadata: {}
|
161
|
+
post_install_message:
|
162
|
+
rdoc_options: []
|
163
|
+
require_paths:
|
164
|
+
- lib
|
165
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
166
|
+
requirements:
|
167
|
+
- - ">="
|
168
|
+
- !ruby/object:Gem::Version
|
169
|
+
version: '0'
|
170
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
171
|
+
requirements:
|
172
|
+
- - ">="
|
173
|
+
- !ruby/object:Gem::Version
|
174
|
+
version: '0'
|
175
|
+
requirements: []
|
176
|
+
rubyforge_project:
|
177
|
+
rubygems_version: 2.6.11
|
178
|
+
signing_key:
|
179
|
+
specification_version: 4
|
180
|
+
summary: Evaluates Ruby code in your markdown, for awesome examples.
|
181
|
+
test_files: []
|