strong_interface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 623aa81d3e30d46a852d757e6911005dca1b09c0cdb1589be7696a216847b2b2
+  data.tar.gz: c39798e031a50dea42bed5c47e335b7072dc62024ecbc2f87c6cc248ee2e291b
+SHA512:
+  metadata.gz: 2867ff46ed12b7fa6357d697a49cca3c8e7931298b9cbbeaf64fc1f6ea9bb91231609e0c6dd3bbc6ec98071715a0383867b73ff08aab4f00e899b2c8fec1c5d4
+  data.tar.gz: b20a94a556ed3c8c0c41516628889d4b28628947cdec0a331226d5fb168b87bdf9aca25650956a213354b699a2f7eacd2ee7132a5e973f32ca2eaa76f2617572

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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 ageev86@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in strong_interface.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    strong_interface (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  strong_interface!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Andrew Ageev
+
+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,122 @@
+# StrongInterface
+
+Simple implementation of an interface pattern for Ruby
+
+This design pattern is widely spread and included in many programming languages.
+And this is an attempt to implement this pattern.
+So, it is not a big deal to make a dsl for checking if method exists at some class or not,
+however it is much more tricky to put it at the top of a class.
+
+In this gem the main problem was solved.
+It allows to put a definition of interfaces which should be implemented wherever within the class or module.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strong_interface'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install strong_interface
+
+## Usage
+
+#### Define an interface
+
+```ruby
+module IDog
+  def self.create(*); end
+  def eat(*); end
+  def voice; end
+end
+```
+
+#### Then implement it
+
+```ruby
+class Lessy
+  extend StrongInterface
+  implements IDog
+  
+  def self.create(name)
+    ...
+  end
+  
+  def eat(food)
+    ...
+  end
+  
+  def voice
+    'Gav'
+  end
+end
+```
+
+#### And if you don't
+
+```ruby
+class Lessy
+  extend StrongInterface
+  implements IDog
+
+  def voice
+    'Gav'
+  end
+end
+```
+
+#### Exception will be raised
+
+```shell
+StrongInterface::MethodNotImplemented (Class method `create` is not implemented at `Lessy`)
+Instance method `eat` is not implemented at `Lessy`
+```
+
+## Validation Strategies
+
+Validation strategy could be set through environment variable `SI_VALIDATION_STRATEGY`.
+This variable could receive only two values: `raise` and `log`. 
+In case of incorrect value the `StrongInterface::UnknownStrategy` will be raised.
+If the variable is not set, the `raise` strategy will be applied.
+
+#### raise (default)
+
+This is a default strategy. When validator finds incorrect implementation, it raises the `StrongInterface::MethodNotImplemented` exception,
+and provides a list of methods which aren't implemented
+
+#### log
+
+In this case nothing raises, the validator just logs the errors.
+It could be convenient, if you don't want to crash the whole application at boot time in production,
+even if it has this kind of a problem in code.
+
+## TODO
+
+- [x] Check if methods of interfaces all exists in a class or module
+- [ ] Check the arguments of methods
+
+## 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/[USERNAME]/strong_interface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/strong_interface/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 StrongInterface project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/strong_interface/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 'strong_interface'
+
+# 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/lib/strong_interface/version.rb

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

data/lib/strong_interface.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'strong_interface/version'
+
+module StrongInterface
+  MethodNotImplemented = Class.new(StandardError)
+  UnknownStrategy = Class.new(StandardError)
+
+  RAISING_STRATEGIES = {
+    'raise' => ->(error) { raise MethodNotImplemented, error },
+    'log' => ->(error) { Logger.new($stdout).warn { error } }
+  }.freeze
+
+  # @param interfaces [Module|Class|Array<Module|Class>] the list of interfaces that class or module should implements
+  # @raise [UnknownStrategy] if SI_NOTIFICATION environment variable has wrong value
+  # @raise [ImplementationError] if describing some methods of an interface has been forgotten and SI_NOTIFICATION environment variable is set to `raise`
+  def implements(interfaces)
+    TracePoint.trace(:end) do |t|
+      next if self != t.self
+
+      errors_strategy = ENV.fetch('SI_VALIDATION_STRATEGY', 'raise')
+      raise UnknownStrategy, errors_strategy if RAISING_STRATEGIES[errors_strategy].nil?
+
+      errors = validate(interfaces)
+
+      RAISING_STRATEGIES[errors_strategy].call(errors.join("\n")) unless errors.empty?
+
+      t.disable
+    end
+  end
+
+  private
+
+  def validate(interfaces)
+    Array(interfaces).flat_map do |interface|
+      validate_class_methods(interface) + validate_instance_methods(interface)
+    end
+  end
+
+  def validate_class_methods(interface)
+    interface.methods(false).filter_map do |klass_method|
+      "Class method `#{klass_method}` is not implemented at `#{self}`" unless methods(false).include?(klass_method)
+    end
+  end
+
+  def validate_instance_methods(interface)
+    interface.instance_methods.filter_map do |instance_method|
+      unless instance_methods.include?(instance_method)
+        "Instance method `#{instance_method}` is not implemented at `#{self}`"
+      end
+    end
+  end
+end

data/strong_interface.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'lib/strong_interface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'strong_interface'
+  spec.version       = StrongInterface::VERSION
+  spec.authors       = ['Andrew Ageev']
+  spec.email         = ['ageev86@gmail.com']
+
+  spec.summary       = 'Simple implementation of an interface pattern for Ruby'
+  spec.description   = 'Simple implementation of an interface pattern for Ruby'
+  spec.homepage      = 'https://github.com/programyan/strong_interface'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.1')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/programyan/strong_interface'
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 = %w[lib]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: strong_interface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Ageev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-09 00:00:00.000000000 Z
+dependencies: []
+description: Simple implementation of an interface pattern for Ruby
+email:
+- ageev86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/strong_interface.rb
+- lib/strong_interface/version.rb
+- strong_interface.gemspec
+homepage: https://github.com/programyan/strong_interface
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/programyan/strong_interface
+  source_code_uri: https://github.com/programyan/strong_interface
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Simple implementation of an interface pattern for Ruby
+test_files: []