md-ruby-eval 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4259a200d3e6d493c265df47644cec7b5aaac025
+  data.tar.gz: 1d4d41bf98e170c8fdf59792e81fdb92eebb3ea7
+SHA512:
+  metadata.gz: 89bf1a78298b9d998a3045ad12d0fadd21a841ff2f92a19a56efe47cbad8c9a8116dcf0aa29e4472aceda46015e6d26373f897a5e02ca8855e8632b73ddc8f1e
+  data.tar.gz: 886963c1bf80d68ed996554d16f23bfb6db5fc95467e3e18f4cdbaa01357cf3e5bc4194d3fd3e9f31615240c6fd79c61a9ea7e581bc0590bf393bafbd8bcf56b

data/LICENSE.txt

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+#  Copyright 2013 Petr Chalupa <git@pitr.ch>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+# md-ruby-eval
+
+    Usage: #{$0} [options] --auto
+           #{$0} [options] INPUT_FILE OUTPUT_FILE
+
+Evaluates Ruby examples in MD files.
+
+It looks for code blocks starting with '```ruby'. The blocks are evaluated in same order
+as they appear in the markdown file. Each top_level parseable piece of code is evaluated
+and the value is added as a comment, e.g.:
+
+    # Title
+
+    First evaluated block:
+
+    ```ruby
+    a = 1 + 2
+    def a; :a; end #
+    [a,
+     :b]
+    ```
+
+    Continuing in next block
+
+    ```ruby
+    a
+    ```
+
+becomes
+
+    # Title
+
+    First evaluated block:
+
+    ```ruby
+    a = 1 + 2         # => 3
+    def a; :a; end
+    [a,
+     :b]              # => [:a,:b]
+    ```
+
+    Continuing in next block
+
+    ```ruby
+    a                 # => 3
+    ```
+
+A parseable piece of code ended with '#' will be evaluated but it's result is not
+added to the output as a comment, which is useful for method and class definitions.
+
+## Example usage of `--auto`
+
+-   `cd doc_dir` go to directory with documentation
+-   `ls` list the files
+
+        a.in.md
+        a.init.rb
+        b.in.md
+        c.md
+
+-   `md-ruby-eval --auto` call the tool
+    -   Creates files `a.out.md` and `b.out.md` evaluating each in isolated environments, before
+        `a.out.md` is evaluated `a.init.md` is required to setup its environment. `c.md` is ignored
+        since it does not have `in` marker.

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/bin/md-ruby-eval

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'md_ruby_eval'
+
+# this will only run if the script was the main, not load'd or require'd
+to_require  = []
+indentation = 40
+auto        = false
+
+OptionParser.new do |opts|
+  opts.banner = File.read(__dir__ + '/../README.md') + "\n## Options:\n\n"
+
+  opts.on('-r', '--require FILE', 'Require given files before processing the MD files') do |v|
+    to_require << v
+  end
+
+  opts.on('-I', '--load-path PATH', 'Adds the path to LOAD_PATH') do |v|
+    $LOAD_PATH << File.expand_path(v)
+  end
+
+  opts.on('-i', '--indent NUMBER', Integer, 'Default indentation of results') do |v|
+    indentation = v
+  end
+
+  opts.on('--[no-]auto',
+          'Automatic mode. Finds `*.in.md` files outputting `*.out.md` files') do |v|
+    auto = true
+  end
+end.parse!
+
+if auto
+  input_paths = Dir.glob('*.in.md')
+  input_paths.each do |input_path|
+
+    pid = fork do
+      to_require.each { |p| require p }
+      init_path = File.basename(input_path, '.in.md') + '.init.rb'
+      if File.exist? init_path
+        puts "using: #{init_path}"
+        load init_path
+      end
+      MDRubyEval.new input_path, input_path.gsub(/(\.in)?\.md$/, '.out.md'), binding, indentation
+    end
+
+    Process.wait pid
+  end
+else
+  input_path, output_path = ARGV.map { |p| File.expand_path p }
+  raise 'no input path' unless input_path && File.exist?(input_path)
+  MDRubyEval.new input_path, output_path, binding, indentation
+end
+

data/lib/md_ruby_eval.rb

@@ -0,0 +1,106 @@
+require 'pry'
+require 'pp'
+require 'optparse'
+
+class MDRubyEval
+
+  def initialize(input_path, output_path, environment, indentation)
+    @input_path  = input_path
+    @output_path = output_path
+    @environment = environment
+    @output      = ''
+    @indentation = indentation
+
+    process_file input_path
+  end
+
+  def evaluate(code, line)
+    eval(code, @environment, @input_path, line)
+  end
+
+  def process_ruby(part, start_line)
+    lines  = part.lines
+    chunks = []
+    line   = ''
+
+    while !lines.empty?
+      line += lines.shift
+      if Pry::Code.complete_expression? line
+        chunks << line
+        line = ''
+      end
+    end
+
+    raise unless line.empty?
+
+    chunk_lines = chunks.map { |chunk| [chunk, [chunk.split($/).size, 1].max] }
+    line_count  = start_line
+    output      = ''
+    chunk_lines.each do |chunk, lines|
+      result = evaluate(chunk, line_count)
+      if chunk.strip.empty? || chunk.include?('#')
+        output << (chunk.end_with?("#\n") ? chunk[0..-3]+"\n" : chunk)
+      else
+        pre_lines = chunk.lines.to_a
+        last_line = pre_lines.pop
+        output << pre_lines.join
+
+        if last_line =~ /\#$/
+          output << last_line.gsub(/\#$/, '')
+        else
+          if last_line.size < @indentation && result.inspect.size < @indentation
+            output << "%-#{@indentation}s %s" % [last_line.chomp, "# => #{result.inspect}\n"]
+          else
+            inspect_lines = result.pretty_inspect.lines
+            output << last_line << "# => #{inspect_lines[0]}" << inspect_lines[1..-1].map { |l| format '#    %s', l }.join
+          end
+        end
+      end
+      line_count += lines
+    end
+    output
+  end
+
+  def process_file(input_path)
+    puts "evaluating: #{input_path}"
+
+    input      = File.read(input_path)
+    parts      = input.split(/^(```\w*\n)/)
+
+    # pp parts.map(&:lines)
+
+    code_block = nil
+    line_count = 1
+
+    parts.each do |part|
+      if part =~ /^```(\w+)$/
+        code_block = $1
+        @output << part
+        line_count += 1
+        next
+      end
+
+      if part =~ /^```$/
+        code_block = nil
+        @output << part
+        line_count += 1
+        next
+      end
+
+      if code_block == 'ruby'
+        @output << process_ruby(part, line_count)
+        line_count += part.lines.size
+        next
+      end
+
+      @output << part
+      line_count += part.lines.size
+    end
+
+    puts "writing: #{@output_path}"
+    File.write(@output_path, @output)
+  rescue => ex
+    puts "#{ex} (#{ex.class})\n#{ex.backtrace * "\n"}"
+
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: md-ruby-eval
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Petr Chalupa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-26 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: git+md-ruby-eval@pitr.ch
+executables:
+- md-ruby-eval
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- VERSION
+files:
+- LICENSE.txt
+- README.md
+- VERSION
+- bin/md-ruby-eval
+- lib/md_ruby_eval.rb
+homepage: https://github.com/pitr-ch/md-ruby-eval
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Evaluator of Ruby examples in Markdown files.
+test_files: []
+has_rdoc: