Dicom_UID 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87ce3cded18e449b8bf2e4b748f76da5ac13716f8a4765434034dcf4f0567155
-  data.tar.gz: a5a2476d25443b8071eecea0c76a3ceea798b48f6aff392c363f74b59741a2cd
+  metadata.gz: 93f2b64dd2594ac1122cc624b35597a2a18af269a26023d6bff74aeedca605cd
+  data.tar.gz: dc0f37dccf407397d7476692289ded0e0658313e93e8e0d07a90640e3f810ebb
 SHA512:
-  metadata.gz: f93a96fe9362387bdb8af185153b9c355f164c1494d3de8fa63ff2f8266db29476af0396a285de8e933a356ff3280d43c980c91ece41edbe6b5796499a9e7f32
-  data.tar.gz: 8c040e45b46f6d7c3124c215b5b1ec2c6dcb6035cc61ea2b3a7a90f3f417423a8cfb1ec7067a9db6725b94c026dcf104d6207755396064dde4f91b339d6aa036
+  metadata.gz: 5d34818eefeb7579057055c4c0d457692895ff6caa4c4ba0ac9af2e33ff54d09e5bea2789525026ef1f12600aeb3c07100554fc78776cbc10faab590ab7a49ce
+  data.tar.gz: bcf8b9e9d594bd46aa70dc54a4898ad506f9a17ebaf009584144a6c8a91363c23217042a0a006be29440519da138f9ba83cabf0310732686666ebed8e35bbc04

data/README.md

@@ -2,10 +2,23 @@
 
 Gem generating DICOM random UID
 
+
+## Documentation
+
+![Here](https://poulpy.github.io/DICOM-UID/docs/)
+
+
 ## Examples
 
 ```ruby
-    DicomUID.random_dicom_uid '10.12.6.64', 60
-    DicomUID.random_dicom_uid '1.1.3.62', 30, false
+DicomUID.random_dicom_uid '10.12.6.64', 60
+# 10.12.6.64.427667812798425850151433034003527467011730.452.0
+DicomUID.random_dicom_uid '1.1.3.62', 30, false
+# 1.1.3.62.5029609471.336514265
+
+DicomUID.random_component 6
+# 9538
+DicomUID.random_component 30, false
+# 59452307
 ```
 

data/lib/dicom_uid.rb

@@ -6,9 +6,32 @@
 # The UID must not be more than 64 characters, dots included.
 module DicomUID
 
-  # Maximum size of an UID
-  MAXIMUM_SIZE = 64
+  # set default values, with org_root if needed
+  # the size of the UID is randomized
+  # fixed_size is the size ogf the whole UID, with the org taken into account
+  def self.random_dicom_uid org_root, fixed_size, odd_byte_boundary = true
+
+    raise TypeError, 'Org root must be a string or an Integer' unless org_root.is_a? String or org_root.is_a? Integer
+    org_root = org_root.to_s if org_root.is_a? Integer
+    raise TypeError unless fixed_size.is_a? Integer and odd_byte_boundary == !!odd_byte_boundary
+
+    # building the org root
+    org_root = self.random_component(62, odd_byte_boundary) if org_root.empty?# UID needs at least an org root
+    raise LeadingZeroError if leading_zero? org_root
+    raise OddByteError if !odd_byte_rule(org_root) and odd_byte_boundary
+
+    # if the fixed size doesn't exist, a random one is created, but
+    # it must be generated so that the UID musn't be above 64 chars
+    fixed_size ||= rand(0..(64 - org_root.length - 1))
+    fixed_size -= 1 if add_missing_dot org_root
 
+    raise OversizedUIDError if fixed_size > 64
+    raise RangeError, 'Size of Org root larger than size provided' if fixed_size < org_root.length
+    raise RangeError, "Size of UID can't be negative" if fixed_size < 0
+
+    # building the suffix
+    self.rand_duid org_root, (fixed_size - org_root.length), odd_byte_boundary
+  end
 
   # Generates random component with defined, maximum length
   # The maximum length is 62. Why ? Because an UID has at least an org_root
@@ -44,38 +67,6 @@ module DicomUID
     component
   end
 
-
-
-
-  # set default values, with org_root if needed
-  # the size of the UID is randomized
-  # fixed_size is the size ogf the whole UID, with the org taken into account
-  def self.random_dicom_uid org_root, fixed_size, odd_byte_boundary = true
-
-    raise TypeError, 'Org root must be a string or an Integer' unless org_root.is_a? String or org_root.is_a? Integer
-    org_root = org_root.to_s if org_root.is_a? Integer
-    raise TypeError unless fixed_size.is_a? Integer and odd_byte_boundary == !!odd_byte_boundary
-
-    # building the org root
-    org_root = self.random_component(62, odd_byte_boundary) if org_root.empty?# UID needs at least an org root
-    raise LeadingZeroError if leading_zero? org_root
-    raise OddByteError if !odd_byte_rule(org_root) and odd_byte_boundary
-
-    # if the fixed size doesn't exist, a random one is created, but
-    # it must be generated so that the UID musn't be above 64 chars
-    fixed_size ||= rand(0..(64 - org_root.length - 1))
-    fixed_size -= 1 if add_missing_dot org_root
-
-    raise OversizedUIDError if fixed_size > 64
-    raise RangeError, 'Size of Org root larger than size provided' if fixed_size < org_root.length
-    raise RangeError, "Size of UID can't be negative" if fixed_size < 0
-
-    # building the suffix
-    self.rand_duid org_root, (fixed_size - org_root.length), odd_byte_boundary
-  end
-
-
-
   # Return an array of UIDs, from a common org root
   def self.random_uids org_root, fixed_size, array_size, odd_byte_boundary = true
     uids = Array.new array_size
@@ -87,8 +78,6 @@ module DicomUID
     uids
   end
 
-
-
   private
 
   # Generates recursively a random dicom uid
@@ -108,14 +97,8 @@ module DicomUID
     self.rand_duid uid, remain - 1, obb
   end
 
-
-
-
-
-
 end
 
-
 def add_missing_dot comp
   raise TypeError unless comp.is_a? String
   if comp[-1] != '.'
@@ -125,13 +108,11 @@ def add_missing_dot comp
   false
 end
 
-
 def odd_byte_rule comp
   return comp[-1].to_i % 2 == 0 || (comp[-2].to_i % 2 == 1 && comp[-1].to_i == 0) if comp.length != 1
   comp[-1].to_i % 2 == 0
 end
 
-
 def leading_zero? org_root
   org_root[0] == '0' and org_root.length != 1
 end
@@ -157,3 +138,4 @@ class OversizedUIDError < StandardError
     super
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Dicom_UID
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Repain Paul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies: []
 description: Generates random UID for DICOM files
 email: paul.repain@yahoo.com