rundoc 1.1.3 → 2.0.0

data/lib/rundoc/code_section.rb

@@ -3,8 +3,8 @@ module Rundoc
   class CodeSection
     class ParseError < StandardError
       def initialize(options = {})
-        keyword     = options[:keyword]
-        command     = options[:command]
+        keyword = options[:keyword]
+        command = options[:command]
         line_number = options[:line_number]
         block = options[:block].lines.map do |line|
           if line == command
@@ -14,37 +14,40 @@ module Rundoc
           end
         end.join("")
 
-        msg =  "Error parsing (line:#{line_number}):\n"
+        msg = "Error parsing (line:#{line_number}):\n"
         msg << ">  '#{command.strip}'\n"
         msg << "No such registered command: '#{keyword}'\n"
         msg << "registered commands: #{Rundoc.known_commands.inspect}\n\n"
         msg << block
         msg << "\n"
-        super msg
+        super(msg)
       end
     end
 
-    COMMAND_REGEX   = Rundoc::Parser::COMMAND_REGEX # todo: move whole thing
+    COMMAND_REGEX = Rundoc::Parser::COMMAND_REGEX # todo: move whole thing
+    AUTOGEN_WARNING = "\n<!-- STOP. This document is autogenerated. Do not manually modify. See the top of the doc for more details. -->"
     attr_accessor :original, :fence, :lang, :code, :commands, :keyword
 
     def initialize(match, options = {})
       @original = match.to_s
       @commands = []
-      @stack    = []
-      @keyword  = options[:keyword] or raise "keyword is required"
+      @stack = []
+      @keyword = options[:keyword] or raise "keyword is required"
       @document_path = options[:document_path]
-      @fence    = match[:fence]
-      @lang     = match[:lang]
-      @code     = match[:contents]
+      @fence = match[:fence]
+      @lang = match[:lang]
+      @code = match[:contents]
       parse_code_command
     end
 
     def render
       result = []
-      env    = {}
+      env = {}
       env[:commands] = []
-      env[:before]   = String.new("#{fence}#{lang}")
-      env[:after]    = String.new(fence)
+      env[:fence_start] = +"#{fence}#{lang}"
+      env[:fence_end] = "#{fence}#{AUTOGEN_WARNING}"
+      env[:before] = []
+      env[:after] = []
       env[:document_path] = @document_path
 
       @stack.each do |s|
@@ -54,30 +57,44 @@ module Rundoc
         end
 
         code_command = s
-        code_output  = code_command.call(env)  || ""
-        code_line    = code_command.to_md(env) || ""
+        code_output = code_command.call(env) || ""
+        code_line = code_command.to_md(env) || ""
 
-        env[:commands] << { object: code_command, output: code_output, command: code_line }
+        env[:commands] << {object: code_command, output: code_output, command: code_line}
 
         tmp_result = []
-        tmp_result << code_line   if code_command.render_command?
+        tmp_result << code_line if code_command.render_command?
         tmp_result << code_output if code_command.render_result?
 
         result << tmp_result unless code_command.hidden?
-        result
       end
 
       return env[:replace] if env[:replace]
 
       return "" if hidden?
 
-      array = [env[:before], result, env[:after]]
+      array = [env[:before]]
+
+      result.flatten!
+      result.compact!
+      result.map! { |s| s.respond_to?(:rstrip) ? s.rstrip : s }
+      result.reject!(&:empty?)
+      result.map!(&:to_s)
+
+      if !result.empty?
+        array << env[:fence_start]
+        array << result
+        array << env[:fence_end]
+      end
+      array << env[:after]
+
       array.flatten!
       array.compact!
-      array.map!(&:rstrip)
+      array.map! { |s| s.respond_to?(:rstrip) ? s.rstrip : s }
       array.reject!(&:empty?)
+      array.map!(&:to_s)
 
-      return array.join("\n") << "\n"
+      array.join("\n") << "\n"
     end
 
     # all of the commands are hidden
@@ -88,7 +105,7 @@ module Rundoc
     # one or more of the commands are not hidden
     def not_hidden?
       return true if commands.empty?
-      commands.map(&:not_hidden?).detect {|c| c }
+      commands.map(&:not_hidden?).detect { |c| c }
     end
 
     def parse_code_command
@@ -97,8 +114,8 @@ module Rundoc
       actual = Rundoc::PegTransformer.new.apply(tree)
       actual = [actual] unless actual.is_a?(Array)
       actual.each do |code_command|
-        @stack   << "\n" if commands.last.is_a?(Rundoc::CodeCommand)
-        @stack   << code_command
+        @stack << "\n" if commands.last.is_a?(Rundoc::CodeCommand)
+        @stack << code_command
         commands << code_command
       end
     rescue ::Parslet::ParseFailed => e
@@ -117,4 +134,4 @@ module Rundoc
     #   end
     # end
   end
-end
+end

data/lib/rundoc/parser.rb

@@ -1,12 +1,12 @@
 module Rundoc
   class Parser
-    DEFAULT_KEYWORD    = ":::"
-    INDENT_BLOCK       = '(?<before_indent>(^\s*$\n|\A)(^(?:[ ]{4}|\t))(?<indent_contents>.*)(?<after_indent>[^\s].*$\n?(?:(?:^\s*$\n?)*^(?:[ ]{4}|\t).*[^\s].*$\n?)*))'
-    GITHUB_BLOCK       = '^(?<fence>(?<fence_char>~|`){3,})\s*?(?<lang>\w+)?\s*?\n(?<contents>.*?)^\g<fence>\g<fence_char>*\s*?\n'
-    CODEBLOCK_REGEX    = /(#{GITHUB_BLOCK})/m
-    COMMAND_REGEX      = ->(keyword) {
-                             /^#{keyword}(?<tag>(\s|=|-|>)?(=|-|>)?)\s*(?<command>(\S)+)\s+(?<statement>.*)$/
-                            }
+    DEFAULT_KEYWORD = ":::"
+    INDENT_BLOCK = '(?<before_indent>(^\s*$\n|\A)(^(?:[ ]{4}|\t))(?<indent_contents>.*)(?<after_indent>[^\s].*$\n?(?:(?:^\s*$\n?)*^(?:[ ]{4}|\t).*[^\s].*$\n?)*))'
+    GITHUB_BLOCK = '^(?<fence>(?<fence_char>~|`){3,})\s*?(?<lang>\w+)?\s*?\n(?<contents>.*?)^\g<fence>\g<fence_char>*\s*?\n'
+    CODEBLOCK_REGEX = /(#{GITHUB_BLOCK})/m
+    COMMAND_REGEX = ->(keyword) {
+      /^#{keyword}(?<tag>(\s|=|-|>)?(=|-|>)?)\s*(?<command>(\S)+)\s+(?<statement>.*)$/
+    }
 
     attr_reader :contents, :keyword, :stack
 
@@ -14,25 +14,23 @@ module Rundoc
       @document_path = document_path
       @contents = contents
       @original = contents.dup
-      @keyword  = keyword
-      @stack    = []
+      @keyword = keyword
+      @stack = []
       partition
     end
 
     def to_md
       result = []
       @stack.each do |s|
-        if s.respond_to?(:render)
-          result << s.render
+        result << if s.respond_to?(:render)
+          s.render
         else
-          result << s
+          s
         end
       end
-      return result.join("")
-    rescue Exception => e
-      File.open("README.md", "w") do |f|
-        f.write(result.join(""))
-      end
+      result.join("")
+    rescue => e
+      File.write("README.md", result.join(""))
       raise e
     end
 
@@ -40,7 +38,7 @@ module Rundoc
     def partition
       until contents.empty?
         head, code, tail = contents.partition(CODEBLOCK_REGEX)
-        @stack << head                  unless head.empty?
+        @stack << head unless head.empty?
         unless code.empty?
           match = code.match(CODEBLOCK_REGEX)
           @stack << CodeSection.new(match, keyword: keyword, document_path: @document_path)
@@ -51,4 +49,4 @@ module Rundoc
   end
 end
 
-# convert string of markdown to array of strings and code_command
+# convert string of markdown to array of strings and code_command

data/lib/rundoc/peg_parser.rb

@@ -1,53 +1,53 @@
-require 'parslet'
+require "parslet"
 
 module Rundoc
   class PegParser < Parslet::Parser
-    rule(:spaces)  { match('\s').repeat(1) }
+    rule(:spaces) { match('\s').repeat(1) }
     rule(:spaces?) { spaces.maybe }
-    rule(:comma)   { spaces? >> str(',') >> spaces? }
-    rule(:digit)   { match('[0-9]') }
-    rule(:lparen)  { str('(') >> spaces? }
-    rule(:rparen)  { str(')') }
-    rule(:newline)     { str("\r").maybe >> str("\n") }
+    rule(:comma) { spaces? >> str(",") >> spaces? }
+    rule(:digit) { match("[0-9]") }
+    rule(:lparen) { str("(") >> spaces? }
+    rule(:rparen) { str(")") }
+    rule(:newline) { str("\r").maybe >> str("\n") }
 
     rule(:singlequote_string) {
       str("'") >> (
-        str("'").absnt? >> any
+        str("'").absent? >> any
       ).repeat.as(:string) >>
-      str("'") >> spaces?
+        str("'") >> spaces?
     }
     rule(:doublequote_string) {
       str('"') >> (
-        str('"').absnt? >> any
+        str('"').absent? >> any
       ).repeat.as(:string) >>
-      str('"') >> spaces?
+        str('"') >> spaces?
     }
     rule(:string) { doublequote_string | singlequote_string }
 
     rule(:number) {
       (
-        str('-').maybe >> (
-          str('0') | (match('[1-9]') >> digit.repeat)
+        str("-").maybe >> (
+          str("0") | (match("[1-9]") >> digit.repeat)
         ) >> (
-          str('.') >> digit.repeat(1)
+          str(".") >> digit.repeat(1)
         ).maybe >> (
-          match('[eE]') >> (str('+') | str('-')).maybe >> digit.repeat(1)
+          match("[eE]") >> (str("+") | str("-")).maybe >> digit.repeat(1)
         ).maybe
       ).as(:number)
     }
 
     rule(:value) {
       string |
-      number |
-      str('true').as(:true) |
-      str('false').as(:false) |
-      str('nil').as(:nil)
+        number |
+        str("true").as(true) |
+        str("false").as(false) |
+        str("nil").as(:nil)
     }
 
     rule(:key) {
       spaces? >> (
-        str(':').absent? >> match('\s').absent? >> any
-      ).repeat.as(:key) >> str(':') >> spaces?
+        str(":").absent? >> match('\s').absent? >> any
+      ).repeat.as(:key) >> str(":") >> spaces?
     }
 
     rule(:key_value) {
@@ -60,16 +60,16 @@ module Rundoc
       spaces? >> (
         key_value >> (comma >> key_value).repeat
       ).as(:named_args) >>
-      spaces?
+        spaces?
     }
 
     rule(:unquoted_string) {
-      (newline.absent? >> any).repeat.as(:string) #>> newline
+      (newline.absent? >> any).repeat.as(:string) # >> newline
     }
 
     rule(:positional_args) {
       spaces? >> value.as(:val) >> (comma >> value.as(:val)).repeat >>
-      comma.maybe >> named_args.maybe
+        comma.maybe >> named_args.maybe
     }
 
     rule(:args) {
@@ -82,17 +82,17 @@ module Rundoc
 
     rule(:parens_method) {
       funcall >> lparen >>
-      args.as(:args) >>
-      rparen
+        args.as(:args) >>
+        rparen
     }
 
     rule(:seattle_method) {
       funcall >> spaces >>
-      (args).as(:args)
+        args.as(:args)
     }
 
     rule(:no_args_method) {
-      spaces? >> ( lparen.absent? >> rparen.absent? >> spaces.absent? >> any).repeat(1)
+      spaces? >> (lparen.absent? >> rparen.absent? >> spaces.absent? >> any).repeat(1)
     }
 
     rule(:method_call) {
@@ -105,13 +105,13 @@ module Rundoc
     # --
     rule(:visability) {
       (
-        match('>|-').maybe.as(:vis_command) >> match('>|-').maybe.as(:vis_result)
+        match(">|-").maybe.as(:vis_command) >> match(">|-").maybe.as(:vis_result)
       ).as(:visability)
     }
 
     # :::
     rule(:start_command) {
-      match(/\A:/) >> str('::')
+      match(/\A:/) >> str("::")
     }
 
     # :::>> $ cat foo.rb
@@ -119,7 +119,7 @@ module Rundoc
       (
         start_command >>
         visability.as(:cmd_visability) >> spaces? >>
-        method_call.as(:cmd_method_call) >> newline.maybe #>> match(/\z/)
+        method_call.as(:cmd_method_call) >> newline.maybe # >> match(/\z/)
       ).as(:command)
     }
 
@@ -135,7 +135,6 @@ module Rundoc
         command
     }
 
-
     # :::>> file.write hello.txt
     # world
     # :::>> file.write foo.txt
@@ -152,13 +151,13 @@ module Rundoc
       code_fence >>
         match('\S').repeat >>
         newline >>
-      multiple_commands >>
-      code_fence >> newline
+        multiple_commands >>
+        code_fence >> newline
     }
 
     rule(:raw_code) {
       (start_command.absent? >> command.absent? >> any).repeat(1).as(:raw_code) >>
-      multiple_commands.maybe
+        multiple_commands.maybe
     }
 
     rule(:code_block) {
@@ -167,27 +166,26 @@ module Rundoc
   end
 end
 
-
 module Rundoc
   class PegTransformer < Parslet::Transform
-    rule(nill:   simple(:nu)) { nil }
-    rule(true:   simple(:tr)) { true }
-    rule(false:  simple(:fa)) { false }
+    rule(nill: simple(:nu)) { nil }
+    rule(true => simple(:tr)) { true }
+    rule(false => simple(:fa)) { false }
     rule(string: simple(:st)) { st.to_s }
 
-    rule(:number => simple(:nb)) {
-      nb.match(/[eE\.]/) ? Float(nb) : Integer(nb)
+    rule(number: simple(:nb)) {
+      /[eE.]/.match?(nb) ? Float(nb) : Integer(nb)
     }
 
     def self.convert_named_args(na)
-      (na.is_a?(Array) ? na : [ na ]).each_with_object({}) { |element, hash|
+      (na.is_a?(Array) ? na : [na]).each_with_object({}) { |element, hash|
         key = element[:key_value][:key].to_sym
         val = element[:key_value][:val]
         hash[key] = val
       }
     end
 
-    rule(:named_args => subtree(:na)) {
+    rule(named_args: subtree(:na)) {
       PegTransformer.convert_named_args(na)
     }
 
@@ -206,7 +204,7 @@ module Rundoc
         args = nil
       else
         keyword = mc[:funcall].to_sym
-        args    = mc[:args]
+        args = mc[:args]
       end
 
       Rundoc.code_command_from_keyword(keyword, args)
@@ -214,47 +212,47 @@ module Rundoc
 
     class Visability
       attr_reader :command, :result
-      alias :command? :command
-      alias :result? :result
+      alias_method :command?, :command
+      alias_method :result?, :result
       def initialize(command:, result:)
         @command = command
-        @result  = result
+        @result = result
       end
     end
 
     class TransformError < ::StandardError
       attr_reader :line_and_column
-      def initialize(message: , line_and_column:)
+      def initialize(message:, line_and_column:)
         @line_and_column = line_and_column || [1, 1]
-        super message
+        super(message)
       end
     end
 
-    rule(:visability => {
-            vis_command: simple(:command),
-            vis_result:  simple(:result)
-        }) {
+    rule(visability: {
+      vis_command: simple(:command),
+      vis_result: simple(:result)
+    }) {
       if result.nil? || command.nil?
         line_and_column = command&.line_and_column
         line_and_column ||= result&.line_and_column
 
         message = +""
         message << "You attempted to use a command that does not begin with two visibility indicators. Please replace: "
-        message << "`:::#{command}#{result}` with `:::#{command || '-'}#{result || '-'}`"
+        message << "`:::#{command}#{result}` with `:::#{command || "-"}#{result || "-"}`"
         raise TransformError.new(message: message, line_and_column: line_and_column)
       end
       Visability.new(
-        command: command.to_s == '>'.freeze,
-        result:  result.to_s  == '>'.freeze
+        command: command.to_s == ">".freeze,
+        result: result.to_s == ">".freeze
       )
     }
 
     rule(
-      cmd_visability: simple(:cmd_vis),      # Visibility#new
+      cmd_visability: simple(:cmd_vis), # Visibility#new
       cmd_method_call: simple(:code_command) # Rundoc::CodeCommand#new
-        ) {
+    ) {
       code_command.render_command = cmd_vis.command?
-      code_command.render_result  = cmd_vis.result?
+      code_command.render_result = cmd_vis.result?
       code_command
     }
 

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "1.1.3"
+  VERSION = "2.0.0"
 end

data/lib/rundoc.rb

@@ -1,12 +1,12 @@
-require 'fileutils'
-require 'pathname'
-require 'rundoc/version'
+require "fileutils"
+require "pathname"
+require "rundoc/version"
 
 module Rundoc
   extend self
 
   def code_command_from_keyword(keyword, args)
-    klass      = code_command(keyword.to_sym) || Rundoc::CodeCommand::NoSuchCommand
+    klass = code_command(keyword.to_sym) || Rundoc::CodeCommand::NoSuchCommand
     original_args = args.dup
     if args.is_a?(Array) && args.last.is_a?(Hash)
       kwargs = args.pop
@@ -62,10 +62,6 @@ module Rundoc
     yield self
   end
 
-  def register_repl(*args, &block)
-    ReplRunner.register_commands(*args, &block)
-  end
-
   def filter_sensitive(sensitive)
     raise "Expecting #{sensitive} to be a hash" unless sensitive.is_a?(Hash)
     @sensitive ||= {}
@@ -77,14 +73,14 @@ module Rundoc
     @sensitive.each do |sensitive, replace|
       doc.gsub!(sensitive.to_s, replace)
     end
-    return doc
+    doc
   end
 
   attr_accessor :project_root
 end
 
-require 'rundoc/parser'
-require 'rundoc/code_section'
-require 'rundoc/code_command'
-require 'rundoc/peg_parser'
-require 'rundoc/cli'
+require "rundoc/parser"
+require "rundoc/code_section"
+require "rundoc/code_command"
+require "rundoc/peg_parser"
+require "rundoc/cli"

data/rundoc.gemspec

@@ -1,34 +1,32 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rundoc/version'
+require "rundoc/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = "rundoc"
-  gem.version       = Rundoc::VERSION
-  gem.authors       = ["Richard Schneeman"]
-  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
-  gem.description   = %q{RunDOC turns docs to runable code}
-  gem.summary       = %q{RunDOC generates runable code from docs}
-  gem.homepage      = "https://github.com/schneems/rundoc"
-  gem.license       = "MIT"
+  gem.name = "rundoc"
+  gem.version = Rundoc::VERSION
+  gem.authors = ["Richard Schneeman"]
+  gem.email = ["richard.schneeman+rubygems@gmail.com"]
+  gem.description = "RunDOC turns docs to runable code"
+  gem.summary = "RunDOC generates runable code from docs"
+  gem.homepage = "https://github.com/schneems/rundoc"
+  gem.license = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
   gem.add_dependency "thor"
-  gem.add_dependency "repl_runner"
-  gem.add_dependency 'parslet', '~> 1'
-  gem.add_dependency 'capybara', '~> 3'
-  gem.add_dependency 'selenium-webdriver', '~> 3'
+  gem.add_dependency "parslet", "~> 2"
+  gem.add_dependency "capybara", "~> 3"
+  gem.add_dependency "selenium-webdriver", "~> 4"
+  gem.add_dependency "base64", "~> 0"
 
-  gem.add_dependency 'aws-sdk-s3', '~> 1'
-  gem.add_dependency 'dotenv'
+  gem.add_dependency "aws-sdk-s3", "~> 1"
+  gem.add_dependency "dotenv"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "minitest"
+  gem.add_development_dependency "standard"
 end
-