salesforce_id_formatter 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62b7e82d6f655aa0ef4f30f2c96e2626c4f3a63c
-  data.tar.gz: 90ea7d900623067fb302d6dc1e55461dd214cf13
+SHA256:
+  metadata.gz: eb9e74dd5d8e24dcb7ce2a782d589d9f76b7bc3b46c2fcf179ce64e41e759f68
+  data.tar.gz: 72fd489c2cbf3f3a41e41fa6059682f924573cfca8eb91d613925a8470b1e43d
 SHA512:
-  metadata.gz: 4bccfb2a208be53db1113b9f49e297fef24d68c31d60945c55832c3738eeee36d6525c193e8b0ee336c536dffa8ff978cfd18be1c2bc24884587e499a630c3e2
-  data.tar.gz: d2759cdcc2e05afd28d3d38b0ffbd038f97055d2f280819f877701c4e53fad25e7375e29acc28840a7984d852889ed6e31d4346699d079e465dd5aa9afc0bd3a
+  metadata.gz: fa3a6fc39a2ce5528fa4f2654d0de8bd3f4e3400ead455026cceaf23a10df6d8df88e433584b0285a36f8f482969a70e25630e404a4bd629453e04d918f8c28b
+  data.tar.gz: 9c78049a7b17d5608763abec6678247c02fc0b9633ac4cef2dc21101c55608fdd325677e328ac7e65968b7f9f61c00b3158c89536351518737365e6ab4c2666b

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+.ruby-version
+.ruby-gemset

data/README.md

@@ -3,18 +3,29 @@ Later on, added three error-correcting characters to make their 18-character ID.
 
 ## Usage
 
-`SalesforceIdFormatter.to_18`:
+#### `SalesforceIdFormatter.to_18`
 
-- Converts a 15-char String to its equivalent 18-char ID as a String: `SalesforceIdFormatter.to_18('70130000001tcyI')  # =>  '70130000001tcyIAAQ'``
-- Leaves a 18-char String unaltered: `SalesforceIdFormatter.to_18('70130000001tcyIAAQ') # =>  '70130000001tcyIAAQ'`
-- Raises `SalesforceIdFormatter::InvalidId` if the given ID doesn't follow Salesforce's conventions
-  http://www.salesforce.com/us/developer/docs/api/Content/field_types.htm#i1435616
-  TL;DR: 15 or 18 alphanumeric, case-sensitive chars
+- Converts a 15-char String to its equivalent 18-char ID as a String:
+  `SalesforceIdFormatter.to_18('70130000001tcyI')  # =>  '70130000001tcyIAAQ'``
+- Leaves a 18-char String unaltered:
+  `SalesforceIdFormatter.to_18('70130000001tcyIAAQ') # =>  '70130000001tcyIAAQ'`
+- Raises `SalesforceIdFormatter::InvalidId` if the given ID doesn't follow
+  Salesforce's conventions
+http://www.salesforce.com/us/developer/docs/api/Content/field_types.htm#i1435616
+TL;DR: 15 or 18 alphanumeric, case-sensitive chars
 
-`SalesforceIdFormatter.to_15` applies the same rules, returning 15-char IDs instead.
+#### `SalesforceIdFormatter.to_15`
 
+- Applies the same rules as `to_18`, returning 15-char IDs instead.
+
+#### `SalesforceIdFormatter.valid_id?`
+
+- Returns false if passed string is either not 15/18 characters or is not
+  alphanumeric.
+
+## Attribution
 Code is a modified version of https://gist.github.com/jbaylor-rpx/2691624
-(original does seemt to calculate control digits correctly)
+(original doesn't seem to calculate control digits correctly)
 
 ## Installation
 

data/lib/salesforce_id_formatter.rb

@@ -1,4 +1,4 @@
-require "salesforce_id_formatter/version"
+require 'salesforce_id_formatter/version'
 
 module SalesforceIdFormatter
   extend self
@@ -14,7 +14,7 @@ module SalesforceIdFormatter
   def to_15(id)
     raise InvalidId unless valid_id?(id)
 
-    id.size == 18 ? id[0..14] : id
+    id.size == 18 ? convert_18_to_15(id) : id
   end
 
   def valid_id?(id)
@@ -23,11 +23,17 @@ module SalesforceIdFormatter
 
   private
 
-  def decimal_to_base_32(dec)
-    Array(base32.rassoc(dec)).first
+  def sfdc_base32_to_decimal(char)
+    sfdc_base32[char]
   end
 
-  def base32
+  def decimal_to_sfdc_base32(dec)
+    Array(sfdc_base32.rassoc(dec)).first
+  end
+
+  # sfdc_base32 because base32 isn't a standard
+  # and this is salesforce's interpretation of it.
+  def sfdc_base32
     @@b32 ||= begin
       hash = {}
       ('A'..'Z').each_with_index {|letter, idx| hash[letter] = idx }
@@ -48,7 +54,22 @@ module SalesforceIdFormatter
       bits[5..9].join.reverse.to_i(2),
       bits[10..14].join.reverse.to_i(2)
     ]
-    checkdigits = checkdigits.map {|d| decimal_to_base_32(d) }.join
+
+    checkdigits = checkdigits.map {|d| decimal_to_sfdc_base32(d) }.join
     str + checkdigits
   end
-end
+
+  def convert_18_to_15(str)
+    # Assume a default of lower-case for each char
+    base = str[0..14].downcase.split('')
+
+    # Convert the last 3 chars to their decimal value
+    dec = str[-3..-1].upcase.split('').collect { |char| sfdc_base32_to_decimal(char) }
+
+    # Convert the decimal values to their binary value, MSB in the on the 'right' of the string
+    bits = dec.map { |d| format('%05b', d.to_i).reverse.split('') }.flatten
+
+    # Finally, upper-case everything with a '1' in the binary string.
+    base.zip(bits).map {|char,bit| bit == '1' ? char.upcase : char }.join
+  end
+end

data/lib/salesforce_id_formatter/version.rb

@@ -1,3 +1,3 @@
 module SalesforceIdFormatter
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/salesforce_id_formatter.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_id_formatter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Raul Murciano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2019-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.7'
 description: ''
 email:
 - raul@heroku.com
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Formats Salesforce IDs