rundoc 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e99ebdb76543d50700d87e4e1d369584785d88500a4ba261b203fc526391234a
-  data.tar.gz: 41c77800630c17ca1cb1e123cd9930290bcdd3e6bf87c7db42da3e4d32159070
+  metadata.gz: da3a985092d1a4964518696470e3caffbccfa38fb4c77babd3bb9db3019574f8
+  data.tar.gz: b10a337ee209e1b915b2bbd806c5e20a39919bb4768e015f3cd3b9ced7690608
 SHA512:
-  metadata.gz: f7e5ab57b964760255e72017c7caa23b13ed3b4042763858d56518a737cf9ac0274f0c8a9c1189b0af061ff47f250cf9438e38302a5664b469166071ff380bf2
-  data.tar.gz: f086f8a367a1770d6dd9bb85832637e94d93b8198e2eaf5e2c38f4b20881a852134d148a9655c517e1eb41c81f1797003e16cd0b1137ddba88ac2c494ca38649
+  metadata.gz: 67f0fc97aabfb49844520018ec31b94ffa9d99472115a1c4d32f19a9f4d352c2474e5b3120769000322b042fb7ac8ea302170c0fc6632e178f2760b1d4ef6ae3
+  data.tar.gz: 04bf8538b5087638a5ff731154ea5c5c3c189bd8ea321d0d2b7690acb604e4a7120dd1adf0f9566fe91c225b9a7e0a634cb642de16e0919c3fedf43e893c12b6

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,13 @@
+name: Check Changelog
+
+on:
+ pull_request:
+  types: [opened, reopened, edited, synchronize]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master
 
+## 1.1.0
+
+- Pipe logic is now implemented through a parser (https://github.com/schneems/rundoc/pull/22)
+- Bugfix, background processes error when the log file is not touched before read, not sure why this is possible but here's a fix for it anyway (https://github.com/schneems/rundoc/commit/620ae55d8a5d3d443cf5e8cb77950a841f92900c)
+
 ## 1.0.1
 
 - Allow non-headless browser sessions and navigation [#23](https://github.com/schneems/rundoc/pull/23)

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.6.3-stretch
+
+RUN useradd rundoc
+RUN curl https://cli-assets.heroku.com/install-ubuntu.sh | sh
+
+RUN apt-get clean && apt-get update && apt-get install -y locales nodejs
+
+RUN locale-gen en_US.UTF-8
+ENV LC_ALL=C.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US.UTF-8
+ENV DISABLE_SPRING=1
+
+WORKDIR /home/rundoc
+RUN mkdir -p /home/rundoc/ && chown -R rundoc:rundoc /home/rundoc
+USER rundoc
+RUN mkdir -p /home/rundoc/workdir
+
+RUN git config --global user.email "developer@example.com"
+RUN git config --global user.name "Dev Eloper"
+
+ADD Gemfile Gemfile.lock
+
+RUN bundle install

data/lib/rundoc/code_command/background/start.rb

@@ -25,6 +25,10 @@ class Rundoc::CodeCommand::Background
     def call(env = {})
       @spawn.wait(@wait)
       @spawn.check_alive! unless @allow_fail
+
+      # WTF BBQ SAUCE
+      FileUtils.touch(@spawn.log)
+
       @spawn.log.read
     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/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/rundoc.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   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/rails_5/rundoc.md

@@ -18,7 +18,7 @@ end
 Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 5 on Heroku. For information on running previous versions of Rails on Heroku, see the tutorial for [Rails 4.x](getting-started-with-rails4) or [Rails 3.x](getting-started-with-rails3).
 
 ```
-:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.0'"
+:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.3'"
 ```
 
 For this guide you will need:
@@ -68,6 +68,12 @@ Then move into your application directory.
 :::>- $ cd myapp
 ```
 
+Create a database locally:
+
+```
+:::>> $ bin/rake db:create
+```
+
 ## Add the pg gem
 
 If you're using an existing app that was created without specifying `--database=postgresql`, you need to add the `pg` gem to your Rails project. Edit your `Gemfile` and change this line:
@@ -158,7 +164,7 @@ Rails 5 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby instal
 ```ruby
 :::-- $ sed -i'' -e '/^ruby/d' ./Gemfile
 :::-> file.append Gemfile#4
-ruby "2.6.0"
+ruby "2.6.3"
 ```
 
 You should also be running the same version of Ruby locally. You can check this by running `$ ruby -v`. You can get more information on [specifying your Ruby version on Heroku here](https://devcenter.heroku.com/articles/ruby-versions).

data/test/fixtures/rails_6/rundoc.md

@@ -19,13 +19,13 @@ end
 Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 6 on Heroku. For information on running previous versions of Rails on Heroku, see the tutorial for [Rails 5.x](getting-started-with-rails5) or [Rails 4.x](getting-started-with-rails4).
 
 ```
-:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.3'"
+:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.5'"
 ```
 
 For this guide you will need:
 
 - Basic familiarity with Ruby/Rails and Git
-- A locally installed version of Ruby 2.2.0+, Rubygems, Bundler, and Rails 6+
+- A locally installed version of Ruby 2.5.0+, Rubygems, Bundler, and Rails 6+
 - A Heroku user account: [Signup is free and instant](https://signup.heroku.com/devcenter).
 
 ## Local setup
@@ -52,7 +52,7 @@ Press Enter at the prompt to upload your existing `ssh` key or create a new one,
 To create a new app, first make sure that you're using Rails 6.x by running `rails -v`. If necessary, you can get the new version of rails by running the following:
 
 ```term
-:::>> $ gem install rails --pre --no-document
+:::>> $ gem install rails --no-document
 ```
 
 Then create a new app and move into its root directory:
@@ -67,6 +67,12 @@ Then move into your application directory.
 :::>- $ cd myapp
 ```
 
+Create a database locally:
+
+```
+:::>> $ bin/rails db:create
+```
+
 ## Add the pg gem
 
 If you're using an existing app that was created without specifying `--database=postgresql`, you need to add the `pg` gem to your Rails project. Edit your `Gemfile` and change this line:
@@ -131,11 +137,11 @@ You can verify that the page is there by running your server:
 :::-- background.stop(name: "server")
 ```
 
-And visiting [http://localhost:3000](http://localhost:3000) in your browser. If you do not see the page, [use the logs](#view-the-logs) that are output to your server to debug.
+And visiting [http://localhost:3000](http://localhost:3000) in your browser. If you do not see the page, [use the logs](#view-logs) that are output to your server to debug.
 
 ## Heroku gems
 
-Previous versions of Rails required you to add a gem to your project [rails_12factor](https://github.com/heroku/rails_12factor) to enable static asset serving and logging on Heroku. If you are deploying a new application, this gem is not needed. If you are upgrading an existing application, you can remove this gem provided you have the apprpriate configuration in your `config/environments/production.rb` file:
+Previous versions of Rails required you to add a gem to your project [rails_12factor](https://github.com/heroku/rails_12factor) to enable static asset serving and logging on Heroku. If you are deploying a new application, this gem is not needed. If you are upgrading an existing application, you can remove this gem provided you have the appropriate configuration in your `config/environments/production.rb` file:
 
 
 ```ruby
@@ -157,7 +163,7 @@ Rails 6 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby instal
 ```ruby
 :::-- $ sed -i'' -e '/^ruby/d' ./Gemfile
 :::-> file.append Gemfile#4
-ruby "2.6.3"
+ruby "2.6.5"
 ```
 
 You should also be running the same version of Ruby locally. You can check this by running `$ ruby -v`. You can get more information on [specifying your Ruby version on Heroku here](https://devcenter.heroku.com/articles/ruby-versions).
@@ -211,7 +217,7 @@ You can verify that the remote was added to your project by running:
 :::>> $ git config --list | grep heroku
 ```
 
-If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you can deploy your code. After you deploy your code, you  need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
+If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise, you can deploy your code. After you deploy your code, you need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
 
 Deploy your code:
 
@@ -351,6 +357,13 @@ You'll also want to add `.env` to your `.gitignore` since this is for local envi
 :::>- $ git commit -m "add .env to .gitignore"
 ```
 
+If you're running Rails 6.0.0 you'll need to create a `tmp/pids` directory:
+
+```term
+:::>> $ mkdir -p tmp/pids
+:::>> $ touch tmp/pids/.gitkeep
+```
+
 Test your Procfile locally using Foreman. You can now start your web server by running:
 
 ```term

data/test/rundoc/parser_test.rb

@@ -83,7 +83,6 @@ puts b
 ```
 RUBY
 
-
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -144,9 +158,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - README.md
 - Rakefile
@@ -224,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: RunDOC generates runable code from docs