leap_salesforce 0.2.24 → 0.2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b9311c1afc5593fb4b3428de805b3a2a9c5a6e8331d827dd40b9d5b60e09d8d
-  data.tar.gz: 9532ceffad0924438eb87b97378faeadd6729e27bc396439a4934f2ee71f71e7
+  metadata.gz: 46ddc1666b0bfa490615de0e71ebfc2c38a038d1979ba11ca316473b9149ee5d
+  data.tar.gz: fd02406910add5f0476180668503aa8cd84a2b17a8d2d177c7bea04cc92a24ec
 SHA512:
-  metadata.gz: 1c81db35151f84596e6d0b80815bebfdcf3f582be9ee2457eb46fe90b06bf989af780be6e9333dbf1de5bae3797193605849f54d87c7652f352ed741ceeb0cfc
-  data.tar.gz: a8998c522c93ed383524758d91dceac18fd6fdf8af41f5db8db3f9898a3be93e6e6f03cb63dd0277bd9a4e404403ebe5929636278c3b92878df89c081be4ac5a
+  metadata.gz: fce2360e07c182e3c2e9c74cd1ba2ab97f383a18d6797ecc84989c67a96f011df0debd4b4ca1f687ee1f757547fb2afc17b54df43dd07bfa92908ee8fa4efe37
+  data.tar.gz: e19d83a1ec699f4e71239e73b27f293d10d0e62c4d3cf1051aec99590bfb795ade0c94bb318ff7f9598c2ec2e42f421f2d2f5ca8c7c071d0023b5d90c5b79636

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,13 @@
 # Modifies RuboCop (Static analysis tool)
-Metrics/LineLength:
-  Max: 160
+Layout/LineLength:
+  Max: 160
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/ChangeLog

@@ -1,3 +1,11 @@
+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)

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.to_s}'" 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 "Exluding picklist '#{picklist}'"
+          else
+            generate_picklist_file picklist
+          end
+        end
       end
 
       # Generate file for a picklist from it's metadata

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/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
+    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,41 @@ 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']
+          create_enum['exclude'].any? do |exclusion_list|
+            !picklist.to_s[Regexp.new(exclusion_list)].nil?
+          end
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
     private
 
     # Set attributes based on description

data/lib/leap_salesforce/users/users.rb

@@ -27,9 +27,16 @@ module LeapSalesforce
         @list << User.new(*user)
       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
+      # @return [LeapSalesforce::User, Array] A user that meets the criteria.
+      #   If all is true this returns array of users
       def where(filter, all: false)
         @all = all
         case filter
@@ -66,20 +73,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 = '0.2.26'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 0.2.26
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler