leap_salesforce 0.2.17 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906a5f6573d0bf393082eadac1e9935fcda4e89c6886a8e2d5fffa15010db289
-  data.tar.gz: 8b8343640b11e301fc53f6c8c5ba6a7253b206a14caaf9f723d74ed4f834318c
+  metadata.gz: f2c0ca47804ac6b8569d9a025d57650cfd749000abcf51a32833734fe82aabc3
+  data.tar.gz: bfdbffd73951d36c605e51250d7db353d50408b1435f95a8a7bb2e296f923e29
 SHA512:
-  metadata.gz: afecc4803505fb9599c49855d7105a9262e79e65f28156b3989508df973365d2f23a9525b306b845d2d30309561c39bcfc66bd092840a26ccf03a9df8de1675b
-  data.tar.gz: 1b4b06ee4497c02852afd97ee9bdfa9d80b88a2df9e9498d6795d0d5fc7a39cad2150f6e2f5138075890d72a6220bc03380c72a83dd2c01914e4e66e449ef021
+  metadata.gz: fe62e4cc025ebb9b51432d295ff377f672127c07cc95d9f0691a3898339baee22beac1f01e8c0da5074bc6194fefde2465513e875e27b4d620dc285c45ef1b49
+  data.tar.gz: aa0431124e5a9e1b0e6664c175a8818af2283b73215c4a5f4cc34f2b3f45e09904560e1bff5c1c69b44e6964c774ce204028e35b619bea5e4c2ca98e1129a9d2

data/ChangeLog

@@ -1,6 +1,10 @@
+Version 0.2.18
+* Bug fix
+  * Fixes #29 to raise error if value retrieved on object after an update failure
+
 Version 0.2.17
 * Bug fix
-  * Do not fail SFDX if SFDX_ACCESS_TOKEN and SFDX_INSTANCE_URL are manually set
+  * Do not fail SFDX if SFDX_ACCESS_TOKEN and SFDX_INSTANCE_URL are manually set and no jwt file is present
 
 Version 0.2.16
 * Bug fix

data/README.md

@@ -46,6 +46,8 @@ The benefits of an open source tool like this are:
                 * [.leap_salesforce.yml](#leap_salesforceyml)
                 * [salesforce_oauth2.yml](#salesforce_oauth2yml)
                 * [config/general.rb](#configgeneralrb)
+            * [Setup scripts](#setup-scripts)
+            * [Changing environment](#changing-environment)
             * [Test Users](#test-users)
         * [CRUD of data](#crud-of-data)
             * [Creating entities](#creating-entities)
@@ -82,6 +84,9 @@ Or install it yourself as:
     $ gem install leap_salesforce
 
 ## Usage
+Note there is a `Leaps` alias that can be declared if you require `leap_salesforce/leaps` which makes commands
+shorter, meaning that `Leaps` can be used instead of `LeapSalesforce`
+
 ### Getting started
 After installing the gem, to get started in creating a fresh repository, the `leap_salesforce` executable can be used.
 It will ask for credentials and setup files that will locally store them. 
@@ -150,7 +155,55 @@ This is where common code is stored for all the environments. This is where you
 as described in the next section.
 
 For sfdx, set the `ENV['SF_USERNAME']` to the user to login to sfdx with and create a `server.key` for 
-authentication. How sfdx will fully work with different user roles is still a work in progress.
+authentication. How sfdx will fully work with different user roles is still a work in progress. 
+
+#### Setup scripts
+The `leap_salesforce init` runs 2 rake tasks on the initial suite after having created the basic files. These are:
+
+* `leaps:create_soql_objects`
+This reads from the list of soql objects defined in `.leap_salesforce.yml` and creates a class inheriting from
+`SoqlData` that maps to a backend object. A difference in name created from this script can be defined in that file
+with format `DesiredClassName:ActualClassName`.
+
+E.g., `Broker: Broker__c` will mean that a Ruby class called `Broker` will be created that will map to the `Broker__c`
+custom object.
+
+A separate file with the ending `_field_names` is also created from the metadata for each object. This creates
+accessors for each field in the table with names that map from a Ruby friendly name to the Salesforce backend name.
+
+* `leaps:create_enums`
+
+This task reads the soql objects defined in `.leap_salesforce.yml` and creates a `metadata/enum` folder that has
+picklist information for all the picklist fields of each object. These are designed to be readonly as they will
+be overridden when this command is run again. 
+ 
+These are designed to be used as:
+
+1. A reference when setting the value of a picklist. Rather than 
+
+`contact.lead_source = 'Web'`
+one can use
+`contact.lead_source = Contact::LeadSource.web`
+which makes it clearer that a picklist value is used (not just free text) and also have a value that can be 
+refactored if there is a change in the picklist.
+
+2. A method of detecting changes in picklist values
+Sometimes due to older methods of deployment (or a disconnect between dev and testing team), a picklist value
+may change without the test team knowing about it (or a known change needs to be verified).
+Since the history of these values can be tracked when these files are committed to source control, a change
+can be detected when a test like the following is run
+
+```ruby
+RSpec.describe 'Picklists' do
+  LeapSalesforce.objects_to_verify.each do |data_class|
+    SoqlEnum.values_for(data_class).each do |picklist|
+      it "#{picklist} has not changed values" do
+        expect(data_class.picklist_for(picklist.name)).to match_array picklist.values
+      end
+    end
+  end
+end
+```
 
 #### Changing environment
 
@@ -430,23 +483,25 @@ Following is the general structure of test automation suite that uses this appro
 test framework used and other preferences.
 
     .
-    ├──  config                         # Code for the configuration of the automation suite
-    │   ├── general.rb                  # Code loaded for common (non confidential code) setup across environments
-    │   ├── credentials                 # Setting of secret properties like passwords
-    │   │  └── salesforce_oauth.yml     # Credentials for connecting to Salesforce via OAuth2.
-    │   └── environments                # Contains ruby files loaded specific to environment following `ENVIRONMENT_NAME.rb` 
-    ├──  lib                            # Common library code
-    │   └── leap_salesforce             # Code generated by or specific to leap_salesforce
-    │      ├── factories                # FactoryBot definitions, describing how to mass produce objects
-    │      ├── metadata                 # Code generated and updated automatically from metadata
-    │      │  └── enum                  # Picklist enumeration objects are stored here 
-    │      └── soql_data                # Objects for handling each object in the backend specified in '.leap_salesforce.yml'
-    ├──  logs                           # Contains API traffic logs for transactions against Salesforce
-    ├──  spec                           # Where RSpec automated tests are stored
-    ├──  .leap_salesforce.yml           # Where common configuration is stored regarding your project. This complements and is read before what's in 'config'
-    ├──  Gemfile                        # Where required ruby gems/libraries are specified
-    ├──  Gemfile.lock                   # Generated file specified details of versions installed by `Gemfile`
-    └──  Rakefile                       # Where common `Rake` tasks are specified. LeapSalesforce specific tasks are required from here
+    ├──  config                             # Code for the configuration of the automation suite
+    │   ├── general.rb                      # Code loaded for common (non confidential code) setup across environments
+    │   ├── credentials                     # Setting of secret properties like passwords
+    │   │  └── salesforce_oauth.yml         # Credentials for connecting to Salesforce via OAuth2.
+    │   └── environments                    # Contains ruby files loaded specific to environment following `ENVIRONMENT_NAME.rb` 
+    ├──  lib                                # Common library code
+    │   └── leap_salesforce                 # Code generated by or specific to leap_salesforce (this folder can be configured in .leap_salesforce.yml)
+    │      ├── factories                    # FactoryBot definitions, describing how to mass produce objects
+    │      ├── metadata                     # Code generated and updated automatically from metadata
+    │      │  └── enum                      # Picklist enumeration objects are stored here 
+    │      └── soql_data                    # Objects for handling each object in the backend specified in '.leap_salesforce.yml'
+    │         ├── {object_name}             # Class mapping to a Soql object 
+    │         └── {object_name}_field_names # Field name accessors auto created/updated based no metadata in Salesforce
+    ├──  logs                               # Contains API traffic logs for transactions against Salesforce
+    ├──  spec                               # Where RSpec automated tests are stored
+    ├──  .leap_salesforce.yml               # Where common configuration is stored regarding your project. This complements and is read before what's in 'config'
+    ├──  Gemfile                            # Where required ruby gems/libraries are specified
+    ├──  Gemfile.lock                       # Generated file specified details of versions installed by `Gemfile`
+    └──  Rakefile                           # Where common `Rake` tasks are specified. LeapSalesforce specific tasks are required from here
 
 ## Docs
 

data/lib/leap_salesforce/soql_data/soql_data.rb

@@ -192,6 +192,7 @@ class SoqlData < Exchange
   # @return [String] Value at backend name
   def [](backend_name)
     if @updated
+      successful? unless backend_name.to_s == 'message' || backend_name.to_s == '$..message'
       @updated = false
       find # Retrieve data freshly after an update
     end

data/lib/leap_salesforce/version.rb

@@ -2,5 +2,5 @@
 
 module LeapSalesforce
   # @return [String] Version of leap salesforce
-  VERSION = '0.2.17'
+  VERSION = '0.2.18'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.18
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-09 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler