rint 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a88bdceba9428f2c280c4c402720ec1e64339f50
-  data.tar.gz: 2c07c6a3ed81db32e97964dbb616581f23f9cd23
+  metadata.gz: 94920569dcb0c8f3ceabdadeeae16ad559b7893e
+  data.tar.gz: a38868d50fea6d32ec02841aab0c1d6745e90188
 SHA512:
-  metadata.gz: 44067cd1e8c048866b797480e638c48dbe5227394b9f12fab6cb24ee5aa4468ecf3fa8abb3eceeba2860d317ba7bfa1c512c4b4fd57201f16adb8910e6aca048
-  data.tar.gz: afa0e5e6cce4f038b147f47b98b1fc8efff5a2e1960148d041f1e91be77c7bdf06fed91c5686195642b1265a199324211b7337da953951129110374a24e9af7a
+  metadata.gz: 5b69a6e1bc56acae37c0d95a1d7ea5ab72e0a7035e8aae42d6fc788388fcdfee41462501b09ca6a5227c5b8f6e1a7caff4a76b0b060311280a53b7d7b330e198
+  data.tar.gz: 8466fca69539bec30f10707b03f9d106f2c24b356391597315aaf03605ea34af6ec2c413de47518d3009ee30d4bd9897a02f9af3b7af17f5bce72f8823bd1625

data/.gitlab-ci.yml

@@ -0,0 +1,29 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: "ruby:2.3"
+
+# Pick zero or more services to be used on all builds.
+# Only needed when using a docker container to run your tests in.
+# Check out: http://docs.gitlab.com/ce/ci/docker/using_docker_images.html#what-is-service
+services:
+
+variables:
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+  - ruby -v                                   # Print out ruby version for debugging
+  # Uncomment next line if your rails app needs a JS runtime:
+  # - apt-get update -q && apt-get install nodejs -yqq
+  - gem install bundler  --no-ri --no-rdoc    # Bundler is not installed with the image
+  - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+rspec:
+  script:
+  - rspec spec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [0.2.0 (unreleased)]
+- Add method arity check to _must_implement_ and refactored specs - @rodrigo-ehresmann
+- Added coverage and build status configuration and badges.
+
+## [0.1.0]
+- Initial implementation, including CLI generator.

data/README.md

@@ -1,6 +1,10 @@
+[![Gem Version](https://badge.fury.io/rb/rint.svg)](https://badge.fury.io/rb/rint) 
+[![build status](https://gitlab.com/jameslopez/rint/badges/master/build.svg)](https://gitlab.com/jameslopez/rint/commits/master)
+[![coverage report](https://gitlab.com/jameslopez/rint/badges/master/coverage.svg)](https://gitlab.com/jameslopez/rint/commits/master)
+
 # Rint (Ruby Interface)
 
-rint provides a way to implement behaviour defined by Interface files, warning when the desired behaviour is missing.
+Rint provides a way to implement behaviour defined by Interface files, warning when the desired behaviour is missing.
 
 ### Example:
 
@@ -10,55 +14,62 @@ module Playable
   include Interface
 
   def initialize
-    must_implement :play, :play_quietly
+    must_implement :play, play_quietly: 1
   end
 end
 
-require 'playable' 
-class Instrument 
+class Instrument
   implements Playable
 end
 
-Instrument.new #will throw: Interface::Error::NotImplementedError: Expected Instrument to implement play for interface Playable
+Instrument.new # will throw: Interface::Error::NotImplementedError: Expected Instrument to implement play for interface Playable
 ```
 
+As showed in the example above,`must_implement` allows you enforce the implementation of the methods, specifying the arity. When not specified, only the method implementation will be checked.
+
 There is also a CLI to generate the interfaces from the command line:
 ```sh
-$ rint c Playable play play_quietly
+$ rint c Playable play play_quietly:1
 ```
 will generate lib/playable.rb (namespaces are also supported).
 
+### Installation
+
+Add it to your Gemfile:
+
+`gem 'rint'`
+
+and run
+
+```sh
+$ bundle install
+```
+
 ### Goals
 
-Duck typing can be evil if not used correctly. While Ruby applications can get a good level of confidence about issues arisen by duck typing, the fear of a method missing exception or constant changes to a class may lead the developer to use safety checks such as respond_to? or raise Errors when a method is missing. This implementation of rint wraps what other static languages use and encapsulates the safety check in a common place, also making explicit the behaviour through the word "implements" and expecting the developer to guess the behaviour of a class without looking at docs or partially implemented code. It also provides a centralised way to implement the interface pattern without having the code throwing an error in a hidden method.
+Duck typing can be evil if not used correctly. While Ruby applications can get a good level of confidence about issues arisen by duck typing, the fear of a method missing exception or constant changes to a class may lead the developer to use safety checks such as respond_to? or raise Errors when a method is missing.
+
+This implementation of rint wraps what other static languages use and encapsulates the safety check in a common place, also making explicit the behaviour through the word "implements" and expecting the developer to guess the behaviour of a class without looking at docs or partially implemented code.
 
-### Version
-0.1.0
+It also provides a centralised way to implement the interface pattern without having the code throwing an error in a hidden method.
 
 ### Options
 
-The environment variable DISABLE_RUBY_INTERFACE can be set to 1 in order to globally disable the interfaces - this also means that no Exception will get thrown. This might be particularly useful in production for performance reasons if we are confident enough through tests that the interfaces are all implemented.
+The environment variable DISABLE_RUBY_INTERFACE can be set to 1 in order to globally disable the interfaces - no Error will get thrown. This might be particularly useful in production for performance reasons if we are confident enough through tests that the interfaces are all implemented.
 
-### Installation
+### Contributing
 
-Add it to your Gemfile:
+- Fork it
 
-gem 'rint'
+- Create your feature branch (git checkout -b my-new-feature)
 
-and run 
+- Commit your changes (git commit -am 'Add some feature')
 
-```sh
-$ bundle install
-```
+- Push to the branch (git push origin my-new-feature)
 
-### Contributing
+- Create new Pull Request
 
-Fork it
-Create your feature branch (git checkout -b my-new-feature)
-Commit your changes (git commit -am 'Add some feature')
-Push to the branch (git push origin my-new-feature)
-Create new Pull Request
-Enjoy!
+- Enjoy!
 
 
 License

data/lib/generators/interface_generator.rb

@@ -35,7 +35,13 @@ class InterfaceGenerator < Thor::Group
   end
 
   def methods
-    args[2..-1].map { |m| ":#{m}" }.join(', ')
+    args[2..-1].map do |m|
+      if m.scan(/\d+/).empty?
+        ":#{m}"
+      else
+        m.gsub(":", ": ")
+      end
+    end.join(", ")
   end
 
   def name

data/lib/interface/error/not_implemented_error.rb

@@ -3,14 +3,15 @@ module Interface
     # Raised when a method has not been implemented by a class that
     # has used the implements <InterfaceName> method.
     class NotImplementedError < NoMethodError
-      def initialize(class_name:, method_name:, interface_name:)
-        super(error_message(class_name, method_name, interface_name), method_name)
+      def initialize(class_name:, method_name:, method_arity:, interface_name:)
+        super(error_message(class_name, method_name, method_arity, interface_name), method_name)
       end
 
       private
 
-      def error_message(class_name, method_name, interface_name)
-        "Expected #{class_name} to implement #{method_name} for interface #{interface_name}"
+      def error_message(class_name, method_name, method_arity, interface_name)
+        arity = method_arity ? "/#{method_arity}" : ""
+        "Expected #{class_name} to implement #{method_name}#{arity} for interface #{interface_name}"
       end
     end
   end

data/lib/interface/helpers.rb

@@ -2,17 +2,47 @@ require 'interface/error/not_implemented_error'
 
 module Interface
   module Helpers
-    # Errors raised here identify the class_name that is not implementing
-    # the method required by the Interface.
+    # Errors raised here identify the class_name that is not implementing or is
+    # implemented with the wrong arity required by the Interface.
     def must_implement(*args)
-      args.each do |method_name|
-        next if respond_to? method_name
-        raise Interface::Error::NotImplementedError.new(
-                class_name: self.class.name,
-                method_name: method_name,
-                interface_name: self.class.ancestors.first
-              )
+      args.each do |method|
+        if method.is_a? Hash
+          method.each do |name, arity|
+            next if valid_method?(name, arity)
+            raise_interface_error(name, arity)
+          end
+        else
+          next if valid_method?(method)
+          raise_interface_error(method)
+        end
       end
     end
+
+    private
+
+    def raise_interface_error(method_name, method_arity = nil)
+      raise Interface::Error::NotImplementedError.new(
+              class_name: self.class.name,
+              method_name: method_name,
+              method_arity: method_arity,
+              interface_name: self.class.ancestors.first
+            )
+    end
+
+    # Check if method is implemented and have the specified arity (where nil
+    # points to 'unlimited').
+    def valid_method?(name, arity = nil)
+      respond_to?(name) && expected_arity?(name, arity)
+    end
+
+    def expected_arity?(method, arity)
+      return true unless arity
+      method_arity(method) == arity
+    end
+
+    # Arity of the implemented method.
+    def method_arity(method_name)
+      method(method_name).arity.abs
+    end
   end
 end

data/lib/interface/version.rb

@@ -1,3 +1,3 @@
 module Interface
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/rint.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_dependency 'thor', '~> 0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +89,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -110,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby interfaces made simple