design_by_contract 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2848a2d974ba0719cfde67f1869c159823ef7a5c
+  data.tar.gz: b09db1b0e27ffaa7fad9fa0367af71b7563cb69f
+SHA512:
+  metadata.gz: ae579964b09e3f8e096924837277a4c54a40c1896fabce5187402a70a7931ac04560b6f0e575354af5b892eb0c73a9ed8b70f05ea5ca3f597756071ed6cd4b04
+  data.tar.gz: 31ba66b25fda22e573e3358bd384174d7415428128b7e32a64c9c686b65f3617652097a2d44512b17eef472dcfbe8ce88b4ee9a28d8ad976bd35ae351618e12c

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

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 adamluzsi@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 design_by_contract.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adam Luzsi
+
+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,50 @@
+# DesignByContract
+
+This is a collection of techniques to create contract between Objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'design_by_contract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install design_by_contract
+
+## Usage
+
+### Interface
+
+The most basic simple usecase for interface is to use it for simply validate a class
+
+```ruby
+
+i = DesignByContract::Interface.new test: [:req, :opt, %i[keyreq keyword] ]
+
+class T
+  def test(value, value_with_default="def", keyword:)
+  end
+end
+
+i.implemented_by?(T) #=> true
+i.implemented_by?(Class) #=> false
+
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/design_by_contract. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DesignByContract project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/design_by_contract/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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

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

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "design_by_contract"
+  spec.version       = File.read(File.join(__dir__, "VERSION")).strip
+  spec.authors       = ["Adam Luzsi"]
+  spec.email         = ["adamluzsi@gmail.com"]
+
+  spec.summary       = %q{Design by contract patterns for developer happiness}
+  spec.description   = %q{Design by contract patterns for developer happiness}
+  spec.homepage      = "https://github.com/adamluzsi/design_by_contract.rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/design_by_contract/interface.rb

@@ -0,0 +1,80 @@
+class DesignByContract::Interface
+  REQUIRED_ARGUMENT = :req
+  OPTIONAL_ARGUMENT = :opt
+  REST_OF_THE_ARGUMENTS = :rest
+
+  REQUIRED_KEYWORD = :keyreq
+  OPTIONAL_KEYWORD = :key
+  AFTER_KEYWORD_ARGUMENTS = :keyrest
+
+  def initialize(method_specifications)
+    @method_specifications = method_specifications
+  end
+
+  def implemented_by?(implementator_class)
+    @method_specifications.each do |name, signature|
+      return false unless implementator_class.method_defined?(name)
+      return false unless signature_match?(implementator_class, name, signature)
+    end
+    true
+  end
+
+  private
+
+  def signature_match?(klass, name, signature)
+    parameters = klass.instance_method(name).parameters
+
+    return false unless req_match?(parameters, signature)
+    return false unless opt_match?(parameters, signature)
+    return false unless rest_match?(parameters, signature)
+    return false unless keyreq_match?(parameters, signature)
+    return false unless key_match?(parameters, signature)
+    return false unless keyrest_match?(parameters, signature)
+
+    true
+  end
+
+  def keyrest_match?(parameters, signature)
+    return true unless signature.include?(:keyrest)
+
+    parameters.any? { |k, _| k == :keyrest }
+  end
+
+  def key_match?(parameters, signature)
+    optional_keys = signature.select { |k| k.is_a?(Array) && k[0] == :key }.map(&:last)
+    return true if optional_keys.empty?
+    actual_keys = parameters.select { |k, _| k == :key }.map(&:last)
+    (optional_keys - actual_keys).empty?
+  end
+
+  def keyreq_match?(parameters, signature)
+    expected_keys = signature.select { |k| k.is_a?(Array) && k[0] == :keyreq }.sort
+    return true if expected_keys.empty?
+    actual_keys = parameters.select { |k, _| k == :keyreq }.sort
+    expected_keys == actual_keys
+  end
+
+  def req_match?(parameters, signature)
+    expected, actually = arg_counts_for(parameters, signature, :req)
+    return true if expected == 0
+    expected == actually
+  end
+
+  def opt_match?(parameters, signature)
+    expected, actually = arg_counts_for(parameters, signature, :opt)
+    return true if expected == 0
+    expected <= actually
+  end
+
+  def rest_match?(parameters, signature)
+    return true unless signature.include?(:rest)
+
+    parameters.any? { |k, _| k == :rest }
+  end
+
+  def arg_counts_for(parameters, signature, type)
+    expected_req_count = signature.select { |v| v == type }.length
+    actual_req_count = parameters.map(&:first).select { |v| v == type }.length
+    [expected_req_count, actual_req_count]
+  end
+end

data/lib/design_by_contract.rb

@@ -0,0 +1,3 @@
+module DesignByContract
+  autoload :Interface, 'design_by_contract/interface'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: design_by_contract
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Luzsi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Design by contract patterns for developer happiness
+email:
+- adamluzsi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- design_by_contract.gemspec
+- lib/design_by_contract.rb
+- lib/design_by_contract/interface.rb
+homepage: https://github.com/adamluzsi/design_by_contract.rb
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Design by contract patterns for developer happiness
+test_files: []