behaves 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd22ae5f7d6af9cc2a76a8d7b73d7ec25af7c759afac262731ef56c79f1d9a3b
-  data.tar.gz: b5abbc034aa95a5067bed0ce7eb2f5472c6b3e89333d8128806499ea25d38fdc
+  metadata.gz: 4c594bfaa286e772150c5e2c31c24fe2b4684cd4fbd68f16341cc30b6c9ebfe0
+  data.tar.gz: 5aa8758aee6a60747332ac0515a73a1bc3a63d3336870237b13290b09f1cda39
 SHA512:
-  metadata.gz: a809170ad8c43554ee5a6845ec558ce803a766ec216a088c7fb21b6b92c355dc5d618b340a48fdf5eb4cb80079d40c429622d8a344998a3a278454aa84414129
-  data.tar.gz: 1ed4e8d27bd2171cc0e2020c1fa869ff099c887ebaeb2ef35c4d639c715d5b5e3787910e272a99b7a5c0b5fe0e31fc0af29715f1de40364652bd32bca113c4ac
+  metadata.gz: 87e3bf7f5c4c218c7e2cd8de1540577455cb51340bfc51f28fc6043a025315af8d07fe8802cdd750488152eb9649b219147534cc17ea08682c7b8b410312e476
+  data.tar.gz: 004aa2b59f31bd916b4df9380ef8d9a5bb3f6a24d88a09c549a85fbfd5b5a6cfc74d379d6c24681e19e6461aac9856be72253358ef66690da4e625f183b058c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    behaves (0.1.1)
+    behaves (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -144,6 +144,35 @@ This extends to more than just method implementation too, you can do anything yo
 
 *Do note that if you use this extensively, you might be better off using inheritance, since this will create more `Method` objects than inheritance.*
 
+### Private Behaviors
+
+Private behaviors can be defined like so:
+
+```ruby
+class Interface
+  extend Behaves
+
+  implements :foo
+  implements :bar, private: true
+end
+
+class Implementor
+  extend Behaves
+
+  behaves_like Interface
+
+  def foo
+    123
+  end
+
+  private
+
+  def bar
+    456
+  end
+end
+```
+
 ## Tips
 If you do not want to type `extend Behaves` every time, you can monkey patch `Behaves` onto `Object` class, like so:
 

data/lib/behaves.rb

@@ -2,8 +2,15 @@ require 'behaves/version'
 require 'set'
 
 module Behaves
-  def implements(*methods)
-    @behaviors ||= Set.new(methods)
+  def implements(*methods, **opts)
+    @_public_behaviors  ||= Set.new
+    @_private_behaviors ||= Set.new
+
+    if opts[:private] == true
+      @_private_behaviors += Set.new(methods)
+    else
+      @_public_behaviors  += Set.new(methods)
+    end
   end
 
   def inject_behaviors (&block)
@@ -12,25 +19,68 @@ module Behaves
 
   def behaves_like(klass)
     add_injected_behaviors(klass)
-    at_exit { check_for_unimplemented(klass) }
+    at_exit {
+      check_for_unimplemented(klass, :public)
+      check_for_unimplemented(klass, :private)
+    }
   end
 
   private
 
-  def check_for_unimplemented(klass)
-    required = defined_behaviors(klass)
+  def check_for_unimplemented(klass, scope)
+    required = defined_behaviors(klass, scope)
 
-    implemented = Set.new(self.instance_methods - Object.instance_methods)
-
-    unimplemented = required - implemented
+    unimplemented = required - implemented(scope)
 
     return if unimplemented.empty?
 
-    raise NotImplementedError, "Expected `#{self}` to behave like `#{klass}`, but `#{unimplemented.to_a.join(', ')}` are not implemented."
+
+    # basic "unimplemented method" error message
+
+    err = <<~ERR
+      \n\n  Expected `#{self}` to behave like `#{klass}`, but the following #{scope} methods are unimplemented:\n
+      #{unimplemented.to_a.map{|method| "    * `#{method}`"}.join("\n")}\n
+    ERR
+
+
+    # add "wrong scope" message
+
+    other_scopes            = (scope == :public) ? [:private] : [:public]
+    methods_in_other_scopes = Set.new( other_scopes.map{|s| implemented(s)}.map(&:to_a).flatten.compact )
+    methods_in_wrong_scope  = unimplemented && methods_in_other_scopes
+
+    if !methods_in_wrong_scope.empty?
+      err += <<~ERR
+        \n  The following methods appear to be defined, but in the wrong scope:\n
+        #{methods_in_wrong_scope.to_a.map{|method| "    * `#{method}`"}.join("\n")}\n\n
+      ERR
+    end
+
+
+    raise NotImplementedError, err
+  end
+
+  def implemented(scope)
+    lookups = {
+      public:           :instance_methods,
+      private:  :private_instance_methods,
+    }
+
+    method_lookup_sym = lookups.fetch(scope) do
+      raise ArgumentError.new <<~ERR
+
+        Invalid `scope`: #{scope}
+        Valid `scope`s include: #{lookups.keys.map{|sym| "`#{sym.inspect}`"}.join(', ')}
+      ERR
+    end
+
+    methods = self.send(method_lookup_sym, false)
+
+    Set.new(methods)
   end
 
-  def defined_behaviors(klass)
-    if behaviors = klass.instance_variable_get("@behaviors")
+  def defined_behaviors(klass, scope)
+    if behaviors = klass.instance_variable_get(:"@_#{scope}_behaviors")
       behaviors
     else
       raise NotImplementedError, "Expected `#{klass}` to define behaviors, but none found."

data/lib/behaves/version.rb

@@ -1,3 +1,3 @@
 module Behaves
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: behaves
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edison Yap
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry