interfacable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92541815265a22003a2ca6d492539f7de968f36d767f00119faacd81169fd493
-  data.tar.gz: 4fb7522de5255bef2ca90679e93f9e040e27875f498f6a8cc803ed241025dea2
+  metadata.gz: 8de2fb0e6c98975d368f5c465b1a45c0fb30aaef9355a2ec981c6afdc8a59766
+  data.tar.gz: d9b3e6a76c2384ba3a25775bcf8e42aa129d46676f84251f5eb81eede7e14fb9
 SHA512:
-  metadata.gz: 408470e3cf8b91e95ee37aa4720c4a56fc1d1ca6b7867c38d514358f9695738fc4407cde19eda6c242cc7dca7bce8c726a12b4dd9ab7cb5a0ae7c188a8100a5d
-  data.tar.gz: 06272c4996b62873632ad2ff90f40335e1b5faf5ad3c55a74e350e37359694c8e20b90e731bee34739e6666f501cfbfb9fe2a890a449391409088d11bd413da4
+  metadata.gz: db99b9ce149cdc158de87fc11195140ac39b9fbb4cccb48f7f5975c173d9fcb879a61e056e85f4a67bd813b69c997ebe16f1ae4e535b02749219b8b5ab3ade53
+  data.tar.gz: aea709d864dd1a0c4939b67b4c662b5283669c4e34bd22cd45e68a7b51b1bbbf7b2d4feac3997488c53eff7cf16e1283947158b458ae71d428b83f856d939c93

data/README.md

@@ -1,8 +1,6 @@
 # Interfacable [![Build Status](https://travis-ci.org/artemave/interfacable.svg?branch=master)](https://travis-ci.org/artemave/interfacable)
 
-_An interface is a programming structure/syntax that allows the computer to enforce certain properties on an object (class)_
-
-This gem allows you to impose interfaces on classes and automatically checks that those constraints are met.
+Impose interfaces on classes and let this gem automatically check that the interface constraints are met.
 
 ## Installation
 
@@ -16,15 +14,15 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install interfacable
-
 ## Usage
 
 In this example:
 
 ```ruby
+class Class
+  include Interfacable
+end
+
 module Carrier
   def call(number); end
 
@@ -32,19 +30,19 @@ module Carrier
 end
 
 class Giffgaff
-  include Interfacable
-
   implements Carrier
 end
 ```
 
-An attempt to run it will result in the following error:
+An attempt to _load_ this code will result in the following error:
 
     Giffgaff must implement: (Interfacable::Error)
       - Carrier#text
       - Carrier#call
 
-It will keep failing until `Giffgaff` defines those methods. Correctly. E.g.:
+It will keep failing until `Giffgaff` defines those methods.
+
+Correctly. E.g.:
 
 ```ruby
 class Giffgaff
@@ -54,9 +52,22 @@ class Giffgaff
 end
 ```
 
-Fail because of method signature mismatch:
+Will fail because of method signature mismatch:
 
     Giffgaff must implement correctly: (Interfacable::Error)
       - Carrier#text:
         - expected arguments: (req, req)
         - actual arguments: (req)
+
+### Rails
+
+For extra piece of mind, we can noop interface checking in production:
+
+```ruby
+# config/initializers/interfacable.rb
+class Class
+  include Interfacable
+
+  def implements(*args); end if Rails.env.production?
+end
+```

data/lib/interfacable.rb

@@ -10,34 +10,23 @@ module Interfacable
   class Error < Exception; end
   # rubocop:enable Lint/InheritException
 
-  def self.extended(base)
-    base.extend ClassMethods
-  end
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
+  def implements(*interfaces)
+    (@interfaces ||= []).push(*interfaces)
 
-  # class methods
-  module ClassMethods
-    def implements(*interfaces)
-      (@interfaces ||= []).push(*interfaces)
-
-      # rubocop:disable Naming/MemoizedInstanceVariableName
-      @interfacable_trace ||= TracePoint.trace(:end) do |t|
-        # simplecov does not see inside this block
-        # :nocov:
-        # rubocop:enable Naming/MemoizedInstanceVariableName
-        if self == t.self
-          unless (errors = ImplementationCheck.new(self).perform(@interfaces)).empty?
-            error_message = ErrorFormatter.new(self).format_errors(errors)
-            raise(Error, error_message)
-          end
-
-          t.disable
+    # rubocop:disable Naming/MemoizedInstanceVariableName
+    @interfacable_trace ||= TracePoint.trace(:end) do |t|
+      # simplecov does not see inside this block
+      # :nocov:
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+      if self == t.self
+        unless (errors = ImplementationCheck.new(self).perform(@interfaces)).empty?
+          error_message = ErrorFormatter.new(self).format_errors(errors)
+          raise(Error, error_message)
         end
-        # :nocov:
+
+        t.disable
       end
+      # :nocov:
     end
   end
 end

data/lib/interfacable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interfacable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - artemave