leap_salesforce 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e05db673469ab9a0bc71da3a58abf22522fb797776e7ed144504177ec43923
-  data.tar.gz: c36487d9759e438fff829f742f8edbe1a7cef970cf272c5eaac3b0b824a3460e
+  metadata.gz: 1bc5400e3a22260ee15346243caca18a4e839d5a32237a236cedb4488e8a073d
+  data.tar.gz: be7c25e87d9dfd868ae7e7347b64ef61bb520a9f017c031e4ec5c0e5b8b27832
 SHA512:
-  metadata.gz: caa01bf5c5268ca4781999f8a997f08ecc23ae3c4be923fb9a76d3a4d430c6dd6e7130df4ff9687077745e9ba61109e327c0af2ba8d2dda1e1e1b06f425d97e1
-  data.tar.gz: 6c4f242aa17da03f03069b541b34f3dd199c4883e48c53fb1d6a02a37cfffc69826426721be9fa12a8e19e0e2c9ed3ebcaca74c5ce8cd0cf82b21c1202d07af4
+  metadata.gz: 48685d0acfa0a8b0b9ae08b94bdf64d41636df9982d45636a3d9e526ff9bef3d32cea0389767a4a2b31b6f6b5b45273c16bb221fc50d0121b96ddaa799b1769d
+  data.tar.gz: e62daf28879015af67c9eda73b495cd106450c962562c72556a4af97492511b238db493f3c21094d81fa2eba362dc05babae9f554b8b873584a1aa7002f59732

data/.gitignore

@@ -9,6 +9,7 @@
 Gemfile.lock
 logs/
 stub/
+.idea/workspace.xml
 
 # Generated files for now
 spec/support/

data/.leap_salesforce.yml

@@ -6,5 +6,6 @@ soql_objects:
   - Document: ContentDocument
   - User:
     create_enum: false
+  - Group
   - Broker: Broker__c
-  - Account
+  - Account

data/ChangeLog

@@ -1,3 +1,9 @@
+Version 0.1.6
+* Bug Fix
+  * Fix 'create_all' rake task
+  * Update string matcher so it excludes ALL non ruby characters
+  * Add example of setting an associated field through a lookup
+
 Version 0.1.5
 * Bug Fix
   * Handle name starting with 0, currency. This time adding string unit tests

data/README.md

@@ -24,8 +24,11 @@ Or install it yourself as:
     $ gem install leap_salesforce
 
 ## Usage
-
+### 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. 
+This assumes that a Salesforce OAuth app be set up to be used for the API which can be done by 
+following [this wiki]('https://gitlab.com/leap-dojo/leap_salesforce/wikis/SetUpOAuthApp').
 
 E.g
 
@@ -33,6 +36,22 @@ E.g
 leap_salesforce init
 ```
 
+Credentials are not stored in stored in source control. They can be setting through the following environment variables:
+
+* 'client_id'
+* 'client_secret'
+* 'password'
+
+Tests can be run using the default `Rake` task.
+
+E.g.,
+
+`rake` # Run all tests
+
+API Traffic logs can be seen in the `logs` folder.
+
+TODO: Finish this. A lot more needed
+
 ## Docs
 
 Technical docs [here](https://www.rubydoc.info/gems/leap_salesforce)

data/exe/leap_salesforce

@@ -33,7 +33,7 @@ module LeapSalesforce
       end
 
       query_for_parameters
-      generate_files binding, ['Gemfile', 'Rakefile', '.leap_salesforce.yml', '.rspec',
+      generate_files binding, ['Gemfile', 'Rakefile', '.leap_salesforce.yml', '.rspec', '.gitignore',
                                { config: ['general.rb', { credentials: 'salesforce_oauth2.yml' }] },
                                { spec: %w[spec_helper.rb limit_spec.rb crud_eg_spec.rb picklists_spec.rb] }]
 

data/lib/leap_salesforce/ext/string.rb

@@ -7,12 +7,15 @@ require 'active_support/core_ext/string'
 
 # Override string object to provide convenience methods for Strings
 class String
+  # @note This removes '?' which is allowed in a method but is not desired for automatic creation of their names
+  #   in the way that is being used here
   # @return [String] Convert string to something that would be friendly to use as in Ruby
   def to_ruby_friendly
-    tr(":'/()$€£¥#+, ", '').tr('-*"', '').tr('&|=', '_')
-                           .gsub('<', '_lt_').gsub('>', '_gt_')
-                           .remove_macrons.tr("\n", '')
-                           .humanize_numbered_string
+    tr('&|=', '_').gsub('<', '_lt_').gsub('>', '_gt_')
+                  .remove_macrons
+                  .humanize_numbered_string
+                  .gsub(/[\s]+/, '_')
+                  .gsub(/[\W]/, '') # Remove any other special characters
   end
 
   # @return [String] Convert String to form a class could use

data/lib/leap_salesforce/generator/default.rb

@@ -21,13 +21,15 @@ module LeapSalesforce
           when 'string' then set("Faker::Lorem.paragraph_by_chars(#{field['length']})")
           when 'id' then set('Best to not hard code this', use_quotes: true)
           when 'boolean' then set('true')
-          when 'picklist' then set("#{class_name}::#{field['name']}.sample")
+          when 'picklist' then set("#{class_name}::#{field['name'].to_class_name}.sample")
           when 'reference'
+            return set('User.find(CreatedDate: "<#{0.days.ago}").id') if field['name'] == 'OwnerId'
+
             soql_obj = LeapSalesforce.soql_objects.find { |so| so.backend_name == field['relationshipName'] }&.reference
             if soql_obj
               "association :#{@field['label'].unused_ruby_name}, factory: :#{soql_obj}"
             else
-              "# Please add #{field['relationshipName']} to .leap_salesforce.yml to create association for #{field}"
+              "# Please add #{field['relationshipName']} to .leap_salesforce.yml (if it's a table) to create association for #{field['relationshipName']}"
             end
           else
             set("Content depending on #{field['type']}", use_quotes: true)
@@ -43,6 +45,7 @@ module LeapSalesforce
           %w[FirstName LastName]
         end
 
+        # @return [Array] List of backend field names to be populated by default for account
         def account
           ['Name']
         end

data/lib/leap_salesforce/generator/generator.rb

@@ -19,10 +19,15 @@ module LeapSalesforce
     # @param [String] content Content to put within file
     def generate_file(filename, content, overwrite: true)
       FileUtils.mkdir_p File.dirname filename unless File.directory? File.dirname(filename)
-      return puts "File '#{filename}' already exists, skipping...".colorize :red if File.exist?(filename) && !overwrite
+      action = if File.exist?(filename)
+                 return puts "File '#{filename}' already exists, skipping...".colorize :red unless overwrite
 
+                 'Updated'
+               else
+                 'Created'
+               end
       File.write filename, content
-      puts "\u2713 Created file at #{filename}".colorize :green
+      puts "\u2713 #{action} #{filename}".colorize :green
     end
 
     # @example Create a spec_helper file and test file in spec folder

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -33,7 +33,7 @@ module LeapSalesforce
             @picklist = picklist
             @enum_name = picklist.to_class_name
             picklist_name = picklist.to_key_name
-            values = entity.picklist_for picklist
+            values = entity.picklist_for(picklist)
             @enum_values = {}
             values.each { |value| @enum_values[value.to_key_name] = value }
             content = read_template 'picklist.rb.erb', binding

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -32,7 +32,7 @@ module LeapSalesforce
         end
         content = read_template 'soql_object.rb.erb', binding
         file = File.join(SOQL_OBJECT_FOLDER, "#{@soql_object.reference}.rb")
-        generate_file file, content
+        generate_file file, content, overwrite: false
       end
 
       # Generate module with fields for Soql Object
@@ -47,7 +47,7 @@ module LeapSalesforce
         @default_fields, @other_fields = filter_fields
         content = read_template 'factory.rb.erb', binding
         file = File.join(FACTORY_FOLDER, "#{@soql_object.reference}.rb")
-        generate_file file, content
+        generate_file file, content, overwrite: false
       end
 
       # Generate soql_object and it's related modules, factories

data/lib/leap_salesforce/generator/templates/.gitignore.erb

@@ -0,0 +1,2 @@
+logs/
+config/credentials/ # Confidential files stored here

data/lib/leap_salesforce/generator/templates/.leap_salesforce.yml.erb

@@ -6,4 +6,5 @@ soql_objects:
   - Document: ContentDocument
   - User:
     create_enum: false # Example of indicating that enumerations are not required to be generated for
-  - Account
+  - Account
+  - Group

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# This file is generated and updated automatically so best not to edit manually
 # Helps handle picklist values for <%= "#{@entity_name}, #{@enum_name}" %>
 class <%= @entity_name %> < SoqlData
   # Enumeration for <%= @enum_name %>

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

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# This file is generated and updated automatically so best not to edit manually
 # Fields for <%= @soql_object.class_name %> mapped from SOQL <%= @soql_object.backend_name %>
 class <%= @soql_object.class_name %> < SoqlData
   module Fields

data/lib/leap_salesforce/rake/setup.rake

@@ -13,11 +13,11 @@ namespace :leaps do
     LeapSalesforce::Generator::SoqlObjects.new.create_all
   end
 
-  # TODO: This does not work
   desc 'Create objects, fields, enums'
   task create_all: :create_soql_objects do
-    # require_all LeapSalesforce.lib_folder
-    LeapSalesforce.objects_to_verify = SoqlData.descendants
-    Rake::Task['leaps:create_enums'].invoke
+    # TODO: This is not ideal. But only way I could get it to work
+    puts `bundle exec rake leaps:create_soql_objects`
+    puts 'Creating enums. Please wait until finished for output'
+    puts `bundle exec rake leaps:create_enums`
   end
 end

data/lib/leap_salesforce/soql_data/soql_object_describe.rb

@@ -52,7 +52,7 @@ module SoqlObjectDescribe
   def picklist_for(field_name)
     properties = properties_for field_name
 
-    properties['picklistValues'].collect { |list| list['label'] }
+    properties['picklistValues'].collect { |list| list['label'] }.compact
   end
 
   # @param [String, Symbol] field_name Salesforce backend field name

data/lib/leap_salesforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LeapSalesforce
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - IQA
@@ -242,7 +242,6 @@ files:
 - ".idea/misc.xml"
 - ".idea/modules.xml"
 - ".idea/vcs.xml"
-- ".idea/workspace.xml"
 - ".leap_salesforce.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -267,6 +266,7 @@ files:
 - lib/leap_salesforce/generator/generator.rb
 - lib/leap_salesforce/generator/soql_enums.rb
 - lib/leap_salesforce/generator/soql_objects.rb
+- lib/leap_salesforce/generator/templates/.gitignore.erb
 - lib/leap_salesforce/generator/templates/.leap_salesforce.yml.erb
 - lib/leap_salesforce/generator/templates/.rspec.erb
 - lib/leap_salesforce/generator/templates/Gemfile.erb