gcnovus-quacks_like 1.0.1

data/README.md

@@ -0,0 +1,37 @@
+## QuacksLike
+
+QuacksLike is a tiny gem intended to push people towards using duck typing instead of static typing.
+
+## Usage
+
+    def some_method(an_argument)
+      case an_argument
+      when quacks_like?(:to_i)                 # responds_to?(:to_i)
+        do_something_with an_argument.to_i
+      when quacks_like?(:foo, :bar)            # responds_to?(:foo) && responds_to?(:bar)
+        an_argument.foo + an_argument.bar
+      else
+        raise "#{an_argument} can't quack properly; is it duck-like?"
+      end
+    end
+    
+## Getting it
+
+First, of course, install the gem:
+
+    sudo gem install gcnovus-quacks_like
+    
+Then add it to either the global namespace:
+
+    require 'rubygems'
+    require 'gcnovus-quacks_like'
+    QuacksLike.install_everywhere!
+    
+or just use it in one class:
+
+    require 'rubygems'
+    require 'gcnovus-quacks_like'
+    
+    class MyClass
+      include QuacksLike
+    end

data/Rakefile

@@ -0,0 +1,99 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$LOAD_PATH.unshift("lib")
+require 'quacks_like'
+
+task :default => ['test']
+
+PROJECT_ROOT = File.expand_path(File.dirname(__FILE__))
+
+LIB_DIRECTORIES = FileList.new do |fl|
+  fl.include "#{PROJECT_ROOT}/lib"
+end
+ 
+TEST_FILES = FileList.new do |fl|
+  fl.include "#{PROJECT_ROOT}/test/**/*_test.rb"
+end
+
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs        = LIB_DIRECTORIES
+  t.test_files  = TEST_FILES
+  t.verbose     = true
+end
+
+desc "Build a code coverage report"
+task :coverage do
+  files = TEST_FILES.join(" ")
+  sh "rcov -o coverage #{files} --exclude ^/Library/Ruby/,^init.rb --include lib/ --include-file ^lib/.*\\.rb"
+end
+
+namespace :coverage do
+  task :clean do
+    rm_r 'coverage' if File.directory?('coverage')
+  end
+end
+
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.main = 'lib/quacks_like.rb'
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.options << "--all"
+  rd.title = 'QuacksLike Documentation'
+end
+
+
+#Hey, thanks, mislave-will_paginate!
+desc %{Update ".manifest" with the latest list of project filenames. Respect\
+.gitignore by excluding everything that git ignores. Update `files` and\
+`test_files` arrays in "*.gemspec" file if it's present.}
+task :manifest do
+  list = `git ls-files --full-name --exclude=*.gemspec --exclude=.*`.chomp.split("\n")
+  
+  if spec_file = Dir['*.gemspec'].first
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+      
+    File.open(spec_file, 'w') { |f| f << spec }
+  end
+  File.open('.manifest', 'w') { |f| f << list.join("\n") }
+end
+
+
+# Hey, thanks, thoughtbot-shoulda
+spec = Gem::Specification.new do |s|
+  s.name = "quacks_like"
+  s.version = QuacksLike::VERSION
+  s.summary = "Type like a duck."
+  s.description = 'QuacksLike is a tiny gem intended to push people towards using duck typing instead of static typing.'
+  s.homepage = "http://github.com/gcnovus/quacks_like"
+
+  s.files = FileList["[A-Z]*", "{lib,test}/**/*"]
+
+  s.has_rdoc = true
+  s.rdoc_options = ["--line-numbers", "--main", "lib/quacks_like.rb"]
+
+  s.authors = ["James Rosen"]
+  s.email = "james.a.rosen@gmail.com"
+end
+ 
+Rake::GemPackageTask.new spec do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+ 
+desc "Clean files generated by rake tasks"
+task :clobber => [:clobber_rdoc, :clobber_package]
+ 
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end

data/lib/quacks_like.rb

@@ -0,0 +1,92 @@
+# == QuacksLike
+#
+# QuacksLike is a tiny gem intended to push people towards using
+# duck typing instead of static typing.
+#
+# == Usage
+#
+#   def some_method(an_argument)
+#     case an_argument
+#     when quacks_like?(:to_i)                 # responds_to?(:to_i)
+#       do_something_with an_argument.to_i
+#     when quacks_like?(:foo, :bar)            # responds_to?(:foo) && responds_to?(:bar)
+#       an_argument.foo + an_argument.bar
+#     else
+#       raise "#{an_argument} can't quack properly; is it duck-like?"
+#     end
+#   end
+#
+# == Installation
+#
+# === Riding the Rails
+#
+# Add the following to your <tt>environment.rb</tt>:
+#
+#   config.gem 'gcnovus-quacks_like', :version => '~> 1.0.0', :lib => 'quacks_like', 
+#    :source => 'http://gems.github.com'
+#
+# === Anywhere else
+#
+# From your command prompt:
+#
+#   sudo gem install gcnovus-quacks_like
+#
+# == Setting it up
+# 
+# === Globally
+#
+# If you don't mind mucking with Kernel and want the easiest thing
+# that could possibly work, do this:
+#
+#   require 'rubygems'
+#   require 'gcnovus-quacks_like'
+#   QuacksLike.install_everywhere!
+#
+# === Or just for one class
+#
+#   require 'rubygems'
+#   require 'gcnovus-quacks_like'
+#   
+#   class MyClass
+#     include QuacksLike    # for instance methods
+#     extend  QuacksLike    # for class methods
+#   end
+module QuacksLike
+  
+  VERSION = '1.0.1'
+  
+  def self.install_everywhere!
+    Kernel.class_eval do
+      include ::QuacksLike
+    end
+  end
+  
+  # Create a new matcher that matches all of the methods given.
+  #
+  # Raises a <tt>NoMethodError</tt> if any method does not respond
+  # to <tt>:to_sym</tt>.
+  #
+  # Raises a <tt>ArgumentError</tt> if any method responds to
+  # <tt>:to_sym</tt> but the result is not a <tt>Symbol</tt>.
+  def quacks_like?(*methods)
+    ::QuacksLike::Matcher.new(*methods)
+  end
+  
+  class Matcher
+    
+    def initialize(*methods)
+      @methods = methods.map do |m|
+        sym = m.to_sym
+        raise ArgumentError.new("#{m} could not be converted to a symbol") unless sym
+        sym
+      end
+    end
+    
+    # Returns +true+ iff +object+ responds to all of <tt>self</tt>'s methods.
+    def ===(object)
+      @methods.all? { |m| object.respond_to?(m) }
+    end
+    
+  end
+  
+end

data/test/quacks_like_test.rb

@@ -0,0 +1,71 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'mocha'
+require 'quacks_like'
+
+class Duck
+  def eat(bread)
+    "yum"
+  end
+  def quack!
+    "quack!!"
+  end
+end
+
+class QuacksLikeTest < Test::Unit::TestCase
+  
+  context 'the QuacksLike class' do
+    setup { Kernel.expects(:include).with(QuacksLike) }
+    should 'be able to install itself everywhere' do
+      QuacksLike.install_everywhere!
+    end
+  end
+  
+  context ':quacks_like?' do
+    
+    setup do
+      extend QuacksLike
+    end
+    
+    context 'given an argument that cannot be converted to a Symbol' do
+      should 'raise an NoMethodError' do
+        assert_raises(NoMethodError) { quacks_like?(Object.new) }
+      end
+    end
+    
+    context 'given an argument that knows how to convert to a Symbol, but can\'t' do
+      should 'raise an ArgumentException' do
+        assert_raises(ArgumentError) { quacks_like?(8) }
+      end
+    end
+    
+    context 'given a single valid argument' do
+      
+      should 'return a Object that acts as a matcher' do
+        matcher = quacks_like?(:foo)
+        assert !matcher.nil?
+        assert matcher.respond_to?(:===)
+      end
+      
+      should 'create a matcher that checks that arguments respond to the given method' do
+        assert   quacks_like?(:eat) === Duck.new
+        assert !(quacks_like?(:juggle) === Duck.new)
+      end
+      
+    end
+    
+    context 'given several valid arguments' do
+      
+      should 'create a matcher that checks that arguments respond to ALL of the given methods' do
+        assert   quacks_like?(:eat, :quack!, :to_s) === Duck.new
+        assert !(quacks_like?(:eat, :juggle, :to_s) === Duck.new)
+      end
+        
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: gcnovus-quacks_like
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- James Rosen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: QuacksLike is a tiny gem intended to push people towards using duck typing instead of static typing.
+email: james.a.rosen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/quacks_like.rb
+- test/quacks_like_test.rb
+has_rdoc: false
+homepage: http://github.com/gcnovus/quacks_like
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --main
+- lib/quacks_like.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Type like a duck.
+test_files: []
+