oneshot_coverage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d13259ff2122dd7ddb6bf748ce5157dd83838b0f5168586e8c68f1d885a1a1de
+  data.tar.gz: abf0ef7744a4526f1c341a2009c71589023c4b42e2dbc97c7a894454ba0ce38a
+SHA512:
+  metadata.gz: 3bb1fdcf50628043fccdc2f6e0bebf0c827da063e5ba3e81bcb61757ae295ab1dc93fa05c0d0937999f515b61484ae897f59f3f093878343228c0e8f93629c1b
+  data.tar.gz: c84d545d172b17108f6539d224be37f6ba81e8059dab842847374123fa1f00bb81d518221d1a0f4768eeea6338e0664cf862262c51d64bdcd428f9d3133a46f3

data/.gitignore

@@ -0,0 +1,95 @@
+# Created by https://www.gitignore.io/api/osx,ruby
+# Edit at https://www.gitignore.io/?templates=osx,ruby
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/osx,ruby
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sangyong-sim@cookpad.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in oneshot_coverage.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    oneshot_coverage (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  oneshot_coverage!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sangyong Sim
+
+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,84 @@
+# OneshotCoverage
+
+This gem is not very useful when you want to use oneshot coverage,
+however, It could be good example to implement it by yourself.
+
+This gem is to provide simple tools to use OneshotCoverage easier. It will log
+files under the target path(usually, project base path).
+In other word, This gem do not log codes under bundler gem path(if exist).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oneshot_coverage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oneshot_coverage
+
+## Usage
+
+### Configuration
+
+```ruby
+OneshotCoverage.configure(
+  target_path: '/base/project/path',
+  logger: OneshotCoverage::Logger::NullLogger.new,
+)
+OneshotCoverage.start
+```
+
+As default, OneshotCoverage supports 2 logger.
+
+- OneshotCoverage::Logger::NullLogger (default)
+- OneshotCoverage::Logger::StdoutLogger
+
+Only required interface is `#post` instance method, so you could implement
+by yourself easily.
+
+```ruby
+class SampleFluentLogger
+  def initialize
+    @logger = Fluent::Logger::FluentLogger.new('tag_prefix')
+  end
+
+  def post(path:, md5_hash:, lineno:)
+    @logger.post(nil, path: path, md5_hash: md5_hash, lineno: lineno)
+  end
+end
+```
+
+### Emit logs
+
+#### With rack application
+
+Please use `OneshotCoverage::Middleware`. This will emit logs per each request.
+
+If you using Rails, below is enough.
+
+```
+require 'oneshot_coverage/railtie'
+```
+
+### With job or batch application
+
+If your job or batch are exit as soon as it finished(i.e. execute via rails runner),
+then you don't need to do anything. `OneshotCoverage.start` will set trap
+to emit via `at_exit`.
+On the other hand, it's not, then you need to emit it manually
+at proper timing(i.e. when batch finished)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OneshotCoverage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/riseshia/oneshot_coverage/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oneshot_coverage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oneshot_coverage.rb

@@ -0,0 +1,95 @@
+require "coverage"
+require "digest/md5"
+
+require "oneshot_coverage/logger/null_logger"
+require "oneshot_coverage/railtie" if defined?(Rails)
+
+module OneshotCoverage
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    ensure
+      if Coverage.running?
+        OneshotCoverage.emit
+      end
+    end
+  end
+
+  class Reporter
+    def initialize(target_path:, logger:)
+      @target_path = target_path
+      @logger = logger
+      if defined?(Bundler)
+        @bundler_path = Bundler.bundle_path.to_s
+      end
+    end
+
+    def emit
+      Coverage.result(clear: true, stop: false).
+        select { |k, v| is_target?(k, v) }.
+        flat_map { |k, v| transform(k, v) }.
+        each { |row| @logger.post(row) }
+    end
+
+    def is_target?(filepath, value)
+      return false if value[:oneshot_lines].empty?
+      return false if !filepath.start_with?(@target_path)
+      return false if @bundle_path && !filepath.start_with?(@bundler_path)
+      true
+    end
+
+    def transform(filepath, value)
+      rel_path = filepath[@target_path.size..]
+      md5_hash =
+        if md5_hash_cache.key?(filepath)
+          md5_hash_cache[filepath]
+        else
+          md5_hash_cache[filepath] = Digest::MD5.file(filepath).hexdigest
+        end
+
+      value[:oneshot_lines].map do |line|
+        {
+          path: rel_path,
+          md5_hash: md5_hash,
+          lineno: line
+        }
+      end
+    end
+
+    def md5_hash_cache
+      @md5_hash_cache ||= {}
+    end
+  end
+
+  module_function
+
+  def start
+    Coverage.start(oneshot_lines: true)
+
+    # To handle execution with exit immediatly
+    at_exit do
+      OneshotCoverage.emit
+    end
+  end
+
+  def emit
+    @reporter&.emit
+  end
+
+  def configure(target_path:, logger: OneshotCoverage::Logger::NullLogger.new)
+    target_path_by_pathname =
+      if target_path.is_a? Pathname
+        target_path
+      else
+        Pathname.new(target_path)
+      end
+    @reporter = OneshotCoverage::Reporter.new(
+      target_path: target_path_by_pathname.cleanpath.to_s + "/",
+      logger: logger,
+    )
+  end
+end

data/lib/oneshot_coverage/logger/null_logger.rb

@@ -0,0 +1,9 @@
+module OneshotCoverage
+  module Logger
+    class NullLogger
+      def post(_row)
+        # Do nothing
+      end
+    end
+  end
+end

data/lib/oneshot_coverage/logger/stdout_logger.rb

@@ -0,0 +1,11 @@
+module OneshotCoverage
+  module Logger
+    class StdoutLogger
+      def post(path:, md5_hash:, lineno:)
+        $stdout.puts(
+          "[OneshotCoverage] logged path: #{path}, md5_hash: #{md5_hash}, lineno: #{lineno}"
+        )
+      end
+    end
+  end
+end

data/lib/oneshot_coverage/railtie.rb

@@ -0,0 +1,11 @@
+unless defined? Rails::Railtie
+  raise "You need to install and require Rails to use this integration"
+end
+
+module OneshotCoverage
+  class Railtie < Rails::Railtie
+    initializer 'oneshot_coverage.configure' do |app|
+      app.middleware.use OneshotCoverage::Middleware
+    end
+  end
+end

data/lib/oneshot_coverage/version.rb

@@ -0,0 +1,3 @@
+module OneshotCoverage
+  VERSION = "0.1.0"
+end

data/oneshot_coverage.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "oneshot_coverage/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oneshot_coverage"
+  spec.version       = OneshotCoverage::VERSION
+  spec.authors       = ["Shia"]
+  spec.email         = ["rise.shia@gmail.com"]
+
+  spec.summary       = %q{Simple toolbox for oneshot coverage}
+  spec.description   = %q{OneshotCoverage will help you to measure oneshot coverage on production}
+  spec.homepage      = "https://github.com/riseshia/oneshot_coverage"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/riseshia/oneshot_coverage"
+    spec.metadata["changelog_uri"] = "https://github.com/riseshia/oneshot_coverage"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.6.1'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: oneshot_coverage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: OneshotCoverage will help you to measure oneshot coverage on production
+email:
+- rise.shia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oneshot_coverage.rb
+- lib/oneshot_coverage/logger/null_logger.rb
+- lib/oneshot_coverage/logger/stdout_logger.rb
+- lib/oneshot_coverage/railtie.rb
+- lib/oneshot_coverage/version.rb
+- oneshot_coverage.gemspec
+homepage: https://github.com/riseshia/oneshot_coverage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riseshia/oneshot_coverage
+  source_code_uri: https://github.com/riseshia/oneshot_coverage
+  changelog_uri: https://github.com/riseshia/oneshot_coverage
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Simple toolbox for oneshot coverage
+test_files: []