leap_salesforce 0.2.24 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b9311c1afc5593fb4b3428de805b3a2a9c5a6e8331d827dd40b9d5b60e09d8d
-  data.tar.gz: 9532ceffad0924438eb87b97378faeadd6729e27bc396439a4934f2ee71f71e7
+  metadata.gz: 3d80eff87ab1c75f73d0f99c2556837698e418c3be87ba611fc044602c262add
+  data.tar.gz: 3a6090439223eeaafdc9194e7e19649ab805abd52885071ddbacc54d9bfd7431
 SHA512:
-  metadata.gz: 1c81db35151f84596e6d0b80815bebfdcf3f582be9ee2457eb46fe90b06bf989af780be6e9333dbf1de5bae3797193605849f54d87c7652f352ed741ceeb0cfc
-  data.tar.gz: a8998c522c93ed383524758d91dceac18fd6fdf8af41f5db8db3f9898a3be93e6e6f03cb63dd0277bd9a4e404403ebe5929636278c3b92878df89c081be4ac5a
+  metadata.gz: 247b89d8a5059f353cee60834a25aa9c7d480df6a71bf2d262fe99023cdc536e44b670ff874793478e55a75ddf9443a62445e124b138c44d9ec772efd613fbbc
+  data.tar.gz: e05ae5ffee8f34badabdda8a1cb8814ba336df63848ccdb662e85439a1e85c44a59ce179354ea2d9790f7b79afb6ce035dabd8fd5d215b0f70393cfbf6ffe253

data/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 include:
   - template: Code-Quality.gitlab-ci.yml
 
-image: ruby:2.6
+image: ruby:2.7
 
 stages:
   - test
@@ -18,7 +18,7 @@ variables:
 pages:
   stage: deploy
   dependencies:
-    - test
+    - test_2.7
   script:
     - mv coverage/ public
   artifacts:
@@ -600,25 +600,49 @@ pages:
     done
   }
 
-test:
+  function setup_integration_env() {
+    # Decrypt server key
+    openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
+    ls -la assets
+    install_jq
+    install_salesforce_cli
+    # Integrated test
+    gem install bundler rake
+    bundle install
+    sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+  }
+
+test_2.6:
+  image: ruby:2.6
   stage: test
+  script:
+    - *sfdx_helpers
+    - setup_integration_env
+    - bundle exec rake check_oauth   # Check OAuth
+    - bundle exec rake leaps:create_soql_objects
+    - bundle exec rake leaps:create_enums
+    - bundle exec rspec
+
+test_2.7:
   script:
     # Decrypt server key
     - *sfdx_helpers
-    - openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
-    - ls -la assets
-    - install_jq
-    - install_salesforce_cli
-    # Integrated test
-    - ruby -v
-    - which ruby
-    - gem install bundler rake
-    - bundle install
-    - sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+    - setup_integration_env
     - bundle exec rake check_oauth   # Check OAuth
     - bundle exec rake leaps:create_soql_objects
     - bundle exec rake leaps:create_enums
-    - bundle exec rspec_booster --job $CI_NODE_INDEX/$CI_NODE_TOTAL
+    - bundle exec rspec
   artifacts:
     paths:
       - coverage/
+
+test_3.0:
+  image: ruby:3.0
+  script:
+    # Decrypt server key
+    - *sfdx_helpers
+    - setup_integration_env
+    - bundle exec rake check_oauth   # Check OAuth
+    - bundle exec rake leaps:create_soql_objects
+    - bundle exec rake leaps:create_enums
+    - bundle exec rspec

data/.leap_salesforce.yml

@@ -6,9 +6,15 @@ soql_objects:
   - Contact
   - Document: ContentDocument
   - User:
-    create_enum: true # Set this to false to not track enums for object
-  - Group
+    create_enum:
+      exclude:
+        - Time
+  - Group:
+    create_enum: false # Set this to false to not track enums for object
   - Broker: Broker__c
-  - Account
+  - Account:
+    create_enum:
+      exclude:
+        - Rating
   - Attachment
   - EventLogFile

data/.rubocop.yml

@@ -1,3 +1,17 @@
 # Modifies RuboCop (Static analysis tool)
-Metrics/LineLength:
-  Max: 160
+Layout/LineLength:
+  Max: 160
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/ChangeLog

@@ -1,3 +1,28 @@
+Version 1.0.1
+* Bug fix
+  * Fix #28 allowing !nil for query by non null values
+
+Version 1.0.0
+* Enhancement
+  * Disable rubocop output for pending ops when creating/fixing files
+  * Specify that working with Ruby 3 is a work in progress
+
+Version 0.2.28
+* Enhancement
+  * Make exclude method able to use class name in exclusion filter (hence easier to use)
+
+Version 0.2.27
+* Bug fix
+  * Patch to update deprecated `create_enum` method so it allows 1 parameter
+
+Version 0.2.26
+* Enhancement
+  * Create method to exclude picklists being created based on regexp in .leap_salesforce.yml
+
+Version 0.2.25
+* Enhancement
+  * `execute_as` user method that raises error if user not present
+
 Version 0.2.24
 * Bug fix
   * Handle metadata label name that is the same name as a method on SoqlData (which one would not want overwriting)
@@ -210,4 +235,4 @@ Version 0.1.1
   * Suggestions for generated factory
   * Begin unit tests
   * Handle Macrons by ensuring they're not copied into Ruby names / Modules
-  * Created executable
+  * Created executable

data/PITCHME.md

@@ -80,7 +80,7 @@ metadata.
 @[3](Declare what it is you're testing)
 @[5](Define what 'it' is, a the object under test must do)
 @[6](Create an instance of the object class - nothing sent to Salesforce yet)
-@[7-8](Set the first and last name to random names)
+@[4,7-8](Set the first and last name to random names)
 @[9](Create the object in Salesforce by sending request via API)
 @[10](Verify creation was successful)
 @[11](Verify first name set as expected)
@@ -92,8 +92,8 @@ metadata.
 
 ---?code=spec/integration/query_spec.rb&lang=ruby&title=Querying entities
 
-@[6](Find an object using a specific attribute specific value)
-@[19](Find an object using a comparator)
+@[21](Find an object using a specific attribute specific value)
+@[29-30](Find list of objects meeting condition)
 
 ---
 

data/README.md

@@ -258,6 +258,10 @@ This method can be used directly with the backend name. E.g, `contact[:FieldName
 This method in turn sets a value of the `@override_parameters[:body]` variable within the entity. 
 The value of request body can be interrogated with `entity.request_parameters.body`.
 
+##### Logging
+
+By default, API traffic will be logged in a log file in a `logs` folder. 
+
 ### CRUD of data
 
 To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
@@ -560,3 +564,5 @@ Everyone interacting in the LeapSalesforce project’s codebases, issue trackers
 
 * Presentation on this library [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)
 * Example of this library within a CI/CD pipeline [here](https://gitlab.com/iqa_public/labs/salesforce_cicd_demo)
+* Using `leap_salesforce` to download event log files [here](https://gitlab.com/samuel-garratt/leap_salesforce_event_log_files)
+

data/Rakefile

@@ -34,3 +34,21 @@ YARD::Doctest::RakeTask.new do |task|
   # TODO: Get all examples working in this way
   task.pattern = 'lib/leap_salesforce/ext/string.rb'
 end
+
+desc 'Task to enter pry terminal and types commands using the standard library code'
+task :pry do
+  require 'pry'
+  Pry.start
+end
+
+desc 'Example of cleaning up data'
+task :remove_contacts do
+  contacts = Contact.where first_name: '!null'
+  puts "Deleting #{contacts.size} contacts"
+  contacts.each do |contact|
+    contact.delete
+    print '.'
+  end
+  contacts = Contact.where first_name: '!null'
+  puts "#{contacts.size} contacts left"
+end

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -28,7 +28,10 @@ module LeapSalesforce
       # @param [LeapSalesforce::SoqlData] entity An object representing an object in Salesforce
       #   Object inheriting from SoqlData that has picklists underneath it
       def create_picklists_for(entity)
-        unless entity.create_enum?
+        soql_object = LeapSalesforce.soql_objects.find { |so| so.class_name == entity.to_s }
+        raise "Could not find soql object for '#{entity}'" unless soql_object
+
+        unless soql_object.create_enum != false
           puts "Skipping picklists for #{entity}"
           return
         end
@@ -36,7 +39,13 @@ module LeapSalesforce
         @entity_name = entity
         picklists = entity.picklists
         puts "#{picklists.count} picklists found"
-        picklists.each { |picklist| generate_picklist_file picklist }
+        picklists.each do |picklist|
+          if soql_object.excludes?(picklist)
+            puts "Excluding picklist '#{picklist}'"
+          else
+            generate_picklist_file picklist
+          end
+        end
       end
 
       # Generate file for a picklist from it's metadata
@@ -61,7 +70,7 @@ module LeapSalesforce
 
       # Clean up files generated for all picklists
       def cleanup_files_created
-        `rubocop -a #{ENUM_FOLDER}`
+        `rubocop -a #{ENUM_FOLDER} --display-only-fail-level-offenses --enable-pending-cops`
       end
     end
   end

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -62,8 +62,8 @@ module LeapSalesforce
           generate_field_module
           generate_factory
         end
-        `rubocop -a #{SOQL_OBJECT_FOLDER}`
-        `rubocop -a #{FACTORY_FOLDER}`
+        `rubocop -a #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
+        `rubocop -a #{FACTORY_FOLDER} --enable-pending-cops`
       end
 
       private

data/lib/leap_salesforce/generator/templates/soql_object.rb.erb

@@ -3,5 +3,4 @@ require_relative '<%= @field_name_file %>'
 class <%= @soql_object.class_name %> < SoqlData
   include <%= @soql_object.class_name %>::Fields
   <%= "soql_object '#{@soql_object.backend_name}'" unless @soql_object.backend_name == @soql_object.class_name %>
-  <%= "create_enum false" if @soql_object.create_enum == false %>
 end

data/lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb

@@ -4,8 +4,8 @@
 # Depending on validation rules and mandatory fields this may or may not work
 
 RSpec.describe 'Contact CRUD' do
-  let(:uniq_value) { 'UNIQ FIRST NAME' }
-  let(:updated_value) { 'New Value' }
+  let(:uniq_value) { "UNIQ #{Faker::Name.first_name} #{Faker::Name.middle_name}" }
+  let(:updated_value) { "New #{Faker::Name.first_name} #{Faker::Name.neutral_first_name}" }
   it 'Create using factory bot' do
     @contact = FactoryBot.create(:contact)
   end

data/lib/leap_salesforce/soql_data/soql.rb

@@ -150,7 +150,8 @@ module LeapSalesforce
       elsif value[0] == 'I' # 'N' not 2nd character
         ['=', value]
       elsif value[0] == '!'
-        ['!=', value[1..-1]]
+        remaining = value[1..-1] == 'nil' ? 'null' : value[1..-1]
+        ['!=', remaining]
       else
         [value[0], value[1..-1]]
       end

data/lib/leap_salesforce/soql_data/soql_settings.rb

@@ -14,18 +14,9 @@ module SoqlSettings
     @soql_object_name || to_s
   end
 
-  # Whether to create enumerations for object when running generation tasks. By default this is true
-  # For some objects you may want to use them without tracking their enumerations
-  def create_enum(set)
-    @create_enum = set
-  end
-
-  # @return [Boolean] Whether to create enum for object
-  def create_enum?
-    if @create_enum.nil?
-      true # True by default
-    else
-      @create_enum
-    end
+  # @deprecated Not used, setting in '.leap_salesforce.yml' controls this now
+  def create_enum(_set)
+    LeapSalesforce.logger.warn "Method 'create_enum' called when it is deprecated" \
+    " from #{caller_locations[0]}"
   end
 end

data/lib/leap_salesforce/soql_object.rb

@@ -11,17 +11,42 @@ module LeapSalesforce
     attr_accessor :reference
     # @return [String] Description of Soql object from '.leap_salesforce' YAML
     attr_accessor :description
-    # @return [Boolean] Whether to create enumerations for object
+    # @return [Boolean, Hash] Whether to create enumerations for object
     attr_accessor :create_enum
 
     # Create a representation of a Soql object from a description (usually in .leap_salesforce.yml)
-    # @param [Hash, String]
+    # @example Specific Salesforce object 'Case' to be represented
+    #   'Case'
+    # @example Represent Broker object by class with different name
+    #   { 'Broker' => Broker__c }
+    # @example Represent Group object, specifying to ignore enums
+    #   {"Group"=>nil, "create_enum"=>true} }
+    # @example Represent User object, specifying to ignore enum with name of Timezone
+    #   {"User"=>nil, "create_enum"=>{"exclude"=>["Timezone"]}}
+    # @param [Hash, String] description
     def initialize(description)
       self.description = description
       interpret_description
       self.reference = @class_name.snakecase
     end
 
+    # @param [String] picklist
+    # @return [Boolean] Whether picklist should be excluded from being generated
+    def excludes?(picklist)
+      if create_enum.is_a? Hash
+        if create_enum['exclude']
+          picklist_class = picklist.to_class_name
+          create_enum['exclude'].any? do |exclusion_list|
+            !picklist.to_s[Regexp.new(exclusion_list)].nil? || !picklist_class[Regexp.new(exclusion_list)].nil?
+          end
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
     private
 
     # Set attributes based on description

data/lib/leap_salesforce/users/user.rb

@@ -16,9 +16,9 @@ module LeapSalesforce
 
     # @param [String, Symbol] key Key used to identify a test user
     # @param [String] username Name used to login with user. In email address format.
-    def initialize(key, username, description: nil)
-      self.key = key
-      self.username = username
+    def initialize(*user_params, description: nil)
+      self.key = user_params[0]
+      self.username = user_params[1]
       self.description = description
     end
 

data/lib/leap_salesforce/users/users.rb

@@ -23,18 +23,31 @@ module LeapSalesforce
           raise LeapSalesforce::UserError, "Incorrect type #{user.class} for user. Expected either " \
           'type LeapSalesforce::User or Array'
         end
+        if user[2]
+          desc = user[2].is_a?(Hash) ? user[2].values[0] : user[2].dup
+          user[2] = nil
+        end
 
-        @list << User.new(*user)
+        @list << User.new(*user, description: desc)
       end
 
+      # @example Filter user by key of :admin
+      #   where(key: :admin)
+      # @example Filter user by description containing Payroll
+      #   where(description: /Payroll/)
+      # @example Filter user by username
+      #   where(username: 'username@domain.com')
       # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find users by
-      # @param [Boolean] all Whether to return all users matching criteria, not just first
-      # @return [LeapSalesforce::User, Array] A user that meets the criteria
-      def where(filter, all: false)
-        @all = all
+      # @param_key [Boolean] all Whether to return all users matching criteria, not just first
+      # @return [LeapSalesforce::User, Array] A user that meets the criteria.
+      #   If all is true this returns array of users
+      def where(filter)
+        @all = false
         case filter
         when :default then list.first # Will then use first user defined
-        when Hash then match_params filter
+        when Hash
+          @all = filter[:all] || false
+          match_params filter
         when String then match_params(username: filter)
         when Symbol then match_params(key: filter)
         when Regexp then match_params(description: filter)
@@ -49,7 +62,7 @@ module LeapSalesforce
       # Iterate through each user, narrowing on filter if provided
       def each(filter = nil)
         if filter
-          where(filter, all: true).each { yield }
+          where({**filter, all: true}).each { yield }
         else
           list.each { yield }
         end
@@ -66,20 +79,26 @@ module LeapSalesforce
         @all ? users : users.first
       end
 
+      # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find user by
+      # @return [Object] Result of block
+      def execute_as(filter)
+        current_user = LeapSalesforce.api_user
+        LeapSalesforce.api_user = LeapSalesforce::Users.where filter
+        result = yield
+        LeapSalesforce.api_user = current_user
+        result
+      end
+
       # Execute block as user matching filter if that user is present
       # If user is not present the current user will be used
       # @return [Object] Result of block
-      def execute_as_if_present(filter)
+      def execute_as_if_present(user_filter)
         raise ArgumentError, 'Pass block to :execute_as_if_present method' unless block_given?
 
-        current_user = LeapSalesforce.api_user
-        if any? filter
-          LeapSalesforce.api_user = LeapSalesforce::Users.where filter
-          result = yield
-          LeapSalesforce.api_user = current_user
-          result
+        if any? user_filter
+          execute_as(user_filter) { yield }
         else
-          LeapSalesforce.logger.warn "No user found user filter #{filter}, using '#{current_user}'"
+          LeapSalesforce.logger.warn "No user found user filter #{user_filter}, using '#{LeapSalesforce.api_user}'"
           yield
         end
       end

data/lib/leap_salesforce/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 1.0.1
 platform: ruby
 authors:
 - IQA
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -355,7 +355,7 @@ homepage: https://gitlab.com/leap-dojo/leap_salesforce
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -371,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Helps with setting up integrated automated test frameworks against Salesforce.
 test_files: []