rint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a88bdceba9428f2c280c4c402720ec1e64339f50
+  data.tar.gz: 2c07c6a3ed81db32e97964dbb616581f23f9cd23
+SHA512:
+  metadata.gz: 44067cd1e8c048866b797480e638c48dbe5227394b9f12fab6cb24ee5aa4468ecf3fa8abb3eceeba2860d317ba7bfa1c512c4b4fd57201f16adb8910e6aca048
+  data.tar.gz: afa0e5e6cce4f038b147f47b98b1fc8efff5a2e1960148d041f1e91be77c7bdf06fed91c5686195642b1265a199324211b7337da953951129110374a24e9af7a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rint.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) <2015> <James Lopez>
+
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,71 @@
+# Rint (Ruby Interface)
+
+rint provides a way to implement behaviour defined by Interface files, warning when the desired behaviour is missing.
+
+### Example:
+
+```ruby
+require 'interface'
+module Playable
+  include Interface
+
+  def initialize
+    must_implement :play, :play_quietly
+  end
+end
+
+require 'playable' 
+class Instrument 
+  implements Playable
+end
+
+Instrument.new #will throw: Interface::Error::NotImplementedError: Expected Instrument to implement play for interface Playable
+```
+
+There is also a CLI to generate the interfaces from the command line:
+```sh
+$ rint c Playable play play_quietly
+```
+will generate lib/playable.rb (namespaces are also supported).
+
+### 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.
+
+### Version
+0.1.0
+
+### 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.
+
+### Installation
+
+Add it to your Gemfile:
+
+gem 'rint'
+
+and run 
+
+```sh
+$ bundle install
+```
+
+### Contributing
+
+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!
+
+
+License
+----
+
+MIT
+
+**Free Software, Hell Yeah!**
+
+Copyright 2015 James Lopez https://github.com/bluegod/rint

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/rint

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'generators/interface_generator.rb'
+InterfaceGenerator.start

data/lib/core_ext/module.rb

@@ -0,0 +1,11 @@
+class Module
+  def implements(*args)
+    prepend(*args) unless disabled_interface?
+  end
+
+  private
+
+  def disabled_interface?
+    ENV['DISABLE_RUBY_INTERFACE'] == '1'
+  end
+end

data/lib/generators/interface_generator.rb

@@ -0,0 +1,48 @@
+require 'thor'
+class InterfaceGenerator < Thor::Group
+  include Thor::Actions
+
+  def self.source_root
+    File.dirname(__FILE__)
+  end
+
+  def check_arguments
+    return unless args.size < 3 || command != 'c'
+    puts 'Use: rint c <class> <methods>'
+    puts 'Example: rint c MyApp::MyClass method_one method_two'
+    exit
+  end
+
+  def define_instance_vars
+    @name = name
+    @file_name = underscore(@name.dup)
+    @methods = methods
+  end
+
+  def create_interface_file
+    template('templates/generic_interface.tt', "lib/#{@file_name}.rb")
+  end
+
+  private
+
+  def underscore(word)
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    word.tr!('-', '_')
+    word.downcase!
+    word
+  end
+
+  def methods
+    args[2..-1].map { |m| ":#{m}" }.join(', ')
+  end
+
+  def name
+    args[1]
+  end
+
+  def command
+    args.first
+  end
+end

data/lib/generators/templates/generic_interface.tt

@@ -0,0 +1,8 @@
+require 'interface/interface'
+module <%= @name %>
+  include Interface
+
+  def initialize
+    must_implement <%= @methods %>
+  end
+end

data/lib/interface/error/not_implemented_error.rb

@@ -0,0 +1,17 @@
+module Interface
+  module Error
+    # 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)
+      end
+
+      private
+
+      def error_message(class_name, method_name, interface_name)
+        "Expected #{class_name} to implement #{method_name} for interface #{interface_name}"
+      end
+    end
+  end
+end

data/lib/interface/helpers.rb

@@ -0,0 +1,18 @@
+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.
+    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
+              )
+      end
+    end
+  end
+end

data/lib/interface/version.rb

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

data/lib/interface.rb

@@ -0,0 +1,6 @@
+require "interface/helpers"
+require 'core_ext/module'
+
+module Interface
+  include Interface::Helpers
+end

data/rint.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rint'
+  spec.version       = Interface::VERSION
+  spec.authors       = ['James Lopez']
+  spec.email         = ['james@jameslopez.es']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Ruby interfaces made simple'
+  spec.description   = 'Provides interface abstraction and implementation to Ruby apps'
+  spec.homepage      = 'https://github.com/bluegod/rint'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_dependency 'thor', '~> 0.19'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Lopez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+description: Provides interface abstraction and implementation to Ruby apps
+email:
+- james@jameslopez.es
+executables:
+- rint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rint
+- lib/core_ext/module.rb
+- lib/generators/interface_generator.rb
+- lib/generators/templates/generic_interface.tt
+- lib/interface.rb
+- lib/interface/error/not_implemented_error.rb
+- lib/interface/helpers.rb
+- lib/interface/version.rb
+- rint.gemspec
+homepage: https://github.com/bluegod/rint
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby interfaces made simple
+test_files: []