rundoc 4.1.4 → 6.0.0

data/lib/rundoc/code_command/rundoc_command.rb

@@ -1,8 +1,23 @@
+# frozen_string_literal: true
+
 module ::Rundoc
-  class CodeCommand
-    class ::RundocCommand < ::Rundoc::CodeCommand
-      def initialize(contents = "")
-        @contents = contents
+  module CodeCommand
+    class RundocCommandArgs
+      attr_reader :code
+
+      def initialize(code = "")
+        @code = code
+      end
+    end
+
+    class RundocCommandRunner
+      attr_reader :io, :contents
+
+      def initialize(user_args:, render_command:, render_result:, io:, contents: nil)
+        @io = io
+        @contents = contents.dup if contents && !contents.empty?
+        @contents = user_args.code + (@contents || +"")
+        @binding = RUNDOC_ERB_BINDINGS[RUNDOC_DEFAULT_ERB_BINDING]
       end
 
       def to_md(env = {})
@@ -10,16 +25,18 @@ module ::Rundoc
       end
 
       def call(env = {})
-        puts "Running: #{contents}"
-        eval(contents) # rubocop:disable Security/Eval
+        io.puts "Running: #{contents}"
+        Rundoc.capture_stdout_stderr(io) do
+          eval(contents, @binding) # rubocop:disable Security/Eval
+        end
         ""
       end
     end
   end
 end
 
-Rundoc.register_code_command(:rundoc, RundocCommand)
-Rundoc.register_code_command(:"rundoc.configure", RundocCommand)
+Rundoc.register_code_command(keyword: :rundoc, args_klass: Rundoc::CodeCommand::RundocCommandArgs, runner_klass: Rundoc::CodeCommand::RundocCommandRunner)
+Rundoc.register_code_command(keyword: :"rundoc.configure", args_klass: Rundoc::CodeCommand::RundocCommandArgs, runner_klass: Rundoc::CodeCommand::RundocCommandRunner)
 
-require "rundoc/code_command/rundoc/depend_on"
 require "rundoc/code_command/rundoc/require"
+require "rundoc/code_command/rundoc/ensure_later"

data/lib/rundoc/code_command/website/driver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "capybara"
 
 Capybara::Selenium::Driver.load_selenium

data/lib/rundoc/code_command/website/navigate.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
+
 class Rundoc::CodeCommand::Website
-  class Navigate < Rundoc::CodeCommand
+  class NavigateArgs
+    attr_reader :name
+
     def initialize(name:)
       @name = name
+    end
+  end
+
+  class NavigateRunner
+    attr_reader :io, :contents
+
+    def initialize(user_args:, render_command:, render_result:, io:, contents: nil)
+      @name = user_args.name
       @driver = nil
+      @io = io
+      @contents = contents.dup if contents && !contents.empty?
     end
 
     def driver
@@ -14,20 +28,12 @@ class Rundoc::CodeCommand::Website
     end
 
     def call(env = {})
-      puts "website.navigate [#{@name}]: #{contents}"
+      io.puts "website.navigate [#{@name}]: #{contents}"
       driver.safe_eval(contents, env)
       ""
     end
-
-    def hidden?
-      true
-    end
-
-    def not_hidden?
-      !hidden?
-    end
   end
 end
 
-Rundoc.register_code_command(:"website.nav", Rundoc::CodeCommand::Website::Navigate)
-Rundoc.register_code_command(:"website.navigate", Rundoc::CodeCommand::Website::Navigate)
+Rundoc.register_code_command(keyword: :"website.nav", args_klass: Rundoc::CodeCommand::Website::NavigateArgs, runner_klass: Rundoc::CodeCommand::Website::NavigateRunner)
+Rundoc.register_code_command(keyword: :"website.navigate", args_klass: Rundoc::CodeCommand::Website::NavigateArgs, runner_klass: Rundoc::CodeCommand::Website::NavigateRunner)

data/lib/rundoc/code_command/website/screenshot.rb

@@ -1,9 +1,23 @@
+# frozen_string_literal: true
+
 class Rundoc::CodeCommand::Website
-  class Screenshot < Rundoc::CodeCommand
+  class ScreenshotArgs
+    attr_reader :name, :upload
+
     def initialize(name:, upload: false)
       @name = name
       @upload = upload
+    end
+  end
+
+  class ScreenshotRunner
+    attr_reader :io
+
+    def initialize(user_args:, render_command:, render_result:, io:, contents: nil)
+      @name = user_args.name
+      @upload = user_args.upload
       @driver = nil
+      @io = io
     end
 
     def driver
@@ -15,7 +29,7 @@ class Rundoc::CodeCommand::Website
     end
 
     def call(env = {})
-      puts "Taking screenshot: #{driver.current_url}"
+      io.puts "Taking screenshot: #{driver.current_url}"
       filename = driver.screenshot(
         upload: @upload,
         screenshots_dir: env[:context].screenshots_dir
@@ -25,14 +39,6 @@ class Rundoc::CodeCommand::Website
       env[:before] << "![Screenshot of #{driver.current_url}](#{relative_filename})"
       ""
     end
-
-    # def hidden?
-    #   true
-    # end
-
-    # def not_hidden?
-    #   !hidden?
-    # end
   end
 end
-Rundoc.register_code_command(:"website.screenshot", Rundoc::CodeCommand::Website::Screenshot)
+Rundoc.register_code_command(keyword: :"website.screenshot", args_klass: Rundoc::CodeCommand::Website::ScreenshotArgs, runner_klass: Rundoc::CodeCommand::Website::ScreenshotRunner)

data/lib/rundoc/code_command/website/visit.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 class Rundoc::CodeCommand::Website
-  class Visit < Rundoc::CodeCommand
+  class VisitArgs
+    attr_reader :name, :url, :scroll, :height, :width, :visible, :max_attempts
+
     def initialize(name:, url: nil, scroll: nil, height: 720, width: 1024, visible: false, max_attempts: 3)
       @name = name
       @url = url
@@ -11,6 +13,22 @@ class Rundoc::CodeCommand::Website
       @visible = visible
       @max_attempts = max_attempts
     end
+  end
+
+  class VisitRunner
+    attr_reader :io, :contents
+
+    def initialize(user_args:, render_command:, render_result:, io:, contents: nil)
+      @name = user_args.name
+      @url = user_args.url
+      @scroll = user_args.scroll
+      @height = user_args.height
+      @width = user_args.width
+      @visible = user_args.visible
+      @max_attempts = user_args.max_attempts
+      @io = io
+      @contents = contents.dup if contents && !contents.empty?
+    end
 
     def driver
       @driver ||= Driver.new(
@@ -18,7 +36,8 @@ class Rundoc::CodeCommand::Website
         url: @url,
         height: @height,
         width: @width,
-        visible: @visible
+        visible: @visible,
+        io: io
       ).tap do |driver|
         Driver.add(@name, driver)
       end
@@ -32,7 +51,7 @@ class Rundoc::CodeCommand::Website
       message = "Visting: #{@url}"
       message << "and executing:\n#{contents}" unless contents.nil? || contents.empty?
 
-      puts message
+      io.puts message
 
       driver.visit(@url, max_attempts: @max_attempts) if @url
       driver.scroll(@scroll) if @scroll
@@ -42,15 +61,7 @@ class Rundoc::CodeCommand::Website
 
       ""
     end
-
-    def hidden?
-      true
-    end
-
-    def not_hidden?
-      !hidden?
-    end
   end
 end
 
-Rundoc.register_code_command(:"website.visit", Rundoc::CodeCommand::Website::Visit)
+Rundoc.register_code_command(keyword: :"website.visit", args_klass: Rundoc::CodeCommand::Website::VisitArgs, runner_klass: Rundoc::CodeCommand::Website::VisitRunner)

data/lib/rundoc/code_command/website.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Rundoc::CodeCommand::Website
 end
 

data/lib/rundoc/code_command/write.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Rundoc
-  class CodeCommand
+  module CodeCommand
     module FileUtil
       def filename
         files = Dir.glob(@filename)
@@ -15,16 +17,42 @@ module Rundoc
       end
     end
 
-    class Write < Rundoc::CodeCommand
-      include FileUtil
+    class WriteArgs
+      attr_reader :path
+
+      def initialize(path)
+        @path = Pathname(path)
+      end
+    end
+
+    class WriteRunner
+      NEWLINE = Object.new
+      def NEWLINE.to_s
+        ""
+      end
+
+      def NEWLINE.empty?
+        false
+      end
+
+      include Rundoc::CodeCommand::FileUtil
+
+      attr_reader :io, :contents
+
+      def initialize(user_args:, render_command:, render_result:, io:, contents: nil)
+        @filename = user_args.path.to_s
+        @io = io
+        @render_command = render_command
+        @contents = contents.dup if contents && !contents.empty?
+      end
 
-      def initialize(filename)
-        @filename = filename
+      def render_command?
+        @render_command
       end
 
       def to_md(env)
         if render_command?
-          if env[:commands].any? { |c| c[:object].not_hidden? }
+          if env[:commands].any? { |c| c[:visibility].not_hidden? }
             raise "must call write in its own code section"
           end
           env[:before] << "In file `#{filename}` write:"
@@ -34,7 +62,7 @@ module Rundoc
       end
 
       def call(env = {})
-        puts "Writing to: '#{filename}'"
+        io.puts "Writing to: '#{filename}'"
         mkdir_p
         File.write(filename, contents)
         contents
@@ -43,8 +71,8 @@ module Rundoc
   end
 end
 
-Rundoc.register_code_command(:write, Rundoc::CodeCommand::Write)
-Rundoc.register_code_command(:"file.write", Rundoc::CodeCommand::Write)
+Rundoc.register_code_command(keyword: :write, args_klass: Rundoc::CodeCommand::WriteArgs, runner_klass: Rundoc::CodeCommand::WriteRunner)
+Rundoc.register_code_command(keyword: :"file.write", args_klass: Rundoc::CodeCommand::WriteArgs, runner_klass: Rundoc::CodeCommand::WriteRunner)
 
 require "rundoc/code_command/file_command/append"
 require "rundoc/code_command/file_command/remove"

data/lib/rundoc/code_command.rb

@@ -1,55 +1,12 @@
-module Rundoc
-  # Generic CodeCommand class to be inherited
-  #
-  class CodeCommand
-    # Newlines are stripped and re-added, this tells the project that
-    # we're intentionally wanting an extra newline
-    NEWLINE = Object.new
-    def NEWLINE.to_s
-      ""
-    end
-
-    def NEWLINE.empty?
-      false
-    end
-
-    attr_accessor :render_result, :render_command,
-      :command, :contents, :keyword,
-      :original_args
-
-    alias_method :render_result?, :render_result
-    alias_method :render_command?, :render_command
-
-    def initialize(*args)
-    end
+# frozen_string_literal: true
 
-    def hidden?
-      !render_command? && !render_result?
-    end
-
-    def not_hidden?
-      !hidden?
-    end
-
-    def push(contents)
-      @contents ||= ""
-      @contents << contents
-    end
-    alias_method :<<, :push
-
-    # Executes command to build project
-    # Is expected to return the result of the command
-    def call(env = {})
-      raise "not implemented on #{inspect}"
-    end
-
-    # the output of the command, i.e. `$ cat foo.txt`
-    def to_md(env = {})
-      raise "not implemented on #{inspect}"
-    end
+module Rundoc
+  module CodeCommand
   end
 end
 
+require "rundoc/code_command/empty_binding"
+require "rundoc/code_command/deferred"
 require "rundoc/code_command/bash"
 require "rundoc/code_command/pipe"
 require "rundoc/code_command/write"
@@ -61,3 +18,4 @@ require "rundoc/code_command/website"
 require "rundoc/code_command/print/text"
 require "rundoc/code_command/print/erb"
 require "rundoc/code_command/pre/erb"
+require "rundoc/code_command/comment"

data/lib/rundoc/context/after_build.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rundoc
   module Context
     # Public interface for the `Rundoc.after_build` proc

data/lib/rundoc/context/execution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rundoc
   module Context
     # Holds configuration for the currently executing script

data/lib/rundoc/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rundoc
   # Represents a single rundoc file on disk,
   #
@@ -11,7 +13,8 @@ module Rundoc
 
     attr_reader :contents, :stack, :context
 
-    def initialize(contents, context:)
+    def initialize(contents, context:, io: $stdout)
+      @io = io
       @context = context
       @contents = contents
       @original = contents.dup
@@ -59,7 +62,8 @@ module Rundoc
             fence: match[:fence],
             lang: match[:lang],
             code: match[:contents],
-            context: context
+            context: context,
+            io: @io
           )
         end
         @contents = tail

data/lib/rundoc/fenced_code_block.rb

@@ -15,7 +15,7 @@ module Rundoc
     def executed_commands
       raise "Nothing executed" unless @env[:commands].any?
 
-      @env[:commands].map { |c| c[:object] }
+      @env[:commands].map { |c| c[:visibility] }
     end
 
     # @param fence [String] the fence used to start the code block like "```".
@@ -24,7 +24,8 @@ module Rundoc
     # @param code [String] the code block contents inside the fence.
     # @param context [Context::Execution] The details about where
     #        the code block came from.
-    def initialize(fence:, lang:, code:, context:)
+    def initialize(fence:, lang:, code:, context:, io: $stdout)
+      @io = io
       @fence = fence
       @lang = lang
       @code = code
@@ -54,12 +55,13 @@ module Rundoc
       env[:after] = []
       env[:context] = @context
       env[:stack] = @stack
+      while (item = @stack.pop)
+        code_command = item.build(io: @io)
 
-      while (code_command = @stack.pop)
         code_output = code_command.call(env) || ""
         code_line = code_command.to_md(env) || ""
-        result << code_line if code_command.render_command?
-        result << code_output if code_command.render_result?
+        result << code_line if item.render_command?
+        result << code_output if item.render_result?
 
         PARTIAL_RESULT.replace(result)
         PARTIAL_ENV.replace(env)
@@ -67,11 +69,12 @@ module Rundoc
         env[:commands] << {
           object: code_command,
           output: code_output,
-          command: code_line
+          command: code_line,
+          visibility: item
         }
       end
 
-      if env[:commands].any? { |c| c[:object].not_hidden? }
+      if env[:commands].any? { |c| c[:visibility].not_hidden? }
         @rendered = self.class.to_doc(result: result, env: env)
       end
       self

data/lib/rundoc/peg_parser.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require "parslet"
 
 module Rundoc
   class PegParser < Parslet::Parser
     rule(:spaces) { match('\s').repeat(1) }
     rule(:spaces?) { spaces.maybe }
+    rule(:horizontal_spaces) { match('[ \t]').repeat(1) }
     rule(:comma) { spaces? >> str(",") >> spaces? }
     rule(:digit) { match("[0-9]") }
     rule(:lparen) { str("(") >> spaces? }
@@ -36,9 +39,16 @@ module Rundoc
       ).as(:number)
     }
 
+    rule(:symbol) {
+      str(":") >> (
+        match("[a-zA-Z_]") >> match("[a-zA-Z0-9_]").repeat
+      ).as(:symbol)
+    }
+
     rule(:value) {
       string |
         number |
+        symbol |
         str("true").as(true) |
         str("false").as(false) |
         str("nil").as(:nil)
@@ -87,7 +97,7 @@ module Rundoc
     }
 
     rule(:seattle_method) {
-      funcall >> spaces >>
+      funcall >> horizontal_spaces >>
         args.as(:args)
     }
 
@@ -172,6 +182,7 @@ module Rundoc
     rule(true => simple(:tr)) { true }
     rule(false => simple(:fa)) { false }
     rule(string: simple(:st)) { st.to_s }
+    rule(symbol: simple(:sy)) { sy.to_s.to_sym }
 
     rule(number: simple(:nb)) {
       /[eE.]/.match?(nb) ? Float(nb) : Integer(nb)
@@ -242,8 +253,8 @@ module Rundoc
         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 == ">",
+        result: result.to_s == ">"
       )
     }
 
@@ -265,16 +276,21 @@ module Rundoc
       code_command
     }
 
-    # The lines before a CodeCommand are rendered
-    # without running any code
     rule(raw_code: simple(:raw_code)) {
-      CodeCommand::Raw.new(raw_code)
+      deferred = CodeCommand::Deferred.new(args_instance: nil, runner_klass: CodeCommand::Raw)
+      deferred.render_command = false
+      deferred.render_result = true
+      deferred.push(raw_code.to_s)
+      deferred
     }
 
-    # Sometimes
     rule(raw_code: sequence(:raw_code)) {
-      hidden = raw_code.nil? || raw_code.empty?
-      CodeCommand::Raw.new(raw_code, visible: !hidden)
+      visible = !raw_code.nil? && !raw_code.empty?
+      deferred = CodeCommand::Deferred.new(args_instance: nil, runner_klass: CodeCommand::Raw)
+      deferred.render_command = false
+      deferred.render_result = visible
+      deferred.push(raw_code.map(&:to_s).join)
+      deferred
     }
   end
 end

data/lib/rundoc/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rundoc
-  VERSION = "4.1.4"
+  VERSION = "6.0.0"
 end