salesforce_id 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 912c9ad236b8c086fb7d334888350c35c863c2f9
-  data.tar.gz: 99cb0828ab0d1334dfa735e11a38e0ee2b7e6037
+  metadata.gz: 2af97469abc84391a77a60f80c5da44789eda37e
+  data.tar.gz: 8949cba7c23211c9110bf9fa7229a6ab1d44dff4
 SHA512:
-  metadata.gz: 7be443143e324aae5c099a6635b65082969bfcba7848ef77469ec008c27f52d3f3b87ee7ad7a0c609a05fb428a2d43d5d11099b413e871d3c701fec263efcf6e
-  data.tar.gz: dcadda7b393f830271f0528a42a4aa3996699137034e7a5c524b61cccaf1d3a6830dbd2b933822330e5f9894b26eb12359ad759376f0f9c279ada8fb5b5af46c
+  metadata.gz: 267d3107c694c631bbaaa5e1d87a1e648cc98366d23fc65c7a265043bbb82e0432426db11ad80d4b0dd2d59a5ea60c883cd755d3ef2a7aef19448e20b39b70cd
+  data.tar.gz: ce73d9946b2a52450415b68177a73d9ef99407513358dc82a39bb00ab7f9bbe644b93fd8285967dd8d40524d84c88e7a1813f3a6d2df6ff7f8d160e9d0dd0bff

data/README.md

@@ -117,8 +117,15 @@ SalesforceId::Random.invalid_insensitive_checksum # => 003G000001SUbc4I9D
 # Generate a valid SalesforceId::Safe salesforce id
 SalesforceId::Random.safe # => #<SalesforceId::Safe:0x007f86f2294c50 @value="003G000001SUbc4IAD">
 
+# Generate a valid SalesforceId::Safe salesforce id with a prefix, useful for
+# factory girl sequences
+SalesforceId::Random.safe("foo") # => #<SalesforceId::Safe:0x007f86f2294c50 @value="fooG000001SUbc4IAD">
+
 # Shorter version to perform `SalesforceId::Random.safe`
 SalesforceId.random # => #<SalesforceId::Safe:0x007f86f2294c50 @value="003G000001SUbc4IAD">
+
+# Shorter version to perform `SalesforceId::Random.safe` with prefix
+SalesforceId.random("foo") # => #<SalesforceId::Safe:0x007f86f2294c50 @value="fooG000001SUbc4IAD">
 ```
 
 #### RSpec matchers

data/lib/salesforce_id.rb

@@ -47,10 +47,13 @@ module SalesforceId
     ::SalesforceId::Safe.new(salesforce_id)
   end
 
-  # Provides a randomly generated salesforce id using {Salesforce::Random}
+  # Provides a randomly generated salesforce id.
+  # Alias of {Salesforce::Random#safe}
+  # @param prefix [String] prefix to be prepended to the id, see
+  #   {Salesforce::Random#safe} for additional details
   # @return [SalesforceId::Safe]
-  def random
-    ::SalesforceId::Random.safe
+  def random(prefix = '')
+    ::SalesforceId::Random.safe(prefix)
   end
 
 end

data/lib/salesforce_id/random.rb

@@ -65,9 +65,27 @@ module ::SalesforceId
     end
 
     # Creates a random salesforce id enclosed in {SalesforceId::Safe} object
+    # @param prefix [String] an optional prefix to be prepended to the ID,
+    #   useful for FactoryGirl sequences, must use salesforce id valid
+    #   characters for case-sensitive IDs
     # @return [SalesforceId::Safe]
-    def safe
-      SalesforceId(sensitive)
+    # @raise [ArgumentError] if prefix is longer than or contains invalid
+    #   characters for case-sensitive id
+    def safe(prefix = "")
+      prefix = prefix.to_s
+
+      raise_prefix_too_long! if prefix.size > ::SalesforceId::SENSITIVE_SIZE
+
+      id = sensitive
+      id = prefix + sensitive[(prefix.size..id.size)]
+
+      SalesforceId(id)
+    end
+
+    private
+
+    def raise_prefix_too_long!
+      raise ArgumentError, "Prefix must be shorter than insensitive length"
     end
 
   end

data/lib/salesforce_id/version.rb

@@ -1,3 +1,3 @@
 module SalesforceId
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_id
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Fire-Dragon-DoL