blood_contracts-ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b7753da5bf340600c41348deca62452860ac5663eb238470f5f2af67f72d162e
+  data.tar.gz: a11f44add5d39132210250f8732e23818abaafebdd0558fcfd2eea3084c4f70b
+SHA512:
+  metadata.gz: d7e28da298037135f8baa122ec04968f2b70137e0379afee26421a744a08b92c1faa8ce224cf2dd2c0fb53a8ebdaf956937c4d17402fa99e704af6901b368328
+  data.tar.gz: a5796575eb357fd0c5753906ebf29e1410372c8ee451165aec8ce070118bcac65b014de53a41f6a005fdcede76a997a45c38b44e39da01358eaca20b21a8d6f1

data/.gitignore

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

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-ext.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-ext.rb

data/.travis.yml

@@ -0,0 +1,19 @@
+---
+sudo:     false
+language: ruby
+cache:    bundler
+before_install:
+  - gem install bundler --no-document
+  - gem update --system
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - 2.4.0
+  - 2.6.0
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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-04]
+
+This is a first public release marked in change log with features extracted from production app.
+Includes:
+- *BC::Ext::Refined* - exteneded refinement type with support of Extractors and Policy for validation
+- *Extractable* - is a simple concern that turns your refinement type into a coercer which tries to extract particular fields from the given value,
+  the bonus is that you need no #match method definition, only methods that you passed to `.extract` DSL
+- *MapValue* - is a type which saves the value in the original form to context and then passes it some mapper class, which should change the
+  form of the input object (e.g. turn it into JSON or XML)
+- *ExpectedError* - is a validation scenario when something goes wrong during validation but in expected way (e.g. API returns a recoverable error),
+  that type is valid too, but `#unpack` returns a Tram::Policy::Errors
+- *DefinableError* - is a concern to define single time Tram::Policy::Errors, when you don't want to delegate validation to policy, but you want
+  to store errors in form of Tram::Policy::Errors
+- *ExceptionCaught and ExceptionHandling* - is a way to turn StandardError inside the type matching into another refinement type, that type is of course
+  ancestor of BC::ContractFailure, but have an additional reader `#exception` which gives you access to the exception and at the same time you could
+  read all the context that was collected till the "exceptional" moment

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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blood_contracts-ext.gemspec
+gemspec

data/LICENSE

@@ -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,369 @@
+[![Build Status](https://travis-ci.org/sclinede/blood_contracts-ext.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/sclinede/blood_contracts-ext/badges/gpa.svg)][codeclimate]
+
+[gem]: https://rubygems.org/gems/blood_contracts-ext
+[travis]: https://travis-ci.org/sclinede/blood_contracts-ext
+[codeclimate]: https://codeclimate.com/github/sclinede/blood_contracts-ext
+
+# BloodContracts::Ext
+
+Refinement types are implemented in BloodContracts::Core, but in production we found several patterns to use with types.
+Let me share them with you.
+
+Welcome, **extended refinement types**.
+
+All those extensions are listed below, stay tuned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blood_contracts-ext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blood_contracts-ext
+
+## Usage
+
+This gems consists mostly of Concerns and Refined classes that extends the powers of refinement types.
+
+### BC::ExceptionHandling
+
+First of all sometimes it is great to replace the usual exception handling with refinement types, because
+inside type you have much more context then just the exception and its backtrace.
+
+For that scenario you only need to prepend your BC::Refined class with BC::ExceptionHandling and when
+the StandardError happen inside your matching pipeline it will turn into BC::ExceptionCaught type
+(which is of course just another ancestor of BC::ContractFailure).
+
+```ruby
+class JsonType < BC::Refined
+  prepend BC::ExceptionHandling
+
+  def match
+    @context[:json_type_input] = value
+    @context[:parsed_json] = JSON.parse(@context[:json_type_input])
+    self
+  end
+end
+
+match = JsonType.match(Class.new) # => #<BC::ExceptionCaught ...>
+match.exception # => TypeError
+match.context # => { :json_type_input => #<Class>, :exception => TypeError }
+```
+
+Now you have access to both the exception (the `#exception` reader) and matching context (the `#context` reader).
+
+### BC::DefinableError
+
+Imagine you have an error message you want to return for your validation, but you have to worry about the translations.
+With BC::DefineableError you don't have to. You just extend your class with `BC::DefinableError.new(:translations_root)` and
+you have simple DSL to define translatable and composable errors.
+
+```ruby
+class EmailType < ::BC::Refined
+  extend BC::DefineableError.new(:type_validations)
+  REGEX = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+  INVALID_EMAIL = define_error(:invalid_email)
+
+  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
+
+match = Email.match("not-an-email") # => #<BC::ContractFailure ...>
+
+# en.yml should include translation for en.type_validations.email_type.invalid_email
+# e.g. "Given value is not a valid email address"
+match.errors.reduce(:merge).messages # => ["Given value is not a valid email address"]
+```
+
+Of course you may prefer a shortcut here, when you use ::BC::Ext::Refined as a base class your failures are
+wrapped into BC::PolicyFailure with even better Tram::Policy integration.
+
+```ruby
+class EmailType < ::BC::Ext::Refined
+  extend BC::DefineableError.new(:type_validations)
+  REGEX = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+  INVALID_EMAIL = define_error(:invalid_email)
+
+  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
+
+match = Email.match("not-an-email") # => #<BC::PolicyFailure ...>
+
+# en.yml should include translation for en.type_validations.email_type.invalid_email
+# e.g. "Given value is not a valid email address"
+match.messages # => ["Given value is not a valid email address"]
+```
+
+As simple as that! Do you still remember our "patter matching" usage?
+It's working anyways:
+
+```ruby
+case match = Email.match("not-an-email")
+when Email
+  # Validation succeeded
+  # Use #unpack or #context to extract the data
+  match # => #<Email ...>
+when BC::PolicyFailure
+  # You have access here to #message and #policy_errors methods
+  match # => #<BC::PolicyFailure ...>
+when BC::ContractFailure
+  # No fancy Tram::Policy integration but anyway #unpack or #messages at your serivce
+  match # => #<BC::ContractFailure>
+else raise # Remember to be exhaustive
+end
+```
+
+### BC::MapValue
+
+Another usual scenario is to transform the value of your type but when logic is too complex
+you prefer to use another class for that. For that case you may try BC::MapValue type which
+will be regular part of your pipeline.
+
+Let's imagine you want to change transform your ActiveModel object to some json through the class.
+Not a big deal, look at the example:
+
+```ruby
+module UPS
+  class JsonRequests::Rates
+    def self.call(origin_country:, destination_country:, weight:)
+      JSON.pretty_generate(
+        "RateRequest": {
+          "Shipment": {
+            "ShipFrom": origin_country,
+            "ShipTo":   destination_country,
+            "Service": { "Code": "65" },
+            "Package": {
+              "PackagingType": { "Code": "00" },
+              "PackageWeight": {
+                "UnitOfMeasurement": { "Code": "KGS" },
+                "Weight": weight.to_s,
+              }
+            }
+          }
+        }
+      )
+    end
+  end
+
+  class ParcelType < BC::Refined
+    prepend BC::ExceptionHandling
+
+    def match
+      parcel = value
+      context.merge!(
+        origin_country: parcel.origin_address.country,
+        destination_country: parcel.destination_address.country,
+        weight: parcel.weight
+      )
+    end
+
+    def mapped
+      @context.slice(:origin_country, :destination_country, :weight)
+    end
+  end
+
+  RatesRequestType = ParcelType.and_then(BC::MapValue.with(JsonRequests::Rates))
+end
+
+match = UPS::RatesRequestType.match(Parcel.find(123)) # => #<BC::MapValue ...>
+match.unpack # =>
+# => {
+#      "RateRequest": {
+#        "Shipment": {
+#          "ShipFrom": "LV",
+#          "ShipTo":   "US",
+#          "Service": { "Code": "65" },
+#          "Package": {
+#            "PackagingType": { "Code": "00" },
+#            "PackageWeight": {
+#              "UnitOfMeasurement": { "Code": "KGS" },
+#              "Weight": "1.15"
+#            }
+#          }
+#        }
+#      }
+#    }
+
+UPS::RatesRequestType.match("not-a-parcel")   # => #<BC::ExceptionCaught ...>
+```
+
+### BC::Extractable
+
+You may notice that in huge number of cases your type is a coercer from an arbitrary object.
+So you may look at the Refinement type as "extractor".
+That only means you have to use several methods to parse the context from the value.
+
+That best example is attempt to use single type for different types of input
+
+```ruby
+class AddressType < BC::Refined
+  extend BC::Extractable
+  prepend BC::ExceptionHandling
+
+  extract :city
+  extract :country_code, method_name: :country
+  extract :street
+
+  def city
+    return value.city if value.respond_to?(:city)
+    value.to_h
+         .transform_keys(&:to_s)
+         .values_at("city", "City")
+         .compact
+         .first
+  end
+
+  def country
+    return value.country if value.respond_to?(:country)
+    value.to_h
+         .transform_keys(&:to_s)
+         .values_at("country", "country_code", "CountryCode")
+         .compact
+         .first
+  end
+
+  def street
+    return value.street if value.respond_to?(:street)
+    value.to_h
+         .transform_keys(&:to_s)
+         .values_at("street", "street_line", "StreetLine")
+         .compact
+         .first
+  end
+end
+
+Address = Struct.new(:country, :city, :street)
+```
+
+That's just a definition, but let's take a look how it will behave in runtime:
+
+```ruby
+address_model = Address.new("RU", "Moscow", "Novoslobodskaya street")
+AddressType.match(address_model) # => #<AddressType ...>
+
+json_address = '{"CountryCode": "RU", "City": "Moscow", "StreetLine": "ul. Novoslobodskaya"}'
+AddressType.match(JSON.parse(json_address)) # => #<AddressType ...>
+
+AddressType.match("anything_else") # => #<BC::ExceptionCaught ...>
+```
+
+### BC::PolicyFailure
+
+There is a great abstraction for validation called Policy object. I like the Tram::Policy implementation, so
+now you're able to delegate validation logic to an external Policy object.
+
+But, sometimes you may prefer to use only Tram::Policy::Errors abstraction for the matching errors.
+For that case, you just need to use `self.failure_klass = BC::PolicyFailure` in your type.
+
+```ruby
+class Phone < ::BC::Refined
+  self.failure_klass = BC::PolicyFailure
+  REGEX = /\A(\+7|8)(9|8)\d{9}\z/i
+
+  def match
+    context[:phone_input] = value.to_s
+    clean_phone = context[:phone_input].gsub(/[\s\(\)-]/, "")
+
+    # translation key is: en.tram-policy.phone.invalid_phone
+    return failure(:invalid_phone) if clean_phone !~ REGEX
+    context[:clean_phone] = clean_phone
+
+    self
+  end
+end
+```
+
+Not a big difference? But, now all your failure calls generate Tram::Policy::Error, which easily translates
+using I18n.
+
+### BC::Ext::Refined
+
+You just saw several fancy tools around the BC::Refined. So, why don't we have everything inside that class?
+Because we try to keep things simple and transparent. But.
+
+If you prefer to have all that tooling in your types - "easy-peasy", use brand new BC::Ext::Refined.
+
+BC::Ext::Refined - is just extended version of BC::Refined (extended by concerns mentioned above).
+
+### BC::ExpectedError
+
+Finally, when you validate responses from API, sometimes "error" is just one of expected scenarios.
+That is why you may prefer special base class for those matching cases.
+
+Welcome - BC::ExpectedError, it's just ancestor of BC::Ext::Refined and by default it maps the context to Tram::Policy::Errors.
+
+```ruby
+module RubygemsAPI
+  class PlainTextError < BC::ExpectedError
+    def match
+      @context[:parsed] ||= JSON.parse(value)
+    rescue JSON::ParserError
+      @context[:plain_text] = value.to_s
+      self
+    end
+  end
+
+  class JsonType < BC::Ext::Refined
+    def match
+      @context[:parsed] ||= JSON.parse(value)
+      self
+    end
+
+    def mapped
+      @context[:parsed]
+    end
+  end
+
+  Response = JsonType.or_a(PlainTextError)
+end
+
+RubygemsAPI::Response.match('{"project": ...}') # => #<JsonType ...>
+
+match = RubygemsAPI::Response.match('Project not found!') # => #<PlainTextError ...>
+
+# translation key: en.contracts.rubygems_api/plain_text_error.message
+match.unpack # => "Service responded with a message: `Project not found!`"
+```
+
+### Summary
+
+That covers all the relevant scenarios for types and contract validations.
+If you have a case that is not covered and you find it useful - feel free to [open an Issue](https://github.com/sclinede/blood_contracts-ext/issues/new)
+
+## 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-ext. 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::Ext project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sclinede/blood_contracts-ext/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blood_contracts/ext"
+
+# 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-ext.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |gem|
+  gem.name          = "blood_contracts-ext"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Sergey Dolganov (sclinede)"]
+  gem.email         = ["sclinede@evilmartians.com"]
+
+  gem.summary       = "Extra helpers for BloodContracts::Core"
+  gem.description   = "Extra helpers for BloodContracts::Core"
+  gem.homepage      = "https://github.com/sclinede/blood_contracts-ext"
+  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_runtime_dependency "tram-policy" , "~> 2.0"
+  gem.add_runtime_dependency "i18n", "~> 1.0"
+
+  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