uptyped 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d501e11734efcd96ece3c6bf2ef54adc439ef93d
+  data.tar.gz: 5db79e56fb78309fbcf9572c5f557c7e486dadda
+SHA512:
+  metadata.gz: b70ada3e4685accedc1929b630788e895cc24d5a97859f2b5eb4e64df552b8ee9555107fca8c16f686bf6609cd27cb670e45bdcced674927e051aac095ed238e
+  data.tar.gz: 01a99e7c9befdcfd389ca36a60a3e1d25c5a6d4904305f2ba98324f8e21fda7338ce4b2786ae5f9933d76d79280ad498bc36d10231547c46644573fa6feb5768

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/uptyped/inherited_interface.rb

@@ -0,0 +1,51 @@
+require "uptyped/version"
+require "uptyped/interface_validator"
+
+module Uptyped
+  module InheritedInterface
+    def self.included(scope)
+      scope.include_context "inherits interface"
+    end
+
+    shared_context 'inherits interface' do
+      unless described_class.superclass == Object
+        describe "public methods:" do
+          it "should contain only public instance methods that are inherited" do
+            validator = Uptyped::InterfaceValidator.new(described_class)
+
+            expect(validator.public_instance_method_errors).to be_empty, validator.public_instance_method_errors
+          end
+
+          it "should contain only public class methods that are inherited" do
+            validator = Uptyped::InterfaceValidator.new(described_class)
+            expect(validator.public_class_method_errors).to be_empty, validator.public_class_method_errors
+          end
+        end
+
+        describe "arity:" do
+          context "instance methods" do
+            it "should have the same public instance method arity as its superclass" do
+              validator = Uptyped::InterfaceValidator.new(described_class)
+
+              expect(validator.instance_method_arity_errors).to be_empty, validator.instance_method_arity_errors
+            end
+          end
+
+          context "class methods" do
+            it "should have the same public instance method arity as its superclass" do
+              validator = Uptyped::InterfaceValidator.new(described_class)
+
+              expect(validator.class_method_arity_errors).to be_empty, validator.class_method_arity_errors
+            end
+          end
+        end
+      end
+    end
+
+    def self.configure
+      RSpec.configure do |config|
+        config.include InheritedInterface
+      end
+    end
+  end
+end

data/lib/uptyped/interface_validator.rb

@@ -0,0 +1,67 @@
+class Uptyped::InterfaceValidator
+  attr_reader :public_instance_method_errors, :public_class_method_errors, :instance_method_arity_errors, :class_method_arity_errors
+
+  def initialize(klass)
+    @validated_class = klass
+    @public_instance_method_errors = []
+    @public_class_method_errors = []
+    @instance_method_arity_errors = []
+    @class_method_arity_errors = []
+    check_for_extra_subclass_instance_methods
+    check_for_extra_subclass_class_methods
+    check_instance_methods_for_arity_mismatches
+    check_class_methods_for_arity_mismatches
+  end
+
+  def success?
+    (public_instance_method_errors + public_class_method_errors + instance_method_arity_errors + class_method_arity_errors).empty?
+  end
+
+  private
+
+  def validated_class
+    @validated_class
+  end
+
+  def check_for_extra_subclass_instance_methods
+    extra_instance_methods = validated_class.instance_methods - validated_class.superclass.instance_methods
+    unless extra_instance_methods.empty?
+      error_message = "expected #{validated_class} to have the same public instance methods as #{validated_class.superclass}, got #{extra_instance_methods}."
+      @public_instance_method_errors << error_message
+    end
+  end
+
+  def check_for_extra_subclass_class_methods
+    local_public_methods = validated_class.methods
+    superclass_public_methods = validated_class.superclass.methods
+    extra_public_methods = local_public_methods - superclass_public_methods
+    unless extra_public_methods.empty?
+      error_message = "expected #{validated_class} to have the same public class methods as #{validated_class.superclass}, got #{extra_public_methods}."
+      @public_class_method_errors << error_message
+    end
+  end
+
+  def check_instance_methods_for_arity_mismatches
+    (validated_class.superclass.instance_methods - validated_class.superclass.superclass.instance_methods).push(:initialize).each do |method|
+      klass_arity = validated_class.instance_method(method).arity
+      superklass_arity = validated_class.superclass.instance_method(method).arity
+
+      unless klass_arity == superklass_arity
+        error_message = "#{validated_class}##{method.to_s} takes #{klass_arity} argument(s) while #{validated_class.superclass}##{method.to_s} takes #{superklass_arity} argument(s)."
+        instance_method_arity_errors << error_message
+      end
+    end
+  end
+
+  def check_class_methods_for_arity_mismatches
+    (validated_class.superclass.methods - validated_class.superclass.superclass.methods).each do |method|
+      klass_arity = validated_class.method(method).arity
+      superklass_arity = validated_class.superclass.method(method).arity
+
+      unless klass_arity == superklass_arity
+        error_message = "#{validated_class}.#{method.to_s} takes #{klass_arity} argument(s) while #{validated_class.superclass}.#{method.to_s} takes #{superklass_arity} argument(s)."
+        @class_method_arity_errors << error_message
+      end
+    end
+  end
+end

data/lib/uptyped/version.rb

@@ -0,0 +1,3 @@
+module Uptyped
+  VERSION = "0.1.0"
+end

data/lib/uptyped.rb

@@ -0,0 +1,4 @@
+module Uptyped
+  require "uptyped/interface_validator"
+  require "uptyped/inherited_interface"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: uptyped
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeffrey Matthias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+description: Currently adds tests to anything that doesn't inherit from Object.
+email:
+- jeffrey@sendgrid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/uptyped.rb
+- lib/uptyped/inherited_interface.rb
+- lib/uptyped/interface_validator.rb
+- lib/uptyped/version.rb
+homepage: https://github.com/sendgrid/uptyped
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds tests to enforce that interface is only inherited from superclass.
+test_files: []