protocol 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5a6e574c6a7e481f83ca95daada71f299edb932
-  data.tar.gz: dedb9e24930b8a181197fa1a1cefe294b966cd5d
+SHA256:
+  metadata.gz: bfef0f48bf225f759ac37b18a433be6c33cfd020415c909180a287a106499c93
+  data.tar.gz: 5150d9283c633ed037e074e24579f9824ab2bc3a4dfecd794fc4a7301d59c3b9
 SHA512:
-  metadata.gz: 44746928c286fde8d894ca7bd7ce7cc4fd4dd8d52cebc77c5c0b9141df1b480383105423340d166481e5dec7fbbafbdaa70254079a8fa9ab5489bf6a59008746
-  data.tar.gz: c8d5db4af17119799fb6d2535db1c0bfcf5c1d1e78a84079b85b37c92a75fc6a47da44682056cbb03102ebe1207aad978440d9bd74498ac90a0e73da33ff64d6
+  metadata.gz: 1c9cd985049db0689046eca4f07b90914cb1901f830e0ecfb9fdc28d95ccfecfe38eb5441a87e0196961f7cc272d0216fda26ab741d48e17061a05af21421fd9
+  data.tar.gz: b0ea3c0c9f7cb114ec7da8b7e27258bc849ad4f9b35b155ba6d3d717d0516f6c35ebcc94d20aec75b72b2a745c2c14232f4cfc034a20731050f16ce24c696ba5

data/.gitignore

@@ -1,6 +1,9 @@
 .*.sw[pon]
 .AppleDouble
+.byebug_history
 .rvmrc
 Gemfile.lock
 coverage
+errors.lst
 pkg
+tags

data/.travis.yml

@@ -1,11 +1,14 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
-  - rbx-19mode
-  - jruby-19mode
+  - jruby
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-19mode
+    - rvm: jruby
 

data/.utilsrc

@@ -0,0 +1,25 @@
+# vim: set ft=ruby:
+
+search do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.(log|fnm|jpg|jpeg|png|pdf|svg)\z|tags|~\z)/i
+end
+
+discover do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+  binary false
+end
+
+strip_spaces do
+  prune_dirs /\A(\..*|CVS|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+end
+
+probe do
+  test_framework :'test-unit'
+end
+
+ssh_tunnel do
+  terminal_multiplexer :tmux
+end

data/Gemfile

@@ -3,5 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'utils'

data/README.rdoc

@@ -217,22 +217,3 @@ shows how:
 Defining protocols and checking against conformance doesn't get in the way of
 Ruby's duck typing, but you can still use protocols to define, document, and
 check implementations that you expect from client code.
-
-==== Error modes in Protocols
-
-You can set different error modes for your protocols. By default the mode is
-set to :error, and a failed protocol conformance check raises a CheckError (a
-marker module) exception. Alternatively you can set the error mode to
-:warning with:
-
- Foo = Protocol do
-   check_failure :warning
- end
-
-during Protocol definition or later
-
-  Foo.check_failure :warning
-
-In :warning mode no execptions are raised, only a warning is printed to
-STDERR. If you set the error mode via Protocol::ProtocolModule#check_failure
-to :none, nothing will happen on conformance check failures.

data/Rakefile

@@ -17,26 +17,9 @@ for methods specified in a protocol.
 EOT
   licenses               << 'GPL-2'
   test_dir               'tests'
-  ignore                 '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc', '.AppleDouble'
+  ignore                 '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc', '.AppleDouble', '.byebug_history', 'tags', 'errors.lst'
   readme                 'README.rdoc'
   dependency             'ruby_parser', '~> 3.0'
   development_dependency 'simplecov'
-
-  install_library do
-    file = 'lib/protocol.rb'
-    dest = CONFIG["sitelibdir"]
-    install(file, dest)
-
-    dest = File.join(CONFIG["sitelibdir"], 'protocol')
-    mkdir_p dest
-    for file in Dir['lib/protocol/*.rb']
-      install(file, dest)
-    end
-
-    dest = File.join(CONFIG["sitelibdir"], 'protocol', 'method_parser')
-    mkdir_p dest
-    for file in Dir['lib/protocol/method_parser/*.rb']
-      install(file, dest)
-    end
-  end
+  development_dependency 'test-unit'
 end

data/VERSION

@@ -1 +1 @@
-1.0.1
+2.0.0

data/examples/comparing.rb

@@ -1,3 +1,6 @@
+
+#!/usr/bin/env ruby
+
 require 'protocol/core'
 
 class Person
@@ -32,7 +35,8 @@ begin
 
     conform_to Comparing
   end
-  puts "Should have thrown Protocol::CheckFailed!"
 rescue Protocol::CheckFailed => e
   p e
+else
+  puts "Should have thrown Protocol::CheckFailed!"
 end

data/examples/enumerating.rb

@@ -1,12 +1,6 @@
-require 'protocol'
+#!/usr/bin/env ruby
 
-Enumerating = Protocol do
-  # Iterate over each element of this Enumerating class and pass it to the
-  # _block_.
-  def each(&block) end
-
-  include Enumerable
-end
+require 'protocol/core'
 
 begin
   class FailAry
@@ -19,9 +13,10 @@ begin
 
     conform_to Enumerating
   end
-  puts "Should have thrown Protocol::CheckFailed!"
 rescue Protocol::CheckFailed => e
   p e # => "Enumerating#each(0&): expected a block argument for FailAry"
+else
+  puts "Should have thrown Protocol::CheckFailed!"
 end
 
 class Ary
@@ -40,8 +35,6 @@ puts Ary.new.map { |x| x * x }.inspect      + " ([1, 4, 9])"
 puts Ary.conform_to?(Enumerating).to_s      + " (true)"
 puts Ary.new.conform_to?(Enumerating).to_s  + " (true)"
 
-Enumerating.check_failure :none
-
 class FailAry2
   def initialize
     @ary = [1, 2, 3]

data/examples/game.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'protocol'
 
 # Small example of the template method pattern with Protocol. (I think, it was

data/examples/hello_world_patternitis.rb

@@ -72,6 +72,4 @@ class HelloWorld
   end
 end
 
-if $0 == __FILE__
-  HelloWorld.main(*ARGV)
-end
+HelloWorld.main(*ARGV)

data/examples/indexing.rb

@@ -1,28 +1,21 @@
-require 'protocol'
+#!/usr/bin/env ruby
 
-Indexing = Protocol {
-  check_failure :error
+require 'protocol/core'
 
-  understand :[]
-
-  understand :[]=
-}
+class Array
+  conform_to Indexing
+end
 
-if $0 == __FILE__
-  class Array
-    conform_to Indexing
-  end
+class Hash
+  conform_to Indexing
+end
 
-  class Hash
+begin
+  class Proc
     conform_to Indexing
   end
-
-  begin
-    class Proc
-      conform_to Indexing
-    end
+rescue Protocol::CheckFailed => e
+  p e
+else
   puts "Should have thrown Protocol::CheckFailed!"
-  rescue Protocol::CheckFailed => e
-    p e
-  end
 end

data/examples/queue.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'protocol'
 
 # Queue + Observer example.
@@ -27,8 +29,7 @@ end
 
 class SneakyO
   def after_enq(q)
-    puts "Enqueued."
-    q.deq
+    puts "Enqueued, actually Sneakily dequeued #{q.deq}."
   end
 
   def after_deq(q)
@@ -130,9 +131,10 @@ q.observer = O.new
 should_be q.empty?, true
 begin
   q.deq
-  puts "Should have thrown Protocol::CheckFailed!"
 rescue Protocol::CheckError => e
   p e
+else
+  puts "Should have thrown Protocol::CheckFailed!"
 end
 should_be q.empty?, true
 should_be q.size, 0
@@ -151,7 +153,8 @@ should_be q.deq, 2
 should_be q.empty?, true
 begin
   q.enq 7
-  puts "Should have thrown Protocol::CheckFailed!"
 rescue Protocol::CheckError => e
   p e
+else
+  puts "Should have thrown Protocol::CheckFailed!"
 end

data/examples/stack.rb

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 require 'protocol'
 
 # Classical Stack example.
@@ -51,25 +53,23 @@ class S
   conform_to StackProtocol
 end
 
-if $0 == __FILE__
-  s = S.new
-  puts s.top.inspect + " (nil)"
-  puts s.empty?.to_s + " (true)"
-  puts s.size.to_s   + " (0)"
-  begin
-    s.pop
-  rescue Protocol::CheckError => e
-    p e # => #<Protocol::PreconditionCheckError: StackProtocol#empty?(0): precondition failed for S>
-  end
-  puts s.empty?.to_s  + " (true)"
-  s.push 2
-  puts s.empty?.to_s  + " (false)"
-  puts s.size.to_s    + " (1)"
-  puts s.top.to_s     + " (2)"
-  s.push 4
-  puts s.top.to_s     + " (4)"
-  puts s.size.to_s    + " (2)"
-  puts s.pop.to_s     + " (4)"
-  puts s.top.to_s     + " (2)"
-  puts s.size.to_s    + " (1)"
+s = S.new
+puts s.top.inspect + " (nil)"
+puts s.empty?.to_s + " (true)"
+puts s.size.to_s   + " (0)"
+begin
+  s.pop
+rescue Protocol::CheckError => e
+  p e # => #<Protocol::PreconditionCheckError: StackProtocol#empty?(0): precondition failed for S>
 end
+puts s.empty?.to_s  + " (true)"
+s.push 2
+puts s.empty?.to_s  + " (false)"
+puts s.size.to_s    + " (1)"
+puts s.top.to_s     + " (2)"
+s.push 4
+puts s.top.to_s     + " (4)"
+puts s.size.to_s    + " (2)"
+puts s.pop.to_s     + " (4)"
+puts s.top.to_s     + " (2)"
+puts s.size.to_s    + " (1)"

data/examples/synchronizing.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require 'protocol/core'
+require 'thread'
+require 'tempfile'
+
+class FileMutex
+  def initialize
+    @tempfile = Tempfile.new 'file-mutex'
+  end
+
+  def path
+    @tempfile.path
+  end
+
+  def lock
+    puts "Synchronizing '#{path}'."
+    @tempfile.flock File::LOCK_EX
+  end
+
+  def unlock
+    puts "Unlocking '#{path}'."
+    @tempfile.flock File::LOCK_UN
+  end
+
+  conform_to Synchronizing
+end
+
+FileMutex.conform_to? Synchronizing     # => true
+FileMutex.new.conform_to? Synchronizing # => true
+
+# Outputs something like:
+#  Synchronizing '...'.
+#  Synchronized with '...'..
+#  Unlocking '...'.
+p mutex = FileMutex.new
+mutex.synchronize do
+  puts "Synchronized with '#{mutex.path}'."
+end
+
+class MemoryMutex
+  def initialize
+    @mutex = Mutex.new
+  end
+
+  def lock
+    @mutex.lock
+  end
+
+  def unlock
+    @mutex.unlock
+  end
+
+  conform_to Synchronizing # actually Mutex itself would conform as well ;)
+end
+
+p mutex = MemoryMutex.new
+mutex.synchronize do
+  puts "Synchronized in memory."
+end
+
+puts MemoryMutex.conform_to?(Synchronizing).to_s     + ' (true)'
+puts MemoryMutex.new.conform_to?(Synchronizing).to_s + ' (true)'
+
+class MyClass
+  def initialize
+    @mutex = FileMutex.new
+  end
+
+  attr_reader :mutex
+
+  def mutex=(mutex)
+    Synchronizing =~ mutex
+    @mutex = mutex
+  end
+end
+
+obj = MyClass.new
+p obj.mutex # => #<FileMutex:0xb788f9ac @tempfile=#<File:/tmp/file-mutex.26553.2>>
+begin
+  obj.mutex = Object.new
+rescue Protocol::CheckFailed => e
+  p e
+else
+  puts "Should have thrown Protocol::CheckFailed!"
+end
+p obj.mutex = MemoryMutex.new # => #<MemoryMutex:0xb788f038 @mutex=#<Mutex:0xb788eea8>>
+# This works as well:
+obj.mutex = Mutex.new
+puts Synchronizing.check(Mutex).to_s        + ' (true)'
+puts Mutex.conform_to?(Synchronizing).to_s  + ' (true)'

data/lib/protocol.rb

@@ -1,6 +1,6 @@
-require 'protocol/version'
 
 module Protocol
+  require 'protocol/version'
   require 'protocol/method_parser/ruby_parser'
   require 'protocol/utilities'
   require 'protocol/protocol_module'
@@ -9,13 +9,4 @@ module Protocol
   require 'protocol/message'
   require 'protocol/errors'
   require 'protocol/xt'
-
-  # The legal check modes, that influence the behaviour of the conform_to
-  # method in a class definition:
-  #
-  # - :error -> raises a CheckFailed exception, containing other
-  #   CheckError exceptions.
-  # - :warning -> prints a warning to STDERR.
-  # - :none -> does nothing.
-  CHECK_MODES = [ :error, :warning, :none ]
 end