sixarm_ruby_xid 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b8b78b48157b5d06b0b0bd0acd50ebb366d8e47
-  data.tar.gz: 01121a252416e4d57b23da700657c3282cf69904
+  metadata.gz: 51f78d9f07ef6aef69becef2af659d95fe05f971
+  data.tar.gz: 35abf0348943973f1b6b962c9bcb2659e289cbd7
 SHA512:
-  metadata.gz: cc7ddce6d4efcabe265120454474ca1d26127bb09cc4c5c291199b8d38880d392a5fdb111194913f8e10d25e1fb533813d6383578c045ae4ca300a221a6fbe92
-  data.tar.gz: 15d570a1ccc39b129975c98087b52de59e81a622d785354b6b8c085577c46f1bfa7e8e1165ce3dfc99498d5863ae60d420284af0967286af564a7e702f12ed46
+  metadata.gz: 87fe6ef0b1dd620118b4486f1ec2b090d720720873b5d521cd45d967791e9b261e5693a1bcc284fd68fce0e3b416120c0fdd4f223193896caabfbf2ed6c3d60d
+  data.tar.gz: 6001f77cdcbac8a470d0f4aa0d2d43311ce8d771d99051863887799fd159d1fd35b114f0dc8a429d27adae35280e9a043bcfe4ec3ff0300093687d9b8f107b87

data/README.md

@@ -1,4 +1,4 @@
-# SixArm.com » Ruby » <br> XID excellent identifier
+# Ruby » <br> XID excellent identifier
 
 [![Code Climate](https://codeclimate.com/github/SixArm/xid.png)](https://codeclimate.com/github/SixArm/sixarm_ruby_xid)
 [![Build Status](https://travis-ci.org/SixArm/xid.png)](https://travis-ci.org/SixArm/sixarm_ruby_xid)
@@ -65,8 +65,11 @@ Methods:
 
   * `XID.new`: create an XID and initialize to a random string.
   * `XID.new(s): create an XID and initialize to a given string.
+  * `XID.valid?`: is this XIDa valid, i.e. the correct format?
+  * `XID#valid?(s)`: is a string a valid XID, i.e. the correct format?
   * `XID#digest`: return a SHA256 digest as a 64-character string.
   * `XID.digest(s)`: return a SHA256 digest as a 64-character string.
+  * `XID.parse(s)`: parse any string with enough data to a new XID.
 
 Notes:
 
@@ -123,6 +126,7 @@ Some databases have specialize fields for 128 bit values, such as PostgreSQL and
 
 ## Changes
 
+* 2015-04-01 3.4.0 Add XID.parse and XID.valid?
 * 2015-02-12 3.3.0 Add XID.digest(s)
 * 2015-02-12 3.2.0 Add XID.new(s) to initialize with a given string.
 * 2015-02-12 3.1.0 Add #digest.

data/lib/sixarm_ruby_xid.rb

@@ -8,16 +8,29 @@ require 'digest/sha2'
 
 class XID < String
 
-  def initialize(s=nil)
-    super(s || SecureRandom.hex(16))
+  def initialize(s = nil)
+    s and (XID.valid?(s) or raise ArgumentError)
+    super(s || SecureRandom.hex)
+  end
+
+  def valid?
+    XID.valid?(self)
+  end
+
+  def self.valid?(s)
+    !!(s && s.is_a?(String) && s.size == 32 && s =~ /\A[0-9a-f]{32}\Z/)
   end
 
   def digest
-    Digest::SHA256.new.update(self).to_s
+    XID.digest(self)
   end
 
   def self.digest(s)
     Digest::SHA256.new.update(s).to_s
   end
 
+  def self.parse(s)
+    XID.new(s.downcase.gsub(/[^0-9a-f]/,'')[0...32])
+  end
+
 end

data/test/sixarm_ruby_xid_test.rb

@@ -27,15 +27,57 @@ describe XID do
 
     end
 
-    describe "with initialize string" do
+    describe "with valid initialize string" do
 
       it "sets" do
-        xid = XID.new("foo")
-        xid.must_equal("foo")
+        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
+
+    describe "with valid string" do
+      it "is true" do
+        XID.valid?("c3d010bbfec046f59c7fe843d32dab32").must_be_same_as true
+      end
+    end
+
+    describe "with invalid string" do
+      it "is false" do
+        XID.valid?("abc").must_be_same_as false
+      end
+    end
+
   end
 
   describe "#digest" do
@@ -55,4 +97,24 @@ describe XID do
 
   end
 
+  describe ".parse" do
+
+    it "converts to lower case" do
+      XID.parse("C3D010BBFEC046F59C7FE843D32DAB32").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "deletes non-hex characters" do
+      XID.parse("!!c3d010bb-fec0-46f59c7f-e843d32dab32!!").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "chops at 32 characters" do
+      XID.parse("c3d010bbfec046f59c7fe843d32dab32aaaaaaaaa").must_equal "c3d010bbfec046f59c7fe843d32dab32"
+    end
+
+    it "raises if the string is invalid" do
+      proc { XID.parse("abc") }.must_raise ArgumentError
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_xid
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - SixArm
@@ -10,27 +10,41 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDbDCCAlSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQ8wDQYDVQQDDAZzaXhh
-  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
-  HhcNMTQwMzEzMDQyMjE4WhcNMTUwMzEzMDQyMjE4WjA+MQ8wDQYDVQQDDAZzaXhh
-  cm0xFjAUBgoJkiaJk/IsZAEZFgZzaXhhcm0xEzARBgoJkiaJk/IsZAEZFgNjb20w
-  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5MZYB72Amo9DyeqBdJeEx
-  r4togM0+diNuL1nCH2FSO/+LX5L9mTPEEW5gexYCasmlOfmk5255EToJNtu1JUM/
-  dMqUbNS5LZ1srFVcyDzIe/wQ9f2OSmb+lAGmlnFLfYSpduMv9fPNISlcs5nFYSR9
-  mpS0kTWcXQPLNDl2cfnkYYjDsuyJ8FmDyG7TTF0c4OWJNLxNDE8To2n8GmmDSwr3
-  0K71F278CJlFoIaSSjnhKxkH8/l+z/Vs58KkjX/7M6nwNgNZMQaFBIO02UDtCi2F
-  ICVtDuWdK0YLv3JnIzvSQPQsfArrw2s8RVKjXlelPMeHJIcCEZcS4K6HIg7vQCkP
-  AgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQrbLvF
-  TNv9r72z+hpCl3BkTPbzwTAcBgNVHREEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTAc
-  BgNVHRIEFTATgRFzaXhhcm1Ac2l4YXJtLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEA
-  H08J7cTJyfm4mXpdM0FFr/f/syQSl2ymJWtcosuKA79A/vYMZ+n9B1gpuJmegjNt
-  lmYByeU50jJJ7JNdkvkTagHCZaxtzclWx6AR5gTd8V/sBKbTWtHe72pOWz/stQs2
-  xD8tQZvdAuBtRXx4ys6e3vigvYjdmTHUR9tT/NGCwmWj7KTk3mwNKBmuQGWTVWrV
-  h6r4cFMt3X5Zu+euYxHqDuwWyub9hp4s30/ea38CoYNdIZcSFtpGuvhwVDU0x5dg
-  sWRVEyjnjnNuAeLP9zv43IDXjS22L2efhap7IOinYjcecpfXJgQaU+6BFAY4sdkQ
-  S1STYSfs3qySBxxAeEyZTw==
+  MIIGCTCCA/GgAwIBAgIJAK3igyLv2hNNMA0GCSqGSIb3DQEBBQUAMGAxCzAJBgNV
+  BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNp
+  c2NvMQ8wDQYDVQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb20wHhcNMTUw
+  MzE0MjA0MTE5WhcNMTcxMjA4MjA0MTE5WjBgMQswCQYDVQQGEwJVUzETMBEGA1UE
+  CBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEPMA0GA1UEChMG
+  U2l4QXJtMRMwEQYDVQQDEwpzaXhhcm0uY29tMIICIjANBgkqhkiG9w0BAQEFAAOC
+  Ag8AMIICCgKCAgEA4et7SlePzuE46eK5BAVVGg+yWt6FkX7xcLt3Uun9RntKPSuR
+  TbS/+KBqbja5reZD64hdQ9npxpQPKafxUm+RlCd9F5KFxwi8G9usKzCTPOwUeDI2
+  TNEfC+1eRU19QuEW58ZC0pC/bx5Zmp6/DTD6VV+qxKEE9U1M5P85LNkwnxqmRIMR
+  AN8VKOG+GRGOMNDGZ8Kp4h5V3Wyu0N7anY8AUveIx1SyLrEbAhcWp1asLs+/H22q
+  92YFgnwTtnDpZsAmNgZrVw9xY0v79BXqPoyKIl2psPfZi2mOIWi/N+cx6LGF1G+B
+  b+NZdAgwuLyFOoVknkTqsuYEsFhxz0dqDUgM/RvGrADxZk6yUD/1lBNTWnIDVKaN
+  Onu08gOb1lfn21Sbd5r/K32hngasiEuDvh61pJVwszBuFv3v++hVlvNzHw9oT7wc
+  W0z258Qw6fkPhozF5l+zaR+xPZG/4Kk4vc3D4mnw5MEHna6Q9rVsVktqGuIOie8Q
+  5MQAyjdNxywnl7GDllX97oVN+35JbyTePeUyZZnk5tb4p6BlYrd3rtQ2Te7tkQRz
+  8T4Scy5THaPvxf8SsfDGSj3AVPARvSX//hSFFxJM+up+S1jsquU0RjBU52nCdh7p
+  1hBZ1nqfVPeSktx3F+R2RZBPA692UKjpSA7r2vOEfoh3rUTEsNUBQGpPg2MCAwEA
+  AaOBxTCBwjAdBgNVHQ4EFgQUHnpLsysq561sVXhWi+3NoSb9n94wgZIGA1UdIwSB
+  ijCBh4AUHnpLsysq561sVXhWi+3NoSb9n96hZKRiMGAxCzAJBgNVBAYTAlVTMRMw
+  EQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNpc2NvMQ8wDQYD
+  VQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb22CCQCt4oMi79oTTTAMBgNV
+  HRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4ICAQCYcCnvJpEhpo5mdVM8JDUuUZFt
+  qP2Kvj9J6tqugO+cuUF2S/ro4gdEQhl7Gv6+DCWHd0FQWJBSXMsZ9a6RhFGAcE5C
+  egK706Gh40yNeobd1aoUh+Pn17kYH2WSBRC+KsIvhZaAnra/1JPZItoge64GS+lM
+  PJJbVrtSati++s39wnss1QlMy9TXoesmR8vqsOU0XdCnK5hOun5RA8SYDWLffsfG
+  E3hvCg4C5viEkPY0YdC0KMSqs5kIA2nCUiqpkwIOa36rVEwiKiU7OCfE3u3baDpL
+  FlfMBznZKOdxDFAmNaxvXBe2XeTzrZPvJtnNLWL6K4LaBHhq3bBdh1Hge0iMkpQ7
+  RTIGlfhlIFkMV3wT0LTsNznUPsoo6e+IW/tDrk23mrNRY6QynTETb+QVIevuzD9m
+  Drcxp/zlVhud+a0ezdnyNvF520arJWvqA4GrOo8F+TT2vVrjscgYjiVGdSq+8wQv
+  Efa5jhe8QwG7R1rdpMMP5yBSAqWuFBczMveX5j4rp9Ifw5/XsZbgwcmdm26bjhzh
+  w2grAHIhvR9mztm6uXQlZhv1fu3P+RWHDSYhnZSCJSCdxPzQJ1mG5T5ahiL3HvCZ
+  2AC9FOGkybW6DJEFSFFMlNk0IILsa/gNp8ufGuTVLWF9FUUdMNK+TMbghnifT8/1
+  n+ES/gQPOnvmVkLDGw==
   -----END CERTIFICATE-----
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies: []
 description: XID generates a new string suitable for security, authentication, tracking,
   etc.
@@ -76,4 +90,3 @@ specification_version: 4
 summary: SixArm.com » Ruby » XID excellent identifier
 test_files:
 - test/sixarm_ruby_xid_test.rb
-has_rdoc: true