rspec_logfmt_formatter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 211c7cbe090b13a9762b825d0cfeb2aecb4e43f2d44037147efd158883144565
-  data.tar.gz: 46c20ba3d51965bdd6f8ceee5bdf4a3f14d9efaf3af5efb73f154ac675a55057
+  metadata.gz: c2379f5938b480ca7b7f9506060f99a482b07d3144644750b6d976a665f5c774
+  data.tar.gz: 18029228ddc06f01d38dbe2e89c480b9411ba8e6b4bf2bc474ff359df6256273
 SHA512:
-  metadata.gz: 46ae8acd77714be862c4da0455cb5c553dbcc1fb05747e158f633323aa5246d46e72154ec0a346e042b735a5b1d645503a0ce5103242997116205ecf2bb86cf6
-  data.tar.gz: a95b1e04e094ae0067baeacffa3cce3a34a8097014c9066ebedbc6575999d22a957d0c7484981c73c3bb11bdc478134ea179f5386b6d357a6a430528e9fb1c67
+  metadata.gz: 55f9cede488a1b1ac881bd7e788217bca1f7e5914e28d5dc7a8ea415e923665a5509195cd96065b2ff1a06eb374dbead8c47c87b35fc029da0da0c96cdd3a3c8
+  data.tar.gz: 05b94d45666d2ac8b9c0955754741db5c3064b9ece162e2f502fed9c7f7b44174d91590f51c469ba5752e0aad865efc044fefe39029deea4097c2b52588ca615

data/README.md

@@ -1,8 +1,9 @@
 # RSpec logfmt Formatter
 
 [![CircleCI](https://circleci.com/gh/carwow/rspec_logfmt_formatter/tree/master.svg?style=svg)](https://circleci.com/gh/carwow/rspec_logfmt_formatter/tree/master)
+[![Gem Version](https://badge.fury.io/rb/rspec_logfmt_formatter.svg)](https://badge.fury.io/rb/rspec_logfmt_formatter)
 
-[RSpec][rspec] 3 results in the [logfmt][logfmt] format that you can push to you observability tool such as [Honeycomb][honeycomb]
+[RSpec][rspec] 3 results in the [logfmt][logfmt] format that you can push to your observability tool such as [Honeycomb][honeycomb]
 
   [rspec]: http://rspec.info/
   [logfmt]: https://brandur.org/logfmt
@@ -11,19 +12,15 @@
 ## Usage
 
 Install the gem:
-<details>
-<summary>WIP</summary>
 
 ```sh
 gem install rspec_logfmt_formatter
 ```
 
-</details>
-
 Use it:
 
 ```sh
-rspec --format RspecLogfmtFormatter::Formatter --out rspec.txt
+rspec --format RspecLogfmtFormatter --out rspec.txt
 ```
 
 You'll get a file `rspec.txt` with your results in it.
@@ -31,7 +28,7 @@ You'll get a file `rspec.txt` with your results in it.
 You can use it in combination with other [formatters][rspec-formatters], too:
 
 ```sh
-rspec --format progress --format RspecLogfmtFormatter::Formatter --out rspec.txt
+rspec --format progress --format RspecLogfmtFormatter --out rspec.txt
 ```
 
   [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
@@ -50,32 +47,51 @@ end
 Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
 
 ```sh
---format RspecLogfmtFormatter::Formatter
---out rspec.txt
+--format RspecLogfmtFormatter --out rspec.txt
 ```
   [bundler]: https://bundler.io
   [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
 
 ### Parallel tests
 
-For use with `parallel_tests`, add `$TEST_ENV_NUMBER` in the output file option (in `.rspec` or `.rspec_parallel`) to avoid concurrent process write conflicts.
+You can sum repeated values in one file using `rspec_logfmt_formatter_collate rspec.txt`.
 
-```sh
---format RspecLogfmtFormatter::Formatter
---out tmp/rspec<%= ENV["TEST_ENV_NUMBER"] %>.txt
+It will rewrite a file like:
+
+```
+tests.count="3"
+tests.count="1"
+```
+
+into:
+
+```
+tests.count="4"
 ```
 
 ### How to push to Honeycomb
 
-TODO
+There are many ways you can push this to honeycomb. One way is to use the [buildevents][buildevents] binary. Then output your spec output to `BUILDEVENT_FILE` e.g.
+
+```sh
+bundle exec rspec --format RspecLogfmtFormatter --out $BUILDEVENT_FILE
+```
+
+  [buildevents]: https://github.com/honeycombio/buildevents
 
 ## Development
 
-TODO
+Pull the repo and run `bundle install`, the specs are run with `bundle exec rspec` and make sure to read the [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ## Releasing
 
-TODO
+Currently this is a manual process and can only be run by a carwow developer.
+
+1. Ensure your `~/.gem/credentials` are correct
+2. Update the [CHANGELOG.md](./CHANGELOG.md)
+3. Update the [version.rb](./lib/rspec_logfmt_formatter/version.rb)
+4. Run `bundle exec rake upload`
+5. Check the tag was pushed and the new version was released
 
 ## License
 

data/exe/rspec_logfmt_formatter_collate

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "rspec_logfmt_formatter"
+
+file = ARGV.first
+out = -> { file ? File.new(file, "w") : $stdout }
+
+ARGF.read
+  .then { |input| RspecLogfmtFormatter.collate input }
+  .then { |collated| out.call.puts collated }

data/lib/rspec_logfmt_formatter.rb

@@ -1,2 +1,42 @@
-require 'rspec_logfmt_formatter/formatter'
-require 'rspec_logfmt_formatter/version'
+require "rspec/core"
+require "rspec/core/formatters/base_formatter"
+
+class RspecLogfmtFormatter < RSpec::Core::Formatters::BaseFormatter
+  RSpec::Core::Formatters.register self, :dump_summary
+
+  def self.collate(input)
+    collated = {}
+
+    input.scan(/(tests\.\w+)="(\d+)"/) do |key, value|
+      collated[key] = collated[key].to_i + value.to_i
+    end
+
+    collated.map { |key, value| "#{key}=\"#{value}\"" }.join("\n")
+  end
+
+  def initialize(...)
+    super
+    @retries = []
+  end
+
+  def dump_summary(notification)
+    @summary = notification
+    logfmt_dump
+  end
+
+  def retry(example)
+    @retries << example
+  end
+
+  private
+
+  def logfmt_dump
+    output.puts [
+      %(tests.count="#{@summary.example_count}"),
+      %(tests.skipped="#{@summary.pending_count}"),
+      %(tests.failures="#{@summary.failure_count}"),
+      %(tests.errors="#{@summary.errors_outside_of_examples_count}"),
+      %(tests.retries="#{@retries.count}")
+    ].join("\n")
+  end
+end

metadata

@@ -1,106 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: rspec_logfmt_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Vickerstaff
-autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: carwow_rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.4.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.4.4
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -110,27 +25,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.6'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
 description: ''
 email:
 - developers@carwow.co.uk
-executables: []
+executables:
+- rspec_logfmt_formatter_collate
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- exe/rspec_logfmt_formatter_collate
 - lib/rspec_logfmt_formatter.rb
-- lib/rspec_logfmt_formatter/formatter.rb
-- lib/rspec_logfmt_formatter/version.rb
 homepage: https://github.com/carwow/rspec_logfmt_formatter
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,15 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: RSpec formatter that honeycomb can read
 test_files: []

data/lib/rspec_logfmt_formatter/formatter.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'rspec/core'
-require 'rspec/core/formatters/base_formatter'
-
-module RspecLogfmtFormatter
-  class Formatter < RSpec::Core::Formatters::BaseFormatter
-    RSpec::Core::Formatters.register self,
-      :start,
-      :stop,
-      :dump_summary
-
-    def start(notification)
-      @start_notification = notification
-      @started = Time.now
-      @retries = []
-      super
-    end
-
-    def stop(notification)
-      @examples_notification = notification
-    end
-
-    def dump_summary(notification)
-      @summary_notification = notification
-      fmt_dump
-    end
-
-    def retry(example)
-      @retries << example
-    end
-
-    private
-
-    attr_reader :started, :retries
-
-    def example_count
-      @summary_notification.example_count
-    end
-
-    def pending_count
-      @summary_notification.pending_count
-    end
-
-    def failure_count
-      @summary_notification.failure_count
-    end
-
-    def duration
-      @summary_notification.duration
-    end
-
-    def error_count
-      if @summary_notification.respond_to?(:errors_outside_of_examples_count)
-        @summary_notification.errors_outside_of_examples_count
-      else
-        0
-      end
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def fmt_dump
-      output << %( tests.name="rspec#{ENV['TEST_ENV_NUMBER']}")
-      output << %( tests.count="#{example_count}")
-      output << %( tests.skipped="#{pending_count}")
-      output << %( tests.failures="#{failure_count}")
-      output << %( tests.errors="#{error_count}")
-      output << %( tests.retries.count="#{retries.size}")
-    end
-    # rubocop:enable Metrics/AbcSize
-  end
-end

data/lib/rspec_logfmt_formatter/version.rb

@@ -1,3 +0,0 @@
-module RspecLogfmtFormatter
-  VERSION = '0.0.1'.freeze
-end