blood_contracts-instrumentation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a1ff83954224dfbb24664768832c7db0e4b621364a92de707c3b1774fbc9e30
+  data.tar.gz: e271b417bdd7082067d91faf6826d91c0f13f5e2f3f01068ddba0a23af3edf8c
+SHA512:
+  metadata.gz: d6c19029329fbf97adbea0fe440b0951c2ac6f9dd251ba4bf0c2e93d40421e9a823e9f5445c3483f4b78a4f3f23a5827bfa42406757d27f8d82264dbb660a66d
+  data.tar.gz: bdb1e16379fd159cff96592bff34fd0ed43182bf8da38720acc3a0bf4e759ee0fe78ba746f84a7fcdf7f5dea2f19463c32f68b11e1c5589c776b8abcb56a51f3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+---
+
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.4
+  Exclude:
+    - examples/*
+    - blood_contracts-instrumentation.gemspec
+    - vendor/bundle/**/*
+
+Metrics/LineLength:
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Exclude:
+    - lib/blood_contracts-instrumentation.rb

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - [2019-07-05]
+
+This is a first public release marked in change log with features extracted from production app.
+Includes:
+TBD

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 sclinede@gmail.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 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blood_contracts-monitoring.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey Dolganov
+
+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,51 @@
+[![Build Status](https://travis-ci.org/sclinede/blood_contracts-instrumentation.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/sclinede/blood_contracts-instrumentation/badges/gpa.svg)][codeclimate]
+[![Inch CI](https://inch-ci.org/github/sclinede/blood_contracts-instrumentation.svg?branch=master)][inch_ci]
+
+[gem]: https://rubygems.org/gems/blood_contracts-instrumentation
+[travis]: https://travis-ci.org/sclinede/blood_contracts-instrumentation
+[codeclimate]: https://codeclimate.com/github/sclinede/blood_contracts-instrumentation
+[inch_ci]: https://inch-ci.org/github/sclinede/blood_contracts-instrumentation
+
+
+# BloodContracts::Instrumentation
+
+...WIP...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blood_contracts-monitoring'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blood_contracts-monitoring
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sclinede/blood_contracts-monitoring. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 BloodContracts::Monitoring project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sclinede/blood_contracts-monitoring/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "blood_contracts/monitoring"
+
+# 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/blood_contracts-instrumentation.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |gem|
+  gem.name          = 'blood_contracts-instrumentation'
+  gem.version       = '0.1.0'
+  gem.authors       = ['Sergey Dolganov (sclinede)']
+  gem.email         = ['sclinede@evilmartians.com']
+
+  gem.summary       = 'Adds instrumentation to BloodContracts refinement types'
+  gem.description   = 'Adds instrumentation to BloodContracts refinement types'
+  gem.homepage      = 'https://github.com/sclinede/blood_contracts-core'
+  gem.license       = 'MIT'
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = gem.files.grep(/^spec/)
+  gem.extra_rdoc_files = Dir['CODE_OF_CONDUCT.md', 'README.md', 'LICENSE', 'CHANGELOG.md']
+
+  gem.required_ruby_version = '>= 2.4'
+
+  gem.add_runtime_dependency 'blood_contracts-core', '~> 0.4'
+
+  gem.add_development_dependency 'bundler', '~> 2.0'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubocop', '~> 0.49'
+end

data/lib/blood_contracts-instrumentation.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "blood_contracts/instrumentation.rb"

data/lib/blood_contracts/instrumentation.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "blood_contracts/core"
+require "securerandom"
+
+# Top-level scope for BloodContracts data validation and monitoring tools
+module BloodContracts
+  # Top-level interface for BloodContracts insturmentation
+  module Instrumentation
+    module_function
+
+    # Configure the instrumentation by modification of the Config object
+    #
+    # @yieldparam [Config]
+    #
+    # @return [Config]
+    #
+    def configure
+      config.tap { |c| yield c }
+    end
+
+    # Register type in the config
+    #
+    # @param type [BC::Refined] which added to the registry
+    #
+    # @return [Nothing]
+    #
+    def register_type(type)
+      config.types << type
+      type.reset_instruments! unless type.anonymous?
+    end
+
+    # Select instruments for the type
+    #
+    # @param type_name [String] used to filter the instruments
+    #
+    # @return [Array<Instrument>]
+    #
+    def select_instruments(type_name)
+      config.send(:select_instruments, type_name)
+    end
+
+    # Resets current instance of Session finalizer
+    #
+    # @return [#finalize!]
+    #
+    def reset_session_finalizer!
+      config.send(:reset_session_finalizer!)
+    end
+
+    # Instrumentation config
+    #
+    # @return [Config]
+    #
+    def config
+      @config ||= Config.new
+    end
+
+    require_relative "./instrumentation/failed_match.rb"
+    require_relative "./instrumentation/session.rb"
+
+    require_relative "./instrumentation/instrument.rb"
+    require_relative "./instrumentation/session_finalizer.rb"
+    require_relative "./instrumentation/session_recording.rb"
+    BC::Refined.prepend(SessionRecording)
+
+    require_relative "./instrumentation/config.rb"
+  end
+end
+
+# Alias for top-level BloodContracts instrumentation
+BCI = BloodContracts::Instrumentation

data/lib/blood_contracts/instrumentation/config.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "set"
+
+module BloodContracts
+  module Instrumentation
+    # Class that configures the instrumentation for refinement types matching
+    class Config
+      # Map of instrument classes where the key is the matching pattern
+      #
+      # @return [Hash<Regexp, Array<Instrument>>]
+      #
+      attr_reader :instruments
+
+      # List of refinement types defined in the app
+      #
+      # @return [Array<BC::Refined>]
+      #
+      attr_reader :types
+
+      # Pool size of finalizer instance
+      #
+      # @return [Integer]
+      #
+      attr_reader :finalizer_pool_size
+
+      # Type of finalizer instance
+      #
+      # @return [Symbol]
+      #
+      attr_reader :session_finalizer
+
+      # Initialize the config with default values
+      # Also inits the SessionFinalizer
+      def initialize
+        @instruments = {}
+        @finalizer_pool_size = SessionFinalizer::DEFAULT_POOL_SIZE
+        @session_finalizer = :basic
+
+        reset_types!
+        reset_session_finalizer!
+      end
+
+      # Set the pool size for SessionFinalizer (make sense only for
+      # SessionFinalizer::Fibers right now)
+      #
+      # @param value [Integer] size of finalizer fibers pool
+      # @return [Integer]
+      #
+      def finalizer_pool_size=(value)
+        @finalizer_pool_size = Integer(value)
+      ensure
+        reset_session_finalizer!
+      end
+
+      # Set the type of SessionFinalizer for instrumentation
+      # See SessionFinalizer::Basic, SessionFinalizer::Threads and
+      # SessionFinalizer::Fibers
+      #
+      # @param value [Symbol] name of SessionFinalizer, could be one of
+      #   :basic, :threads, :fibers
+      # @return [Symbol]
+      #
+      def session_finalizer=(value)
+        @session_finalizer = value
+      ensure
+        reset_session_finalizer!
+      end
+
+      # Main setting in the config
+      # Define an instument for Refinement Types, applies only to types
+      # matched by the pattern by type class name
+      #
+      # @param pattern [String, Regexp] defines which types to apply this
+      #   instrument
+      # @param processor [Proc, #call] defines the processor for insturmentation
+      #   session, during the finalize phase the processor#call method would be
+      #   called with Session instance as a parameter
+      #
+      # @option before [Proc, #call] defines a method that is called right
+      #   after Session#start inside matching process of the refinement type
+      # @option after [Proc, #call] defines a method that is called right
+      #   after Session#finish inside matching process of the refinement type
+      #
+      # @return [Nothing]
+      #
+      def instrument(pattern, processor, **kwargs)
+        pattern = /#{pattern}/i unless pattern.is_a?(Regexp)
+
+        old_value = @instruments[pattern].to_a
+        new_value = old_value << Instrument.build(processor, **kwargs)
+        @instruments[pattern] = new_value
+
+        reset_cache!(pattern)
+      end
+
+      # @protected
+      # Select only instruments matching the type_name
+      protected def select_instruments(type_name)
+        @instruments.flat_map do |pattern, instruments|
+          next unless type_name =~ /#{pattern}/i
+          instruments
+        end.compact
+      end
+
+      # @protected
+      # Reset instruments cache for refinement types that match filter
+      protected def reset_cache!(filter = nil)
+        filter = /#{filter}/i unless filter.is_a?(Regexp)
+
+        types.each { |type| type.reset_instruments! if type.name =~ filter }
+      end
+
+      # @protected
+      protected def reset_types!
+        @types = Set.new
+      end
+
+      # @protected
+      # Reset session finalizer instance using current config
+      protected def reset_session_finalizer!
+        SessionFinalizer.init(session_finalizer, pool_size: finalizer_pool_size)
+      end
+    end
+  end
+end