simplecov-oj 0.18.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a5cb1f33b1f2da7cf91879ec6ab44c70ea9d3069a1d67bc7953426da1c06489
-  data.tar.gz: 64abb42d0f448f50854ab31fc41b004122c41c4e3ea5b1379aaf1ceb1e503fc8
+  metadata.gz: 60d72ce4fabbc34bfdcdecfd55a2690eb928f2ffc84766df8f1efd8d0bee7a9e
+  data.tar.gz: 1672afa2ebb6de22847270b5c87dd10c03b703f4e07564578387d7adb6857c08
 SHA512:
-  metadata.gz: 266222bbef8d53d90d3eb6f9d8b1fa352b7ecd542180e37f509e87c783197a1ea130d3135a92947c2c991d579240346b0869814ebe7442c9efbdd81c7bf3ef72
-  data.tar.gz: 4afe0864271389a015292f944035bc354e1be3d64ed4a105c4f221a8119c1f0362d95c5c464af5b73b1b7155beac92e008f5f9f3a52549a1f5b013d48f8088eb
+  metadata.gz: f364cf184acc5fbc061f1ba8c0eb0e34b17cd32bfe877361f115e57654d7722d52f691f881655155ec140ed590d342f0284dcbe6bf573efbae3982ccf85625b4
+  data.tar.gz: b8e086143e8dfc01d7df5739d45e2ed7f692da96d5afe4fb3dfb11a4459d1844599c4fe0400960fb4c8cc0defb2df8a091b5080c6fb066106981a4e02b993213

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v0.18.0](https://github.com/mhenrixon/simplecov-oj/tree/v0.18.0) (2020-01-29)
+
+[Full Changelog](https://github.com/mhenrixon/simplecov-oj/compare/v0.2...v0.18.0)
+
 ## [v0.2](https://github.com/mhenrixon/simplecov-oj/tree/v0.2) (2013-07-20)
 
 [Full Changelog](https://github.com/mhenrixon/simplecov-oj/compare/aa3f4993ad39ba63229938d23ac2470b6f2cee3e...v0.2)

data/README.md

@@ -1,17 +1,21 @@
-# simplecov-json
+# simplecov-oj
 
-JSON formatter for the ruby 1.9+ code coverage gem SimpleCov
+JSON formatter for the ruby 2.5+ code coverage gem SimpleCov
 
 ## Usage
 
-1. Add simplecov-json to your `Gemfile` and `bundle install`:
+1. Add simplecov-oj to your `Gemfile` and `bundle install`:
 
-        gem 'simplecov-json', :require => false, :group => :test
+```ruby
+gem 'simplecov-oj', require: false, group: :test
+```
 
-2. Require simplecov-json and set it up as SimpleCov's formatter:
+2. Require simplecov-oj and set it up as SimpleCov's formatter:
 
-        require 'simplecov-json'
-        SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
+```ruby
+require 'simplecov-oj'
+SimpleCov.formatter = SimpleCov::Formatter::OjFormatter
+```
 
 ## Result
 
@@ -20,31 +24,30 @@ Generated JSON can be found in coverage/coverage.json
 The format you can expect is:
 ```json
 {
-    "timestamp": 1348489587,
-    "command_name": "RSpec",
-    "files": [
-        {
-            "filename": "/home/user/rails/environment.rb",
-            "covered_percent": 50.0,
-            "coverage": [
-                null,
-                1,
-                null,
-                null,
-                1
-            ],
-            "covered_strength": 0.50,
-            "covered_lines": 2,
-            "lines_of_code": 4
-        },
-        ...
-    ],
-    "metrics": {
-          "covered_percent": 81.70731707317073,
-          "covered_strength": 0.8170731707317073,
-          "covered_lines": 67,
-          "total_lines": 82
-    }
+  "timestamp": 1348489587,
+  "command_name": "RSpec",
+  "files": [
+    {
+      "filename": "/home/user/rails/environment.rb",
+      "covered_percent": 50.0,
+      "coverage": [
+        null,
+        1,
+        null,
+        null,
+        1
+      ],
+      "covered_strength": 0.50,
+      "covered_lines": 2,
+      "lines_of_code": 4
+    },
+  ],
+  "metrics": {
+    "covered_percent": 81.70731707317073,
+    "covered_strength": 0.8170731707317073,
+    "covered_lines": 67,
+    "total_lines": 82
+  }
 }
 ```
 
@@ -61,4 +64,4 @@ If you want to contribute, please:
 
 ## Copyright
 
-Copyright (c) 2013 Mikael Llongo. See LICENSE for details.
+Copyright (c) 2020 Mikael Henriksson. See LICENSE for details.

data/lib/simple_cov/formatter/format_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  #
+  # Module FormatResult uses Oj to dup the result to the configured output path
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module FormatResult
+    def self.call(result, output_file_path)
+      data = SimpleCov::Oj::ResultToHash.new(result).to_h
+      json = ::Oj.dump(data, mode: :compat)
+
+      File.open(output_file_path, 'w+') do |file|
+        file.puts json
+      end
+
+      json
+    end
+  end
+end

data/lib/simple_cov/formatter/oj_formatter.rb

@@ -12,7 +12,8 @@ module SimpleCov
     class OjFormatter
       #
       # @return [String] name of the file with coverage.json data
-      FILE_NAME = "coverage.json"
+      FILE_NAME = 'coverage.json'
+      OUTPUT_FILE_PATH = File.join(SimpleCov.coverage_path, FILE_NAME)
 
       #
       # Formats the result as a hash, dump it to json with Oj and then save it to disk
@@ -22,35 +23,11 @@ module SimpleCov
       # @return [<type>] <description>
       #
       def format(result)
-        json = dump_json(result)
-        puts SimpleCov::Oj::OutputMessage.new(result, output_filepath)
+        json = SimpleCov::FormatResult.call(result, OUTPUT_FILE_PATH)
+        puts SimpleCov::Oj::OutputMessage.new(result, OUTPUT_FILE_PATH)
 
         json
       end
-
-      private
-
-      # @private
-      def dump_json(result)
-        data = SimpleCov::Oj::ResultToHash.new(result).to_h
-        json = ::Oj.dump(data, mode: :compat)
-
-        File.open(output_filepath, "w+") do |file|
-          file.puts json
-        end
-
-        json
-      end
-
-      # @private
-      def output_filename
-        FILE_NAME
-      end
-
-      # @private
-      def output_filepath
-        File.join(SimpleCov.coverage_path, output_filename)
-      end
     end
   end
 end

data/lib/simple_cov/oj/output_message.rb

@@ -26,7 +26,7 @@ module SimpleCov
       # @return [String]
       #
       def to_s
-        "Coverage report generated" \
+        'Coverage report generated' \
         " for #{command_name}" \
         " to #{output_filepath}." \
         " #{covered_lines} / #{total_lines} LOC (#{covered_percent.round(2)}%) covered."

data/lib/simple_cov/oj/result_to_hash.rb

@@ -18,7 +18,7 @@ module SimpleCov
         @data = {
           timestamp: result.created_at.to_i,
           command_name: result.command_name,
-          files: [],
+          files: []
         }
       end
 

data/lib/simple_cov/oj/result_wrapper.rb

@@ -29,7 +29,7 @@ module SimpleCov
           covered_percent: covered_percent,
           covered_strength: covered_strength,
           covered_lines: covered_lines,
-          total_lines: total_lines,
+          total_lines: total_lines
         }
       end
 

data/lib/simple_cov/oj/source_file_wrapper.rb

@@ -39,11 +39,18 @@ module SimpleCov
 
       # @private
       def coverage_data
-        if SimpleCov::SourceFile.instance_methods.include?(:coverage_data)
-          source_file.coverage_data
-        else
-          source_file.coverage
-        end
+        return coverage if coverage.is_a?(Array)
+
+        coverage.transform_keys(&:to_sym)[:lines]
+      end
+
+      def coverage
+        @coverage ||=
+          if SimpleCov::SourceFile.instance_methods.include?(:coverage_data)
+            source_file.coverage_data
+          else
+            source_file.coverage
+          end
       end
 
       # @private

data/lib/simple_cov/oj/version.rb

@@ -9,6 +9,6 @@ module SimpleCov
   module Oj
     #
     # @return [String] the current version of the gem
-    VERSION = "0.18.0"
+    VERSION = '0.21.0'
   end
 end

data/lib/simplecov-oj.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "simplecov"
-require "oj"
+require 'simplecov'
+require 'oj'
 
-require "simple_cov/oj/result_wrapper"
-require "simple_cov/oj/source_file_wrapper"
-require "simple_cov/oj/result_to_hash"
-require "simple_cov/oj/result_to_hash"
-require "simple_cov/oj/output_message"
-require "simple_cov/oj/version"
-require "simple_cov/formatter/oj_formatter"
+require 'simple_cov/oj/result_wrapper'
+require 'simple_cov/oj/source_file_wrapper'
+require 'simple_cov/oj/result_to_hash'
+require 'simple_cov/oj/output_message'
+require 'simple_cov/oj/version'
+require 'simple_cov/formatter/format_result'
+require 'simple_cov/formatter/oj_formatter'

data/lib/tasks/changelog.rake

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-desc "Generate a Changelog"
+desc 'Generate a Changelog'
 task :changelog do
   # rubocop:disable Style/MutableConstant
   CHANGELOG_CMD ||= %w[
@@ -13,12 +13,12 @@ task :changelog do
     simplecov-oj
     --token
   ]
-  ADD_CHANGELOG_CMD      ||= "git add --all"
-  COMMIT_CHANGELOG_CMD   ||= "git commit -a -m 'Update changelog'"
+  ADD_CHANGELOG_CMD ||= 'git add --all'
+  COMMIT_CHANGELOG_CMD ||= "git commit -a -m 'Update changelog'"
   # rubocop:enable Style/MutableConstant
 
-  sh("git checkout master")
-  sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
+  sh('git checkout master')
+  sh(*CHANGELOG_CMD.push(ENV['CHANGELOG_GITHUB_TOKEN']))
   sh(ADD_CHANGELOG_CMD)
   sh(COMMIT_CHANGELOG_CMD)
 end

data/spec/simple_cov/formatter/oj_formatter_spec.rb

@@ -1,18 +1,47 @@
 # frozen_string_literal: true
 
 RSpec.describe SimpleCov::Formatter::OjFormatter do
-  let(:formatter)     { described_class.new }
-  let(:result)        { instance_double(SimpleCov::Result) }
-  let(:command_name)  { "RSpec" }
-  let(:created_at)    { Time.now.to_s }
-  let(:foo)           { instance_double(SimpleCov::SourceFile) }
-  let(:foo_line_list) { instance_double(Array) }
-  let(:bar)           { instance_double(SimpleCov::SourceFile) }
-  let(:bar_line_list) { instance_double(Array) }
+  let(:formatter)         { described_class.new }
+  let(:result)            { instance_double(SimpleCov::Result) }
+  let(:command_name)      { 'RSpec' }
+  let(:created_at)        { Time.now.to_s }
+  let(:foo)               { instance_double(SimpleCov::SourceFile) }
+  let(:foo_line_list)     { instance_double(Array) }
+  let(:foo_coverage_data) { [1, nil, 0, 0, nil, 1, nil] }
+  let(:bar)               { instance_double(SimpleCov::SourceFile) }
+  let(:bar_line_list)     { instance_double(Array) }
+  let(:bar_coverage_data) { [nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil] }
 
-  describe "#format" do
+  describe '#format' do
     subject(:format) { formatter.format(result) }
 
+    let(:expected_hash) do
+      {
+        'timestamp' => created_at.to_i,
+        'command_name' => 'RSpec',
+        'files' => [
+          { 'filename' => '/lib/foo.rb',
+            'covered_percent' => 50.0,
+            'coverage' => [1, nil, 0, 0, nil, 1, nil],
+            'covered_strength' => 0.50,
+            'covered_lines' => 2,
+            'lines_of_code' => 4 },
+          { 'filename' => '/lib/bar.rb',
+            'covered_percent' => 71.42,
+            'coverage' => [nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil],
+            'covered_strength' => 0.71,
+            'covered_lines' => 5,
+            'lines_of_code' => 7 }
+        ],
+        'metrics' => {
+          'covered_percent' => 73.33,
+          'covered_strength' => 0.87,
+          'covered_lines' => 11,
+          'total_lines' => 15
+        }
+      }.to_json
+    end
+
     before do
       allow(result).to receive(:created_at).and_return(created_at)
       allow(result).to receive(:command_name).and_return(command_name)
@@ -20,15 +49,15 @@ RSpec.describe SimpleCov::Formatter::OjFormatter do
       allow(result).to receive(:covered_percent).and_return(73.33)
       allow(result).to receive(:covered_strength).twice.and_return(0.87)
       allow(result).to receive(:files).and_return([foo, bar])
-      allow(result).to receive(:filenames).twice.and_return(["/lib/foo.rb", "/lib/bar.rb"])
+      allow(result).to receive(:filenames).twice.and_return(['/lib/foo.rb', '/lib/bar.rb'])
       allow(result).to receive(:total_lines).and_return(15)
 
-      allow(foo).to receive(:filename).twice.and_return("/lib/foo.rb")
+      allow(foo).to receive(:filename).twice.and_return('/lib/foo.rb')
       allow(foo).to receive(:covered_percent).and_return(50.0)
       if SimpleCov::SourceFile.instance_methods.include?(:coverage_data)
-        allow(foo).to receive(:coverage_data).and_return([1, nil, 0, 0, nil, 1, nil])
+        allow(foo).to receive(:coverage_data).and_return(foo_coverage_data)
       else
-        allow(foo).to receive(:coverage).and_return([1, nil, 0, 0, nil, 1, nil])
+        allow(foo).to receive(:coverage).and_return(foo_coverage_data)
       end
       allow(foo).to receive(:covered_strength).twice.and_return(0.50)
       allow(foo).to receive(:covered_lines).and_return(foo_line_list)
@@ -36,12 +65,12 @@ RSpec.describe SimpleCov::Formatter::OjFormatter do
 
       allow(foo_line_list).to receive(:count).and_return(2)
 
-      allow(bar).to receive(:filename).twice.and_return("/lib/bar.rb")
+      allow(bar).to receive(:filename).twice.and_return('/lib/bar.rb')
       allow(bar).to receive(:covered_percent).and_return(71.42)
       if SimpleCov::SourceFile.instance_methods.include?(:coverage_data)
-        allow(bar).to receive(:coverage_data).and_return([nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil])
+        allow(bar).to receive(:coverage_data).and_return(bar_coverage_data)
       else
-        allow(bar).to receive(:coverage).and_return([nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil])
+        allow(bar).to receive(:coverage).and_return(bar_coverage_data)
       end
       allow(bar).to receive(:covered_strength).twice.and_return(0.71)
       allow(bar).to receive(:covered_lines).and_return(bar_line_list)
@@ -50,31 +79,13 @@ RSpec.describe SimpleCov::Formatter::OjFormatter do
       allow(bar_line_list).to receive(:count).and_return(5)
     end
 
-    it "formats json nicely" do
-      expect(format).to eq({
-        "timestamp" => created_at.to_i,
-        "command_name" => "RSpec",
-        "files" => [
-          { "filename" => "/lib/foo.rb",
-            "covered_percent" => 50.0,
-            "coverage" => [1, nil, 0, 0, nil, 1, nil],
-            "covered_strength" => 0.50,
-            "covered_lines" => 2,
-            "lines_of_code" => 4 },
-          { "filename" => "/lib/bar.rb",
-            "covered_percent" => 71.42,
-            "coverage" => [nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil],
-            "covered_strength" => 0.71,
-            "covered_lines" => 5,
-            "lines_of_code" => 7 },
-        ],
-        "metrics" => {
-          "covered_percent" => 73.33,
-          "covered_strength" => 0.87,
-          "covered_lines" => 11,
-          "total_lines" => 15,
-        },
-      }.to_json)
+    it { is_expected.to be_json_eql(expected_hash) }
+
+    context 'when coverage_data is a hash with the key `lines:`' do
+      let(:foo_coverage_data) { { lines: [1, nil, 0, 0, nil, 1, nil] } }
+      let(:bar_coverage_data) { { lines: [nil, 1, nil, 1, 1, 1, 0, 0, nil, 1, nil] } }
+
+      it { is_expected.to be_json_eql(expected_hash) }
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
-require "simplecov-oj"
-require "pry"
+require 'bundler/setup'
+require 'simplecov'
+
+require 'pry'
+require 'rspec'
+require 'json_spec'
+
+require 'simplecov-oj'
+
+RSpec.configure do |config|
+  config.include JsonSpec::Helpers
+end
 
 RSpec.configure do |config|
   config.define_derived_metadata do |meta|
@@ -18,10 +28,10 @@ RSpec.configure do |config|
 
   config.shared_context_metadata_behavior = :apply_to_host_groups
   config.filter_run_when_matching :focus
-  config.example_status_persistence_file_path = "spec/.rspec-status"
+  config.example_status_persistence_file_path = 'spec/.rspec-status'
   config.disable_monkey_patching!
   config.warnings = true
-  config.default_formatter = "doc" if config.files_to_run.one?
+  config.default_formatter = 'doc' if config.files_to_run.one?
   config.profile_examples = 10
   config.order = :random
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-oj
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Mikael Henriksson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -39,7 +39,7 @@ dependencies:
         version: '0.14'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '0.14'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  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
@@ -121,33 +135,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: github-markup
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: github_changelog_generator
+  name: github-markup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +188,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/simple_cov/formatter/format_result.rb
 - lib/simple_cov/formatter/oj_formatter.rb
 - lib/simple_cov/oj/output_message.rb
 - lib/simple_cov/oj/result_to_hash.rb
@@ -193,23 +208,23 @@ metadata:
   documentation_uri: https://mhenrixon.github.io/simplecov-oj
   source_code_uri: https://github.com/mhenrixon/simplecov-oj
   changelog_uri: https://github.com/mhenrixon/simplecov-oj/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Oj formatter for SimpleCov code coverage tool for ruby 2.4+
 test_files: