rundoc 0.0.1 → 1.1.1

data/lib/rundoc/code_command/bash.rb

@@ -43,7 +43,7 @@ class Rundoc::CodeCommand::Bash < Rundoc::CodeCommand
       result = sanitize_escape_chars io.read
     end
     unless $?.success?
-      raise "Command `#{@line}` exited with non zero status: #{result}" unless keyword.include?("fail")
+      raise "Command `#{@line}` exited with non zero status: #{result}" unless keyword.to_s.include?("fail")
     end
     return result
   end

data/lib/rundoc/code_command/bash/cd.rb

@@ -5,14 +5,32 @@ class Rundoc::CodeCommand::Bash
   class Cd < Rundoc::CodeCommand::Bash
 
     def initialize(line)
-      @line     = line
+      @line = line
+    end
+
+    # Ignore duplicate chdir warnings "warning: conflicting chdir during another chdir block"
+    def supress_chdir_warning
+      old_stderr     = $stderr
+      capture_stderr = StringIO.new
+      $stderr        = capture_stderr
+      return yield
+    ensure
+      if old_stderr
+        $stderr = old_stderr
+        capture_string = capture_stderr.string
+        $stderr.puts capture_string if capture_string.each_line.count > 1 || !capture_string.include?("conflicting chdir")
+      end
     end
 
     def call(env)
       line = @line.sub('cd', '').strip
       puts "running $ cd #{line}"
-      Dir.chdir(line)
-      nil
+
+      supress_chdir_warning do
+        Dir.chdir(line)
+      end
+
+      return nil
     end
   end
 end

data/lib/rundoc/code_command/file_command/append.rb

@@ -1,18 +1,25 @@
 class Rundoc::CodeCommand::FileCommand
   class Append < Rundoc::CodeCommand
+    include FileUtil
 
     def initialize(filename)
       @filename, line = filename.split('#')
-      @line_number    = Integer(line) if line
+      if line
+        @line_number = Integer(line)
+      else
+        @line_number = nil
+      end
     end
 
     def to_md(env)
+      return unless render_command?
+
       raise "must call write in its own code section" unless env[:commands].empty?
       before = env[:before]
       if @line_number
-        env[:before] = "In file `#{@filename}`, on line #{@line_number} add:\n\n#{before}"
+        env[:before] = "In file `#{filename}`, on line #{@line_number} add:\n\n#{before}"
       else
-        env[:before] = "At the end of `#{@filename}` add:\n\n#{before}"
+        env[:before] = "At the end of `#{filename}` add:\n\n#{before}"
       end
       nil
     end
@@ -36,7 +43,7 @@ class Rundoc::CodeCommand::FileCommand
 
     def insert_contents_into_at_line(doc)
       lines = doc.lines
-      raise "Expected #{@filename} to have at least #{@line_number} but only has #{lines.count}" if lines.count < @line_number
+      raise "Expected #{filename} to have at least #{@line_number} but only has #{lines.count}" if lines.count < @line_number
       result = []
       lines.each_with_index do |line, index|
         line_number = index.next
@@ -50,19 +57,17 @@ class Rundoc::CodeCommand::FileCommand
     end
 
     def call(env = {})
-      dir = File.expand_path("../", @filename)
-      FileUtils.mkdir_p(dir)
-
-      doc = File.read(@filename)
+      mkdir_p
+      doc = File.read(filename)
       if @line_number
-        puts "Writing to: '#{@filename}' line #{@line_number} with: #{contents.inspect}"
+        puts "Writing to: '#{filename}' line #{@line_number} with: #{contents.inspect}"
         doc = insert_contents_into_at_line(doc)
       else
-        puts "Appending to file: '#{@filename}' with: #{contents.inspect}"
+        puts "Appending to file: '#{filename}' with: #{contents.inspect}"
         doc = concat_with_newline(doc, contents)
       end
 
-      File.open(@filename, "w") do |f|
+      File.open(filename, "w") do |f|
         f.write(doc)
       end
       contents

data/lib/rundoc/code_command/file_command/remove.rb

@@ -1,5 +1,6 @@
 class Rundoc::CodeCommand::FileCommand
   class Remove < Rundoc::CodeCommand
+    include FileUtil
 
     def initialize(filename)
       @filename = filename
@@ -8,19 +9,19 @@ class Rundoc::CodeCommand::FileCommand
     def to_md(env)
       raise "must call write in its own code section" unless env[:commands].empty?
       before = env[:before]
-      env[:before] = "In file `#{@filename}` remove:\n\n#{before}"
+      env[:before] = "In file `#{filename}` remove:\n\n#{before}"
       nil
     end
 
     def call(env = {})
-      puts "Deleting '#{contents.strip}' from #{@filename}"
-      raise "#{@filename} does not exist" unless File.exist?(@filename)
+      puts "Deleting '#{contents.strip}' from #{filename}"
+      raise "#{filename} does not exist" unless File.exist?(filename)
 
       regex = /^\s*#{Regexp.quote(contents)}/
-      doc   = File.read(@filename)
+      doc   = File.read(filename)
       doc.sub!(regex, '')
 
-      File.open(@filename, "w") do |f|
+      File.open(filename, "w") do |f|
         f.write(doc)
       end
       contents

data/lib/rundoc/code_command/no_such_command.rb

@@ -1,6 +1,10 @@
 module Rundoc
   class CodeCommand
     class NoSuchCommand < Rundoc::CodeCommand
+
+      def call(env = {})
+        raise "No such command registered with rundoc: #{@keyword.inspect} for '#{@keyword} #{@original_args}'"
+      end
     end
   end
 end

data/lib/rundoc/code_command/pipe.rb

@@ -6,12 +6,8 @@ module Rundoc
       # ::: | tail -n 2
       # => "test\ntmp.file\n"
       def initialize(line)
-        line_array = line.split(" ")
-        @first     = line_array.shift.strip
-        @delegate  = Rundoc.code_command_from_keyword(@first, line_array.join(" "))
-        @delegate  = Rundoc::CodeCommand::Bash.new(line) if @delegate.kind_of?(Rundoc::CodeCommand::NoSuchCommand)
+        @delegate = parse(line)
       end
-
       # before: "",
       # after:  "",
       # commands:
@@ -27,6 +23,23 @@ module Rundoc
       def to_md(env = {})
         ""
       end
+
+      private def parse(code)
+        parser = Rundoc::PegParser.new.command
+        tree = parser.parse(code)
+        actual = Rundoc::PegTransformer.new.apply(tree)
+
+        if actual.is_a?(Array)
+          return actual.first
+        else
+          return actual
+        end
+
+      # Since `| tail -n 2` does not start with a `$` assume any "naked" commands
+      # are bash
+      rescue Parslet::ParseFailed
+        Rundoc::CodeCommand::Bash.new(code)
+      end
     end
   end
 end

data/lib/rundoc/code_command/raw.rb

@@ -0,0 +1,18 @@
+module Rundoc
+  class CodeCommand
+    class Raw < CodeCommand
+      def initialize(contents, visible: true)
+        @contents = contents
+        @render_result = visible
+      end
+
+      def call(env = {})
+        contents.to_s
+      end
+
+      def to_md(env = {})
+        contents.to_s
+      end
+    end
+  end
+end

data/lib/rundoc/code_command/rundoc/depend_on.rb

@@ -0,0 +1,37 @@
+class ::Rundoc::CodeCommand
+  class RundocCommand
+    class DependOn < ::Rundoc::CodeCommand
+
+      # Pass in the relative path of another rundoc document in order to
+      # run all of it's commands (but not to )
+      def initialize(path)
+        raise "Path must be relative (i.e. start with `.` or `..`. #{path.inspect} does not" unless path.start_with?(".")
+        @path = Pathname.new(path)
+      end
+
+      def to_md(env = {})
+        ""
+      end
+
+      def call(env = {})
+        current_path = Pathname.new(env[:document_path]).dirname
+        document_path = @path.expand_path(current_path)
+        # Run the commands, but do not
+        puts "rundoc.depend_on: Start executing #{@path.to_s.inspect}"
+        output = Rundoc::Parser.new(document_path.read, document_path: document_path.to_s).to_md
+        puts "rundoc.depend_on: Done executing #{@path.to_s.inspect}, discarding intermediate document"
+        output
+      end
+
+      def hidden?
+        true
+      end
+
+      def not_hidden?
+        !hidden?
+      end
+    end
+  end
+end
+
+Rundoc.register_code_command(:"rundoc.depend_on", ::Rundoc::CodeCommand::RundocCommand::DependOn)

data/lib/rundoc/code_command/rundoc/require.rb

@@ -0,0 +1,41 @@
+class ::Rundoc::CodeCommand
+  class RundocCommand
+    class Require < ::Rundoc::CodeCommand
+
+      # Pass in the relative path of another rundoc document in order to
+      # run all of it's commands. Resulting contents will be displayed
+      # in current document
+      def initialize(path)
+        raise "Path must be relative (i.e. start with `.` or `..`. #{path.inspect} does not" unless path.start_with?(".")
+        @path = Pathname.new(path)
+      end
+
+      def to_md(env = {})
+        ""
+      end
+
+      def call(env = {})
+        env[:replace] ||= String.new
+        current_path = Pathname.new(env[:document_path]).dirname
+        document_path = @path.expand_path(current_path)
+
+        puts "rundoc.require: Start executing #{@path.to_s.inspect}"
+        output = Rundoc::Parser.new(document_path.read, document_path: document_path.to_s).to_md
+        puts "rundoc.require: Done executing #{@path.to_s.inspect}, putting contents into document"
+
+        env[:replace] << output
+        return ""
+      end
+
+      def hidden?
+        true
+      end
+
+      def not_hidden?
+        !hidden?
+      end
+    end
+  end
+end
+
+Rundoc.register_code_command(:"rundoc.require", ::Rundoc::CodeCommand::RundocCommand::Require)

data/lib/rundoc/code_command/rundoc_command.rb

@@ -2,7 +2,8 @@ module ::Rundoc
   class CodeCommand
     class ::RundocCommand < ::Rundoc::CodeCommand
 
-      def initialize(line)
+      def initialize(contents = "")
+        @contents = contents
       end
 
       def to_md(env = {})
@@ -18,5 +19,8 @@ module ::Rundoc
   end
 end
 
+Rundoc.register_code_command(:rundoc, RundocCommand)
+Rundoc.register_code_command(:"rundoc.configure", RundocCommand)
 
-Rundoc.register_code_command(:rundoc, ::Rundoc::CodeCommand::RundocCommand)
+require 'rundoc/code_command/rundoc/depend_on'
+require 'rundoc/code_command/rundoc/require'

data/lib/rundoc/code_command/website.rb

@@ -0,0 +1,7 @@
+class Rundoc::CodeCommand::Website
+end
+
+require 'rundoc/code_command/website/driver'
+require 'rundoc/code_command/website/screenshot'
+require 'rundoc/code_command/website/visit'
+require 'rundoc/code_command/website/navigate'

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

@@ -0,0 +1,111 @@
+require 'capybara'
+
+Capybara::Selenium::Driver.load_selenium
+
+class Rundoc::CodeCommand::Website
+  class Driver
+    attr_reader :session
+
+    def initialize(name: , url: , width: 1024, height: 720, visible: false)
+      browser_options = ::Selenium::WebDriver::Chrome::Options.new
+      browser_options.args << '--headless' unless visible
+      browser_options.args << '--disable-gpu' if Gem.win_platform?
+      browser_options.args << '--hide-scrollbars'
+      # browser_options.args << "--window-size=#{width},#{height}"
+      @width = width
+      @height = height
+
+      @driver = Capybara::Selenium::Driver.new(nil, browser: :chrome, options: browser_options)
+      driver_name = "rundoc_driver_#{name}".to_sym
+      Capybara.register_driver(driver_name) do |app|
+        @driver
+      end
+
+      @session = Capybara::Session.new(driver_name)
+    end
+
+    def visit(url)
+      @session.visit(url)
+    end
+
+    def timestamp
+      Time.now.utc.strftime("%Y%m%d%H%M%S%L%N")
+    end
+
+    def current_url
+      session.current_url
+    end
+
+    def scroll(value = 100)
+      session.execute_script "window.scrollBy(0,#{value})"
+    end
+
+    def teardown
+      session.reset_session!
+    end
+
+    def self.tasks
+      @tasks
+    end
+
+    def safe_eval(code)
+      @driver.send(:eval, code)
+    rescue => e
+      msg = String.new
+      msg << "Error running code #{code.inspect} at #{current_url.inspect}\n"
+      msg << "saving a screenshot to: `tmp/error.png`"
+      puts msg
+      session.save_screenshot("tmp/error.png")
+      raise e
+    end
+
+    def screenshot(upload: false)
+      @driver.resize_window_to(@driver.current_window_handle, @width, @height)
+      FileUtils.mkdir_p("tmp/rundoc_screenshots")
+      file_name = self.class.next_screenshot_name
+      file_path = "tmp/rundoc_screenshots/#{file_name}"
+      session.save_screenshot(file_path)
+
+      return file_path unless upload
+
+      case upload
+      when 's3', 'aws'
+        puts "Uploading screenshot to S3"
+        require 'aws-sdk-s3'
+        ENV.fetch('AWS_ACCESS_KEY_ID')
+        s3 = Aws::S3::Resource.new(region: ENV.fetch('AWS_REGION'))
+
+        key = "#{timestamp}/#{file_name}"
+        obj = s3.bucket(ENV.fetch('AWS_BUCKET_NAME')).object(key)
+        obj.upload_file(file_path)
+
+        obj.client.put_object_acl(
+          acl: 'public-read' ,
+          bucket: ENV.fetch('AWS_BUCKET_NAME'),
+          key: key
+        )
+
+        obj.public_url
+      else
+        raise "Upload #{upload.inspect} is not valid, use 's3' instead"
+      end
+    end
+
+    @tasks = {}
+    def self.add(name, value)
+      raise "Task named #{name.inspect} is already started, choose a different name" if @tasks[name]
+      @tasks[name] = value
+    end
+
+    def self.find(name)
+      raise "Could not find task with name #{name.inspect}, known task names: #{@tasks.keys.inspect}" unless @tasks[name]
+      @tasks[name]
+    end
+
+    def self.next_screenshot_name
+      @count ||= 0
+      @count += 1
+      return "screenshot_#{@count}.png"
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+class Rundoc::CodeCommand::Website
+  class Navigate < Rundoc::CodeCommand
+    def initialize(name: )
+      @name   = name
+      @driver = Rundoc::CodeCommand::Website::Driver.find(name)
+    end
+
+    def to_md(env = {})
+      ""
+    end
+
+    def call(env = {})
+      puts "website.navigate [#{@name}]: #{contents}"
+      @driver.safe_eval(contents)
+      ""
+    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)