duck_enforcer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ec0abe7bb33ad27ec9683838b48c84c617e0ab7
+  data.tar.gz: 0cfba434337fac107af0952219b7d0421766362a
+SHA512:
+  metadata.gz: cb42ea35c07adc6799a8f01eaa3f8735b8ca51d7e1fddc7323a81a9f02a742f16d27cdac71f3a6db238f3ae07f94d5ad177b6e55e1deb9d6744875cf5f66a37a
+  data.tar.gz: ce6cf25fba9675f17f9ac6ebca271c3e144453e5160485537fc3f2fd26866841057c34257404a693e09d2230fb6eca4505623c437b952077072d4f8ae271eb24

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-14 Bozhidar Batsov
+
+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,147 @@
+# DuckEnforcer
+
+_Add a java smell to your ruby_
+
+Working on a project with a lots of other developer ? No longer wanting to explain what a duck is meant to be able to do ? DuckEnforcer might be for you !
+
+```ruby
+class Quacker < DuckEnforcer
+  implement :quack
+end
+
+class GoodDuck
+  def quack() puts 'quack'; end
+  quacks_like_a! Quacker # OK, all good
+end
+
+class BadDuck
+  def waddle() puts 'waddle'; end
+  quacks_like_a! Quacker # Raise a NotImplementedError
+end
+```
+
+## Installation
+
+Easy as pie:
+
+```
+gem install duck_enforcer
+```
+
+Or in a Gemfile:
+
+```
+gem 'duck_enforcer'
+```
+
+and finally:
+
+```
+require 'duck_enforcer'
+```
+
+## Usage
+
+Using DuckEnforcer is a four steps process:
+
+1. Define your interface
+2. Write your implementations
+3. ...
+4. Profit.
+
+### Defining an interface
+
+Just define your interface as a class inheriting from DuckEnforcer.
+
+Add an `implement` statement per needed method.
+
+Exemple of an Observer interface:
+
+```ruby
+require 'duck_enforcer'
+
+class MyObserver < DuckEnforcer
+  implement :update
+end
+```
+
+### Writing implementations
+
+To (kind of) 'implement' the interface, you just have to write a class defining an instance method per 'implement' statement, and (optionally) add the `quacks_like_a!` statement:
+
+```ruby
+class LoggerObserver
+  def update(value)
+    puts value
+  end
+
+  quacks_like_a! MyObserver
+end
+
+class RecorderObserver
+  attr_reader :values
+
+  def update(value)
+    (@values ||= []) << value
+  end
+
+  quacks_like_a! MyObserver
+end
+```
+
+If you add another method to your interface, your script will fail while loading the classes that miss the new method, making it far more easy to update a duck typing based hierarchy.
+
+### Scope restriction
+
+In order to avoid leaking your abstrations, you can as well use the `as_a` helper, that encapsulate the callee in a DuckEnforcer wrapper, limiting access to interface methods only (plus Object instance methods).
+
+Example:
+
+```ruby
+class ConcreteObserver
+  def update(value)
+    log(value)
+  end
+
+  def log(value)
+    puts value
+  end
+
+  quacks_like_a! MyObserver
+end
+
+class Foobar
+  def initialize(observer)
+    # here, we are encapsulating observer in a DuckEnforcer wrapper
+    @observer = observer.as_a MyObserver
+  end
+
+  def bar=(value)
+    @observer.log('Failure') # That call will raise a NoMethodError
+    @observer.update(value)  # That call will succeed
+    @bar = value
+  end
+end
+```
+
+In the previous example, to get rid of the NoMethodError, you have to either:
+
+* Add an `implement :log` statement in MyObserver (worst solution so far, as you are delegating two responsibilities to implementing objects: logging and update processing)
+* Remove the log call, and inject a logger object in your Foobar constructor (cleaner).
+
+Last interesting remark: an object can quack like a tons of things...
+
+```ruby
+  class Writable
+    implement :write
+  end
+
+  class Readable
+    implement :read
+  end
+
+  class File
+    # ...
+    quacks_like_a! Writable, Readable
+  end
+```

data/duck_enforcer.gemspec

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'duck_enforcer/version'
+
+Gem::Specification.new do |s|
+  s.name = 'duck_enforcer'
+  s.version = DuckEnforcer::Version::STRING
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.0.0'
+  s.authors = ['Alexandre Ignjatovic']
+  s.description = <<-EOF
+    A duck typing enforcer.
+  EOF
+
+  s.email = 'alexandre.ignjatovic@gmail.com'
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ %r{^(?:
+    spec/.*
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    |\.rubocop_todo.yml
+    |.*\.eps
+    )$}x
+  end
+  s.test_files = []
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.extra_rdoc_files = ['LICENSE.txt', 'README.md']
+  s.homepage = 'http://github.com/bankair/duck_enforcer'
+  s.licenses = ['MIT']
+  s.require_paths = ['lib']
+  s.rubygems_version = '1.8.23'
+
+  s.summary = 'A ruby microframework to enforce duck typing.'
+
+  s.add_development_dependency('rspec', '~> 3.4')
+end

data/lib/duck_enforcer.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+require 'duck_enforcer/version'
+
+# DuckEnforcer base class
+class DuckEnforcer
+  require 'forwardable'
+  extend Forwardable
+
+  def self.implement(*args)
+    def_delegators :@obj, *args
+    Array(args).each { |method| (@methods ||= []) << method }
+  end
+
+  def self.check_conformity!(klass)
+    @methods.each do |method|
+      unless klass.instance_methods.include? method
+        raise(NotImplementedError, "Missing method #{method} in class #{klass}")
+      end
+    end
+  end
+
+  def initialize(obj)
+    self.class.check_conformity! obj.class
+    @obj = obj
+  end
+end
+
+# Add the Class.quacks_like_a! helper method
+class Class
+  def quacks_like_a!(*args)
+    Array(args).each do |klass|
+      unless klass.ancestors.include? DuckEnforcer
+        raise(ArgumentError, "#{klass.inspect} is not a DuckEnforcer")
+      end
+      klass.check_conformity!(self)
+    end
+  end
+end
+
+# Add the Object#as_a helper method
+class Object
+  def as_a(klass)
+    klass.new(self)
+  end
+end

data/lib/duck_enforcer/version.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+class DuckEnforcer
+  # This module holds the DuckEnforcer version information.
+  module Version
+    STRING = '1.0.0'
+
+    module_function
+
+    def version(_debug = false)
+      STRING
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: duck_enforcer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexandre Ignjatovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: "    A duck typing enforcer.\n"
+email: alexandre.ignjatovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- duck_enforcer.gemspec
+- lib/duck_enforcer.rb
+- lib/duck_enforcer/version.rb
+homepage: http://github.com/bankair/duck_enforcer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby microframework to enforce duck typing.
+test_files: []