rundoc 1.1.2 → 2.0.0

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

@@ -3,11 +3,9 @@ class Rundoc::CodeCommand::FileCommand
     include FileUtil
 
     def initialize(filename)
-      @filename, line = filename.split('#')
-      if line
-        @line_number = Integer(line)
-      else
-        @line_number = nil
+      @filename, line = filename.split("#")
+      @line_number = if line
+        Integer(line)
       end
     end
 
@@ -15,17 +13,18 @@ class Rundoc::CodeCommand::FileCommand
       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] << if @line_number
+        "In file `#{filename}`, on line #{@line_number} add:"
       else
-        env[:before] = "At the end of `#{filename}` add:\n\n#{before}"
+        "At the end of `#{filename}` add:"
       end
+      env[:before] << NEWLINE
       nil
     end
 
     def last_char_of(string)
-      string[-1,1]
+      string[-1, 1]
     end
 
     def ends_in_newline?(string)
@@ -53,7 +52,7 @@ class Rundoc::CodeCommand::FileCommand
         end
         result << line
       end
-      doc = result.flatten.join("")
+      result.flatten.join("")
     end
 
     def call(env = {})
@@ -67,13 +66,10 @@ class Rundoc::CodeCommand::FileCommand
         doc = concat_with_newline(doc, contents)
       end
 
-      File.open(filename, "w") do |f|
-        f.write(doc)
-      end
+      File.write(filename, doc)
       contents
     end
   end
 end
 
-
-Rundoc.register_code_command(:'file.append',  Rundoc::CodeCommand::FileCommand::Append)
+Rundoc.register_code_command(:"file.append", Rundoc::CodeCommand::FileCommand::Append)

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

@@ -8,8 +8,8 @@ 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:"
+      env[:before] << NEWLINE
       nil
     end
 
@@ -18,16 +18,13 @@ class Rundoc::CodeCommand::FileCommand
       raise "#{filename} does not exist" unless File.exist?(filename)
 
       regex = /^\s*#{Regexp.quote(contents)}/
-      doc   = File.read(filename)
-      doc.sub!(regex, '')
+      doc = File.read(filename)
+      doc.sub!(regex, "")
 
-      File.open(filename, "w") do |f|
-        f.write(doc)
-      end
+      File.write(filename, doc)
       contents
     end
   end
 end
 
-
-Rundoc.register_code_command(:'file.remove',  Rundoc::CodeCommand::FileCommand::Remove)
+Rundoc.register_code_command(:"file.remove", Rundoc::CodeCommand::FileCommand::Remove)

data/lib/rundoc/code_command/no_such_command.rb

@@ -1,7 +1,6 @@
 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

data/lib/rundoc/code_command/pipe.rb

@@ -1,7 +1,6 @@
 module Rundoc
   class CodeCommand
     class Pipe < Rundoc::CodeCommand
-
       # ::: ls
       # ::: | tail -n 2
       # => "test\ntmp.file\n"
@@ -33,7 +32,7 @@ module Rundoc
         actual = actual.first if actual.is_a?(Array)
 
         actual = Rundoc::CodeCommand::Bash.new(code) if actual.is_a?(Rundoc::CodeCommand::NoSuchCommand)
-        return actual
+        actual
 
       # Since `| tail -n 2` does not start with a `$` assume any "naked" commands
       # are bash
@@ -44,7 +43,5 @@ module Rundoc
   end
 end
 
-
 Rundoc.register_code_command(:pipe, Rundoc::CodeCommand::Pipe)
-Rundoc.register_code_command(:|,    Rundoc::CodeCommand::Pipe)
-
+Rundoc.register_code_command(:|, Rundoc::CodeCommand::Pipe)

data/lib/rundoc/code_command/print/erb.rb

@@ -0,0 +1,48 @@
+require "erb"
+
+class EmptyBinding
+  def self.create
+    new.empty_binding
+  end
+
+  def empty_binding
+    binding
+  end
+end
+
+RUNDOC_ERB_BINDINGS = Hash.new { |h, k| h[k] = EmptyBinding.create }
+
+class Rundoc::CodeCommand
+  class PrintERB < Rundoc::CodeCommand
+    def initialize(line = nil, binding: "default")
+      @line = line
+      @binding = RUNDOC_ERB_BINDINGS[binding]
+    end
+
+    def to_md(env)
+      if render_before?
+        env[:before] << render
+      end
+
+      ""
+    end
+
+    def render
+      @render ||= ERB.new([@line, contents].compact.join("\n")).result(@binding)
+    end
+
+    def call(erb = {})
+      if render_before?
+        ""
+      else
+        render
+      end
+    end
+
+    def render_before?
+      !render_command? && render_result?
+    end
+  end
+end
+
+Rundoc.register_code_command(:"print.erb", Rundoc::CodeCommand::PrintERB)

data/lib/rundoc/code_command/print/text.rb

@@ -0,0 +1,33 @@
+class Rundoc::CodeCommand
+  class PrintText < Rundoc::CodeCommand
+    def initialize(line)
+      @line = line
+    end
+
+    def to_md(env)
+      if render_before?
+        env[:before] << [@line, contents].compact.join("\n")
+      end
+
+      ""
+    end
+
+    def hidden?
+      !render_result?
+    end
+
+    def call(env = {})
+      if render_before?
+        ""
+      else
+        [@line, contents].compact.join("\n")
+      end
+    end
+
+    def render_before?
+      !render_command? && render_result?
+    end
+  end
+end
+
+Rundoc.register_code_command(:"print.text", Rundoc::CodeCommand::PrintText)

data/lib/rundoc/code_command/raw.rb

@@ -15,4 +15,4 @@ module Rundoc
       end
     end
   end
-end
+end

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

@@ -1,7 +1,6 @@
 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)

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

@@ -1,7 +1,6 @@
 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
@@ -15,7 +14,7 @@ class ::Rundoc::CodeCommand
       end
 
       def call(env = {})
-        env[:replace] ||= String.new
+        env[:replace] ||= +""
         current_path = Pathname.new(env[:document_path]).dirname
         document_path = @path.expand_path(current_path)
 
@@ -24,7 +23,7 @@ class ::Rundoc::CodeCommand
         puts "rundoc.require: Done executing #{@path.to_s.inspect}, putting contents into document"
 
         env[:replace] << output
-        return ""
+        ""
       end
 
       def hidden?

data/lib/rundoc/code_command/rundoc_command.rb

@@ -1,7 +1,6 @@
 module ::Rundoc
   class CodeCommand
     class ::RundocCommand < ::Rundoc::CodeCommand
-
       def initialize(contents = "")
         @contents = contents
       end
@@ -12,7 +11,7 @@ module ::Rundoc
 
       def call(env = {})
         puts "Running: #{contents}"
-        eval(contents)
+        eval(contents) # rubocop:disable Security/Eval
         ""
       end
     end
@@ -22,5 +21,5 @@ end
 Rundoc.register_code_command(:rundoc, RundocCommand)
 Rundoc.register_code_command(:"rundoc.configure", RundocCommand)
 
-require 'rundoc/code_command/rundoc/depend_on'
-require 'rundoc/code_command/rundoc/require'
+require "rundoc/code_command/rundoc/depend_on"
+require "rundoc/code_command/rundoc/require"

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

@@ -1,4 +1,4 @@
-require 'capybara'
+require "capybara"
 
 Capybara::Selenium::Driver.load_selenium
 
@@ -6,17 +6,17 @@ class Rundoc::CodeCommand::Website
   class Driver
     attr_reader :session
 
-    def initialize(name: , url: , width: 1024, height: 720, visible: false)
+    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 << "--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
+      driver_name = :"rundoc_driver_#{name}"
       Capybara.register_driver(driver_name) do |app|
         @driver
       end
@@ -44,14 +44,14 @@ class Rundoc::CodeCommand::Website
       session.reset_session!
     end
 
-    def self.tasks
-      @tasks
+    class << self
+      attr_reader :tasks
     end
 
     def safe_eval(code)
       @driver.send(:eval, code)
     rescue => e
-      msg = String.new
+      msg = +""
       msg << "Error running code #{code.inspect} at #{current_url.inspect}\n"
       msg << "saving a screenshot to: `tmp/error.png`"
       puts msg
@@ -69,19 +69,19 @@ class Rundoc::CodeCommand::Website
       return file_path unless upload
 
       case upload
-      when 's3', 'aws'
+      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'))
+        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 = 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'),
+          acl: "public-read",
+          bucket: ENV.fetch("AWS_BUCKET_NAME"),
           key: key
         )
 
@@ -105,7 +105,7 @@ class Rundoc::CodeCommand::Website
     def self.next_screenshot_name
       @count ||= 0
       @count += 1
-      return "screenshot_#{@count}.png"
+      "screenshot_#{@count}.png"
     end
   end
 end

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

@@ -1,7 +1,7 @@
 class Rundoc::CodeCommand::Website
   class Navigate < Rundoc::CodeCommand
-    def initialize(name: )
-      @name   = name
+    def initialize(name:)
+      @name = name
       @driver = Rundoc::CodeCommand::Website::Driver.find(name)
     end
 

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

@@ -1,6 +1,6 @@
 class Rundoc::CodeCommand::Website
   class Screenshot < Rundoc::CodeCommand
-    def initialize(name: , upload: false)
+    def initialize(name:, upload: false)
       @driver = Rundoc::CodeCommand::Website::Driver.find(name)
       @upload = upload
     end

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

@@ -1,8 +1,8 @@
 class Rundoc::CodeCommand::Website
   class Visit < Rundoc::CodeCommand
-    def initialize(name: , url: nil, scroll: nil, height: 720, width: 1024, visible: false)
+    def initialize(name:, url: nil, scroll: nil, height: 720, width: 1024, visible: false)
       @name = name
-      @url  = url
+      @url = url
       @scroll = scroll
       @driver = Driver.new(
         name: name,
@@ -19,7 +19,7 @@ class Rundoc::CodeCommand::Website
     end
 
     def call(env = {})
-      message = String.new("Visting: #{@url}")
+      message = +"Visting: #{@url}"
       message << "and executing:\n#{contents}" unless contents.nil? || contents.empty?
 
       puts message
@@ -27,11 +27,10 @@ class Rundoc::CodeCommand::Website
       @driver.visit(@url) if @url
       @driver.scroll(@scroll) if @scroll
 
-
       return "" if contents.nil? || contents.empty?
       @driver.safe_eval(contents)
 
-      return ""
+      ""
     end
 
     def hidden?

data/lib/rundoc/code_command/website.rb

@@ -1,7 +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'
+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/write.rb

@@ -23,27 +23,26 @@ module Rundoc
       end
 
       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}` write:\n\n#{before}"
+        if render_command?
+          raise "must call write in its own code section" unless env[:commands].empty?
+          env[:before] << "In file `#{filename}` write:"
+          env[:before] << NEWLINE
+        end
         nil
       end
 
       def call(env = {})
         puts "Writing to: '#{filename}'"
         mkdir_p
-        File.open(filename, "w") do |f|
-          f.write(contents)
-        end
+        File.write(filename, contents)
         contents
       end
     end
   end
 end
 
+Rundoc.register_code_command(:write, Rundoc::CodeCommand::Write)
+Rundoc.register_code_command(:"file.write", Rundoc::CodeCommand::Write)
 
-Rundoc.register_code_command(:write,        Rundoc::CodeCommand::Write)
-Rundoc.register_code_command(:'file.write', Rundoc::CodeCommand::Write)
-
-require 'rundoc/code_command/file_command/append'
-require 'rundoc/code_command/file_command/remove'
+require "rundoc/code_command/file_command/append"
+require "rundoc/code_command/file_command/remove"

data/lib/rundoc/code_command.rb

@@ -2,12 +2,23 @@ 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
+      :command, :contents, :keyword,
+      :original_args
 
-    alias :render_result? :render_result
-    alias :render_command? :render_command
+    alias_method :render_result?, :render_result
+    alias_method :render_command?, :render_command
 
     def initialize(*args)
     end
@@ -24,28 +35,28 @@ module Rundoc
       @contents ||= ""
       @contents << contents
     end
-    alias :<< :push
+    alias_method :<<, :push
 
     # Executes command to build project
     # Is expected to return the result of the command
     def call(env = {})
-      raise "not implemented on #{self.inspect}"
+      raise "not implemented on #{inspect}"
     end
 
     # the output of the command, i.e. `$ cat foo.txt`
     def to_md(env = {})
-      raise "not implemented on #{self.inspect}"
+      raise "not implemented on #{inspect}"
     end
   end
 end
 
-
-require 'rundoc/code_command/bash'
-require 'rundoc/code_command/pipe'
-require 'rundoc/code_command/write'
-require 'rundoc/code_command/repl'
-require 'rundoc/code_command/rundoc_command'
-require 'rundoc/code_command/no_such_command'
-require 'rundoc/code_command/raw'
-require 'rundoc/code_command/background'
-require 'rundoc/code_command/website'
+require "rundoc/code_command/bash"
+require "rundoc/code_command/pipe"
+require "rundoc/code_command/write"
+require "rundoc/code_command/rundoc_command"
+require "rundoc/code_command/no_such_command"
+require "rundoc/code_command/raw"
+require "rundoc/code_command/background"
+require "rundoc/code_command/website"
+require "rundoc/code_command/print/text"
+require "rundoc/code_command/print/erb"