interfacer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a833ad6c374e5255b3390d46b0f8bac7f14d040f88a255182efc159170d1b6f
+  data.tar.gz: 3d40f9c176ce3ef82c164780d09c6efdf77212ca8cb1d461e06166011af43fc2
+SHA512:
+  metadata.gz: 9c20b5f30a63ced573767ec4a4cb9d7b2b772aace4757a610564ea041465ffb72b4658fb50f9d53fa970cd95f88a97f78a3a3139f76e391ba8b931035d912240
+  data.tar.gz: b2564c14983ca1732bc40f25487243b747470b4781106e3dd654e4f7b8a3fc3b0784f756fdffb6980b9746bc47180e9b52510002bb492266007a3e7b00705c54

data/.yardopts

@@ -0,0 +1,7 @@
+--output-dir=yardoc
+--markup-provider=redcarpet
+--markup=markdown
+--no-private
+--embed-mixins
+--plugin rspec
+--files doc/*md

data/README.md

@@ -0,0 +1,104 @@
+# About
+
+[![Gem version][GV img]][Gem version]
+[![Build status][BS img]][Build status]
+[![Coverage status][CS img]][Coverage status]
+[![CodeClimate status][CC img]][CodeClimate status]
+[![YARD documentation][YD img]][YARD documentation]
+
+How much abstraction is too much?
+
+On one hand <abbr title="Inversion of control">IoC</abbr> is probably a too heavy canon for a dynamic language like Ruby, instantiating external dependencies in `#initalize` doesn't sound like a good idea either.
+
+If I have to replace a dependency, I want to know what interface it has to provide.
+
+That is what methods is my project actually using, so not the same as `class MyCollection implements ListInterface`.
+
+# Example
+
+```ruby
+require 'import'
+
+Interfacer = import('interfacer').Interfacer
+
+class Post
+  extend Interfacer
+
+  attribute(:time_class, '.now', '#to_s') { Time }
+
+  def publish!
+    "~ Post #{self.inspect} has been published at #{self.time_class.now} (using #{self.time_class})."
+  end
+end
+
+puts "~ With the default time_class."
+post = Post.new
+puts post.publish!
+
+puts "\n~ With overriden time_class."
+require 'date'
+
+post = Post.new
+post.time_class = DateTime
+puts post.publish!
+```
+
+To me, this is what I consider to be the golden middle way. There's nearly no extra code, no factory method etc, but I can replace the time class any time I want.
+
+Why?
+
+```ruby
+class TimeMock
+  class << self
+    alias_method :now, :new
+  end
+
+  def to_s
+    'Monday evening'
+  end
+end
+
+describe Post do
+  before(:each) do
+    subject.time_class = TimeMock
+  end
+
+  it "prints out when a post was published" do
+    expect(post.publish!).to match(/has been published at Monday evening/)
+  end
+end
+```
+
+You can say that you could just stub `Time.now` and you're right, but I'm not a huge fan of that approach. I like clear dependencies, actual objects and (on a slightly different subject, but still vaguely related) I think tests should test public APIs and not order in which things are executed (when used mocks), because everything breaks when you do internal refactoring.
+
+But whatever, let's have an another example.
+
+```ruby
+settings = import('settings')
+
+class Post
+  attribute :json_encoder, '.generate' { settings.json_encoder }
+end
+```
+
+Now when you decide to switch to say `oj`, all you have to do is this:
+
+```ruby
+# settings.rb
+
+require 'oj'
+
+export json_encoder: Oj
+```
+
+[Gem version]: https://rubygems.org/gems/interfacer
+[Build status]: https://travis-ci.org/botanicus/interfacer
+[Coverage status]: https://coveralls.io/github/botanicus/interfacer
+[CodeClimate status]: https://codeclimate.com/github/botanicus/interfacer/maintainability
+[YARD documentation]: http://www.rubydoc.info/github/botanicus/interfacer/master
+
+[GV img]: https://badge.fury.io/rb/interfacer.svg
+[BS img]: https://travis-ci.org/botanicus/interfacer.svg?branch=master
+[CS img]: https://img.shields.io/coveralls/botanicus/interfacer.svg
+[CC img]: https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability
+[YD img]: http://img.shields.io/badge/yard-docs-blue.svg

data/lib/interfacer.rb

@@ -0,0 +1,59 @@
+# @api private
+class InterfaceSpec
+  def initialize(required_interface_methods)
+    @required_interface_methods = required_interface_methods
+  end
+
+  def missing_methods(tested_class)
+    @required_interface_methods.reject do |method_name|
+      if method_name[0] == '.'
+        tested_class.respond_to?(method_name[1..-1])
+      elsif method_name[0] == '#'
+        tested_class.instance_methods.include?(method_name[1..-1].to_sym)
+      else
+        raise ArgumentError.new("Incorrect method name. Method name must start with either . or #, such as .new or #to_s.")
+      end
+    end
+  end
+
+  def fullfills_interface?(tested_class)
+    self.missing_methods(tested_class).empty?
+  end
+end
+
+# @api public
+class InterfaceRequirementsNotMetError < StandardError
+  def initialize(attr_name, missing_methods)
+    super("Attribute #{attr_name} expects #{missing_methods.inspect} to be defined.")
+  end
+end
+
+# @api public
+module Interfacer
+  def interface_specs_for_attrs
+    @interface_specs_for_attrs ||= Hash.new
+  end
+
+  def attribute(attr_name, *required_methods, &block)
+    interface_specs_for_attrs[attr_name] = InterfaceSpec.new(required_methods)
+
+    define_method(attr_name) do
+      value = instance_variable_get(:"@#{attr_name}")
+      return value if value
+      instance_variable_set(:"@#{attr_name}", block.call)
+    end
+
+    define_method(:"#{attr_name}=") do |value|
+      spec = self.class.interface_specs_for_attrs[attr_name]
+
+      unless spec.fullfills_interface?(value)
+        raise InterfaceRequirementsNotMetError.new(attr_name, spec.missing_methods(value))
+      end
+
+      instance_variable_set(:"@#{attr_name}", value)
+    end
+  end
+end
+
+export Interfacer: Interfacer,
+       InterfaceRequirementsNotMetError: InterfaceRequirementsNotMetError

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: interfacer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James C Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commonjs_modules
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: "."
+email: james@101ideas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- README.md
+- lib/interfacer.rb
+homepage: http://github.com/botanicus/interfacer
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.7.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []