shuber-interface 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sean Huber - shuber@huberry.com
+
+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.rdoc

@@ -0,0 +1,56 @@
+= interface
+
+Implementable interfaces in ruby
+
+
+== Installation
+
+  gem install shuber-interface
+
+  require 'interface'
+
+
+== Usage
+
+Simply create a module with any methods that you'd like its implementing objects to define
+
+  module RemoteControl
+    # turns the device on
+    def on
+    end
+    
+    # turns the device off
+    def off
+    end
+  end
+
+Then use the <tt>implements</tt> method in your classes (also aliased as <tt>implement</tt> to conform with <tt>include</tt> and <tt>extend</tt> naming conventions)
+
+  class BrokenDevice
+    implements RemoteControl
+  end
+  
+  BrokenDevice.new.on # NotImplementedError: BrokenDevice needs to implement 'on' for interface RemoteControl
+  
+  class WorkingDevice < BrokenDevice
+    def on
+      @power = true
+    end
+
+    def off
+      @power = false
+    end
+  end
+  
+  WorkingDevice.new.on # true
+  
+  WorkingDevice.interfaces # [RemoteControl]
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the interface gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs += ['lib', 'test']
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the interface gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'interface'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/interface/abstract.rb

@@ -0,0 +1,12 @@
+module Interface
+  # When extended, this abstract interface will re-define an object's methods to raise <tt>NotImplementedError</tt> when called
+  module Abstract
+    def self.extended(base) # :nodoc:
+      base.class_eval do
+        instance_methods(false).each do |method|
+          define_method(method) { |*args| raise NotImplementedError.new("#{self.class} needs to implement '#{method}' for interface #{base}") }
+        end
+      end
+    end
+  end
+end

data/lib/interface/version.rb

@@ -0,0 +1,17 @@
+module Interface
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   Interface::Version.string # '1.0.2'
+    def self.string
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/interface.rb

@@ -0,0 +1,36 @@
+# Implementable interfaces in ruby
+module Interface
+  autoload :Abstract, 'interface/abstract'
+  autoload :Version, 'interface/version'
+
+  # Takes a module (or multiple in reverse order), extends it with <tt>Interface::Abstract</tt>, then includes it into the current object
+  #
+  # Example
+  #
+  #   module Remote
+  #     # turns the device on
+  #     def on
+  #     end
+  #   end
+  #
+  #   class Device
+  #     implements Remote
+  #
+  #     def on
+  #       @power = true
+  #     end
+  #   end
+  def implements(*modules)
+    modules.flatten.reverse!.each { |mod| include mod.extend(Abstract) }
+  end
+
+  # Conforms with naming conventions for include and extend
+  alias_method :implement, :implements
+
+  # Returns an array of interfaces implemented by the current object
+  def interfaces
+    included_modules.select { |mod| mod.is_a?(Abstract) }
+  end
+end
+
+Object.send(:include, Interface)

data/lib/shuber-interface.rb

@@ -0,0 +1 @@
+require 'interface'

data/test/interface_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module MockModule end
+module MockInterface end
+
+module Remote
+  def on
+  end
+end
+
+class BrokenDevice
+  implements Remote, MockInterface
+end
+
+class Device < BrokenDevice
+  include MockModule
+
+  def on
+    @power = true
+  end
+end
+
+class InterfaceTest < Test::Unit::TestCase
+
+  def test_should_include_interface
+    assert BrokenDevice.included_modules.include?(Remote)
+  end
+
+  def test_interface_should_include_abstract
+    assert Remote.is_a?(Interface::Abstract)
+  end
+
+  def test_should_raise_not_implemented_error
+    assert_raises(NotImplementedError) { BrokenDevice.new.on }
+  end
+
+  def test_should_not_raise_not_implemented_error
+    assert Device.new.on
+  end
+
+  def test_should_return_interfaces
+    assert_equal [Remote, MockInterface], Device.interfaces
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'interface'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-interface
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Implementable interfaces in ruby
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/interface.rb
+- lib/interface/abstract.rb
+- lib/interface/version.rb
+- lib/shuber-interface.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/interface_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/shuber/interface
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Implementable interfaces in ruby
+test_files: 
+- test/interface_test.rb
+- test/test_helper.rb