simple_contracts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2363b3f293eb320fc635695476d458706c6c163f502d81b0bf0dbf32547cc24
+  data.tar.gz: 9db7c767d18d88e6a65a1bfb29b77b28dbab386ac009535f95c53f618a8687e5
+SHA512:
+  metadata.gz: b68223981593a3685823bc85b7b95a97b69593c2de8069420ebeada6e0b17ffdb2d9fb67cc1a5255e4355500d675a623ba0aed808409047b03601c145ffbf4c2
+  data.tar.gz: 18effeed0def8ff7893e01858208d2333e03902e0f521f13d1a6544dba4f2d6705e516fe6b0796c01815a4d51772ef001e1f5ea10b607425735640c8c9dbba2c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 bibendi
+
+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,80 @@
+[![Build Status](https://travis-ci.com/bibendi/simple_contracts.svg?branch=master)](https://travis-ci.com/bibendi/simple_contracts)
+
+# SimpleContracts
+
+## Plain Old Ruby Object Implementation of Contract
+
+This project contains the most simple implementation of Contract written in Ruby (and maybe later in other languages).
+
+The Contract is inspired by Design by Contracts approach and pushes Fail Fast techinque further.
+
+So, Contract is a class with the only public method , that validates some action/behavior agains Contract Rules:
+ - Guarantees - the rules that SHOULD be valid for each check of behavior
+ - Expectations - list of all expected states that COULD be valid for the behavior check
+
+Contract validates, that:
+ - ALL Guarantees were met
+ - AT LEAST ONE Expectations was met
+
+Otherwise, Contract raises an exception with details, at least on what step behavior was broken.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_contracts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_contracts
+
+## Usage
+
+```ruby
+  class TwitterContract < SimpleContracts::Base
+    def initialize(post)
+      super
+      @post = post
+    end
+
+    private
+
+    def guarantee_verified_delete
+      return true if Twitter::REST::Client.statuses(@post.tweet_id).empty?
+      false
+    end
+
+    def expect_some_action1
+      ...
+    end
+
+    def expect_some_action2
+      ...
+    end
+
+    # ... other rules
+  end
+
+  @post = Post.find(params.require(:post_id))
+
+  # Use synchronously, (raises exception, "Fails Fast"™):
+  TwitterContract.(@post, async: false) { TwitterAPI.destroy(@post) }
+
+  # Use asynchronously (does not affect TwitterAPI.destroy,
+  # but tracks any problems with TwitterContract validation)
+  TwitterContract.(@post) { TwitterAPI.destroy(@post) }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bibendi/simple_contracts.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/simple_contracts.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "simple_contracts/version"
+require "simple_contracts/base"
+
+module SimpleContracts
+end

data/lib/simple_contracts/base.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require 'concurrent/future'
+require 'logger'
+
+require 'simple_contracts/sampler'
+require 'simple_contracts/statistics'
+
+# Base class for writting contracts.
+# the only public method is SimpleContracts::Base#call (or alias SimpleContracts::Base#match!)
+#
+# The purpose is to validate some action against your expectations.
+# There are 2 kind of them:
+# - Guarantee - state that SHOULD be recognized for after every the actions
+# - Expectation - state that COULD be recognized after the action
+#
+# The key behavior is:
+# - First verify that all Guarantees are met, then
+# - Then move to Expectation and verify that at least one of them met.
+# - If any of those checks fail - we should recieve detailed exception - why.
+#
+# There are 2 kind of exceptions:
+# - GuaranteeError - happens if one of the Guarantees failes
+# - ExpectationsError - happens if none of Expextations were meet.
+#
+# Both of them raise with the @meta object, which contains extra debugging info.
+module SimpleContracts
+  class GuaranteesError < StandardError; end
+  class ExpectationsError < StandardError; end
+
+  class Base
+    class << self
+      def call(*args, **kwargs)
+        new(*args, **kwargs).call { yield }
+      end
+
+      def guarantees_methods
+        @guarantees_methods ||= methods_with_prefix("guarantee_")
+      end
+
+      def expectations_methods
+        @expectations_methods ||= methods_with_prefix("expect_")
+      end
+
+      private
+
+      def methods_with_prefix(prefix)
+        private_instance_methods.
+          each_with_object([]) do |method_name, memo|
+            method_name = method_name.to_s
+            next unless method_name.start_with?(prefix)
+            memo << method_name
+          end.sort
+      end
+    end
+
+    def initialize(*args, async: nil, logger: nil, sampler: nil, stats: nil, **kwargs)
+      @async = async.nil? ? default_async : !!async
+      @sampler = sampler
+      @stats = stats
+      @logger = logger
+      @input = {args: args, kwargs: kwargs}
+      @meta = {checked: [], input: @input}
+    end
+
+    def call
+      return yield unless enabled?
+      @output = yield
+      @async ? verify_async : verify
+      @output
+    end
+
+    alias match! call
+
+    def serialize
+      Marshal.dump(input: @input, output: @output, meta: @meta)
+    end
+
+    def deserialize(state_dump)
+      Marshal.load(state_dump)
+    end
+
+    def contract_name
+      self.class.name
+    end
+
+    private
+
+    def default_async
+      true
+    end
+
+    def concurrent_options
+      {}
+    end
+
+    def call_matchers
+      match_guarantees!
+      match_expectations!
+    end
+
+    def verify
+      call_matchers
+    rescue StandardError => error
+      observe_errors(Time.now, nil, error)
+      raise
+    end
+
+    def verify_async
+      execute_async { call_matchers }
+    end
+
+    def execute_async
+      ::Concurrent::Future.
+        execute(concurrent_options) { yield }.
+        add_observer(self, :observe_errors)
+    end
+
+    def observe_errors(_time, _value, reason)
+      return unless reason
+
+      rule = rule_from_error(reason)
+      error = reason if rule == :unexpected_error
+
+      keep_meta(rule, error)
+    rescue StandardError => error
+      logger.error(error)
+      raise
+    end
+
+    def rule_from_error(error)
+      case error
+      when GuaranteesError
+        :guarantee_failure
+      when ExpectationsError
+        :expectation_failure
+      else
+        :unexpected_error
+      end
+    end
+
+    def keep_meta(rule, error = nil)
+      sample_path = sampler.sample!(rule)
+      meta = sample_path ? @meta.merge(sample_path: sample_path) : @meta
+      stats.log(rule, meta, error)
+    end
+
+    def sampler
+      @sampler ||= ::SimpleContracts::Sampler.new(self)
+    end
+
+    def stats
+      @stats ||= ::SimpleContracts::Statistics.new(contract_name, logger: logger)
+    end
+
+    def logger
+      @logger ||= ::Logger.new(STDOUT)
+    end
+
+    def enabled?
+      ENV["ENABLE_#{self.class.name}"].to_s != 'false'
+    end
+
+    def match_guarantees!
+      methods = self.class.guarantees_methods
+      return if methods.empty?
+      return if methods.all? do |method_name|
+        @meta[:checked] << method_name
+        !!send(method_name)
+      end
+
+      raise GuaranteesError, @meta
+    end
+
+    def match_expectations!
+      methods = self.class.expectations_methods
+      return if methods.empty?
+      return if methods.any? do |method_name|
+        @meta[:checked] << method_name
+        next unless !!send(method_name)
+        keep_meta(method_name)
+        true
+      end
+
+      raise ExpectationsError, @meta
+    end
+  end
+end

data/lib/simple_contracts/sampler.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SimpleContracts
+  class Sampler
+    PATH_TEMPLATE = "%<contract_name>s/%<rule>s/%<period>i.dump"
+    DEFAULT_PERIOD_SIZE = 60 * 60 # every hour
+
+    def initialize(contract, period_size: nil)
+      @context = contract
+      @contract_name = contract.contract_name
+      @period_size = period_size || default_period_size
+    end
+
+    def sample!(rule)
+      path = sample_path(rule)
+      return unless need_sample?(path)
+      capture(rule)
+      path
+    end
+
+    def sample_path(rule, period = current_period)
+      File.join(
+        root_path,
+        PATH_TEMPLATE % {contract_name: @contract_name, rule: rule, period: period}
+      )
+    end
+
+    # to use in interactive Ruby session
+    def read(path = nil, rule: nil, period: nil)
+      path ||= sample_path(rule, period)
+      raise(ArgumentError, "Sample path should be defined") unless path
+      @context.deserialize(File.read(path))
+    end
+
+    private
+
+    def need_sample?(path)
+      !File.exist?(path)
+    end
+
+    def capture(rule)
+      FileUtils.mkdir_p(File.dirname(sample_path(rule)))
+      File.write(sample_path(rule), @context.serialize)
+    end
+
+    def current_period
+      Time.now.to_i / (@period_size || 1).to_i
+    end
+
+    def default_period_size
+      Integer(ENV["CONTRACT_#{@contract_name}_SAMPLE_PERIOD_SIZE"] || DEFAULT_PERIOD_SIZE)
+    end
+
+    def root_path
+      ENV["CONTRACT_ROOT_PATH"] || File.join("/tmp", "contracts")
+    end
+  end
+end

data/lib/simple_contracts/statistics.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+
+module SimpleContracts
+  class Statistics
+    TEMPLATE = "[contracts-match] %<payload>s;"
+
+    def initialize(contract_name, logger: nil)
+      @contract_name = contract_name
+      @logger = logger
+    end
+
+    def log(rule, meta, error = nil)
+      logger.debug(log_data(rule: rule, meta: meta, error: error))
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def log_data(**kwargs)
+      TEMPLATE % {payload: payload(**kwargs)}
+    end
+
+    def payload(rule:, meta: nil, error: nil)
+      JSON.dump({
+        time: Time.now, contract_name: @contract_name, rule: rule, meta: meta, error: error
+      }.compact)
+    end
+  end
+end

data/lib/simple_contracts/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleContracts
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: simple_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bibendi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/simple_contracts.rb
+- lib/simple_contracts/base.rb
+- lib/simple_contracts/sampler.rb
+- lib/simple_contracts/statistics.rb
+- lib/simple_contracts/version.rb
+homepage: https://github.com/bibendi/simple_contracts
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Plain Old Ruby Object Implementation of Contract
+test_files: []