leap_salesforce 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60fb84b150303c1dc91eb621c40d5c155f439ecd7047911a321d65129259943
-  data.tar.gz: '0966f9cb9274d9f5d7f3d9f2cc85391bf57b909eb6c2d63792452a70e5f690f3'
+  metadata.gz: 65554ee3c2903f5a1d49f2433d6ae95f89b98acd1d31c110b61f34eba61c2660
+  data.tar.gz: f5bbc9c392441f97bfe3f38046f18c8e27529a8805ebdc6229f4a47a7f755b2d
 SHA512:
-  metadata.gz: dc9ae149d641d926b3d165c28356a39655b5bc1376488db5526b4b61dffe351d7212a05b800b0e932796fcb40296f39face2cd68e67347987925d74c6eae56b6
-  data.tar.gz: 8a7de04ea12fa03beaf419a756f4a9bc5acdba392b9162d7e920aa29652c882034488e69ee2d569b095e0e57f9266ca8002a5b95544be7e2c716ffdfbdb094f4
+  metadata.gz: 30edbcffe1599ee7b1a8ac199e357b7b8143a10d697c623faf492704f5aa8450fd6f81694dd6a4be5ce5c59fa23c20e069fee1bac1a4f1b69c76c6feb93f04c6
+  data.tar.gz: cfa46d6dc2f7e6a50c24fc5bfa1635985d823ea5fe20fb54dc5706d7acf6323fe6333c783b292fa9bd0ff7f7d08a19c9ae942c74bf4bbfe88201a15268ee96c2

data/.leap_salesforce.yml

@@ -1,10 +1,11 @@
 environment: prod # This is irrelevant for sfdx auth which uses user/alias
 lib_folder: spec/support
+# enum_folder: spec/support/enum
 sfdx: false
 # Example of settings for generating Java classes
 # language: java
-# soql_field_start_text: |
-#   package com.salesforce.test.pojo.soqlObjects;
+# soql_field_start_text: package com.salesforce.test.pojo.soqlObjects;
+# soql_enum_start_text: package com.salesforce.test.enums
 soql_objects:
   - Case
   - Contact

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 1.4.3
+* Simplify Java POMO's created using Lombok
+* Add executable to create enum objects in Java with 'leap_salesforce create_soql_enums' and 'leap_salesforce create_all' that creates both objects and enums
+
+Version 1.4.2
+* Fixed leap_salesforce version method
+
 Version 1.4.1
 * Fixed method names that need to match types 
 * Fixed file name created. Needs to be with '.java' in lower case

data/README.md

@@ -3,7 +3,8 @@
 Welcome to LeapSalesforce gem. This gem helps ones to perform integration tests on Salesforce. It reads the Metadata
 from Salesforce and creates the foundation for API tests. 
 
-Support for UI testing is being worked on in another gem [leap_salesforce_ui](https://gitlab.com/leap-dojo/leap_salesforce_ui)
+Support for UI testing is being worked on in another gem [leap_salesforce_ui](https://gitlab.com/leap-dojo/leap_salesforce_ui).
+An example using this and the learnings it involved are in a Java Project [Leap Salesforce Java](https://gitlab.com/leap-dojo/leap_salesforce_java)
 
 ## Is this for you?
 
@@ -223,6 +224,8 @@ RSpec.describe 'Picklists' do
 end
 ```
 
+One can also create this using the executable, e.g `leap_salesforce create_soql_enums`.
+
 #### Changing environment
 
 The `LEAP_ENV` environment variable can be used to change environment in non sfdx mode. The default is set through

data/exe/leap_salesforce

@@ -4,11 +4,10 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'thor'
-require 'dotenv'
-Dotenv.load
+require 'leap_salesforce/error'
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/generator/generator'
-require 'leap_salesforce/error'
+require 'leap_salesforce/version'
 require 'colorize'
 
 module LeapSalesforce
@@ -65,17 +64,40 @@ Please ignore "config/credentials/" and "logs/"'.colorize :red
     option :language
     def create_soql_objects
       LeapSalesforce.language = options[:language] if options[:language]
-      require 'leap_salesforce/generator/soql_objects'      
+      require 'leap_salesforce/generator/soql_objects'
       LeapSalesforce.oauth_working?
       LeapSalesforce::Users.execute_as_if_present key: :admin do
         LeapSalesforce::Generator::SoqlObjects.new.create_all
       end
     end
 
+    desc 'create_soql_enums', 'Creates enum objects for SOQL objects from metadata based on .leap_salesforce.yml'
+    option :language
+    def create_soql_enums(check_auth = true)
+      LeapSalesforce.language = options[:language] if options[:language]
+      require 'leap_salesforce/generator/soql_enums'
+      LeapSalesforce::Users.execute_as_if_present key: :admin do
+        LeapSalesforce::Generator::SoqlEnums.new.create
+      end
+    end
+
+    desc 'create_all', 'Creates SOQL objects and enum objects from metadata based on .leap_salesforce.yml'
+    option :language
+    def create_all
+      puts 'Creating soql objects'.colorize :yellow
+      create_soql_objects
+      puts 'Creating soql enums'.colorize :yellow
+      create_soql_enums
+    end
+
     desc 'version', 'Version this library'
     def version
       puts LeapSalesforce::VERSION
     end
+
+    def self.exit_on_failure?
+      true
+    end
   end
 end
 

data/lib/leap_salesforce/auth.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'error'
+require 'dotenv'
+Dotenv.load
 
 module LeapSalesforce
   # Code related to authorising in LeapSalesforce

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -1,26 +1,31 @@
 # frozen_string_literal: true
 
 require_relative 'soql_objects'
+require_relative '../soql_data/soql_data'
 
 module LeapSalesforce
   # Generators for creating code
   module Generator
-    # Creates Soql Enumerations / Picklists from objects in LeapSalesforce.objects_to_verify
+    # Creates Soql Enumerations / Picklists from objects in LeapSalesforce.soql_objects
     class SoqlEnums
       include Generator
 
       # @return [String] Folder where enumeration objects are stored
-      ENUM_FOLDER = File.join(LeapSalesforce.lib_folder, 'metadata', 'enum').freeze
+      if LeapSalesforce.enum_folder
+        ENUM_FOLDER = LeapSalesforce.enum_folder
+      else
+        ENUM_FOLDER = File.join(LeapSalesforce.lib_folder, 'metadata', 'enum').freeze
+      end
 
-      # Create Soql enumerations for all objects specified to verify
+      # Create Soql enumerations for all objects specified in .leap_salesforce.yml
       def create
-        if LeapSalesforce.objects_to_verify.empty?
-          raise LeapSalesforce::SetupError, 'LeapSalesforce.objects_to_verify is empty. ' \
-        'Please set the list of objects you want to verify in .leap_salesforce:soql_objects ' \
+        if LeapSalesforce.soql_objects.empty?
+          raise LeapSalesforce::SetupError, 'LeapSalesforce.soql_objects is empty. ' \
+        'Please set the list of objects you want to create enums for in .leap_salesforce:soql_objects ' \
         'and then run task "leaps:create_soql_objects" to create objects'
         end
         reset_enum_folder
-        LeapSalesforce.objects_to_verify.each { |entity| create_picklists_for entity }
+        LeapSalesforce.soql_objects.each { |entity| create_picklists_for entity }
         cleanup_files_created
       end
 
@@ -28,16 +33,23 @@ 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)
-        soql_object = LeapSalesforce.soql_objects.find { |so| so.class_name == entity.to_s }
-        raise "Could not find soql object for '#{entity}'" unless soql_object
-
+        soql_object = entity # LeapSalesforce.soql_objects.find { |so| so.class_name == entity.to_s }
+        @soql_data_object = Class.new(SoqlData) do
+          soql_object soql_object.backend_name
+        end
+        @entity_name = entity.class_name
+        unless soql_object
+          LeapSalesforce.logger.warn "Could not find soql object for '#{@entity_name}', ignoring" 
+          return
+        end
+      
         unless soql_object.create_enum != false
-          puts "Skipping picklists for #{entity}"
+          puts "Skipping picklists for #{@entity_name}"
           return
         end
-        puts "Creating picklists for #{entity}"
-        @entity_name = entity
-        picklists = entity.picklists
+        puts "Creating picklists for #{@entity_name}"
+        
+        picklists = @soql_data_object.picklists
         puts "#{picklists.count} picklists found"
         picklists.each do |picklist|
           if soql_object.excludes?(picklist)
@@ -53,13 +65,20 @@ module LeapSalesforce
         @picklist = picklist
         @enum_name = picklist.to_class_name
         picklist_name = picklist.to_key_name
-        values = @entity_name.picklist_for(picklist)
+        values = @soql_data_object.picklist_for(picklist)
         @enum_values = {}
         values.each do |value|
           @enum_values[value.to_key_name_for(@enum_values)] = value
         end
-        content = read_template 'picklist.rb.erb', binding
-        file = File.join(ENUM_FOLDER, @entity_name.to_s.snakecase, "#{picklist_name}.rb")
+        if LeapSalesforce.language == "ruby"
+          content = read_template 'picklist.rb.erb', binding
+          file = File.join(ENUM_FOLDER, @entity_name.to_s.snakecase, "#{picklist_name}.rb")
+        elsif LeapSalesforce.language == 'java'
+          content = read_template 'picklist.java.erb', binding
+          file = File.join(ENUM_FOLDER, @entity_name.to_s, "#{@enum_name}.java")
+        else
+          raise LeapSalesforce::SetupError, "Unsupported language '#{LeapSalesforce.language}'"
+        end
         generate_file file, content
       end
 
@@ -70,6 +89,8 @@ module LeapSalesforce
 
       # Clean up files generated for all picklists
       def cleanup_files_created
+        return unless LeapSalesforce.language == "ruby" 
+
         `rubocop -A #{ENUM_FOLDER} --display-only-fail-level-offenses --enable-pending-cops`
       end
     end

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -44,7 +44,7 @@ module LeapSalesforce
         if LeapSalesforce.language == 'ruby'
           field_content = read_template 'soql_object_field_names.rb.erb', binding
           field_file = File.join(SOQL_OBJECT_FOLDER, "#{@field_name_file}.rb")
-        elsif LeapSalesforce.language == "java"
+        elsif LeapSalesforce.language == 'java'
           field_content = read_template 'soql_object_field_names.java.erb', binding
           field_file = File.join(SOQL_OBJECT_FOLDER, "#{@soql_object.class_name}.java")
         else

data/lib/leap_salesforce/generator/templates/picklist.java.erb

@@ -0,0 +1,23 @@
+<%= LeapSalesforce.soql_enum_start_text %>.<%= @entity_name %>; 
+
+/** This file is generated and updated automatically so best not to edit manually
+ * Helps handle picklist values for <%= "#{@entity_name}, #{@enum_name}" %>
+*/ 
+public enum <%= @enum_name %> {
+<% @enum_values.each_with_index do |value, index|  %>
+  <%= value[0].camelize(:upper).to_s %>("<%= value[1] %>")<%= index == @enum_values.length - 1 ? ';' : ',' %><% end%> 
+ 
+  private String displayName;
+
+  public String displayName() { return displayName; }
+
+  @Override public String toString() { return displayName; }
+
+  <%= @enum_name %>(String displayName) {
+    this.displayName = displayName;
+  }
+
+  public static <%= @enum_name %> getRandom() {
+    return values()[(int) (Math.random() * values().length)];
+  }
+}

data/lib/leap_salesforce/generator/templates/soql_object_field_names.Java.erb

@@ -2,24 +2,22 @@
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+import lombok.Data;
+
 /**
 * Auto-generated code created by leap_salesforce. Do not manually
 * update as this can be overwritten when `leap_salesforce create_soql_objects` is run  
 */
 @JsonIgnoreProperties(ignoreUnknown=true)
+@Data
 public class <%= @soql_object.class_name %> {
 
 <% @soql_class.fields.each do |field| %>
-	@JsonProperty(value="<%= field['name'] %>")
-	String <%= field['name'].camelize(:lower) %>;
-<% end %>
-
-<% @soql_class.fields.each do |field| %>
-	public String get<%= field['name'].camelize(:upper) %>() { return <%= field['name'].camelize(:lower) %>; }
 	/**
 	 * Label: '<%= field['label'] %>', Type: <%= field['type'] %><%= ", Relationship:" + field['relationshipName'] if field['relationshipName'] %>
 	 */
-	public void set<%= field['name'].camelize(:upper) %>(String <%= field['name'].camelize(:lower) %>) { this.<%= field['name'].camelize(:lower) %> = <%= field['name'].camelize(:lower) %>; }
+	@JsonProperty(value="<%= field['name'] %>")
+	String <%= field['name'].camelize(:lower) %>;
 <% end %>
 }
 

data/lib/leap_salesforce/leaps.rb

@@ -2,6 +2,5 @@
 
 # Create a Leaps alias to LeapSalesforce as it's faster to type.
 # This will not be automatically required in case as 'Leaps' may be defined elsewhere
-
 require 'leap_salesforce'
 Leaps = LeapSalesforce

data/lib/leap_salesforce/parameters.rb

@@ -11,6 +11,7 @@ CREATE_APP_LINK = 'https://trailhead.salesforce.com/content/learn/projects/autom
 module LeapSalesforce
   @config_folder = 'config'
   @lib_folder = File.join('lib', 'leap_salesforce').freeze
+  @enum_folder = nil
   @objects_to_verify = []
   @soql_objects = []
   @client_id = ENV['client_id']
@@ -18,6 +19,7 @@ module LeapSalesforce
   @password = ENV['password']
   @language = 'ruby'
   @soql_field_start_text = ''
+  @soql_enum_start_text = ''
   @environment = nil
   @logger = Logger.new $stdout
   @sfdx = false
@@ -124,6 +126,8 @@ module LeapSalesforce
     attr_accessor :security_token
     # @return [String] Path where library generated assets are stored. By default lib/leap_salesforce
     attr_accessor :lib_folder
+    # @return [String] Path where generated enum files are stored. By default this is null and just appeneded to lib_folder
+    attr_accessor :enum_folder
     # @return [Array] List of objects to verify metadata for. This includes enums, required values
     #   Changes to these values will need to be version controlled
     attr_accessor :objects_to_verify
@@ -139,6 +143,9 @@ module LeapSalesforce
     # classes in the Salesforce object
     attr_accessor :soql_field_start_text
 
+    # @return [String] Text to be added as start of auto generated Soql enums
+    attr_accessor :soql_enum_start_text
+
     # @return [Array] list_of_soql_objects Array describing Soql objects taken from .leap_salesforce.yml
     def soql_objects=(list_of_soql_objects)
       @soql_objects = list_of_soql_objects.collect do |soql_object_desc|

data/lib/leap_salesforce/version.rb

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

data/lib/leap_salesforce.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'leap_salesforce/version'
-
 require 'facets/string/snakecase'
 require 'soaspec'
 Soaspec::OAuth2.refresh_token = :once   # Save access token and reuse it
@@ -21,8 +20,6 @@ require 'faker' # For fake data
 require 'leap_salesforce/error'
 require 'leap_salesforce/loader'
 require 'leap_salesforce/session'
-require 'dotenv'
-Dotenv.load
 
 # If variable is present within LeapSalesforce set it
 def load_variables_from(file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -358,6 +358,7 @@ files:
 - lib/leap_salesforce/generator/templates/config/environments/specific_file.rb.erb
 - lib/leap_salesforce/generator/templates/config/general.rb.erb
 - lib/leap_salesforce/generator/templates/factory.rb.erb
+- lib/leap_salesforce/generator/templates/picklist.java.erb
 - lib/leap_salesforce/generator/templates/picklist.rb.erb
 - lib/leap_salesforce/generator/templates/soql_object.rb.erb
 - lib/leap_salesforce/generator/templates/soql_object_field_names.Java.erb