grpc_mock 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9241226768f0034733f8ef7a99e49b8bf439996b
-  data.tar.gz: 03f3b6324da7f8e4ddc9ded9f961776fdca8eba8
+  metadata.gz: dab269f850e0b8b76e59bf38cda65711c45777e9
+  data.tar.gz: b4940189dfaf12d0709fe82bc8f35683b2d6f079
 SHA512:
-  metadata.gz: '08f73b53a70a36699e1f64c150fa020cc11a0748b170ec3a1ced993675559ab773a550bd593daee1f1eb7c58aa8da859d960053815e9705dd9b005cc4764affc'
-  data.tar.gz: 4930f5722109ec87371520c8629fe78499c3b0581646c4be2d43f6d5ff9efb5016115416a68cb40a92ce03248d120ff9fb1aea02738fe26ec6a9f7ec9fda695f
+  metadata.gz: 9306c34913f4f82cad53287296c5d41add574e83976afb2292095f755146638cc100bb9256ea51ac514e1b98c26de7fb8c93d7c4b8c6070bb8dae6e2634b20ff
+  data.tar.gz: 10113af184c522fc9cf9f29dd4198726a6eec7198d7b0182a0a156b7fd5819cb06f8991cf3bff0807a3f8bc950f822c0f52492a5882b7221ce533301cd6b8982

data/.rubocop.yml

@@ -1,3 +1,92 @@
 AllCops:
   Exclude:
     - 'spec/examples/**/*'
+    - '**/**/*_pb.rb' # auto-generated
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Naming/PredicateName:
+  NamePrefixBlacklist:
+    - "is_"
+    - "have_"
+  NamePrefix:
+    - "is_"
+    - "have_"
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/BlockLength:
+  Max: 40

data/.ruby-version

@@ -0,0 +1 @@
+2.4

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.4
+  - 2.5.3
+  - 2.4.5
 before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 TODO: Write your name
+Copyright (c) 2019 Yuta Iwama
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
 # GrpcMock [![Build Status](https://travis-ci.org/ganmacs/grpc_mock.svg?branch=master)](https://travis-ci.org/ganmacs/grpc_mock)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/grpc_mock`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Library for stubbing grpc in Ruby.
 
 ## Installation
 
@@ -22,22 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If you use [RSpec](https://github.com/rspec/rspec), add the following code to spec/spec_helper.rb:
+
+```ruby
+require 'grpc_mock/rspec'
+```
+
+## Examples
+
+See definition of protocol buffers and gRPC generated code in [spec/exmaples/hello](https://github.com/ganmacs/grpc_mock/tree/master/spec/examples/hello)
+
+##### Stubbed request based on path and with the default response
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").to_return(Hello::HelloResponse.new(msg: 'test'))
+
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
+client = client.hello(Hello::HelloRequest.new(msg: 'hi')) # => Hello::HelloResponse.new(msg: 'test')
+```
+
+##### Stubbing requests based on path and request
+
+```ruby
+GrpcMock.stub_request("/hello.hello/Hello").with(Hello::HelloRequest.new(msg: 'hi')).to_return(Hello::HelloResponse.new(msg: 'test'))
+
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
+client = client.hello(Hello::HelloRequest.new(msg: 'hello')) # => send a request to server
+client = client.hello(Hello::HelloRequest.new(msg: 'hi'))    # => Hello::HelloResponse.new(msg: 'test') (without any requests to server)
+```
 
-## Development
+##### Real requests to network can be allowed or disabled
 
-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.
+```ruby
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure)
 
-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).
+GrpcMock.disable_net_connect!
+client = client.hello(Hello::HelloRequest.new(msg: 'hello')) # => Raise NetConnectNotAllowedError error
+
+GrpcMock.allow_net_connect!
+client = Hello::Hello::Stub.new('localhost:8000', :this_channel_is_insecure) # => send a request to server
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grpc_mock. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ganmacs/grpc_mock. 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 GrpcMock project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grpc_mock/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'grpc_mock'

data/grpc_mock.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grpc_mock/version'
@@ -5,7 +7,7 @@ require 'grpc_mock/version'
 Gem::Specification.new do |spec|
   spec.name          = 'grpc_mock'
   spec.version       = GrpcMock::VERSION
-  spec.authors       = ['ganmacs']
+  spec.authors       = ['Yuta Iwama']
   spec.email         = ['ganmacs@gmail.com']
 
   spec.summary       = 'Library for stubbing grpc in Ruby'
@@ -20,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'grpc', '>= 1.12.0', '< 1.15.0'
+  spec.add_dependency 'grpc', '>= 1.12.0', '< 1.18.0'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'grpc-tools'

data/lib/grpc_mock.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
+require 'grpc_mock/api'
 require 'grpc_mock/version'
 require 'grpc_mock/configuration'
 require 'grpc_mock/adapter'
+require 'grpc_mock/stub_registry'
 
 module GrpcMock
+  extend GrpcMock::Api
+
   class << self
     def enable!
       adapter.enable!
@@ -12,12 +18,12 @@ module GrpcMock
       adapter.disable!
     end
 
-    def disable_net_connect!
-      config.allow_net_connect = false
+    def reset!
+      GrpcMock.stub_registry.reset!
     end
 
-    def allow_net_connect!
-      config.allow_net_connect = true
+    def stub_registry
+      @stub_registry ||= GrpcMock::StubRegistry.new
     end
 
     def adapter

data/lib/grpc_mock/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grpc_mock/grpc_stub_adapter'
 
 module GrpcMock

data/lib/grpc_mock/api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'grpc_mock/request_stub'
+require 'grpc_mock/matchers/request_including_matcher'
+
+module GrpcMock
+  module Api
+    # @param path [String]
+    def stub_request(path)
+      GrpcMock.stub_registry.register_request_stub(GrpcMock::RequestStub.new(path))
+    end
+
+    # @param values [Hash]
+    def request_including(values)
+      GrpcMock::Matchers::RequestIncludingMatcher.new(values)
+    end
+
+    def disable_net_connect!
+      GrpcMock.config.allow_net_connect = false
+    end
+
+    def allow_net_connect!
+      GrpcMock.config.allow_net_connect = true
+    end
+  end
+end

data/lib/grpc_mock/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrpcMock
   class Configuration
     attr_accessor :allow_net_connect

data/lib/grpc_mock/errors.rb

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
 module GrpcMock
   class NetConnectNotAllowedError < StandardError
     def initialize(sigunature)
       super("Real GRPC connections are disabled. #{sigunature} is requested")
     end
   end
+
+  class NoResponseError < StandardError
+    def initialize(msg)
+      super("There is no response: #{msg}")
+    end
+  end
 end

data/lib/grpc_mock/grpc_stub_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grpc'
 require 'grpc_mock/errors'
 
@@ -6,48 +8,63 @@ module GrpcMock
     # To make hook point for GRPC::ClientStub
     # https://github.com/grpc/grpc/blob/bec3b5ada2c5e5d782dff0b7b5018df646b65cb0/src/ruby/lib/grpc/generic/service.rb#L150-L186
     class AdapterClass < GRPC::ClientStub
-      def request_response(method, *args)
+      def request_response(method, request, *args)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
-        if GrpcMock.config.allow_net_connect
+        mock = GrpcMock.stub_registry.response_for_request(method, request)
+        if mock
+          mock
+        elsif GrpcMock.config.allow_net_connect
           super
         else
           raise NetConnectNotAllowedError, method
         end
       end
 
-      def client_streamer(method, *args)
+      # TODO
+      def client_streamer(method, requests, *args)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
-        if GrpcMock.config.allow_net_connect
+        r = requests.to_a       # FIXME: this may not work
+        mock = GrpcMock.stub_registry.response_for_request(method, r)
+        if mock
+          mock
+        elsif GrpcMock.config.allow_net_connect
           super
         else
           raise NetConnectNotAllowedError, method
         end
       end
 
-      def server_streamer(method, *args)
+      def server_streamer(method, request, *args)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
-        if GrpcMock.config.allow_net_connect
+        mock = GrpcMock.stub_registry.response_for_request(method, request)
+        if mock
+          mock
+        elsif GrpcMock.config.allow_net_connect
           super
         else
           raise NetConnectNotAllowedError, method
         end
       end
 
-      def bidi_streamer(method, *args)
+      def bidi_streamer(method, requests, *args)
         unless GrpcMock::GrpcStubAdapter.enabled?
           return super
         end
 
-        if GrpcMock.config.allow_net_connect
+        r = requests.to_a       # FIXME: this may not work
+        mock = GrpcMock.stub_registry.response_for_request(method, r)
+        if mock
+          mock
+        elsif GrpcMock.config.allow_net_connect
           super
         else
           raise NetConnectNotAllowedError, method

data/lib/grpc_mock/matchers/hash_argument_matcher.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GrpcMock
+  module Matchers
+    # Base class for Hash matchers
+    # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb
+    class HashArgumentMatcher
+      def self.stringify_keys!(arg, options = {})
+        case arg
+        when Array
+          arg.map do |elem|
+            options[:deep] ? stringify_keys!(elem, options) : elem
+          end
+        when Hash
+          Hash[
+            *arg.map do |key, value|
+              k = key.is_a?(Symbol) ? key.to_s : key
+              v = (options[:deep] ? stringify_keys!(value, options) : value)
+              [k, v]
+            end.inject([]) { |r, x| r + x }]
+        else
+          arg
+        end
+      end
+
+      def initialize(expected)
+        @expected = Hash[
+          GrpcMock::Matchers::HashArgumentMatcher.stringify_keys!(expected, deep: true).sort,
+        ]
+      end
+
+      def ==(_actual, &block)
+        @expected.all?(&block)
+      rescue NoMethodError
+        false
+      end
+
+      def self.from_rspec_matcher(matcher)
+        new(matcher.instance_variable_get(:@expected))
+      end
+    end
+  end
+end

data/lib/grpc_mock/matchers/request_including_matcher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'grpc_mock/matchers/hash_argument_matcher'
+
+module GrpcMock
+  module Matchers
+    class RequestIncludingMatcher < HashArgumentMatcher
+      def ==(actual)
+        if actual.respond_to?(:to_h)
+          actual = actual.to_h
+        end
+
+        actual = Hash[GrpcMock::Matchers::HashArgumentMatcher.stringify_keys!(actual, deep: true)]
+        super { |key, value| inner_including(value, key, actual) }
+      rescue NoMethodError
+        false
+      end
+
+      private
+
+      def inner_including(expect, key, actual)
+        if actual.key?(key)
+          actual_value = actual[key]
+          if expect.is_a?(Hash)
+            RequestIncludingMatcher.new(expect) == actual_value
+          else
+            expect === actual_value
+          end
+        else
+          false
+        end
+      end
+
+      def inspect
+        "reqeust_including(#{@expected.inspect})"
+      end
+    end
+  end
+end

data/lib/grpc_mock/request_pattern.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GrpcMock
+  class RequestPattern
+    # @param path [String]
+    def initialize(path)
+      @path = path
+      @block = nil
+      @request = nil
+    end
+
+    def with(request = nil, &block)
+      if request.nil? && !block_given?
+        raise ArgumentError, '#with method invoked with no arguments. Either options request or block must be specified.'
+      end
+
+      @request = request
+      @block = block
+    end
+
+    def match?(path, request)
+      @path == path && (@request.nil? || @request == request) && (@block.nil? || @block.call(path))
+    end
+  end
+end

data/lib/grpc_mock/request_stub.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'grpc_mock/request_pattern'
+require 'grpc_mock/resopnse_sequence'
+require 'grpc_mock/errors'
+
+module GrpcMock
+  class RequestStub
+    # @param path [String] gRPC path like /${service_name}/${method_name}
+    def initialize(path)
+      @request_pattern = RequestPattern.new(path)
+      @response_sequence = []
+    end
+
+    def with(request = nil, &block)
+      @request_pattern.with(request, &block)
+      self
+    end
+
+    def to_return(*resp)
+      @response_sequence << GrpcMock::ResponsesSequence.new(resp)
+      self
+    end
+
+    def response
+      if @response_sequence.empty?
+        raise GrpcMock::NoResponseError, 'Must be set some values by using #GrpMock::RequestStub#to_run'
+      elsif @response_sequence.size == 1
+        @response_sequence.first.next
+      else
+        if @response_sequence.first.end?
+          @response_sequence.shift
+        end
+
+        @response_sequence.first.next
+      end
+    end
+
+    # @param path [String]
+    # @param request [Object]
+    # @return [Bool]
+    def match?(path, request)
+      @request_pattern.match?(path, request)
+    end
+  end
+end

data/lib/grpc_mock/resopnse_sequence.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GrpcMock
+  class ResponsesSequence
+    attr_accessor :repeat
+
+    def initialize(responses)
+      @repeat = 1
+      @responses = responses
+      @current = 0
+      @last = @responses.length - 1
+    end
+
+    def end?
+      @repeat == 0
+    end
+
+    def next
+      if @repeat > 0
+        response = @responses[@current]
+        next_pos
+        response
+      else
+        @responses.last
+      end
+    end
+
+    private
+
+    def next_pos
+      if @last == @current
+        @current = 0
+        @repeat -= 1
+      else
+        @current += 1
+      end
+    end
+  end
+end

data/lib/grpc_mock/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grpc_mock'
 
 RSpec.configure do |config|
@@ -8,4 +10,8 @@ RSpec.configure do |config|
   config.after(:suite) do
     GrpcMock.disable!
   end
+
+  config.after(:each) do
+    GrpcMock.reset!
+  end
 end

data/lib/grpc_mock/stub_registry.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GrpcMock
+  class StubRegistry
+    def initialize
+      @request_stubs = []
+    end
+
+    def reset!
+      @request_stubs = []
+    end
+
+    # @param stub [GrpcMock::RequestStub]
+    def register_request_stub(stub)
+      @request_stubs.unshift(stub)
+      stub
+    end
+
+    # @param path [String]
+    # @param request [Object]
+    def response_for_request(path, request)
+      rstub = @request_stubs.find do |stub|
+        stub.match?(path, request)
+      end
+
+      if rstub
+        rstub.response.dup
+      end
+    end
+  end
+end

data/lib/grpc_mock/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrpcMock
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_mock
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
-- ganmacs
+- Yuta Iwama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -19,7 +19,7 @@ dependencies:
         version: 1.12.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.12.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,8 +124,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,10 +135,17 @@ files:
 - grpc_mock.gemspec
 - lib/grpc_mock.rb
 - lib/grpc_mock/adapter.rb
+- lib/grpc_mock/api.rb
 - lib/grpc_mock/configuration.rb
 - lib/grpc_mock/errors.rb
 - lib/grpc_mock/grpc_stub_adapter.rb
+- lib/grpc_mock/matchers/hash_argument_matcher.rb
+- lib/grpc_mock/matchers/request_including_matcher.rb
+- lib/grpc_mock/request_pattern.rb
+- lib/grpc_mock/request_stub.rb
+- lib/grpc_mock/resopnse_sequence.rb
 - lib/grpc_mock/rspec.rb
+- lib/grpc_mock/stub_registry.rb
 - lib/grpc_mock/version.rb
 homepage: https://github.com/ganmacs/grpc_mock
 licenses:
@@ -160,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Library for stubbing grpc in Ruby

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 TODO: Write your email address. 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/