extraction_token_util 0.0.2 → 0.0.3a11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77df6f96a575e9474c235cfd5896debda89c3e9a482ee8777e1a1132d6cf5f33
-  data.tar.gz: 66af9ab43913879d49019e9cb3b6a83ed40985e13d71fdd1f594d42003045d75
+  metadata.gz: 807964dad3726d71b70ad733c4d1d2362ad0d7ece464e277d5c86868d616db12
+  data.tar.gz: 947c1a665fdf8e23bf01789b17ce487aa8e62d8f6bbbc3214e7728c4531e06a4
 SHA512:
-  metadata.gz: c67131dd5fd0fb4ad3144eb5219669c22d869f8e1efff33a1282ded41fc43a4cf5e5f068b4b53ca122195af922500481a56b08bd15f7581ad625fc6db44eb39d
-  data.tar.gz: 196c12621df992657b964c287b8b32009283cc40e36482fa9bd42076d8f881936746d4c27a056131daa64a0f4038ef5729e1f523b0bc8e33ce1eb801c5dd59b2
+  metadata.gz: aa5a205ebdf99bd9b2b314fe02a9e58f8303955a075b1a79ca105c3cb678cc90af08eb1eeeea938938fc8af4b14a97e9176dc268a68ced77cec5eb3eb8205422
+  data.tar.gz: 77973aab9f3e5bc6256a5d2f746df0889dfda93ff162aa2ddc24034d9869634ac3dcb1e2798612a6fedaf9fc6bbf0520d75599a31645b8da03b7838c780195c9

data/lib/extraction_token_util.rb

@@ -1,85 +1,106 @@
+# frozen_string_literal: true
+
+#
+# This Gem provides support for common string operations with tokens in
+# Extraction lims like:
+# - quoting / unquoting strings
+# - padding / unpadding a string of digits until reaching a fixed size by
+# using zeroes support to perform recognizion of the following tokens:
+# - generate the address positions of the wells of a rack (A01, B01... F12)
+#
+# Also provides pattern recognision for UUID, Wildcard variables (Eg: ?a,
+# ?rack, etc.), Fluidx barcodes: (Eg: FR1234678), Well Location: (Eg: A02, F11)
+#
 module ExtractionTokenUtil
-  def self.UUID_REGEXP
-    /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
-  end
+  UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.freeze
+  WILDCARD = /\?\w*/.freeze
+  LOCATION = /^([A-H])(\d{1,2})$/.freeze
 
   def self.fluidx_barcode_prefix
     'F'
   end
 
-  def self.WILDCARD_REGEXP
-    /\?\w*/
-  end
-
-  def self.LOCATION_REGEXP
-    /^([A-H])(\d{1,2})$/
-  end
-
-  def self.is_uuid?(str)
-    str.kind_of?(String) && !str.match(ExtractionTokenUtil.UUID_REGEXP).nil?
+  def self.uuid?(str)
+    str.is_a?(String) && !str.match(ExtractionTokenUtil::UUID).nil?
   end
 
   def self.quote_if_uuid(str)
-    return quote(str) if is_uuid?(str)
-    return str
+    return quote(str) if uuid?(str)
+
+    str
   end
 
-  def self.is_valid_fluidx_barcode?(barcode)
+  def self.valid_fluidx_barcode?(barcode)
     barcode.to_s.start_with?(fluidx_barcode_prefix)
   end
 
   def self.uuid(str)
-    str.match(ExtractionTokenUtil.UUID_REGEXP)[0]
+    str.match(ExtractionTokenUtil::UUID)[0]
   end
 
-  def self.is_wildcard?(str)
-    str.kind_of?(String) && !str.match(ExtractionTokenUtil.WILDCARD_REGEXP).nil?
+  def self.wildcard?(str)
+    str.is_a?(String) && !str.match(ExtractionTokenUtil::WILDCARD).nil?
   end
 
   def self.kind_of_asset_id?(str)
-    !!(str.kind_of?(String) && (is_wildcard?(str) || is_uuid?(str)))
+    (str.is_a?(String) && (wildcard?(str) || uuid?(str)))
   end
 
   def self.to_asset_group_name(wildcard)
     return wildcard if wildcard.nil?
+
     wildcard.gsub('?', '')
   end
 
   def self.generate_positions(letters, columns)
-    size=letters.size * columns.size
-    location_for_position = size.times.map do |i|
-      "#{letters[(i%letters.length).floor]}#{pad((columns[(i/letters.length).floor]).to_s,'0',2)}"
+    size = letters.size * columns.size
+    size.times.map do |idx|
+      letter = position_letter_for_index(idx, letters)
+      number = position_number_for_index(idx, letters, columns)
+      "#{letter}#{number}"
     end
   end
 
-  def self.pad(str,chr,size)
-    "#{(size-str.size).times.map{chr}.join('')}#{str}"
+  def self.position_letter_for_index(idx, letters)
+    letters[(idx % letters.length).floor]
+  end
+
+  def self.position_number_for_index(idx, letters, columns)
+    pad((columns[(idx / letters.length).floor]).to_s, '0', 2)
+  end
+
+  def self.pad(str, chr, size)
+    "#{(size - str.size).times.map { chr }.join('')}#{str}"
   end
 
   def self.unpad_location(location)
     return location unless location
+
     loc = location.match(/(\w)(0*)(\d*)/)
-    loc[1]+loc[3]
+    loc[1] + loc[3]
   end
 
   def self.pad_location(location)
     return location unless location
-    parts = location.match(ExtractionTokenUtil.LOCATION_REGEXP)
-    return nil if parts.length == 0
+
+    parts = location.match(ExtractionTokenUtil::LOCATION)
+    return nil if parts.to_a.empty?
+
     letter = parts[1]
     number = parts[2]
-    number = ExtractionTokenUtil.pad(number,"0",2) unless number.length == 2
+    number = ExtractionTokenUtil.pad(number, '0', 2) unless number.length == 2
     "#{letter}#{number}"
   end
 
   def self.quote(str)
     return str unless str
+
     "\"#{str}\""
   end
 
   def self.unquote(str)
     return str unless str
-    str.gsub(/\"/,"")
-  end
 
+    str.gsub(/\"/, '')
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extraction_token_util
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3a11
 platform: ruby
 authors:
 - Eduardo Martin Rojo
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables: []
@@ -48,11 +76,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Set of Ruby methods to provide lexical support to common formats in use in