simplecov-sublime 0.21.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa51a66b96ac0fd6681bee07a33f0211954f7ccedad5dba69f17041288485fea
+  data.tar.gz: eaf18e111ca35e02049b811253d6b8f59191b84964ebf2ba3c5ec37795dbd6de
+SHA512:
+  metadata.gz: 06e9eb450cc7463f3de667850f93cc678510b0ba3b5452ba4c5fb9fe487bb814e0863d8e2652caefbff5d326275aeedc260e4d7d56963696b80d5175dd7aa2e4
+  data.tar.gz: 3d55f80c37acb45d28e21c6d8a9e8ef47ad5ce98242d00c7bba746ac37e8fbd44a7c4c6e1fa567ec487e49c158d824c31785769c1d7eced133d467e3de26915e

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010-2020 Mikael Henriksson http://mhenrixon.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# simplecov-sublime
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/4da5beeb8233b5739e07/maintainability)](https://codeclimate.com/github/mhenrixon/simplecov-sublime/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/4da5beeb8233b5739e07/test_coverage)](https://codeclimate.com/github/mhenrixon/simplecov-sublime/test_coverage)
+
+JSON formatter for the ruby 2.5+ code coverage gem SimpleCov
+
+## Usage
+
+1. Add simplecov-sublime to your `Gemfile` and `bundle install`:
+
+```ruby
+gem 'simplecov-sublime', require: false, group: :test
+```
+
+2. Require simplecov-sublime and set it up as SimpleCov's formatter:
+
+```ruby
+require 'simplecov-sublime'
+SimpleCov.formatter = SimpleCov::Formatter::SublimeFormatter
+```
+
+## Result
+
+Generated JSON can be found in coverage/sublime.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
+  }
+}
+```
+
+## Making Contributions
+
+If you want to contribute, please:
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Send me a pull request on Github.
+  * Check that travis build passes for your pull request.
+
+
+## Copyright
+
+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 JSON to dump the result to the configured output path
+  #
+  # @author Mikael Henriksson <mikael@mhenrixon.com>
+  #
+  module FormatResult
+    def self.call(result, output_file_path)
+      data = SimpleCov::Sublime::ResultToHash.new(result).to_h
+      json = ::JSON.dump(data)
+
+      File.open(output_file_path, 'w+') do |file|
+        file.puts json
+      end
+
+      json
+    end
+  end
+end

data/lib/simple_cov/formatter/sublime_formatter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# @see SimpleCov https://github.com/colszowka/simplecov
+module SimpleCov
+  # @see SimpleCov::Formatter https://github.com/colszowka/simplecov
+  module Formatter
+    #
+    # Formats Simplecov Results into a json file `coverage.json`
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.se>
+    #
+    class SublimeFormatter
+      #
+      # @return [String] name of the file with coverage.json data
+      FILE_NAME = 'sublime.json'
+      OUTPUT_FILE_PATH = File.join(SimpleCov.coverage_path, FILE_NAME)
+
+      #
+      # Formats the result as a hash, dump it to json with JSON and then save it to disk
+      #
+      # @param [SimpleCov::Result] result
+      #
+      # @return [<type>] <description>
+      #
+      def format(result)
+        json = SimpleCov::FormatResult.call(result, OUTPUT_FILE_PATH)
+        puts SimpleCov::Sublime::OutputMessage.new(result, OUTPUT_FILE_PATH)
+
+        json
+      end
+    end
+  end
+end

data/lib/simple_cov/sublime/output_message.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Sublime
+    #
+    # Generates a nicely formatted string about generated coverage
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.se>
+    #
+    class OutputMessage
+      #
+      # Initialize a new OutputMessage
+      #
+      # @param [SimplCov::Result] result the final simplecov result
+      # @param [String] output_filepath path to the filename
+      #
+      def initialize(result, output_filepath)
+        @result          = result
+        @output_filepath = output_filepath
+      end
+
+      #
+      # Returns a nicely formatted string about the generated coverage data
+      #
+      #
+      # @return [String]
+      #
+      def to_s
+        'Coverage report generated' \
+        " for #{command_name}" \
+        " to #{output_filepath}." \
+        " #{covered_lines} / #{total_lines} LOC (#{covered_percent.round(2)}%) covered."
+      end
+      alias inspect to_s
+
+      private
+
+      attr_reader :result, :output_filepath
+
+      def command_name
+        result.command_name
+      end
+
+      def covered_lines
+        result.total_lines
+      end
+
+      def total_lines
+        result.total_lines
+      end
+
+      def covered_percent
+        result.covered_percent
+      end
+    end
+  end
+end

data/lib/simple_cov/sublime/result_to_hash.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Sublime
+    #
+    # Massage result into a hash that can be dumped to json by OJ
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.se>
+    #
+    class ResultToHash
+      #
+      # Initialize a new ResultToHash
+      #
+      # @param [SimpleCov::Result] result the final result from simplecov
+      #
+      def initialize(result)
+        @result = result
+        @data = {
+          timestamp: result.created_at.to_i,
+          command_name: result.command_name,
+          files: []
+        }
+      end
+
+      #
+      # Create a hash from the result that can be used for JSON dumping
+      #
+      #
+      # @return [Hash]
+      #
+      def to_h
+        extract_files
+        extract_metrics
+        data
+      end
+
+      private
+
+      attr_reader :result, :data
+
+      # @private
+      def extract_files
+        data[:files] = source_file_collection
+      end
+
+      # @private
+      def source_file_collection
+        result.files.each_with_object([]) do |source_file, memo|
+          next unless result.filenames.include?(source_file.filename)
+
+          memo << SourceFileWrapper.new(source_file).to_h
+        end
+      end
+
+      # @private
+      def extract_metrics
+        data[:metrics] = ResultWrapper.new(result).to_h
+      end
+    end
+  end
+end

data/lib/simple_cov/sublime/result_wrapper.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Sublime
+    #
+    # Representation of the simplecov result including it's coverage data, source code,
+    # source lines and featuring helpers to interpret that data.
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class ResultWrapper
+      #
+      # Wrap the SimpleCov::Result to enable hash conversion without monkey patching
+      #
+      # @param [SimpleCov::Result] result the simplecov result to generate hash for
+      #
+      def initialize(result)
+        @result = result
+      end
+
+      #
+      # Returns a nicely formatted hash from the simplecov result data
+      #
+      #
+      # @return [Hash]
+      #
+      def to_h
+        {
+          covered_percent: covered_percent,
+          covered_strength: covered_strength,
+          covered_lines: covered_lines,
+          total_lines: total_lines
+        }
+      end
+
+      private
+
+      attr_reader :result
+
+      # @private
+      def covered_strength
+        return 0.0 unless (coverage = result.covered_strength)
+
+        coverage.nan? ? 0.0 : coverage
+      end
+
+      # @private
+      def covered_percent
+        result.covered_percent
+      end
+
+      # @private
+      def covered_lines
+        result.covered_lines
+      end
+
+      # @private
+      def total_lines
+        result.total_lines
+      end
+    end
+  end
+end

data/lib/simple_cov/sublime/source_file_wrapper.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  module Sublime
+    #
+    # Representation of a source file including it's coverage data, source code,
+    # source lines and featuring helpers to interpret that data.
+    #
+    # @author Mikael Henriksson <mikael@mhenrixon.com>
+    #
+    class SourceFileWrapper
+      #
+      # Wrap the SimpleCov::SourceFile to enable hash conversion without monkey patching
+      #
+      # @param [SimpleCov::SourceFile] source_file the source file to generate hash for
+      #
+      def initialize(source_file)
+        @source_file = source_file
+      end
+
+      #
+      # Returns a nicely formatted hash from the source file data
+      #
+      #
+      # @return [Hash]
+      #
+      def to_h
+        { filename: filename,
+          covered_percent: covered_percent,
+          coverage: coverage_data,
+          covered_strength: covered_strength,
+          covered_lines: covered_lines_count,
+          lines_of_code: lines_of_code }
+      end
+
+      private
+
+      attr_reader :source_file
+
+      # @private
+      def coverage_data
+        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
+      def covered_lines
+        source_file.covered_lines
+      end
+
+      # @private
+      def covered_lines_count
+        covered_lines.count
+      end
+
+      # @private
+      def covered_percent
+        source_file.covered_percent
+      end
+
+      # @private
+      def covered_strength
+        return 0.0 unless (coverage = source_file.covered_strength)
+
+        coverage.nan? ? 0.0 : coverage
+      end
+
+      # @private
+      def filename
+        source_file.filename
+      end
+
+      # @private
+      def lines_of_code
+        source_file.lines_of_code
+      end
+    end
+  end
+end

data/lib/simple_cov/sublime/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  #
+  # Module Sublime provides helpers for formatting coverage for the SimpleCov sublime plugin
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  module Sublime
+    #
+    # @return [String] the current version of the gem
+    VERSION = '0.21.0'
+  end
+end

data/lib/simplecov-sublime.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'json'
+
+require 'simple_cov/sublime/result_wrapper'
+require 'simple_cov/sublime/source_file_wrapper'
+require 'simple_cov/sublime/result_to_hash'
+require 'simple_cov/sublime/output_message'
+require 'simple_cov/sublime/version'
+require 'simple_cov/formatter/format_result'
+require 'simple_cov/formatter/sublime_formatter'

data/lib/tasks/changelog.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+desc 'Generate a Changelog'
+task :changelog do
+  # rubocop:disable Style/MutableConstant
+  CHANGELOG_CMD ||= %w[
+    github_changelog_generator
+    --no-verbose
+    --no-http-cache
+    --user
+    mhenrixon
+    --project
+    simplecov-sublime
+    --token
+  ]
+  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(ADD_CHANGELOG_CMD)
+  sh(COMMIT_CHANGELOG_CMD)
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-sublime
+version: !ruby/object:Gem::Version
+  version: 0.21.0
+platform: ruby
+authors:
+- Mikael Henriksson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 'Sublime  formatter for SimpleCov code coverage tool for ruby 2.5+
+
+  '
+email:
+- mikael@mhenrixon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/simple_cov/formatter/format_result.rb
+- lib/simple_cov/formatter/sublime_formatter.rb
+- lib/simple_cov/sublime/output_message.rb
+- lib/simple_cov/sublime/result_to_hash.rb
+- lib/simple_cov/sublime/result_wrapper.rb
+- lib/simple_cov/sublime/source_file_wrapper.rb
+- lib/simple_cov/sublime/version.rb
+- lib/simplecov-sublime.rb
+- lib/tasks/changelog.rake
+homepage: https://github.com/mhenrixon/simplecov-sublime
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mhenrixon/simplecov-sublime
+  bug_tracker_uri: https://github.com/mhenrixon/mhenrixon/issues
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key:
+specification_version: 4
+summary: Sublime formatter for SimpleCov code coverage tool for ruby 2.5+
+test_files: []