blood_contracts-instrumentation 0.1.0

data/lib/blood_contracts/instrumentation/session_recording.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module BloodContracts
+  module Instrumentation
+    # Prependable module for matching session recording
+    module SessionRecording
+      # Adds @session initialization to constructor
+      def initialize(*)
+        super
+        self.class.instruments
+        @session = self.class.session_klass.new(self.class.name)
+      end
+
+      # Wrapper for BC::Refined#match call, to add instrumentaion
+      # Usage:
+      #   class JsonType < BC::Refined
+      #     # now during #match call you will have access to @session
+      #     prepend BloodContracts::Instrumentation::Match
+      #
+      #     def match
+      #       context[:parsed] = JSON.parse(value.to_s)
+      #       self
+      #     end
+      #   end
+      module Match
+        # Wraps original call in session start and finish call
+        # Note that @session.finish(result) is called even when
+        # exception was raised during the call
+        #
+        # @return [BC::Refined]
+        #
+        def match
+          @session.start
+          self.class.instruments.each { |i| i.before(@session) }
+
+          result = super
+        rescue StandardError => e
+          result = FailedMatch.new(e, context: @context)
+          raise e
+        ensure
+          finalize!(result)
+        end
+
+        # Finish the matching session and delegate finalize to SessionFinalizer
+        #
+        # @param result [BC::Refined] result of type matching pipeline
+        #
+        # @return [Nothing]
+        #
+        def finalize!(result)
+          @session.finish(result)
+          self.class.instruments.each { |i| i.after(@session) }
+          SessionFinalizer.instance.finalize!(self.class.instruments, @session)
+        end
+      end
+
+      # Modification to inheritance for the session recording
+      module Inheritance
+        # Register the inherited type and set the session klass same as parent
+        #
+        # @param child [BC::Refined] class to enhance
+        #
+        # @return [Nothing]
+        #
+        def inherited(child)
+          child.session_klass = session_klass
+          Instrumentation.register_type(child)
+          super
+        end
+      end
+
+      # Modifications in singleton class of BC::Refined
+      #
+      # @param other [BC::Refined] class to enhance
+      #
+      # rubocop:disable Metrics/MethodLength
+      def self.prepended(other)
+        class << other
+          prepend Inheritance
+
+          # Class to use as a session (writer)
+          #
+          # @return [Session]
+          #
+          attr_writer :session_klass
+
+          # Class to use as a session
+          # By default is set to Session
+          #
+          # @return [Session]
+          #
+          def session_klass
+            @session_klass ||= Session
+          end
+
+          # Whether type anonymous or not
+          #
+          # @return [Boolean]
+          #
+          def anonymous?
+            name.nil?
+          end
+
+          # List of instruments for the type
+          #
+          # @return [Array<Instrument>]
+          #
+          def instruments
+            return @instruments if defined? @instruments
+
+            reset_instruments!
+          end
+
+          # Alias for instruments reader
+          # See #instruments
+          alias setup_instruments instruments
+
+          # Reset the List of instruments for the type
+          # Note, that if list of instruments is empty there is no need to
+          # init the session, so type is not prepended by Match wrapper
+          #
+          # @return [Array<Instrument>]
+          #
+          def reset_instruments!
+            @instruments = Instrumentation.select_instruments(name)
+          ensure
+            prepend(Match) unless @instruments.empty?
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/spec/blood_contracts/instrumentation_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+RSpec.describe BloodContracts::Instrumentation do
+  before do
+    module Test
+      require "json"
+
+      class EmailType < BC::Refined
+        REGEX = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+        def match
+          context[:email_input] = value.to_s
+          return failure(:invalid_email) if context[:email_input] !~ REGEX
+          context[:email] = context[:email_input]
+          self
+        end
+      end
+
+      class JsonType < BC::Refined
+        def match
+          context[:parsed] = JSON.parse(value.to_s)
+          self
+        end
+      end
+    end
+  end
+
+  describe ".configure" do
+    subject do
+      described_class.configure { |cfg| cfg.finalizer_pool_size = 5 }
+    end
+
+    it do
+      is_expected.to eq(described_class.config)
+      expect(subject.finalizer_pool_size).to eq(5)
+    end
+  end
+
+  describe ".register_type" do
+    before { described_class.register_type(Test::JsonType) }
+
+    subject { described_class.config }
+
+    it { expect(subject.types).to include(Test::JsonType) }
+  end
+
+  describe ".select_instruments" do
+    before do
+      described_class.configure do |cfg|
+        cfg.instrument "Json", lambda { |session|
+          puts "[SID:#{session.id}] #{session.result_type_name}"
+        }
+      end
+    end
+
+    subject { described_class.select_instruments(type) }
+
+    context "when type matches instruments condition" do
+      let(:type) { Test::JsonType.name }
+
+      it { is_expected.to match_array([kind_of(described_class::Instrument)]) }
+    end
+
+    context "when type doesn't match instruments condition" do
+      let(:type) { Test::EmailType.name }
+
+      it { is_expected.to be_empty }
+    end
+  end
+
+  describe ".reset_session_finalizer!" do
+    before do
+      described_class.configure { |cfg| cfg.session_finalizer = :fibers }
+      old_finalizer
+    end
+
+    let(:old_finalizer) { described_class::SessionFinalizer.instance }
+
+    subject { described_class.reset_session_finalizer! }
+
+    it { is_expected.not_to eq(old_finalizer) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "blood_contracts/instrumentation"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.around do |example|
+    module Test; end
+    example.run
+    Object.send(:remove_const, :Test)
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: blood_contracts-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Dolganov (sclinede)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blood_contracts-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: Adds instrumentation to BloodContracts refinement types
+email:
+- sclinede@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CODE_OF_CONDUCT.md
+- README.md
+- CHANGELOG.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blood_contracts-instrumentation.gemspec
+- lib/blood_contracts-instrumentation.rb
+- lib/blood_contracts/instrumentation.rb
+- lib/blood_contracts/instrumentation/config.rb
+- lib/blood_contracts/instrumentation/failed_match.rb
+- lib/blood_contracts/instrumentation/instrument.rb
+- lib/blood_contracts/instrumentation/session.rb
+- lib/blood_contracts/instrumentation/session_finalizer.rb
+- lib/blood_contracts/instrumentation/session_finalizer/basic.rb
+- lib/blood_contracts/instrumentation/session_finalizer/fibers.rb
+- lib/blood_contracts/instrumentation/session_finalizer/threads.rb
+- lib/blood_contracts/instrumentation/session_recording.rb
+- spec/blood_contracts/instrumentation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sclinede/blood_contracts-core
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Adds instrumentation to BloodContracts refinement types
+test_files:
+- spec/blood_contracts/instrumentation_spec.rb
+- spec/spec_helper.rb