leap_salesforce 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e7d68b35916d600c053d7ec95f01bc26694eebf0bf176da4fa595b07506087
-  data.tar.gz: c3466149eaef469e70359c88c6d3ea3e125adea0f6b1bffbcdf5415699088d98
+  metadata.gz: 13951c22ceafff2467ca471cb6fda3c9b7ab34dd707c7e23371be362aee3199d
+  data.tar.gz: 2285ff9c9b90f44da101c8b186646ae8e7d4a7ff83b16bcd04807f72f5432d3c
 SHA512:
-  metadata.gz: c6daeecb2f063de6d7b615e16c9ab2931988c74404c53f5ef7d1ab5e79f21645ddcf6587bc377204c5f13314e97e8d6c70bcaaa63188668b5837fe728e1f530d
-  data.tar.gz: 6afc1a7aa1b7d0574a6821adf1eb5844a91c394f96158e5f970c4f7ee67b986544c1cc42aeb0d92310399482ea8e66de672a994e6cbf5b2192690aed8ea6130a
+  metadata.gz: 6377865707517db0bc51c59bf8e2f7d17a7ceba3191c5cd9759dfbde7e904cd2471e4574c8e981a3a781dfa1f9bc487a0f414d3b8c94c6cd618d6b2145d0b752
+  data.tar.gz: a033b46017e9dbd28b743a38b97fcd5c16663a5f3addf07dd3039354101a6a610c501c4f004e6ba1357d465d0a5212fb48dac1de8e20787a1565ac612148c21a

data/.gitignore

@@ -18,6 +18,7 @@ spec/support/
 
 # Here are folders related to testing this project in it's own CI
 config/credentials/
+.env
 
 # rspec failure tracking
 .rspec_status

data/.leap_salesforce.yml

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

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 1.4
+* Ability to generate Java classes from metadata using the exe 'leap_salesforce create_soql_objects --language=java'
+
+Version 1.3.1
+* Require facets so that `snakecase` method ensured to work
+
 Version 1.3.0
 * Updated sfdx commands to use new terms, not deprecated ones
 

data/README.md

@@ -104,6 +104,8 @@ Credentials are not stored in stored in source control. They can be setting thro
 * 'client_secret'
 * 'password'
 
+> If these variables can be set in a `.env` file they will be loaded automatically
+
 > Security tokens can be set for each user (adding to password in OAuth like in [this article](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm))
 > To do that set an environment variable as USER_KEY_token. E.g, so for a user with a key of :admin
 > the token would be set with the `admin_token` environment variable
@@ -174,6 +176,19 @@ 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.
 
+A java class can be created using the following syntax in `.leap_salesforce.yml`. The default language will be Ruby
+
+```yaml
+language: java
+lib_folder: main/java  # Path to store auto generated Java classes
+soql_field_start_text: |
+  package com.salesforce.test.pojo.soqlObjects;
+```
+
+These task can also be executed from the executable of this project with `leap_salesforce create_soql_objects --language=ruby`
+
+For generation of other languages, raise an issue
+
 * `leaps:create_enums`
 
 This task reads the soql objects defined in `.leap_salesforce.yml` and creates a `metadata/enum` folder that has

data/Rakefile

@@ -7,6 +7,8 @@ require 'rake/clean'
 require 'yard'
 require 'yard/doctest/rake'
 
+require 'dotenv'
+Dotenv.load
 require 'leap_salesforce/rake' # TODO: Append this line to existing repo
 
 CLEAN.include 'tmp/*'

data/exe/leap_salesforce

@@ -4,6 +4,8 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'thor'
+require 'dotenv'
+Dotenv.load
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/generator/generator'
 require 'leap_salesforce/error'
@@ -58,6 +60,17 @@ module LeapSalesforce
       puts 'Your .gitignore is already present so not updated.
 Please ignore "config/credentials/" and "logs/"'.colorize :red
     end
+
+    desc 'create_soql_objects', 'Creates SOQL objects from metadata based on .leap_salesforce.yml'
+    option :language, default: 'ruby'
+    def create_soql_objects
+      LeapSalesforce.language = options[:language]
+      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
   end
 end
 

data/leap_salesforce.gemspec

@@ -26,7 +26,7 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'parallel'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -35,6 +35,8 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_development_dependency 'yard-doctest'
   spec.add_dependency 'activerecord', '7'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'facets'
   spec.add_dependency 'factory_bot'
   spec.add_dependency 'faker', '>= 2.0'
   spec.add_dependency 'humanize'

data/lib/leap_salesforce/ext/string.rb

@@ -92,6 +92,12 @@ class String
     name.keyword? ? "my_#{name}" : name
   end
 
+  # @return [String] Camel case string that is not taken by keywords like 'class', 'alias'
+  # @param [Symbol] type :upper or :lower, default :upper
+  def unused_camel_name(type = :upper)
+    unused_ruby_name.camelize(type)
+  end
+
   # @return [String] Zulu time stamp for string
   def to_zulu_date_string
     Time.parse(self).strftime('%Y-%m-%dT%H:%M:%S.000Z')

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -12,7 +12,8 @@ module LeapSalesforce
     class SoqlObjects
       include Generator
 
-      SOQL_OBJECT_FOLDER = File.join(LeapSalesforce.lib_folder, 'soql_data').freeze
+      SOQL_DATA_FOLDER = LeapSalesforce.language == "java" ? 'SoqlObjects' : 'soql_data'
+      SOQL_OBJECT_FOLDER = File.join(LeapSalesforce.lib_folder, SOQL_DATA_FOLDER).freeze
       FACTORY_FOLDER = File.join(LeapSalesforce.lib_folder, 'factories').freeze
 
       # Create temporary class for building API requests on
@@ -31,6 +32,7 @@ module LeapSalesforce
           raise LeapSalesforce::SetupError, "Error producing Soql data for '#{@soql_class}', soql table " \
           " '#{@soql_object.backend_name}'. Error message: '#{desc.error_message}'"
         end
+        return unless LeapSalesforce.language == "ruby"
         content = read_template 'soql_object.rb.erb', binding
         file = File.join(SOQL_OBJECT_FOLDER, "#{@soql_object.reference}.rb")
         generate_file file, content, overwrite: false
@@ -38,13 +40,21 @@ module LeapSalesforce
 
       # Generate module with fields for Soql Object
       def generate_field_module
-        field_content = read_template 'soql_object_field_names.rb.erb', binding
-        field_file = File.join(SOQL_OBJECT_FOLDER, "#{@field_name_file}.rb")
-        generate_file field_file, field_content
+        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"
+          field_content = read_template 'soql_object_field_names.Java.erb', binding
+          field_file = File.join(SOQL_OBJECT_FOLDER, "#{@soql_object.class_name}.Java")
+        else
+          raise LeapSalesforce::SetupError, "Unsupported language '#{LeapSalesforce.language}'"
+        end    
+        generate_file field_file, field_content        
       end
 
       # Generate factory for mass generating objects using FactoryBot
       def generate_factory
+        return unless LeapSalesforce.language == "ruby"
         @default_fields, @other_fields = filter_fields
         content = read_template 'factory.rb.erb', binding
         file = File.join(FACTORY_FOLDER, "#{@soql_object.reference}.rb")
@@ -62,8 +72,10 @@ module LeapSalesforce
           generate_field_module
           generate_factory
         end
-        `rubocop -A #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
-        `rubocop -A #{FACTORY_FOLDER} --enable-pending-cops`
+        if LeapSalesforce.language == 'ruby'
+          `rubocop -A #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
+          `rubocop -A #{FACTORY_FOLDER} --enable-pending-cops`
+        end
       end
 
       private

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

@@ -0,0 +1,22 @@
+<%= LeapSalesforce.soql_field_start_text %>
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+* 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)
+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['label'].unused_camel_name %>() { return <%= field['name'].camelize(:lower) %>; }
+	public void set<%= field['label'].unused_camel_name %>(String <%= field['name'].camelize(:lower) %>) { this.<%= field['name'].camelize(:lower) %> = <%= field['name'].camelize(:lower) %>; }
+<% end %>
+}
+

data/lib/leap_salesforce/parameters.rb

@@ -16,6 +16,8 @@ module LeapSalesforce
   @client_id = ENV['client_id']
   @client_secret = ENV['client_secret']
   @password = ENV['password']
+  @language = "ruby"
+  @soql_field_start_text = ""
   @environment = nil
   @logger = Logger.new $stdout
   @sfdx = false
@@ -130,6 +132,13 @@ module LeapSalesforce
     # @return [Logger] Logger used by LeapSalesforce
     attr_accessor :logger
 
+    # @return [Symbol] Name of the language used
+    attr_accessor :language
+
+    # @return [String] Text to be added as start of auto generated Soql field names 
+    # classes in the Salesforce object
+    attr_accessor :soql_field_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.3.0'
+  VERSION = '1.4.0'
 end

data/lib/leap_salesforce.rb

@@ -2,6 +2,7 @@
 
 require 'leap_salesforce/version'
 
+require 'facets/string/snakecase'
 require 'soaspec'
 Soaspec::OAuth2.refresh_token = :once   # Save access token and reuse it
 Soaspec.log_warnings = false            # Log any API warnings
@@ -20,6 +21,8 @@ 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.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - IQA
@@ -9,22 +9,22 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-19 00:00:00.000000000 Z
+date: 2024-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -332,6 +360,7 @@ files:
 - lib/leap_salesforce/generator/templates/factory.rb.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
 - lib/leap_salesforce/generator/templates/soql_object_field_names.rb.erb
 - lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb
 - lib/leap_salesforce/generator/templates/spec/limit_spec.rb.erb
@@ -385,7 +414,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Helps with setting up integrated automated test frameworks against Salesforce.