gelauto 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12cc9a0a73a5ed28daf5df44cc9b0ece74b51ce1e28114b55f9868e956816420
-  data.tar.gz: b77e3b82e0b89a84473dda0db7d20978926e879c25a3ee484d74af04d058edd4
+  metadata.gz: d8bc0cbf96338d28a4c1551f2fc2cf7e7cbea122ccbf1ecbcbe3904713d77293
+  data.tar.gz: 42e169f43e1d41de1ebd1d426dcd23358271aa3a658dc3d8d37288767223df13
 SHA512:
-  metadata.gz: '04583e3ed26dd8537ca43b5c0beb8202f2ecc64a91e49b8e88b38c916ecb0ac2253894527332dd156344cc6056d10239b83932b241e28f575ace51aa069d7f8e'
-  data.tar.gz: 8a60e3eb0ae8c43f9ba58625338bbeba9ff7bbba9e7569cedd218a332d976656c61306ac60c10ade2c09010d5e41d808493e0ca489633d21f424b8006376435a
+  metadata.gz: c74d87844d920d0abc555b55f395d61ca0235fd34a4bbcc6eb449a76ee5b304f36a37cf40d8b74817b380162def7aa1224d813fbc0fc7e8f209644428423fbc4
+  data.tar.gz: 850a310b37004110ddbe9b78906c1524fd262cd8ae1c67c861172818231c930bcfd83ac57e9b394ef800ee255330e6b7f2a900bd5018026f78bc588ad68bb236

data/README.md

@@ -42,8 +42,9 @@ You can run Gelauto either via the command line or by adding it to your bundle.
 
 First, install the gem by running `gem install gelauto`. That will make the `gelauto` executable available on your system.
 
-Gelauto's only subcommand is `run`, which accepts a list of Ruby files to scan for methods and a command to run that will exercise your code. In this example, we're going to be running an [RSpec](https://github.com/rspec/rspec) test suite.
+Gelauto's only subcommand is `run`, which accepts a list of Ruby files to scan for methods and a command to run that will exercise your code.
 
+In this example, we're going to be running an [RSpec](https://github.com/rspec/rspec) test suite.
 Like most RSpec test suites, let's assume ours is stored in the `spec/` directory (that's the RSpec default too). Let's furthermore assume our code is stored in the `lib` directory. To run the test suite in `spec/` and add type definitions to our files in `lib/`, we might run the following command:
 
 ```bash
@@ -52,6 +53,12 @@ gelauto run --annotate $(find . -name '*.rb') -- bundle exec rspec spec/
 
 You can also choose to run Gelauto with the `--rbi` flag, which will cause Gelauto to print results to standard output in [RBI format](https://sorbet.org/docs/rbi).
 
+In this second example, we're going to be running a minitest test suite. Like most minitest suites, let's assume ours is stored in the `test/` directory (that's the Rails default too). To run the test suite in `test/`, we might run the following command:
+
+```bash
+gelauto run --annotate $(find . -name '*.rb') -- bundle exec rake test/
+```
+
 ### Gelauto in your Bundle
 
 If you would rather run Gelauto as part of your bundle, add it to your Gemfile like so:
@@ -102,13 +109,23 @@ end
 
 #### RSpec Helper
 
-Gelauto comes with a handy RSpec helper that can do all this for you. Simply add
+Gelauto comes with a handy RSpec helper that can do most of this for you. Simply add
 
 ```ruby
 require 'gelauto/rspec'
 ```
 
-to your spec_helper.rb, Rakefile, or wherever RSpec is configured.
+to your spec_helper.rb, Rakefile, or wherever RSpec is configured. You'll also need to set the `GELAUTO_FILES` environment variable when running your test suite. For example:
+
+```bash
+GELAUTO_FILES=$(find ./lib -name *.rb) bundle exec rspec
+```
+
+Files can be separated by spaces, newlines, or commas. Finally, if you want Gelauto to annotate them, set `GELAUTO_ANNOTATE` to `true`, eg:
+
+```bash
+GELAUTO_FILES=$(find ./lib -name *.rb) GELAUTO_ANNOTATE=true bundle exec rspec
+```
 
 ## How does it Work?
 

data/lib/gelauto/rspec.rb

@@ -1,13 +1,19 @@
 require 'gelauto'
 
 RSpec.configure do |config|
-  config.before(:suite) { Gelauto.setup }
+  config.before(:suite) do
+    Gelauto.paths += ENV.fetch('GELAUTO_FILES', '').split(/[\s\n,]/).map(&:strip)
+    Gelauto.setup
+  end
+
   config.after(:suite) do
     Gelauto.teardown
 
-    Gelauto.each_absolute_path do |path|
-      Gelauto.annotate_file(path)
-      Gelauto::Logger.info("Annotated #{path}")
+    if ENV['GELAUTO_ANNOTATE'] == 'true'
+      Gelauto.each_absolute_path do |path|
+        Gelauto.annotate_file(path)
+        Gelauto::Logger.info("Annotated #{path}")
+      end
     end
   end
 end

data/lib/gelauto/version.rb

@@ -1,3 +1,3 @@
 module Gelauto
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gelauto
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser