rundoc 1.0.0 → 1.1.3

data/lib/rundoc/code_command/rundoc_command.rb

@@ -19,5 +19,8 @@ module ::Rundoc
   end
 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'

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)

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

@@ -0,0 +1,28 @@
+class Rundoc::CodeCommand::Website
+  class Screenshot < Rundoc::CodeCommand
+    def initialize(name: , upload: false)
+      @driver = Rundoc::CodeCommand::Website::Driver.find(name)
+      @upload = upload
+    end
+
+    def to_md(env = {})
+      ""
+    end
+
+    def call(env = {})
+      puts "Taking screenshot: #{@driver.current_url}"
+      filename = @driver.screenshot(upload: @upload)
+      env[:replace] = "![Screenshot of #{@driver.current_url}](#{filename})"
+      ""
+    end
+
+    # def hidden?
+    #   true
+    # end
+
+    # def not_hidden?
+    #   !hidden?
+    # end
+  end
+end
+Rundoc.register_code_command(:"website.screenshot", Rundoc::CodeCommand::Website::Screenshot)

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

@@ -0,0 +1,47 @@
+class Rundoc::CodeCommand::Website
+  class Visit < Rundoc::CodeCommand
+    def initialize(name: , url: nil, scroll: nil, height: 720, width: 1024, visible: false)
+      @name = name
+      @url  = url
+      @scroll = scroll
+      @driver = Driver.new(
+        name: name,
+        url: url,
+        height: height,
+        width: width,
+        visible: visible
+      )
+      Driver.add(@name, @driver)
+    end
+
+    def to_md(env = {})
+      ""
+    end
+
+    def call(env = {})
+      message = String.new("Visting: #{@url}")
+      message << "and executing:\n#{contents}" unless contents.nil? || contents.empty?
+
+      puts message
+
+      @driver.visit(@url) if @url
+      @driver.scroll(@scroll) if @scroll
+
+
+      return "" if contents.nil? || contents.empty?
+      @driver.safe_eval(contents)
+
+      return ""
+    end
+
+    def hidden?
+      true
+    end
+
+    def not_hidden?
+      !hidden?
+    end
+  end
+end
+
+Rundoc.register_code_command(:"website.visit", Rundoc::CodeCommand::Website::Visit)

data/lib/rundoc/code_section.rb

@@ -32,6 +32,7 @@ module Rundoc
       @commands = []
       @stack    = []
       @keyword  = options[:keyword] or raise "keyword is required"
+      @document_path = options[:document_path]
       @fence    = match[:fence]
       @lang     = match[:lang]
       @code     = match[:contents]
@@ -42,8 +43,9 @@ module Rundoc
       result = []
       env    = {}
       env[:commands] = []
-      env[:before]   = "#{fence}#{lang}"
-      env[:after]    = "#{fence}"
+      env[:before]   = String.new("#{fence}#{lang}")
+      env[:after]    = String.new(fence)
+      env[:document_path] = @document_path
 
       @stack.each do |s|
         unless s.respond_to?(:call)
@@ -55,7 +57,7 @@ module Rundoc
         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?
@@ -65,10 +67,17 @@ module Rundoc
         result
       end
 
+      return env[:replace] if env[:replace]
+
       return "" if hidden?
 
       array = [env[:before], result, env[:after]]
-      return array.flatten.compact.map(&:rstrip).reject(&:empty?).join("\n") << "\n"
+      array.flatten!
+      array.compact!
+      array.map!(&:rstrip)
+      array.reject!(&:empty?)
+
+      return array.join("\n") << "\n"
     end
 
     # all of the commands are hidden

data/lib/rundoc/parser.rb

@@ -10,10 +10,11 @@ module Rundoc
 
     attr_reader :contents, :keyword, :stack
 
-    def initialize(contents, options = {})
+    def initialize(contents, keyword: DEFAULT_KEYWORD, document_path: nil)
+      @document_path = document_path
       @contents = contents
       @original = contents.dup
-      @keyword  = options[:keyword] || DEFAULT_KEYWORD
+      @keyword  = keyword
       @stack    = []
       partition
     end
@@ -42,7 +43,7 @@ module Rundoc
         @stack << head                  unless head.empty?
         unless code.empty?
           match = code.match(CODEBLOCK_REGEX)
-          @stack << CodeSection.new(match, keyword: keyword)
+          @stack << CodeSection.new(match, keyword: keyword, document_path: @document_path)
         end
         @contents = tail
       end

data/lib/rundoc/peg_parser.rb

@@ -119,7 +119,7 @@ module Rundoc
       (
         start_command >>
         visability.as(:cmd_visability) >> spaces? >>
-        method_call.as(:cmd_method_call) >> newline #>> match(/\z/)
+        method_call.as(:cmd_method_call) >> newline.maybe #>> match(/\z/)
       ).as(:command)
     }
 

data/lib/rundoc/version.rb

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

data/rundoc.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   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.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"
 
@@ -21,6 +21,11 @@ Gem::Specification.new do |gem|
   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 'aws-sdk-s3', '~> 1'
+  gem.add_dependency 'dotenv'
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "mocha"

data/test/fixtures/build_logs/rundoc.md

@@ -0,0 +1,56 @@
+Logs produced while building your application (deploying) are separated from your [runtime logs](https://devcenter.heroku.com/articles/logging#log-retrieval). The build logs for failed and successful deploys are available via the dashboard of the application.
+
+```
+:::-- $ touch Gemfile
+:::-- $ bundle _1.15.2_ install
+:::-- $ git init && git add . && git commit -m first
+:::-- $ heroku create
+:::-- $ git push heroku master
+```
+
+To view your build logs, first visit the dashboard for the application (`https://dashboard.heroku.com/apps/<app-name>`):
+
+```
+:::>> website.visit(name: "dashboard", url: "https://dashboard.heroku.com", visible: true)
+
+while current_url != "https://dashboard.heroku.com/apps"
+  puts "waiting for successful login: #{current_url}"
+  sleep 1
+end
+
+git_url = `git config --get remote.heroku.url`.chomp
+app_name = git_url.split("/").last.gsub(".git", "")
+session.visit "https://dashboard.heroku.com/apps/#{app_name}"
+sleep 2
+
+email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`
+session.execute_script %Q{$("span:contains(#{email}").html('developer@example.com')}
+
+:::>> website.screenshot(name: "dashboard", upload: "s3")
+```
+
+Next click on the "Activity" tab:
+
+```
+:::>> website.nav(name: "dashboard")
+session.first(:link, "Activity").click
+sleep 2
+
+email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`
+session.execute_script %Q{$("span:contains(#{email}").html('developer@example.com')}
+
+:::>> website.screenshot(name: "dashboard", upload: "s3")
+```
+
+From here you can click on "View build log" to see your most recent build:
+
+```
+:::>> website.nav(name: "dashboard")
+session.first(:link, "View build log").click
+sleep 2
+
+email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`
+session.execute_script %Q{$("span:contains(#{email}").html('developer@example.com')}
+
+:::>> website.screenshot(name: "dashboard", upload: "s3")
+```

data/test/fixtures/depend_on/dependency/rundoc.md

@@ -0,0 +1,5 @@
+```
+:::>> $ mkdir foo
+:::>> $ cd foo
+:::>> $ echo "hello" >> hello.txt
+```

data/test/fixtures/depend_on/main/rundoc.md

@@ -0,0 +1,10 @@
+# Hello
+
+```
+:::-- rundoc.depend_on "../dependency/rundoc.md"
+```
+
+```
+:::>> $ ruby -e "raise 'nope' unless File.read('hello.txt').chomp == 'hello'"
+```
+

data/test/fixtures/java/rundoc.md

@@ -0,0 +1,9 @@
+
+Hello
+
+```
+:::>- $ git clone https://github.com/heroku/java-getting-started
+:::>- $ cd java-getting-started
+```
+
+world

data/test/fixtures/rails_4/rundoc.md

@@ -9,7 +9,7 @@ end
 ```
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_4/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_4/rundoc.md
 -->
 
 > warning
@@ -56,7 +56,7 @@ Press enter at the prompt to upload your existing `ssh` key or create a new one,
 You may be starting from an existing app, if so [upgrade to Rails 4](http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-3-2-to-rails-4-0) before continuing. If not, a vanilla Rails 4 app will serve as a suitable sample app. To build a new app make sure that you're using the Rails 4.x using `$ rails -v`. You can get the new version of rails by running,
 
 ```term
-:::>> $ gem install rails -v 4.2.9 --no-ri --no-rdoc
+:::>> $ gem install rails -v 4.2.9 --no-document
 ```
 
 Note: There may be a [more recent version of Rails](https://rubygems.org/gems/rails/versions) available, we recommend always running the latest. You may want to [run Rails 5 on Heroku](https://devcenter.heroku.com/articles/getting-started-with-rails5).
@@ -224,15 +224,18 @@ Make sure you are in the directory that contains your Rails app, then create an
 You can verify that the remote was added to your project by running
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you may deploy your code. After you deploy your code, you will need to migrate your database, make sure it is properly scaled and use logs to debug any issues that come up.
 
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
@@ -394,7 +397,7 @@ Looks good, so press Ctrl-C to exit and you can deploy your changes to Heroku:
 ```term
 :::> $ git add .
 :::> $ git commit -m "use puma via procfile"
-:::> $ git push heroku master
+:::> $ git push heroku main
 ```
 
 Check `ps`, you'll see the web process uses your new command specifying Puma as the web server