sf_cli 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6cc1ab1222fe6f4c19b78853eed5a06c7e7f9047146b5f59a08a888fb369a54
-  data.tar.gz: f73f3784ed62def6460450fc6780f13fae73ae5d64ee7652b60379d50fcbc3e5
+  metadata.gz: f20d5801d3a2c887f01fa3fb3ab8775153d78b27d760ac2c6b148dac749a4945
+  data.tar.gz: 9295c01a6eab70749c2a0367a99d29f90ac3e7dafd65c49315ac521820362506
 SHA512:
-  metadata.gz: 80a77af9028ef5fed8b195d79356c0df6fc3b304a5eab26b8d094333d9148097cabb51b21592091815dc1ae0b768a3f1dbd35b88d01921d02986e5ee9b43add4
-  data.tar.gz: 1dbc012a4c8b0895f00ac1f741c1262d6b7319de72c08ef5d92f61204acdbb4f052755dd596883a989addaae35589039623d3d82ca9eace7a3ca97ae38a8e291
+  metadata.gz: 31b95e54526b884b83e19e6b870b99b148114b99692b92e4c01ea092a9068d4e779d708beba850fd60471bf44821ffcf859a00e094573e7ea8e2b70b46a341f9
+  data.tar.gz: 68637d5bd35140a9dc851176e9e22ae341c8c1029d451f63dfc0d076d5ea103f50b6f743d2c98743d121277b59cbb335933e6f98f74484509c1fe74bd02ed33b

data/lib/sf_cli/console/commands.rb

@@ -1,5 +1,6 @@
 require 'sf_cli'
 require 'sf_cli/sf/model'
+require 'sf_cli/sf/model/query_condition'
 require 'sf_cli/sf/model/sf_command_connection'
 require 'stringio'
 
@@ -48,7 +49,8 @@ module SfCli
         sf.apex.run target_org: target_org, file: StringIO.new(apex_code)
       end
 
-      def query(soql)
+      def query(_soql)
+        soql = _soql.is_a?(SfCli::Sf::Model::QueryMethods::QueryCondition) ? _soql.to_soql : _soql
         conf.inspect_mode = false
         puts sf.data.query(soql, format: :human, target_org: target_org)
         conf.inspect_mode = true

data/lib/sf_cli/sf/data/query.rb

@@ -17,6 +17,10 @@ module SfCli::Sf::Data
     # @example
     #   sf.data.query 'SELECT Id, Name FROM Account LIMIT 1' # => [{Id: "abc", Name: "account name"}]
     #
+    #   accounts = sf.data.query('SELECT Id, Name From Account') do |record|
+    #                record['Name'] += " Changed!" # can manipulate the record in block
+    #              end
+    #
     #   Account = Struct.new(:Id, :Name)
     #   sf.data.query('SELECT Id, Name From Account Limit 3', model_class: Account)  # returns an array of Account struct object
     #
@@ -39,7 +43,7 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified command reference
     #
-    def query(soql, target_org: nil, format: nil, bulk: false, wait: nil, api_version: nil, model_class: nil)
+    def query(soql, target_org: nil, format: nil, bulk: false, wait: nil, api_version: nil, model_class: nil, &block)
       flags    = {
         :"query"    => %("#{soql}"),
         :"target-org" => target_org,
@@ -53,9 +57,15 @@ module SfCli::Sf::Data
       raw_output = format ? true : false
       format = format&.to_sym || :json
 
-      result = exec(__method__, flags: flags, switches: switches, redirection: :null_stderr, raw_output: raw_output, format: format)
+      exec_result = exec(__method__, flags: flags, switches: switches, redirection: :null_stderr, raw_output: raw_output, format: format)
+
+      results = return_result(exec_result, raw_output, bulk, model_class)
+
+      return results if raw_output
+
+      results.each(&block) if block_given?
 
-      return_result(result, raw_output, bulk, model_class)
+      results
     end
 
     # Resume a bulk query job, which you previously started, and get records

data/lib/sf_cli/sf/model/generator.rb

@@ -12,17 +12,28 @@ module SfCli
         end
 
         def generate(object_name)
+          return false if generated? object_name
+
           schema = describe(object_name)
           class_definition = ClassDefinition.new(schema)
 
           instance_eval "::#{object_name} = #{class_definition}"
           klass = Object.const_get object_name.to_sym
           klass.connection = connection
+
+          true
         end
 
         def describe(object_name)
           connection.describe object_name
         end
+
+        def generated?(object_name)
+          Object.const_get object_name.to_sym
+          true
+        rescue NameError
+          false
+        end
       end
     end
   end

data/lib/sf_cli/sf/model/query_condition.rb

@@ -40,7 +40,7 @@ module SfCli
           def not(*expr)
             return self unless valid_expr?(expr)
 
-            conditions.append %|NOT(#{to_string_expr(expr)})|
+            conditions.append %|(NOT(#{to_string_expr(expr)}))|
             self
           end
 
@@ -132,6 +132,8 @@ module SfCli
                       %|'#{expr[2]}'|
                     when :Time
                       expr[2].to_datetime
+                    when :NilClass
+                      :null
                     when :Array
                       candidates = expr[2].map do |o|
                           case o.class.name.to_sym
@@ -139,11 +141,13 @@ module SfCli
                             %|'#{o}'|
                           when :Time
                             o.to_datetime
+                          when :NilClass
+                            :null
                           else
                             o
                           end
                         end
-                      %|IN (#{candidates.join(', ')})|
+                      %|(#{candidates.join(', ')})|
                     else
                       expr[2]
                     end
@@ -165,6 +169,8 @@ module SfCli
                 %|#{k} = '#{v}'|
               when :Time
                 %|#{k} = #{v.to_datetime}|
+              when :NilClass
+                %|#{k} = null|
               when :Array
                 candidates = v.map do |o|
                     case o.class.name.to_sym
@@ -172,6 +178,8 @@ module SfCli
                       %|'#{o}'|
                     when :Time
                       %|#{o.to_datetime}|
+                    when :NilClass
+                      :null
                     else
                       o
                     end

data/lib/sf_cli/sf/sobject/schema.rb

@@ -19,23 +19,29 @@ module SfCli
         end
 
         def field_names
-          @field_names ||= fields.map{|f| f.name.to_sym}
+          @field_names ||= fields.map{|f| f.name.to_sym}.sort
         end
 
         def field_labels
-          @field_labels ||= fields.map{|f| f.label}
+          @field_labels ||= fields.map{|f| f.label}.sort
         end
 
         def children_relations
-          schema['childRelationships']
-            .select{|r| r['relationshipName'].nil? == false}
-            .map{|r| {name: r['relationshipName'].to_sym, field: r['field'].to_sym, class_name: r['childSObject'].to_sym}}
+          @children_relations ||=
+            schema['childRelationships']
+              .select{|r| r['relationshipName'].nil? == false}
+              .map{|r| {name: r['relationshipName'].to_sym, field: r['field'].to_sym, class_name: r['childSObject'].to_sym}}
         end
 
         def parent_relations
-          fields
-            .select{|f| !(f.relationship_name.nil? || f.reference_to.nil?) && f.reference_to.size > 0}
-            .map{|f| {name: f.relationship_name.to_sym, field: f.name.to_sym, class_name: f.reference_to.first.to_sym} }
+          @parent_relations ||=
+            fields
+              .select{|f| !(f.relationship_name.nil? || f.reference_to.nil?) && f.reference_to.size > 0}
+              .map{|f| {name: f.relationship_name.to_sym, field: f.name.to_sym, class_name: f.reference_to.first.to_sym} }
+        end
+
+        def relations
+          @relations ||= Relations.new(children_relations + parent_relations)
         end
 
         def to_h
@@ -212,6 +218,35 @@ module SfCli
           @schema
         end
 
+        Relation = Struct.new(:name, :field, :class_name)
+
+        class Relations
+          include Enumerable
+
+          def initialize(relations)
+            @relations = relations.map{|r| Relation.new(name: r[:name], field: r[:field], class_name: r[:class_name])}
+          end
+
+          def each(&block)
+            relations.each(&block)
+          end
+
+          def names
+            map(&:name).sort
+          end
+
+          def find(name)
+            relations.find{|r| r.name == name.to_sym}
+          end
+
+          private
+
+          def relations
+            @relations
+          end
+        end
+
+
         class Fields
           include Enumerable
 
@@ -235,7 +270,7 @@ module SfCli
 
             find do |field|
               attr_val = field.__send__(attr_name.to_sym)
-              attr_val == val
+              attr_val == val.to_s
             end
           end
 

data/lib/sf_cli/version.rb

@@ -1,3 +1,3 @@
 module SfCli
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies: []
 description: A class library for introducing Salesforce CLI to Ruby scripting. Currenty
   only sf command is the target of development.