safer 0.2.0 → 0.2.1

data/History.txt

@@ -7,3 +7,9 @@
 * ClassProtocol renamed to Protocol.
 * Protocol can non-violently check if a class or instance conforms.
 * Added much documentation.
+
+=== 0.2.1 / 2010-10-17
+
+* README.txt still referred to ClassProtocol.  Fixed.
+* The Safer module documentation now refers to its submodules.
+* Regularized use of '::' and '.'.

data/README.txt

@@ -8,12 +8,12 @@ Safer is an umbrella library, with components designed to make it simple to
 verify and improve the safety of your ruby code.  There are at present two
 modules under the safer umbrella:
 
-[<tt>Safer::IVar</tt>]          generates specially-named accessor functions
-                                for class instance variables.
-[<tt>Safer::ClassProtocol</tt>] is used to provide a ruby analogue to
-                                Objective-C Protocols (which are similar to
-                                Java interfaces, but do not require
-                                inheritance).
+[<tt>Safer::IVar</tt>]     generates specially-named accessor functions
+                           for class instance variables.
+[<tt>Safer::Protocol</tt>] is used to provide a ruby analogue to
+                           Objective-C Protocols (which are similar to
+                           Java interfaces, but do not require
+                           inheritance).
 
 == FEATURES/PROBLEMS:
 

data/lib/safer/ivar.rb

@@ -130,7 +130,7 @@ module Safer
     # For example, given the following listing:
     #   class OuterClass
     #     class InnerClass
-    #       SYMNM = Safer::IVar::symbol_names(self, :foo)
+    #       SYMNM = Safer::IVar.symbol_names(self, :foo)
     #       puts(SYMNM.to_s)
     #     end
     #   end
@@ -146,12 +146,12 @@ module Safer
     # [+klass+] Class object into which to generate the variable accessor
     #           functions.
     # [+nmlist+] List of symbols for which to create accessor routines.
-    # Uses Safer::IVar::symbol_names to determine the symbol names of the
+    # Uses Safer::IVar.symbol_names to determine the symbol names of the
     # accessor routines.
     # For example, the listing:
     #   class MyClass
     #     class SubClass
-    #       Safer::IVar::instance_variable(self, :foo, :bar)
+    #       Safer::IVar.instance_variable(self, :foo, :bar)
     #     end
     #   end
     # is equivalent to the following code:
@@ -174,10 +174,10 @@ module Safer
     ##
     # export the reader routines for instance variables in a nicer way.
     # [+klass+] Class object for which to define reader accessors for
-    #           instance variables defined by Safer::IVar::instance_variables.
+    #           instance variables defined by Safer::IVar.instance_variable.
     # [+nmlist+] List of symbols for which to define reader accessors.
     #            Each symbol in +nmlist+ should have previously been given as
-    #            an argument to Safer::IVar::instance_variables(+klass+).
+    #            an argument to Safer::IVar.instance_variable(+klass+).
     def self.export_reader(klass, *nmlist)
       symlist = self.symbol_names(klass, *nmlist)
       nmlist.size.times do |index|
@@ -190,10 +190,10 @@ module Safer
     ##
     # export the writer routines for instance variables in a nicer way.
     # [+klass+] Class object for which to define writer accessors for
-    #           instance variables defined by Safer::IVar::instance_variables.
+    #           instance variables defined by Safer::IVar.instance_variable.
     # [+nmlist+] List of symbols for which to define writer accessors.
     #            Each symbol in +nmlist+ should have previously been given as
-    #            an argument to Safer::IVar::instance_variables(+klass+).
+    #            an argument to Safer::IVar.instance_variable(+klass+).
     def self.export_writer(klass, *nmlist)
       symlist = self.symbol_names(klass, *nmlist)
       nmlist.size.times do |index|
@@ -209,10 +209,10 @@ module Safer
     # export both reader and writer routines for instance variables in a
     # nicer way.
     # [+klass+] Class object for which to define accessors for
-    #           instance variables defined by Safer::IVar::instance_variables.
+    #           instance variables defined by Safer::IVar.instance_variable.
     # [+nmlist+] List of symbols for which to define accessors.
     #            Each symbol in +nmlist+ should have previously been given as
-    #            an argument to Safer::IVar::instance_variables(+klass+).
+    #            an argument to Safer::IVar.instance_variable(+klass+).
     def self.export_accessor(klass, *nmlist)
       self.export_reader(klass, *nmlist)
       self.export_writer(klass, *nmlist)

data/lib/safer/protocol.rb

@@ -62,9 +62,9 @@ module Safer
   #    end
   #  end
   #  # should succeed.
-  #  a = YourClass::new(Foo.new)
+  #  a = YourClass.new(Foo.new)
   #  # should raise a Safer::Protocol::Error::InstanceError.
-  #  b = YourClass::new(15)
+  #  b = YourClass.new(15)
   #
   # ==Rationale
   # It is often the case that we expect objects passed to our methods to
@@ -115,7 +115,7 @@ module Safer
       if ! block
         block = proc do |h, el| true ; end
       end
-      array.inject(Hash::new) do |h, el|
+      array.inject(Hash.new) do |h, el|
         newval = block.call(h, el)
         if newval
           h[el] = newval
@@ -130,8 +130,8 @@ module Safer
     # Protocol::Violation objects: one for class-method protocol
     # violations, and one for instance-method protocol violations.
     class Violation
-      Safer::IVar::instance_variable(self, :table)
-      Safer::IVar::instance_variable(self, :report)
+      Safer::IVar.instance_variable(self, :table)
+      Safer::IVar.instance_variable(self, :report)
 
       ##
       # :attr_reader: table
@@ -142,12 +142,13 @@ module Safer
       # the protocol, the value for that method will be the arity discovered in
       # the object.  (The desired arity can be accessed through the
       # Protocol::Signature for that method.)
-      Safer::IVar::export_reader(self, :table)
+      Safer::IVar.export_reader(self, :table) 
+
       ##
       # :attr_reader: report
       # String describing the errors from +table+ in a more human-readable
       # fashion.
-      Safer::IVar::export_reader(self, :report)
+      Safer::IVar.export_reader(self, :report)
 
       ##
       # Create a new Protocol::Violation object.
@@ -169,12 +170,12 @@ module Safer
     # two of these objects - one describing class methods, and one describing
     # instance methods.
     class Signature
-      Safer::IVar::instance_variable(self, :table)
+      Safer::IVar.instance_variable(self, :table)
       ##
       # :attr_reader: table
       # +Hash+ object, in which the keys are the names of methods, and the
       # value for a key is the required arity of that method.
-      Safer::IVar::export_reader(self, :table)
+      Safer::IVar.export_reader(self, :table)
 
       ##
       # Create a Protocol::Signature object.
@@ -195,7 +196,7 @@ module Safer
       def find_violations(object, get_method)
         report = ''
         have_error = false
-        error_table = Hash::new
+        error_table = Hash.new
         self.safer_protocol_signature__table.each_pair do |name, arity|
           begin
             m = object.send(get_method, name)
@@ -236,34 +237,34 @@ module Safer
     ## Safer::Protocol::Error
     # Error generated when a class does not conform to a protocol signature.
     class Error < StandardError
-      Safer::IVar::instance_variable(self, :error_object)
-      Safer::IVar::instance_variable(self, :protocol)
-      Safer::IVar::instance_variable(self, :class_violations)
-      Safer::IVar::instance_variable(self, :instance_violations)
-      Safer::IVar::instance_variable(self, :report)
+      Safer::IVar.instance_variable(self, :error_object)
+      Safer::IVar.instance_variable(self, :protocol)
+      Safer::IVar.instance_variable(self, :class_violations)
+      Safer::IVar.instance_variable(self, :instance_violations)
+      Safer::IVar.instance_variable(self, :report)
 
       ##
       # :attr_reader: error_object
       # Object that does not properly implement a desired method protocol.
-      Safer::IVar::export_reader(self, :error_object)
+      Safer::IVar.export_reader(self, :error_object)
       ##
       # :attr_reader: protocol
       # Protocol object describing the signature that error_object failed
       # to properly implement.
-      Safer::IVar::export_reader(self, :protocol)
+      Safer::IVar.export_reader(self, :protocol)
       ##
       # :attr_reader: class_violations
       # Protocol::Violation describing class-method protocol violations.
-      Safer::IVar::export_reader(self, :class_violations)
+      Safer::IVar.export_reader(self, :class_violations)
       ##
       # :attr_reader: instance_violations
       # Protocol::Violation describing instance-method protocol violations.
-      Safer::IVar::export_reader(self, :instance_violations)
+      Safer::IVar.export_reader(self, :instance_violations)
       ##
       # :attr_reader: report
       # String for displaying human-readable error message describing protocol
       # violations.
-      Safer::IVar::export_reader(self, :report)
+      Safer::IVar.export_reader(self, :report)
 
 
       ##
@@ -332,25 +333,25 @@ module Safer
     end # Safer::Protocol::Error
 
 
-    Safer::IVar::instance_variable(self, :name)
-    Safer::IVar::instance_variable(self, :class_signature)
-    Safer::IVar::instance_variable(self, :instance_signature)
+    Safer::IVar.instance_variable(self, :name)
+    Safer::IVar.instance_variable(self, :class_signature)
+    Safer::IVar.instance_variable(self, :instance_signature)
 
     ##
     # :attr_reader: name
     # Name of this protocol signature.  Typically derived from the class name
     # from which this signature is derived.
-    Safer::IVar::export_reader(self, :name)
+    Safer::IVar.export_reader(self, :name)
     ##
     # :attr_reader: class_signature
     # Signatures of required class methods for objects implementing this
     # protocol.
-    Safer::IVar::export_reader(self, :class_signature)
+    Safer::IVar.export_reader(self, :class_signature)
     ##
     # :attr_reader: instance_signature
     # Signatures of required instance methods for objects implementing this
     # protocol.
-    Safer::IVar::export_reader(self, :instance_signature)
+    Safer::IVar.export_reader(self, :instance_signature)
 
     ##
     # Create a +Protocol+ object.

data/lib/safer.rb

@@ -1,8 +1,16 @@
 ##
 # Safer is an umbrella library, whose components are designed to improve
-# the safety of your code.
+# the safety of your code.  There are at present two modules under the safer
+# umbrella:
+#
+# [<tt>Safer::IVar</tt>]     generates specially-named accessor functions
+#                            for class instance variables.
+# [<tt>Safer::Protocol</tt>] is used to provide a ruby analogue to
+#                            Objective-C Protocols (which are similar to
+#                            Java interfaces, but do not require
+#                            inheritance).
 module Safer
   ##
   # Current release of Safer.
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/test_safer_ivar.rb

@@ -4,19 +4,19 @@ require 'test/unit'
 module Root
   class Test
     class Instance
-      Safer::IVar::instance_variable(self, :instance)
+      Safer::IVar.instance_variable(self, :instance)
     end
     class Reader
-      Safer::IVar::instance_variable(self, :instance)
-      Safer::IVar::export_reader(self, :instance)
+      Safer::IVar.instance_variable(self, :instance)
+      Safer::IVar.export_reader(self, :instance)
     end
     class Writer
-      Safer::IVar::instance_variable(self, :instance)
-      Safer::IVar::export_writer(self, :instance)
+      Safer::IVar.instance_variable(self, :instance)
+      Safer::IVar.export_writer(self, :instance)
     end
     class Accessor
-      Safer::IVar::instance_variable(self, :instance)
-      Safer::IVar::export_accessor(self, :instance)
+      Safer::IVar.instance_variable(self, :instance)
+      Safer::IVar.export_accessor(self, :instance)
     end
   end
 end
@@ -50,13 +50,13 @@ class TC_SaferIVar < Test::Unit::TestCase
   end
 
   def test_class_symbol_prefix
-    assert_equal("root", Safer::IVar::class_symbol_prefix(Root))
-    assert_equal("root_test", Safer::IVar::class_symbol_prefix(Root::Test))
-    assert_equal("root_test_instance", Safer::IVar::class_symbol_prefix(Root::Test::Instance))
-    k = Root.class_eval("$k = Class::new(Root::Test::Instance)")
-    assert_same(nil, Safer::IVar::class_symbol_prefix(k))
+    assert_equal("root", Safer::IVar.class_symbol_prefix(Root))
+    assert_equal("root_test", Safer::IVar.class_symbol_prefix(Root::Test))
+    assert_equal("root_test_instance", Safer::IVar.class_symbol_prefix(Root::Test::Instance))
+    k = Root.class_eval("$k = Class.new(Root::Test::Instance)")
+    assert_same(nil, Safer::IVar.class_symbol_prefix(k))
     b = k.class_eval("class Blah ; end ; Blah")
-    assert_equal("blah", Safer::IVar::class_symbol_prefix(b))
+    assert_equal("blah", Safer::IVar.class_symbol_prefix(b))
   end
 
   def test_instance
@@ -72,14 +72,14 @@ class TC_SaferIVar < Test::Unit::TestCase
         assert_no_respond_to(obj, :instance=)
       end
     end
-    ti = Root::Test::Instance::new
+    ti = Root::Test::Instance.new
     assert_respond_to(ti, :root_test_instance__instance)
     test_accessors.call(ti, false, false)
-    tr = Root::Test::Reader::new
+    tr = Root::Test::Reader.new
     test_accessors.call(tr, true, false)
-    tw = Root::Test::Writer::new
+    tw = Root::Test::Writer.new
     test_accessors.call(tw, false, true)
-    ta = Root::Test::Accessor::new
+    ta = Root::Test::Accessor.new
     test_accessors.call(ta, true, true)
   end
 end

data/test/test_safer_protocol.rb

@@ -38,10 +38,10 @@ class TC_SaferProtocol < Test::Unit::TestCase
     @instance_protocol = Safer::Protocol.create_from_class(TestArityInstance)
     @both_protocol = Safer::Protocol.create_from_class(TestArityBoth)
 
-    @class_instance = TestArityClass::new
-    @instance_instance = TestArityInstance::new
-    @both_instance = TestArityBoth::new
-    @error_instance = TestArityError::new
+    @class_instance = TestArityClass.new
+    @instance_instance = TestArityInstance.new
+    @both_instance = TestArityBoth.new
+    @error_instance = TestArityError.new
   end
   def teardown
     @class_protocol = nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: safer
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Aidan Cully
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 -04:00
+date: 2010-10-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,12 +55,12 @@ description: |-
   verify and improve the safety of your ruby code.  There are at present two
   modules under the safer umbrella:
   
-  [<tt>Safer::IVar</tt>]          generates specially-named accessor functions
-                                  for class instance variables.
-  [<tt>Safer::ClassProtocol</tt>] is used to provide a ruby analogue to
-                                  Objective-C Protocols (which are similar to
-                                  Java interfaces, but do not require
-                                  inheritance).
+  [<tt>Safer::IVar</tt>]     generates specially-named accessor functions
+                             for class instance variables.
+  [<tt>Safer::Protocol</tt>] is used to provide a ruby analogue to
+                             Objective-C Protocols (which are similar to
+                             Java interfaces, but do not require
+                             inheritance).
 email: 
 - aidan@panix.com
 executables: []