sixarm_ruby_xid 3.4.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f5b6519a9ac4fad507d584b4e79e3a8acd07052
-  data.tar.gz: ae6ae65995d3091262ce3444951ede3437335a4e
+  metadata.gz: 0f6d3accebde3354b4b649117469e7e7fd67a7aa
+  data.tar.gz: 05feb7ba4b25e7f485425a37fab9a803c0c0099d
 SHA512:
-  metadata.gz: ddce1beb9a306f2b3f5c95a836eff8aba4aa12a723f91102f6cde20cd353990dc028b6d06b3a5515f0738195dffa7fa1449a997080f0954b4deae3fe354203bf
-  data.tar.gz: 10012f4d5b4a0f1a51e16a35ab2a1c0f98dd80903cfff4cac3709c68bc13b5187f866e8f2015da018c85cdb639d764cce4f141c36aaa4f11ae39fc6eb616bb6a
+  metadata.gz: d1af7e6bd0d539cd3a2a5214140d56774183b7b6fd63f273a9664f47eafeee62af87210340e5a54d0fae7c1dfa0ef7ec281bdbf06f7d9657fbefd297be68e547
+  data.tar.gz: e1a67f1e6d6c06e49761cf25b84f2b2bb3e94ee095121d06b6c9bfa0f1a3549aa93462c8605fda30bc779943ae188992d63e25830c176d8b4cd44c5be6f8e18a

data/Rakefile

@@ -9,9 +9,3 @@ end
 
 task :default => [:test]
 task :default => [:test]
-task :default => [:test]
-task :default => [:test]
-task :default => [:test]
-task :default => [:test]
-task :default => [:test]
-task :default => [:test]

data/lib/sixarm_ruby_xid/xid.rb

@@ -6,34 +6,19 @@ XID class.
 require "securerandom"
 require "digest/sha2"
 
-class XID < String
+class XID
 
-  # Initialize a new XID, optionally with a string.
+  # Generate a new XID string.
   #
   # Example:
   #
-  #     xid = XID.new
+  #     string = XID.generate
+  #     #=> "4bb88af57d4ddc224fecad688442423d"
   #
-  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
+  # Return: [String] A new XID string
   #
-  # Return: [XID] A new XID
-  #
-  def initialize(s = nil)
-    s and (XID.valid?(s) or raise ArgumentError)
-    super(s || SecureRandom.hex)
-  end
-
-  # Is this XID valid?
-  #
-  # Example:
-  #
-  #     xid = XID.new
-  #     xid.valid? #=> true
-  #
-  # Return: [true/false]
-  #
-  def valid?
-    XID.valid?(self)
+  def self.generate
+    SecureRandom.hex
   end
 
   # Is a given XID string valid?
@@ -45,57 +30,30 @@ class XID < String
   #
   # Return: [true/false]
   #
-  def self.valid?(s)
-    !!(s && s.is_a?(String) && s.size == 32 && s =~ /\A[0-9a-f]{32}\Z/)
-  end
-
-  # Compute the XID digest of this XID.
-  #
-  # This is useful for proving knowledge of the XID,
-  # without needed to expose the XID.
-  #
-  # Example:
-  #
-  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
-  #     xid.digest
-  #     #=> 4d648be0ca9dbb9e3a1b6b30b9d13c79ecbc0818dfca4125cc7961e32d61112c
-  #
-  def digest
-    XID.digest(self)
-  end
-
-  # Compute the XID digest of a given string.
-  #
-  # This is useful for proving knowledge of the XID,
-  # without needed to expose the XID.
-  #
-  # Example:
-  #
-  #     xid = XID.new("4bb88af57d4ddc224fecad688442423d")
-  #     xid.digest
-  #     #=> 4d648be0ca9dbb9e3a1b6b30b9d13c79ecbc0818dfca4125cc7961e32d61112c
-  #
-  def self.digest(s)
-    Digest::SHA256.new.update(s).to_s
+  def self.valid?(string)
+    !!(string && string.is_a?(String) && string.size == 32 && string =~ /\A[0-9a-f]{32}\z/)
   end
 
-  # Parse a string to an XID.
+  # Parse any object to an XID string.
   #
-  # This does three steps:
+  # This does these steps:
   #
-  #   * downcase
-  #   * delete any non-hex characters
-  #   * take the first 32 characters
+  #   * Convert the object to a string by calling `#to_s`.
+  #   * Convert the string to lower case by calling `#downcase`.
+  #   * Delete any non-hex characters.
+  #   * Take the first 32 characters.
   #
   # Example:
   #
-  #     xid = XID.parse("***FFAD30A1-BE5E-B511-9ED8-976CAB0281B6***")
+  #     string = XID.parse("***FFAD30A1-BE5E-B511-9ED8-976CAB0281B6***")
   #     #=> "ffad30a1be5eb5119ed8976cab0281b6"
   #
   # Return: [XID] A new XID
   #
-  def self.parse(s)
-    XID.new(s.downcase.gsub(/[^0-9a-f]/,'')[0...32])
+  def self.parse(object)
+    xid = object.to_s.downcase.gsub(/[^0-9a-f]/,'')[0...32]
+    raise ArgumentError if !XID.valid?(xid)
+    xid
   end
 
 end

data/test/sixarm_ruby_xid_test/xid_test.rb

@@ -8,14 +8,14 @@ describe XID do
     describe "with initialize defaults" do
 
       it "is a string with the correct length and characters" do
-        xid = XID.new
+        xid = XID.generate
         xid.must_match /\A[0-9a-f]{32}\z/
       end
 
       it "is always different" do
         seen = Set.new
         99999.times.each{
-          xid = XID.new
+          xid = XID.generate
           seen.include?(xid).must_equal false
           seen.add(xid)
         }
@@ -23,41 +23,6 @@ describe XID do
 
     end
 
-    describe "with valid initialize string" do
-
-      it "sets" do
-        s = "1cf2a839c0890bb9be7e9d56b7405a54"
-        xid = XID.new(s)
-        xid.must_equal(s)
-      end
-
-    end
-
-    describe "with invalid initialize string" do
-
-      it "raises" do
-        proc { XID.new("invalid") }.must_raise ArgumentError
-      end
-
-    end
-
-  end
-
-  describe ".valid" do
-
-    describe "with valid string" do
-      it "is true" do
-        xid = XID.new("c3d010bbfec046f59c7fe843d32dab32")
-        xid.valid?.must_equal true
-      end
-    end
-
-    describe "with invalid string" do
-      it "never gets called because it fails to create an xid" do
-        proc { XID.new("abc") }.must_raise ArgumentError
-      end
-    end
-
   end
 
   describe "#valid" do
@@ -76,25 +41,15 @@ describe XID do
 
   end
 
-  describe "#digest" do
-
-    it "digests" do
-      xid  = XID.new
-      xid.digest.must_match /\A[0-9a-f]{64}\z/
-    end
-
-  end
-
-  describe ".digest" do
+  describe ".parse" do
 
-    it "digests" do
-      XID.digest("foo").must_match /\A[0-9a-f]{64}\z/
+    it "converts objects to strings" do
+      obj = Minitest::Mock.new
+      obj.expect(:to_s, "!!C3D010BBFEC046F59C7FE843D32DAB32!!")
+      XID.parse(obj).must_equal "c3d010bbfec046f59c7fe843d32dab32"
+      obj.verify
     end
 
-  end
-
-  describe ".parse" do
-
     it "converts to lower case" do
       XID.parse("C3D010BBFEC046F59C7FE843D32DAB32").must_equal "c3d010bbfec046f59c7fe843d32dab32"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_xid
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 4.0.0
 platform: ruby
 authors:
 - SixArm
@@ -44,7 +44,7 @@ cert_chain:
   2AC9FOGkybW6DJEFSFFMlNk0IILsa/gNp8ufGuTVLWF9FUUdMNK+TMbghnifT8/1
   n+ES/gQPOnvmVkLDGw==
   -----END CERTIFICATE-----
-date: 2015-07-19 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest