bossy 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc3ed9df38c9d7c470ebd5e8eb68e6de1b52e501
-  data.tar.gz: dd739f714eae9a6e022d78b961e10c36c0516869
+  metadata.gz: c47b19da9df1ee76c5afb78b067dd8887f651a1d
+  data.tar.gz: 6c90c4c8942e7fb4ec4638516634008a034a626b
 SHA512:
-  metadata.gz: bd99784c4f4534b6268ee98843d87b30bbda05380afdd012ca70dc74f40d95e44dec9819918c9e91c461379e5377344b222b22a299dc0335ead26b5c4cbbd3de
-  data.tar.gz: 7904f26b24c0d2928b6d27f61c674e496228374ba01b49f0efda144dedc4cef3b38ee828a2f1c48eeefa8b07ea8e85d07feb2e02f84cf097f938145fd36855c0
+  metadata.gz: 5569e6eb54fb22351f54d3f1053ae6584b1dbc56019d8a216e4ffd529ef2b211dedb263864ab9b6f2bd99d73ce653e7ba3a7c57a7afe60026f5790b059c6fe1f
+  data.tar.gz: fe2d5f1b0bb6b911797884d99b695d861c5cf6aff8007b1d53efe8ffde72af225cc219b31939d73716b1dd1733edf1492733e7d9aac8a18103259b5994ad1ca6

data/lib/bossy/class_methods.rb

@@ -0,0 +1,14 @@
+# These methods are what get added to any class that implements a Bossy
+module Bossy::ClassMethods
+  def interface=(new_interface)
+    if @bossy_interface.nil?
+	  @bossy_interface = new_interface
+    else # If we already have an interface, just add methods to it.
+      @bossy_interface.add_required_methods(new_interface.interface_methods)
+    end
+  end
+
+  def interface
+    @bossy_interface
+  end
+end

data/lib/bossy/errors/method_missing.rb

@@ -0,0 +1,6 @@
+module Bossy
+  module Errors
+    # Raised if a class or instance does not meet the interface requirements.
+    class MethodMissing < RuntimeError; end
+  end
+end

data/lib/bossy/interface.rb

@@ -0,0 +1,42 @@
+module Bossy
+  class Interface
+    attr_accessor :klass, :interface_methods
+
+    def initialize(klass, required_methods)
+      @klass = klass
+      @interface_methods = []
+      add_required_methods(required_methods)
+    end
+
+    def validate!
+      interface_methods.each do |method_signature|
+        unless class_has_method?(klass, method_signature.name)
+          raise Bossy::Errors::MethodMissing, "Please define #{klass}##{method_signature.name} with the signature:\n\n#{method_signature}\n\n"
+        end
+      end
+
+      return true
+    end
+
+    def add_required_methods(m)
+      @interface_methods += m
+    end
+
+    def to_s
+      bullet = "\u279E".encode
+      s  = "Interface for #{@klass}\n"
+      s += interface_methods.map{|m| "#{bullet} #{m}" }.join("\n")
+      return s
+    end
+
+    def print
+      puts to_s
+    end
+
+    def class_has_method?(klass, method_name)
+      klass.instance_methods(true).include?(method_name)
+    end
+    private :class_has_method?
+
+  end
+end

data/lib/bossy/method_signature.rb

@@ -0,0 +1,26 @@
+# This class encapsulates the definition of a method signature.
+# That includes the method name, return type, parameters and parameter types.
+# Basically it captures: `String my_method(Integer arg1, Float arg2)`.
+# You can instantiate this class by calling:
+# `Bossy::MethodSignature.new(String: :my_method, Integer: :arg1, Float: :arg2)`
+#
+module Bossy
+  class MethodSignature
+    attr_reader :name
+
+    def initialize(method_type, method_name, args)
+      @type = method_type
+      @name = method_name
+      @name = @name.to_s if RUBY_VERSION.to_f < 1.9
+      @args = args
+    end
+
+    def to_s
+      "#{@type} #{@name}(#{args_to_s(@args)})"
+    end
+
+    def args_to_s(args)
+      args.map{|nt| "#{nt.first} #{nt.last}"}.join(", ")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bossy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Adam Stasio
@@ -50,6 +50,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/bossy/class_methods.rb
+- lib/bossy/errors/method_missing.rb
+- lib/bossy/interface.rb
+- lib/bossy/method_signature.rb
 - lib/bossy.rb
 homepage: http://nowhere.yet
 licenses: