Various textual changes after review

Author: herwinw

library/openssl/digest/block_length_spec.rb

@@ -6,7 +6,7 @@
 require 'openssl'
 
 describe "OpenSSL::Digest#block_length" do
-  describe "block_length of OpenSSL::Digest.new(name)" do
+  context "when the digest object is created via a name argument" do
     it "returns a SHA1 block length" do
       OpenSSL::Digest.new('sha1').block_length.should == SHA1Constants::BlockLength
     end
@@ -15,16 +15,16 @@
       OpenSSL::Digest.new('sha256').block_length.should == SHA256Constants::BlockLength
     end
 
-    it "returns a SHA384 block_length" do
+    it "returns a SHA384 block length" do
       OpenSSL::Digest.new('sha384').block_length.should == SHA384Constants::BlockLength
     end
 
-    it "returns a SHA512 block_length" do
+    it "returns a SHA512 block length" do
       OpenSSL::Digest.new('sha512').block_length.should == SHA512Constants::BlockLength
     end
   end
 
-  describe "block_length of subclasses" do
+  context "when the digest object is created via a subclass" do
     it "returns a SHA1 block length" do
       OpenSSL::Digest::SHA1.new.block_length.should == SHA1Constants::BlockLength
     end
@@ -33,11 +33,11 @@
       OpenSSL::Digest::SHA256.new.block_length.should == SHA256Constants::BlockLength
     end
 
-    it "returns a SHA384 block_length" do
+    it "returns a SHA384 block length" do
       OpenSSL::Digest::SHA384.new.block_length.should == SHA384Constants::BlockLength
     end
 
-    it "returns a SHA512 block_length" do
+    it "returns a SHA512 block length" do
       OpenSSL::Digest::SHA512.new.block_length.should == SHA512Constants::BlockLength
     end
   end

library/openssl/digest/digest_length_spec.rb

@@ -6,38 +6,38 @@
 require 'openssl'
 
 describe "OpenSSL::Digest#digest_length" do
-  describe "digest_length of OpenSSL::Digest.new(name)" do
-    it "returns a SHA1 block length" do
+  context "when the digest object is created via a name argument" do
+    it "returns a SHA1 digest length" do
       OpenSSL::Digest.new('sha1').digest_length.should == SHA1Constants::DigestLength
     end
 
-    it "returns a SHA256 block length" do
+    it "returns a SHA256 digest length" do
       OpenSSL::Digest.new('sha256').digest_length.should == SHA256Constants::DigestLength
     end
 
-    it "returns a SHA384 digest_length" do
+    it "returns a SHA384 digest length" do
       OpenSSL::Digest.new('sha384').digest_length.should == SHA384Constants::DigestLength
     end
 
-    it "returns a SHA512 digest_length" do
+    it "returns a SHA512 digest length" do
       OpenSSL::Digest.new('sha512').digest_length.should == SHA512Constants::DigestLength
     end
   end
 
-  describe "digest_length of subclasses" do
-    it "returns a SHA1 block length" do
+  context "when the digest object is created via a subclass" do
+    it "returns a SHA1 digest length" do
       OpenSSL::Digest::SHA1.new.digest_length.should == SHA1Constants::DigestLength
     end
 
-    it "returns a SHA256 block length" do
+    it "returns a SHA256 digest length" do
       OpenSSL::Digest::SHA256.new.digest_length.should == SHA256Constants::DigestLength
     end
 
-    it "returns a SHA384 digest_length" do
+    it "returns a SHA384 digest length" do
       OpenSSL::Digest::SHA384.new.digest_length.should == SHA384Constants::DigestLength
     end
 
-    it "returns a SHA512 digest_length" do
+    it "returns a SHA512 digest length" do
       OpenSSL::Digest::SHA512.new.digest_length.should == SHA512Constants::DigestLength
     end
   end

library/openssl/digest/initialize_spec.rb

@@ -5,7 +5,7 @@
 require_relative '../../../library/digest/sha512/shared/constants'
 require 'openssl'
 
-describe "OpenSSL::Digest initialization" do
+describe "OpenSSL::Digest#initialize" do
   describe "can be called with a digest name" do
     it "returns a SHA1 object" do
       OpenSSL::Digest.new("sha1").name.should == "SHA1"
@@ -31,7 +31,7 @@
       -> { OpenSSL::Digest.new(:SHA1) }.should raise_error(TypeError, /wrong argument type Symbol/)
     end
 
-    it "doest not call #to_str on the argument" do
+    it "does not call #to_str on the argument" do
       name = mock("digest name")
       name.should_not_receive(:to_str)
       -> { OpenSSL::Digest.new(name) }.should raise_error(TypeError, /wrong argument type/)
@@ -55,17 +55,17 @@
       OpenSSL::Digest.new(OpenSSL::Digest::SHA512.new).name.should ==  "SHA512"
     end
 
-    it "cannot be called with a digest class" do
-      -> { OpenSSL::Digest.new(OpenSSL::Digest::SHA1) }.should raise_error(TypeError, /wrong argument type Class/)
-    end
-
-    it "ignores the state of the name object" do
+    it "ignores the state of the digest object" do
       sha1 = OpenSSL::Digest.new('sha1', SHA1Constants::Contents)
       OpenSSL::Digest.new(sha1).digest.should == SHA1Constants::BlankDigest
     end
   end
 
-  describe "ititialization with an empty string" do
+  it "cannot be called with a digest class" do
+    -> { OpenSSL::Digest.new(OpenSSL::Digest::SHA1) }.should raise_error(TypeError, /wrong argument type Class/)
+  end
+
+  context "when called without an initial String argument" do
     it "returns a SHA1 digest" do
       OpenSSL::Digest.new("sha1").digest.should == SHA1Constants::BlankDigest
     end
@@ -83,26 +83,26 @@
     end
   end
 
-  describe "can be called with a digest name and data" do
-    it "returns a SHA1 digest" do
+  context "when called with an initial String argument" do
+    it "returns a SHA1 digest of that argument" do
       OpenSSL::Digest.new("sha1", SHA1Constants::Contents).digest.should == SHA1Constants::Digest
     end
 
-    it "returns a SHA256 digest" do
+    it "returns a SHA256 digest of that argument" do
       OpenSSL::Digest.new("sha256", SHA256Constants::Contents).digest.should == SHA256Constants::Digest
     end
 
-    it "returns a SHA384 digest" do
+    it "returns a SHA384 digest of that argument" do
       OpenSSL::Digest.new("sha384", SHA384Constants::Contents).digest.should == SHA384Constants::Digest
     end
 
-    it "returns a SHA512 digest" do
+    it "returns a SHA512 digest of that argument" do
       OpenSSL::Digest.new("sha512", SHA512Constants::Contents).digest.should == SHA512Constants::Digest
     end
   end
 
   context "can be called on subclasses" do
-    describe "can be called without data on subclasses" do
+    describe "can be called without an initial String argument on subclasses" do
       it "returns a SHA1 digest" do
         OpenSSL::Digest::SHA1.new.digest.should == SHA1Constants::BlankDigest
       end
@@ -120,7 +120,7 @@
       end
     end
 
-    describe "can be called with data on subclasses" do
+    describe "can be called with an initial String argument on subclasses" do
       it "returns a SHA1 digest" do
         OpenSSL::Digest::SHA1.new(SHA1Constants::Contents).digest.should == SHA1Constants::Digest
       end

library/openssl/digest/name_spec.rb

@@ -2,7 +2,7 @@
 require 'openssl'
 
 describe "OpenSSL::Digest#name" do
-  it "returns the name of digest when called on an instance" do
+  it "returns the name of digest" do
     OpenSSL::Digest.new('SHA1').name.should == 'SHA1'
   end
 

library/openssl/digest/reset_spec.rb

@@ -6,33 +6,31 @@
 require 'openssl'
 
 describe "OpenSSL::Digest#reset" do
-  describe "resets the state of the digest" do
-    it "works for a SHA1 digest" do
-      digest = OpenSSL::Digest.new('sha1', SHA1Constants::Contents)
-      digest.reset
-      digest.update(SHA1Constants::Contents)
-      digest.digest.should == SHA1Constants::Digest
-    end
+  it "works for a SHA1 digest" do
+    digest = OpenSSL::Digest.new('sha1', SHA1Constants::Contents)
+    digest.reset
+    digest.update(SHA1Constants::Contents)
+    digest.digest.should == SHA1Constants::Digest
+  end
 
-    it "works for a SHA256 digest" do
-      digest = OpenSSL::Digest.new('sha256', SHA256Constants::Contents)
-      digest.reset
-      digest.update(SHA256Constants::Contents)
-      digest.digest.should == SHA256Constants::Digest
-    end
+  it "works for a SHA256 digest" do
+    digest = OpenSSL::Digest.new('sha256', SHA256Constants::Contents)
+    digest.reset
+    digest.update(SHA256Constants::Contents)
+    digest.digest.should == SHA256Constants::Digest
+  end
 
-    it "works for a SHA384 digest" do
-      digest = OpenSSL::Digest.new('sha384', SHA384Constants::Contents)
-      digest.reset
-      digest.update(SHA384Constants::Contents)
-      digest.digest.should == SHA384Constants::Digest
-    end
+  it "works for a SHA384 digest" do
+    digest = OpenSSL::Digest.new('sha384', SHA384Constants::Contents)
+    digest.reset
+    digest.update(SHA384Constants::Contents)
+    digest.digest.should == SHA384Constants::Digest
+  end
 
-    it "works for a SHA512 digest" do
-      digest = OpenSSL::Digest.new('sha512', SHA512Constants::Contents)
-      digest.reset
-      digest.update(SHA512Constants::Contents)
-      digest.digest.should == SHA512Constants::Digest
-    end
+  it "works for a SHA512 digest" do
+    digest = OpenSSL::Digest.new('sha512', SHA512Constants::Contents)
+    digest.reset
+    digest.update(SHA512Constants::Contents)
+    digest.digest.should == SHA512Constants::Digest
   end
 end

library/openssl/digest/shared/update.rb

@@ -5,7 +5,7 @@
 require 'openssl'
 
 describe :openssl_digest_update, shared: true do
-  context "it supports full data chunks" do
+  context "when given input as a single string" do
     it "returns a SHA1 digest" do
       digest = OpenSSL::Digest.new('sha1')
       digest.send(@method, SHA1Constants::Contents)
@@ -31,7 +31,7 @@
     end
   end
 
-  context "it support smaller chunks" do
+  context "when given input as multiple smaller substrings" do
     it "returns a SHA1 digest" do
       digest = OpenSSL::Digest.new('sha1')
       SHA1Constants::Contents.each_char { |b| digest.send(@method, b) }
@@ -57,7 +57,7 @@
     end
   end
 
-  context "it converts input using #to_str" do
+  context "when input is not a String and responds to #to_str" do
     it "returns a SHA1 digest" do
       str = mock('str')
       str.should_receive(:to_str).and_return(SHA1Constants::Contents)
@@ -91,7 +91,7 @@
     end
   end
 
-  context "it raises a TypeError for input that cannot be coerced into a String" do
+  context "when input is not a String and does not respond to #to_str" do
     it "raises a TypeError with SHA1" do
       digest = OpenSSL::Digest.new('sha1')
       -> {