cbra_contracts 0.1.0b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d2368442341678d0753676087bd38c87e5daa2f712d927d0eb8fd8559957fbd
+  data.tar.gz: ef5b754910e1eb711fe3347a46d2b84f156f69ae593d99d98f119a3eac784f29
+SHA512:
+  metadata.gz: 4cd6aede1fc1a351d985a3ab975e3d1d69dffe56e60a3de7af6ad27c7708972c2eb31156e3a769089841ba37222a3fb28a794415624b879dde0a2e0381038276
+  data.tar.gz: 1c5d236e69e7b2c42fac38271367d21c01ef964b41d73f88a9a58351c68f3410eab5b42cac096ea0acea63569ae10180d3fa60788dd202f7073e8771d5f1b70b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

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

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 kyle.wiest@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 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cbra_contracts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kyle Wiest
+
+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,130 @@
+# Component Based Rails Application (CBRA) Contracts
+
+## Introduction
+
+Many Rails applications start simply enough. A generator command here, a
+migration there and soon enough, you've got a working application. Some end up
+as a [Majestic Monolith](https://m.signalvnoise.com/the-majestic-monolith/).
+
+As some applications grow, and new developers come and go they can drift from
+"Majestic" and become more and more challenging to work in. God objects, tightly
+coupled models and a lack of clear boundaries creep up seemingly overnight and
+now what you thought was a small change can trigger a host of test failures.
+
+At this point, a common solution is to reach for microservices. Smaller, domain
+specific applications that are deployed independently sound great! The tradeoffs
+being that you now have a new problem to worry about - the network. What calls
+can fail and where, retry policies and latency are now brought to the forefront.
+Deployment infrastructure, more complicated CI/CD pipelines, complicated local
+environments are all potential pitfalls of a microservice architecture.
+
+Another alternative is to break your monolith into modular "components." These
+components are still built and deployed together but offer a more clear
+separation of domain-specific functionality.
+
+CBRA Contracts aims to help guide the transition from a less-than-majestic
+monolith to a collection of clearly separated functionality with distinct
+boundaries and ... contracts.
+
+## How it Works
+
+CBRA Contracts provides a DSL and "convention over configuration" approach to
+define contract interfaces between application components. These contracts serve
+to define a public interface for a component while hiding all implementation
+details.
+
+If a developer needs to use a functional component, she needs to look no further
+than the contract to see what methods are available, what arguments need to be
+passed and what return type she can expect.
+
+This also allows for fearless refactoring of implementation code _inside_ of the
+component. As long as the contract is fulfilled, any implementation is safe to
+refactor or swap altogether.
+
+### Usage
+
+In your component Gemfile, include `gem 'cbra_contracts'` or in your `.gemspec`
+include `spec.runtime_dependency 'cbra_contracts'`.
+
+### Example
+
+Let's define a contract!
+
+```ruby
+# A sample `Weather` component of our application
+
+# weather/lib/contract.rb
+module Weather
+  extend CBRAContracts::DSL
+  
+  define_contract 'Weather', 'Provides weather lookups and predictions' do
+
+    contract_method :lookup, 'Lookup the current weather of a location' do |m|
+      m.param :postal_code, :string, 'Postal code of the weather request'
+      m.param :time_of_day, :int, 'The time of day, in seconds'
+      m.produces WeatherReport
+    end
+
+  end
+end
+```
+
+Our Weather component now has a public interface that provides one method,
+`lookup` and promises to return a `WeatherReport` provided that the caller
+also adheres to the contract and provides arguments for `:postal_code` and
+`:time_of_day`.
+
+By convention, the implementation of the lookup should live in the
+`weather/lib/weather/lookup.rb` class.
+
+```ruby
+# weather/lib/weather/lookup.rb
+
+module Weather
+  class Lookup
+    def call(postal_code:, time_of_day:)
+      ## implementation goes here
+      
+      WeatherReport.new(88, 'Sunny')
+    end
+  end
+  
+  class WeatherReport
+    attr_reader :degrees, :description
+    
+    def initialize(degrees, description)
+      @degrees = degrees
+      @description = description
+    end
+  end
+end
+```
+
+This can be overriden in the contract method definition block by setting
+`m.implementation = MyCustomImplementationClass.new`.
+
+## Future Goals
+
+* Contract test stubs
+* Documentation generation
+* OpenAPI spec generation
+* Rack endpoint routing
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/bluebottlecoffee/cbra_contracts. 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
+[AGPL License](https://www.gnu.org/licenses/agpl-3.0.en.html).
+
+## Code of Conduct
+
+Everyone interacting in the CbraContracts project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/bluebottlecoffee/cbra_contracts/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cbra_contracts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cbra_contracts'
+  spec.version       = CBRAContracts::VERSION
+  spec.authors       = ['Blue Bottle Coffee']
+  spec.email         = ['opensource@bluebottlecoffee.com']
+
+  spec.summary       = 'DSL to delcare your Rails component contracts'
+  spec.description   = 'DSL to delcare your Rails component contracts'
+  spec.homepage      = 'https://github.com/bluebottlecoffee/CBRA-Contracts'
+  spec.license       = 'AGPL'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-inflector', '~> 0.2'
+  spec.add_runtime_dependency 'dry-schema', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/lib/cbra_contracts.rb

@@ -0,0 +1,5 @@
+require 'cbra_contracts/version'
+
+module CBRAContracts
+  class Error < StandardError; end
+end

data/lib/cbra_contracts/contract.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CBRAContracts
+  class Contract
+    attr_reader :name, :description, :contract_methods
+
+    def initialize(name, description)
+      @name = name
+      @description = description
+      @contract_methods = []
+    end
+
+    def add_contract_method(contract_method)
+      contract_methods << contract_method
+    end
+  end
+end

data/lib/cbra_contracts/contract_method.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'dry/inflector'
+require 'dry/schema'
+require 'cbra_contracts/contract_method_parameter'
+
+module CBRAContracts
+  class ContractMethod
+    attr_reader :name, :description, :params, :return_type
+
+    def initialize(name, description, impl_scope)
+      @name = name
+      @description = description
+      @impl_scope = impl_scope
+      @params = []
+    end
+
+    def param(name, type, description)
+      @params << Parameter.new(name, type, description)
+    end
+
+    def produces(klass)
+      @return_type = klass
+    end
+
+    def invoke(args)
+      valid = argument_schema.call(args)
+      if valid.success?
+        implementation.call(args)
+      else
+        raise_argument_error(valid.errors.messages)
+      end
+    end
+
+    def implementation
+      @implementation ||= Object.const_get(default_impl_class).new
+    end
+
+    def implementation=(impl)
+      @implementation = impl
+    end
+
+    def build_argument_schema
+      schema = Dry::Schema::DSL.new
+      params.each do |p|
+        schema.required(p.name).filled(p.type)
+      end
+
+      @argument_schema = schema.call
+    end
+
+    private
+
+    attr_reader :impl_scope, :argument_schema
+
+    def default_impl_class
+      "#{impl_scope}::#{Dry::Inflector.new.classify(name)}"
+    end
+
+    def raise_argument_error(error_messages)
+      msg = error_messages.map do |m|
+        "Argument #{m.path} #{m.text}"
+      end.join(', ')
+
+      raise ArgumentError, msg
+    end
+  end
+end

data/lib/cbra_contracts/contract_method_parameter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CBRAContracts
+  class Parameter
+    class InvalidParameterType < Error; end
+
+    VALID_TYPES = %i[string integer float].freeze
+
+    attr_reader :name, :type, :description
+
+    def initialize(name, type, description)
+      raise InvalidParameterType unless VALID_TYPES.include?(type)
+
+      @name = name
+      @type = type
+      @description = description
+    end
+  end
+end

data/lib/cbra_contracts/dsl.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'cbra_contracts'
+require 'cbra_contracts/contract'
+require 'cbra_contracts/contract_method'
+
+module CBRAContracts
+  module DSL
+    def self.extended(component)
+      @@component = component
+    end
+
+    def define_contract(name, description)
+      @@contract = Contract.new(name, description)
+      add_contract_getter_and_setter
+      @@component.contract = @@contract
+
+      yield
+    end
+
+    def contract_method(name, description)
+      contract_method = ContractMethod.new(name, description, @@component.to_s)
+      @@contract.add_contract_method(contract_method)
+      define_component_contract_method(contract_method)
+
+      yield contract_method
+
+      contract_method.build_argument_schema
+    end
+
+    # Class private; not meant to be used publicly
+    def add_contract_getter_and_setter
+      class << @@component
+        def contract
+          @@contract
+        end
+
+        def contract=(contract)
+          @@contract = contract
+        end
+      end
+    end
+
+    # Class private; not meant to be used publicly
+    def define_component_contract_method(contract_method)
+      @@component.module_eval do
+        self.define_method(contract_method.name) do |args|
+          contract_method.invoke(args)
+        end
+        module_function contract_method.name
+      end
+    end
+  end
+end

data/lib/cbra_contracts/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CBRAContracts
+  VERSION = '0.1.0b'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cbra_contracts
+version: !ruby/object:Gem::Version
+  version: 0.1.0b
+platform: ruby
+authors:
+- Blue Bottle Coffee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: DSL to delcare your Rails component contracts
+email:
+- opensource@bluebottlecoffee.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cbra_contracts.gemspec
+- lib/cbra_contracts.rb
+- lib/cbra_contracts/contract.rb
+- lib/cbra_contracts/contract_method.rb
+- lib/cbra_contracts/contract_method_parameter.rb
+- lib/cbra_contracts/dsl.rb
+- lib/cbra_contracts/version.rb
+homepage: https://github.com/bluebottlecoffee/CBRA-Contracts
+licenses:
+- AGPL
+metadata: {}
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: DSL to delcare your Rails component contracts
+test_files: []