tldr 0.1.1 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/CHANGELOG.md +9 -0
 - data/README.md +22 -0
 - data/lib/tldr/rake.rb +4 -0
 - data/lib/tldr/version.rb +1 -1
 - data/lib/tldr.rb +6 -0
 - data/script/setup +21 -0
 - data/script/test +10 -21
 - metadata +4 -4
 - data/script/parse +0 -6
 - data/script/run +0 -6
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 05c0bd6cc3f9a95769cf36122dc0b15d3b8991fd1e52ebe631e96e27ca0a20d3
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: ad535be63a614c6154c8e8d20317b666641e127e244dff4e6c3196bafd65b485
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: 31300d441a674c0cb5bf997126a4e49206ba78b25d4320047506ec078d2e804733251d12117d4e70b0a02d3bd8dbb116908d6ddab845ff5c3b2bcaca66fed95e
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: cf7583cdcb753e2b12178a5db25f001acf0f81088ae35e14df0089ede4e9dc3cbeb95b6d69d0ea1d3add9ce7070c6d7d3e63ba95460765060f428e55068f93cd
         
     | 
    
        data/CHANGELOG.md
    CHANGED
    
    | 
         @@ -1,5 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ## [Unreleased]
         
     | 
| 
       2 
2 
     | 
    
         | 
| 
      
 3 
     | 
    
         
            +
            ## [0.2.1]
         
     | 
| 
      
 4 
     | 
    
         
            +
             
     | 
| 
      
 5 
     | 
    
         
            +
            * Define a default empty setup/teardown in the base class, to guard against
         
     | 
| 
      
 6 
     | 
    
         
            +
            users getting `super: no superclass method `setup'` errors when they dutifully
         
     | 
| 
      
 7 
     | 
    
         
            +
            call super from their hooks
         
     | 
| 
      
 8 
     | 
    
         
            +
             
     | 
| 
      
 9 
     | 
    
         
            +
            ## [0.2.0]
         
     | 
| 
      
 10 
     | 
    
         
            +
             
     | 
| 
      
 11 
     | 
    
         
            +
            - Add a rake task "tldr"
         
     | 
| 
       3 
12 
     | 
    
         
             
            ## [0.1.1]
         
     | 
| 
       4 
13 
     | 
    
         | 
| 
       5 
14 
     | 
    
         
             
            - Improve Minitest compatibility by mixing in Assertions#capture_io
         
     | 
    
        data/README.md
    CHANGED
    
    | 
         @@ -203,6 +203,28 @@ with these caveats: 
     | 
|
| 
       203 
203 
     | 
    
         
             
              TLDR::Assertions::MinitestCompatibility` into the `TLDR` base class or
         
     | 
| 
       204 
204 
     | 
    
         
             
              individual test classes
         
     | 
| 
       205 
205 
     | 
    
         | 
| 
      
 206 
     | 
    
         
            +
            ### Running TLDR with Rake
         
     | 
| 
      
 207 
     | 
    
         
            +
             
     | 
| 
      
 208 
     | 
    
         
            +
            TLDR ships with a [very](lib/tldr/rake.rb) minimal rake task that simply shells
         
     | 
| 
      
 209 
     | 
    
         
            +
            out to the `tldr` CLI. If you want to run TLDR with Rake, you can configure
         
     | 
| 
      
 210 
     | 
    
         
            +
            the test run by setting flags on an env var named `TLDR_OPTS` or else in
         
     | 
| 
      
 211 
     | 
    
         
            +
            the [.tldr.yml](#setting-defaults-in-tldryml).
         
     | 
| 
      
 212 
     | 
    
         
            +
             
     | 
| 
      
 213 
     | 
    
         
            +
            Here's an example Rakefile:
         
     | 
| 
      
 214 
     | 
    
         
            +
             
     | 
| 
      
 215 
     | 
    
         
            +
            ```ruby
         
     | 
| 
      
 216 
     | 
    
         
            +
            require "standard/rake"
         
     | 
| 
      
 217 
     | 
    
         
            +
            require "tldr/rake"
         
     | 
| 
      
 218 
     | 
    
         
            +
             
     | 
| 
      
 219 
     | 
    
         
            +
            task default: [:tldr, "standard:fix"]
         
     | 
| 
      
 220 
     | 
    
         
            +
            ```
         
     | 
| 
      
 221 
     | 
    
         
            +
             
     | 
| 
      
 222 
     | 
    
         
            +
            You could then run the task with:
         
     | 
| 
      
 223 
     | 
    
         
            +
             
     | 
| 
      
 224 
     | 
    
         
            +
            ```
         
     | 
| 
      
 225 
     | 
    
         
            +
            $ TLDR_OPTS="--no-parallel" bundle exec rake tldr
         
     | 
| 
      
 226 
     | 
    
         
            +
            ```
         
     | 
| 
      
 227 
     | 
    
         
            +
             
     | 
| 
       206 
228 
     | 
    
         
             
            ### How will I run all my tests in CI without the time bomb going off?
         
     | 
| 
       207 
229 
     | 
    
         | 
| 
       208 
230 
     | 
    
         
             
            TLDR will run all your tests in CI without the time bomb going off.
         
     | 
    
        data/lib/tldr/rake.rb
    ADDED
    
    
    
        data/lib/tldr/version.rb
    CHANGED
    
    
    
        data/lib/tldr.rb
    CHANGED
    
    
    
        data/script/setup
    ADDED
    
    
    
        data/script/test
    CHANGED
    
    | 
         @@ -1,25 +1,14 @@ 
     | 
|
| 
       1 
     | 
    
         
            -
            #!/usr/bin/env  
     | 
| 
       2 
     | 
    
         
            -
            $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
         
     | 
| 
      
 1 
     | 
    
         
            +
            #!/usr/bin/env bash
         
     | 
| 
       3 
2 
     | 
    
         | 
| 
       4 
     | 
    
         
            -
             
     | 
| 
      
 3 
     | 
    
         
            +
            set -e
         
     | 
| 
       5 
4 
     | 
    
         | 
| 
       6 
     | 
    
         
            -
             
     | 
| 
       7 
     | 
    
         
            -
              def test_passes
         
     | 
| 
       8 
     | 
    
         
            -
                assert true
         
     | 
| 
       9 
     | 
    
         
            -
              end
         
     | 
| 
      
 5 
     | 
    
         
            +
            bundle exec rake
         
     | 
| 
       10 
6 
     | 
    
         | 
| 
       11 
     | 
    
         
            -
             
     | 
| 
       12 
     | 
    
         
            -
             
     | 
| 
       13 
     | 
    
         
            -
             
     | 
| 
      
 7 
     | 
    
         
            +
            cd example/a
         
     | 
| 
      
 8 
     | 
    
         
            +
            bundle exec tldr | grep "😁😁"
         
     | 
| 
      
 9 
     | 
    
         
            +
            cd ../..
         
     | 
| 
       14 
10 
     | 
    
         | 
| 
       15 
     | 
    
         
            -
             
     | 
| 
       16 
     | 
    
         
            -
             
     | 
| 
       17 
     | 
    
         
            -
             
     | 
| 
       18 
     | 
    
         
            -
             
     | 
| 
       19 
     | 
    
         
            -
              def test_slow
         
     | 
| 
       20 
     | 
    
         
            -
                skip
         
     | 
| 
       21 
     | 
    
         
            -
                sleep 2
         
     | 
| 
       22 
     | 
    
         
            -
              end
         
     | 
| 
       23 
     | 
    
         
            -
            end
         
     | 
| 
       24 
     | 
    
         
            -
             
     | 
| 
       25 
     | 
    
         
            -
            TLDR::Run.run(TLDR::Config.new(paths: []))
         
     | 
| 
      
 11 
     | 
    
         
            +
            cd example/b
         
     | 
| 
      
 12 
     | 
    
         
            +
            bundle exec ruby -Itest test/some_test.rb | grep "😁"
         
     | 
| 
      
 13 
     | 
    
         
            +
            bundle exec rake tldr | grep "😁"
         
     | 
| 
      
 14 
     | 
    
         
            +
            cd ../..
         
     | 
    
        metadata
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: tldr
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 0. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 0.2.1
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - Justin Searls
         
     | 
| 
         @@ -61,6 +61,7 @@ files: 
     | 
|
| 
       61 
61 
     | 
    
         
             
            - lib/tldr/backtrace_filter.rb
         
     | 
| 
       62 
62 
     | 
    
         
             
            - lib/tldr/error.rb
         
     | 
| 
       63 
63 
     | 
    
         
             
            - lib/tldr/planner.rb
         
     | 
| 
      
 64 
     | 
    
         
            +
            - lib/tldr/rake.rb
         
     | 
| 
       64 
65 
     | 
    
         
             
            - lib/tldr/reporters.rb
         
     | 
| 
       65 
66 
     | 
    
         
             
            - lib/tldr/reporters/base.rb
         
     | 
| 
       66 
67 
     | 
    
         
             
            - lib/tldr/reporters/default.rb
         
     | 
| 
         @@ -76,8 +77,7 @@ files: 
     | 
|
| 
       76 
77 
     | 
    
         
             
            - lib/tldr/value/test_result.rb
         
     | 
| 
       77 
78 
     | 
    
         
             
            - lib/tldr/value/wip_test.rb
         
     | 
| 
       78 
79 
     | 
    
         
             
            - lib/tldr/version.rb
         
     | 
| 
       79 
     | 
    
         
            -
            - script/ 
     | 
| 
       80 
     | 
    
         
            -
            - script/run
         
     | 
| 
      
 80 
     | 
    
         
            +
            - script/setup
         
     | 
| 
       81 
81 
     | 
    
         
             
            - script/test
         
     | 
| 
       82 
82 
     | 
    
         
             
            homepage: https://github.com/tenderlove/tldr
         
     | 
| 
       83 
83 
     | 
    
         
             
            licenses:
         
     | 
| 
         @@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement 
     | 
|
| 
       101 
101 
     | 
    
         
             
                - !ruby/object:Gem::Version
         
     | 
| 
       102 
102 
     | 
    
         
             
                  version: '0'
         
     | 
| 
       103 
103 
     | 
    
         
             
            requirements: []
         
     | 
| 
       104 
     | 
    
         
            -
            rubygems_version: 3.4. 
     | 
| 
      
 104 
     | 
    
         
            +
            rubygems_version: 3.4.6
         
     | 
| 
       105 
105 
     | 
    
         
             
            signing_key:
         
     | 
| 
       106 
106 
     | 
    
         
             
            specification_version: 4
         
     | 
| 
       107 
107 
     | 
    
         
             
            summary: TLDR will run your tests, but only for 1.8 seconds.
         
     | 
    
        data/script/parse
    DELETED