pig-ci-rails 0.1.4 → 0.1.5
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 +4 -0
- data/README.md +11 -8
- data/lib/pig_ci/version.rb +1 -1
- data/pig_ci.gemspec +1 -1
- metadata +10 -4
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 9a0910dfcd93b0aa8da420798e8888787f3c7c614a86836c6d456c89123aeea3
         | 
| 4 | 
            +
              data.tar.gz: c550a0069bd3d36eeba1511a3c9601777c8bbdb7f939d6c039b5cf0415f54b0a
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: f7411322993aa119f7e8f70d545ec214aed0730467b7274aab4ea4f33a9359ef6569b649056882c9eaaed4f44e9429232b65c980e536539bf98c703dc5feb7c3
         | 
| 7 | 
            +
              data.tar.gz: 82d3ed70e9f709d0d464c8df1acb9c37f9a2c62c722f48c98362d2d4f5e5d3f6a402cbcfe8c522a0ffcd5b85533c2dda38f81e05d2f34d158f446c32e3d93ac1
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    
    
        data/README.md
    CHANGED
    
    | @@ -7,6 +7,8 @@ | |
| 7 7 |  | 
| 8 8 | 
             
            # PigCI
         | 
| 9 9 |  | 
| 10 | 
            +
            
         | 
| 11 | 
            +
             | 
| 10 12 | 
             
            Monitor your Ruby Applications metrics (Memory, SQL Requests & Request Time) as part of your test suite.
         | 
| 11 13 |  | 
| 12 14 | 
             
            Please consider supporting this project by adding [PigCI](https://pigci.com/) to your GitHub project & using this as part of CI. The CI tool will fail PRs that exceed metric threshold (e.g. a big increase in memory).
         | 
| @@ -52,10 +54,12 @@ You can hookup your project to PigCI.com, this will fail PRs when metric thresho | |
| 52 54 | 
             
            require 'pig_ci'
         | 
| 53 55 | 
             
            PigCI.start do |config|
         | 
| 54 56 | 
             
              # When you connect your project, you'll be given an API key.
         | 
| 55 | 
            -
              config.api_key = ' | 
| 57 | 
            +
              config.api_key = 'your-api-key-here'
         | 
| 56 58 | 
             
            end
         | 
| 57 59 | 
             
            ```
         | 
| 58 60 |  | 
| 61 | 
            +
            It's a great way to track metrics over time & support this project.
         | 
| 62 | 
            +
             | 
| 59 63 | 
             
            ### Configuring PigCI
         | 
| 60 64 |  | 
| 61 65 | 
             
            This gems was setup to be configured by passing a block to the `PigCI.start` method, e.g:
         | 
| @@ -68,7 +72,7 @@ PigCI.start do |config| | |
| 68 72 |  | 
| 69 73 | 
             
              # E.g. disable terminal summary output
         | 
| 70 74 | 
             
              config.generate_terminal_summary = false
         | 
| 71 | 
            -
            end # if  | 
| 75 | 
            +
            end # if RSpec.configuration.files_to_run.count > 1
         | 
| 72 76 | 
             
            ```
         | 
| 73 77 |  | 
| 74 78 | 
             
            You can see the full configuration options [lib/pig_ci.rb](https://github.com/PigCI/pig-ci-rails/blob/master/lib/pig_ci.rb#L21).
         | 
| @@ -116,21 +120,20 @@ end | |
| 116 120 |  | 
| 117 121 | 
             
            ## Development
         | 
| 118 122 |  | 
| 119 | 
            -
            After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake  | 
| 123 | 
            +
            After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
         | 
| 120 124 |  | 
| 121 125 | 
             
            To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
         | 
| 122 126 |  | 
| 123 127 | 
             
            ## TODO
         | 
| 124 128 |  | 
| 125 129 | 
             
            Features I'd like to add at some point:
         | 
| 126 | 
            -
             | 
| 130 | 
            +
             | 
| 127 131 | 
             
            * HTML output to include branch - Right now they're just timestamps which makes filtering hard.
         | 
| 128 | 
            -
            *  | 
| 129 | 
            -
            * Should I reject database requests that have a value of 0? I think so.
         | 
| 130 | 
            -
            * Document setting branch/commit encase of weird CI.
         | 
| 132 | 
            +
            * Document setting branch/commit to handle when CI doesn't set it correctly.
         | 
| 131 133 | 
             
            * Add rake for submitting reports.
         | 
| 132 134 | 
             
            * https://rubydoc.info/gems/yard/file/docs/GettingStarted.md - Document the gem so it's easier for people to jump on.
         | 
| 133 | 
            -
            *  | 
| 135 | 
            +
            * Support ActionCable (when requests have no key).
         | 
| 136 | 
            +
            * Add support for "upsert" for when tests are split over multiple machines
         | 
| 134 137 |  | 
| 135 138 | 
             
            ## Contributing
         | 
| 136 139 |  | 
    
        data/lib/pig_ci/version.rb
    CHANGED
    
    
    
        data/pig_ci.gemspec
    CHANGED
    
    | @@ -34,7 +34,7 @@ Gem::Specification.new do |spec| | |
| 34 34 | 
             
              spec.add_dependency 'colorize', '>= 0.8.1'
         | 
| 35 35 | 
             
              spec.add_dependency 'get_process_mem', '~> 0.2.3'
         | 
| 36 36 | 
             
              spec.add_dependency 'httparty', '>= 0.16'
         | 
| 37 | 
            -
              spec.add_dependency 'i18n', '>=  | 
| 37 | 
            +
              spec.add_dependency 'i18n', '>= 0.9', '< 2'
         | 
| 38 38 | 
             
              spec.add_dependency 'rails', '>= 4.2.0'
         | 
| 39 39 | 
             
              spec.add_dependency 'terminal-table', '~> 1.8.0'
         | 
| 40 40 |  | 
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: pig-ci-rails
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 0.1. | 
| 4 | 
            +
              version: 0.1.5
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Mike Rogers
         | 
| 8 8 | 
             
            autorequire: 
         | 
| 9 9 | 
             
            bindir: bin
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date: 2019-09- | 
| 11 | 
            +
            date: 2019-09-23 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: activesupport
         | 
| @@ -72,14 +72,20 @@ dependencies: | |
| 72 72 | 
             
                requirements:
         | 
| 73 73 | 
             
                - - ">="
         | 
| 74 74 | 
             
                  - !ruby/object:Gem::Version
         | 
| 75 | 
            -
                    version: ' | 
| 75 | 
            +
                    version: '0.9'
         | 
| 76 | 
            +
                - - "<"
         | 
| 77 | 
            +
                  - !ruby/object:Gem::Version
         | 
| 78 | 
            +
                    version: '2'
         | 
| 76 79 | 
             
              type: :runtime
         | 
| 77 80 | 
             
              prerelease: false
         | 
| 78 81 | 
             
              version_requirements: !ruby/object:Gem::Requirement
         | 
| 79 82 | 
             
                requirements:
         | 
| 80 83 | 
             
                - - ">="
         | 
| 81 84 | 
             
                  - !ruby/object:Gem::Version
         | 
| 82 | 
            -
                    version: ' | 
| 85 | 
            +
                    version: '0.9'
         | 
| 86 | 
            +
                - - "<"
         | 
| 87 | 
            +
                  - !ruby/object:Gem::Version
         | 
| 88 | 
            +
                    version: '2'
         | 
| 83 89 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 84 90 | 
             
              name: rails
         | 
| 85 91 | 
             
              requirement: !ruby/object:Gem::Requirement
         |