waiter_ 1.0.3 → 1.0.4
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/README.md +14 -0
- data/lib/version.rb +1 -1
- data/lib/waiter.rb +3 -8
- metadata +1 -1
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA1:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 28fd836b52aa3644ed99eff76ae18e5765973b52
         | 
| 4 | 
            +
              data.tar.gz: ba1c81050e528e821a3c3c38d3fa827bb2cde57f
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 9f79b008a65f9cd464e71168104dd4a6cb4be127344306b9b194decd9a9e90e581dae67ff8116353762d779b8de9ffd777db241d859988e0f6e5f434ab57a3fd
         | 
| 7 | 
            +
              data.tar.gz: a0fa65f870848f23cb3dc3e3ea7bc37b54ba6b08187216061e01da14afb714c5a88839894aeed8ca724edb54e419c9c622681c124ae21836faaabdf611d20819
         | 
    
        data/README.md
    CHANGED
    
    | @@ -54,3 +54,17 @@ wait.every(5).up_to(30).until { | |
| 54 54 | 
             
              true == true
         | 
| 55 55 | 
             
            }
         | 
| 56 56 | 
             
            ```
         | 
| 57 | 
            +
             | 
| 58 | 
            +
            A custom failure message can be prepended.
         | 
| 59 | 
            +
             | 
| 60 | 
            +
            ```ruby
         | 
| 61 | 
            +
            wait.fail_with("A custom message").for('foo').to eq 'bar'
         | 
| 62 | 
            +
             | 
| 63 | 
            +
            #=> Waiter::TimeoutError:
         | 
| 64 | 
            +
            #     A custom message
         | 
| 65 | 
            +
            #     Timed out after waiting for 15s.
         | 
| 66 | 
            +
            #     Polled every 1s.
         | 
| 67 | 
            +
            #
         | 
| 68 | 
            +
            #     Expected: 'bar'
         | 
| 69 | 
            +
            #     got: 'foo'
         | 
| 70 | 
            +
            ```
         | 
    
        data/lib/version.rb
    CHANGED
    
    
    
        data/lib/waiter.rb
    CHANGED
    
    | @@ -60,7 +60,7 @@ module Waiter | |
| 60 60 | 
             
                def initialize(opts = {})
         | 
| 61 61 | 
             
                  @timeout = opts[:timeout] || DEFAULT_TIMEOUT
         | 
| 62 62 | 
             
                  @polling = opts[:polling] || DEFAULT_POLLING
         | 
| 63 | 
            -
                  @failure_message = opts[:failure_message] | 
| 63 | 
            +
                  @failure_message = opts[:failure_message]
         | 
| 64 64 | 
             
                end
         | 
| 65 65 |  | 
| 66 66 | 
             
                def for(value = nil, &block)
         | 
| @@ -135,16 +135,11 @@ module Waiter | |
| 135 135 |  | 
| 136 136 | 
             
                private
         | 
| 137 137 |  | 
| 138 | 
            -
                def default_failure_message
         | 
| 139 | 
            -
                  [
         | 
| 140 | 
            -
                    "Timed out after waiting for #{@timeout}s.",
         | 
| 141 | 
            -
                    "Polled for #{@polling}s."
         | 
| 142 | 
            -
                  ].join("\n")
         | 
| 143 | 
            -
                end
         | 
| 144 | 
            -
             | 
| 145 138 | 
             
                def build_error(error = nil)
         | 
| 146 139 | 
             
                  [
         | 
| 147 140 | 
             
                    @failure_message,
         | 
| 141 | 
            +
                    "Timed out after waiting for #{@timeout}s.",
         | 
| 142 | 
            +
                    "Polled every #{@polling}s.",
         | 
| 148 143 | 
             
                    error
         | 
| 149 144 | 
             
                  ].join("\n")
         | 
| 150 145 | 
             
                end
         |