oop-interface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adcb81e23d62c55d873632321e2337e89782b773
+  data.tar.gz: b9ee510a2f6846034b1a2b985112444b16eaaf21
+SHA512:
+  metadata.gz: 25d092dee5f35034b820fc3a8a8d62f52750a6f5b8694fdbb70128992473f7022438e9089ff065de69e361def682c34e8cb6792b2188842179e237945b7627b6
+  data.tar.gz: 75c1712764d1eea63644652db2ae5359c9455028c25d1fbe761663b03ce70d9a44c8c80699d133e6d3c74f1ebe7a0670e3efdba712f98bf7852af24752aafedd

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 interface.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    oop-interface (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  oop-interface!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrzej Sliwa
+
+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,85 @@
+# OOP Interface for Ruby
+
+This gem takes inspiration from https://github.com/shuber/interface and 
+borrow some implementation details from it, extend it and modify available api.
+
+Credits for [Sean Huber](https://github.com/shuber)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oop-interface'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interface
+
+## Usage
+
+Example usage:
+
+      require "interface"
+
+      module Order
+        def submit; end
+        def add_position(_position); end
+      end
+    
+      module Saver
+        def save; end
+      end
+    
+      class OrderImpl
+        include Interface
+        implements Order, Saver
+        def submit
+          :submitted
+        end
+    
+        def save(some: 5)
+          "save #{some}"
+        end
+      end
+      
+      > OrderImpl.interfaces
+       => [Order, Saver] 
+      > OrderImpl.unimplemented_methods
+       => {Order=>[:add_position]} 
+      > saver = OrderImpl.new.as(Saver)
+       => #<Saver:70247745038560> 
+      > saver.submit
+      NoMethodError: undefined method `submit' for #<Saver:70247745038560>
+      > saver.save(some: 8)
+      "save 8"
+      > OrderImpl.new.add_position
+      NotImplementedError: OrderImpl needs to implement 'add_position' for interface Order
+      > OrderImpl.new.is_a? Saver
+      => true 
+      > OrderImpl.new.is_a? Order
+      => true
+      
+The main idea behind of implementation of such gem, was limiting the scope.
+For example when you are implementing Aggregate Root (following Domain Driven Design) 
+in ActiveRecord, you would like to expose only public contract methods to ensure that 
+Aggregate Root boundaries are not crossed by using directly relations or ActiveRecord 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/andrzejsliwa/interface.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "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/interface.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "interface/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oop-interface"
+  spec.version       = Interface::VERSION
+  spec.authors       = ["Andrzej Sliwa", "Sean Huber"]
+  spec.email         = ["andrzej.sliwa@i-tool.eu"]
+
+  spec.summary       = %q{Simple implementation of interfaces in Ruby}
+  spec.description   = %q{Simple implementation of interfaces in Ruby}
+  spec.homepage      = "http://github.com/andrzejsliwa/oop-interface"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/interface.rb

@@ -0,0 +1,87 @@
+require "interface/version"
+
+module Interface
+  UnknownInterface = Class.new(StandardError)
+  module Abstract
+    def self.extended(interface)
+      interface.class_eval do
+        instance_methods(false).each do |method|
+          define_method(method) do |*args, &block|
+            methods = [:super, :method_missing]
+            begin
+              send(methods.shift, *args, &block)
+            rescue NoMethodError
+              if methods.empty?
+                raise NotImplementedError.new("#{self.class} needs to implement '#{method}' for interface #{interface}")
+              else
+                args.unshift(method.to_sym)
+                retry
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def implements(*modules)
+      modules.flatten.reverse!.each { |mod| include mod.extend(Abstract) }
+    end
+    alias_method :implement, :implements
+
+    def interfaces
+      klass = is_a?(Class) ? self : self.class
+      klass.included_modules.select { |mod| mod.is_a?(Abstract) }
+    end
+
+    def unimplemented_methods
+      interfaces.inject({}) do |hash, interface|
+        methods = unimplemented_methods_for(interface)
+        methods.empty? ? hash : hash.merge!(interface => methods)
+      end
+    end
+
+    def unimplemented_methods_for(interface)
+      interface.instance_methods(false).reject do |method|
+        !method_defined?(method.to_sym) || instance_method(method.to_sym).owner != interface
+      end.sort.map(&:to_sym)
+    end
+  end
+
+  def as(interface)
+    raise UnknownInterface.new(interface) unless self.class.interfaces.include?(interface)
+    Class.new do
+      def initialize(target)
+        @target = target
+      end
+
+      interface.instance_methods.select do |method|
+        interface.instance_method(method.to_sym).owner == interface
+      end.each do |method|
+        define_method(method) do |*args, &block|
+          @target.public_send(method, *args, &block)
+        end
+      end
+
+      [:is_a?, :kind_of?, :instance_of?].each do |type_method|
+        define_method(type_method) do |target, &block|
+          return true if target == interface
+          super
+        end
+      end
+
+      define_method(:inspect) do
+        "#<#{interface.name}:#{self.object_id}>"
+      end
+
+      def to_s
+        inspect
+      end
+    end.new(self)
+  end
+end

data/lib/interface/version.rb

@@ -0,0 +1,3 @@
+module Interface
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: oop-interface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrzej Sliwa
+- Sean Huber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Simple implementation of interfaces in Ruby
+email:
+- andrzej.sliwa@i-tool.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- interface.gemspec
+- lib/interface.rb
+- lib/interface/version.rb
+homepage: http://github.com/andrzejsliwa/oop-interface
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.11
+signing_key: 
+specification_version: 4
+summary: Simple implementation of interfaces in Ruby
+test_files: []