sf_cli 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e80b705227bf6cc0a20eb798294a8179ac417b70ee1720626c34ede61c57f9
-  data.tar.gz: a47fae091fde1fa337f11a3265dc27703a14642ad3dc287dfb400f41f3e0fcdb
+  metadata.gz: f20d5801d3a2c887f01fa3fb3ab8775153d78b27d760ac2c6b148dac749a4945
+  data.tar.gz: 9295c01a6eab70749c2a0367a99d29f90ac3e7dafd65c49315ac521820362506
 SHA512:
-  metadata.gz: c4f31ede06a4efd8e9bf8e257712ffa2f5be05e0b7a06e79d7d5a056671480d06eaaaace79c5b2896ae4037ae53de46620a5337841b8e9c415397c70fffc9f59
-  data.tar.gz: 24a8d99be40d9f0df743dbe0839dd25c31c6d3870123f50f2b806d580c588e37578a7d2341c2eb8a73f3003748e8ddc0ef44f7315467a2e8c67841e0b65189c3
+  metadata.gz: 31b95e54526b884b83e19e6b870b99b148114b99692b92e4c01ea092a9068d4e779d708beba850fd60471bf44821ffcf859a00e094573e7ea8e2b70b46a341f9
+  data.tar.gz: 68637d5bd35140a9dc851176e9e22ae341c8c1029d451f63dfc0d076d5ea103f50b6f743d2c98743d121277b59cbb335933e6f98f74484509c1fe74bd02ed33b

data/bin/sf_cli

@@ -8,13 +8,15 @@ def generate_project(project_name, params)
   base_dir        = Dir.pwd
   target_org      = params[:"target-org"]
   retrieve_source = params[:retrieve]
+  editor          = params[:editor]
 
   sf.project.generate project_name, manifest: true
 
   Dir.chdir project_name
 
-  sf.project.generate_manifest from_org: target_org, output_dir: 'manifest'          if target_org
+  sf.project.generate_manifest from_org: target_org, output_dir: 'manifest' if target_org
   sf.project.retrieve_start manifest: 'manifest/package.xml', target_org: target_org if retrieve_source
+  system 'code .' if editor
 ensure
   Dir.chdir base_dir
 end
@@ -25,11 +27,14 @@ Version = SfCli::VERSION
 
 opt.on('-i', '--irb', 'Start irb session that integrates sf_cli and object model library.') { system 'irb -r sf_cli/console' }
 opt.on('-g OBJECT', '--generate', 'Generate OBJECT. As of now, only project is available as OBJECT.')
-opt.on('-o TARGET_ORG', '--target-org', 'Username or alias of the target org. When specified with "-g model", the manifest file is created based on the org')
-opt.on('-r', '--retrieve', 'Retrieve source files.When specified with "-g model", source files is loaded according to the manifest file.')
+opt.on('-o TARGET_ORG', '--target-org', 'Username or alias of the target org. When specified with "-g project", the manifest file is created based on the org')
+opt.on('-r', '--retrieve', 'Retrieve source files.When specified with "-g project", source files is loaded according to the manifest file.')
+opt.on('-e', '--editor', 'Open VS Code for current directory. When specified with "-g project", it opens the project directory')
 
 opt.parse!(ARGV, into: params)
 
 if params[:generate] == 'project'
   generate_project(ARGV[0], params)
+elsif params[:editor]
+  system 'code .'
 end

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/org/list_limits.rb

@@ -1,7 +1,7 @@
 module SfCli::Sf::Org
   module ListLimits
     #
-    # Returns the metadata types that are enabled for your org.
+    # List the limits in your org
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
     # @param api_version [Numeric]       override the api version used for api requests made by this command
     #

data/lib/sf_cli/sf/org/list_metadata.rb

@@ -1,7 +1,7 @@
 module SfCli::Sf::Org
   module ListMetadata
     #
-    # Returns the metadata types that are enabled for your org.
+    # List the metadata components and properties of a specified type
     # @param metadata    [Symbol,String] name of metadata type
     # @param folder      [Symbol,String] folder associated with the component such as Report, EmailTemplate, Dashboard and Document
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used

data/lib/sf_cli/sf/org/login.rb

@@ -1,6 +1,6 @@
 module SfCli::Sf::Org
   module Login
-    # Login to the org by the browser.
+    # Log in to a Salesforce org using the web server flow
     # @param target_org   [Symbol,String] an alias of paticular org, or username can be used
     # @param instance_url [String]        URL of the instance that the org lives on.
     # @param browser      [Symbol,String] browser in which to open the org.

data/lib/sf_cli/sf/project/generate.rb

@@ -3,7 +3,7 @@ module SfCli::Sf::Project
     Result = Struct.new(:output_dir, :files, :raw_output, :warnings)
 
     #
-    # Generate a Salesforce project
+    # Generate a Salesforce DX project
     # @param name       [Symbol,String] project name
     # @param template   [Symbol,String] project template name
     # @param output_dir [String]        output directory

data/lib/sf_cli/sf/project/generate_manifest.rb

@@ -1,6 +1,6 @@
 module SfCli::Sf::Project
   module GenerateManifest
-    # Generate the manifest file of a Salesforce DX project
+    # Create a project manifest that lists the metadata components you want to deploy or retrieve
     # @param metadata    [Array]   an array that consists of metadata type like CustomObject, Layout and so on.  (default: [])
     # @param api_version [Integer] API version (default: nil)
     # @param output_dir  [String]  manifest's output directory in the project directory. You can use relative path from the project root (default: nil)

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

@@ -2,7 +2,7 @@ require_relative './schema'
 
 module SfCli::Sf::Sobject
   module Describe
-    # Returns a schema object containing the Salesforce object schema
+    # Get a Salesforce object schema
     # @param object_type [Symbol,String] object type(ex: Account)
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
     # @param api_version [Numeric]       override the api version used for api requests made by this command

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

@@ -1,6 +1,6 @@
 module SfCli::Sf::Sobject
   module List
-    # Returns a list of Salesforce object name
+    # List all Salesforce objects of a specified category.
     # @param object_type [Symbol,String] 'all' or 'custom'
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
     # @param api_version [Numeric]       override the api version used for api requests made by this command

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

@@ -19,29 +19,51 @@ 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
           schema
         end
 
+        def action_overrides
+          schema["actionOverrides"]
+        end
+
+        def activateable?
+          schema["activateable"]
+        end
+
+        def associateEntityType
+          schema["associateEntityType"]
+        end
+
+        def associateParentEntity
+          schema["associateParentEntity"]
+        end
+
         def compact_layoutable?
           schema["compactLayoutable"]
         end
@@ -196,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
 
@@ -219,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.0'
+  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.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 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.
@@ -16,10 +16,8 @@ email:
 executables:
 - sf_cli
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- README.rdoc
 - bin/sf_cli
 - lib/sf_cli.rb
 - lib/sf_cli/console.rb

data/README.rdoc

@@ -1,94 +0,0 @@
-= Salesforce CLI library for Ruby
-https://badge.fury.io/rb/sf_cli.png
-
-This is a class library for introducing {Salesforce CLI}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm] to Ruby scripting.<br>
-It is designed to be similar usability to the original command.<br>
-Currently only *sf* command is the target of development.
-
-[rubygems]          https://rubygems.org/gems/sf_cli
-[official document] https://tmkw.github.io/sf_cli/
-
-== prerequisite
-{Salesforce CLI}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm] must be installed.<br>
-As of as of September in 2024, ver.2.56.7 is the development target.
-
-== install
-Rubygem::
-  the simplest way:
-    $ gem install sf_cli
-Bundler::
-  in Gemfile:
-    gem 'sf_cli'
-  then,
-    $ bundle install
-== Usage
-Load module
-  require 'sf_cli'
-
-Login to org
-  sf.org.login_web
-
-Get Salesforce Object schema 
-  sf.sobject.describe :Account
-
-Get a record
-  sf.data.get_record :Account, record_id: 'xxxxxxx'
-  sf.data.get_record :Account, where: {Name: 'Jonny B.Good', Country: 'USA'}
-
-Execute SOQL
-  sf.data.query "SELECT Id, Name FROM Account LIMIT 1" # => [{Id: "abc", Name: "account name"}]
-
-Create a record
-  sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33}
-
-Update a record
-  sf.data.update_record :Account, record_id: 'xxxxxxx', values: {Name: 'New Account Name'}
-  sf.data.update_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}, values: {Phone: 'xxxxx', bar: 2000}
-
-Delete a record
-  sf.data.delete_record :Hoge__c, record_id: 'xxxxxxx'
-  sf.data.delete_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}
-
-Using Bulk API 2.0
-  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', wait: 5  # waiting for 5 minutes at maximum
-
-Run Apex
-  sf.apex.run file: 'path/to/file'
-  sf.apex.run file: StringIO.new("System.debug('Hello World')")
-== Object Model Support
-With sf command:
-  rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
-  rows.first      # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
-  rows.first.Name # Akin Kristen
-Doing the same thing independently:
-  contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
-  contact.Name # Akin Kristen
-== Developer Console
-Developer console integrates both sf_cli's command methods and object model librry into IRB to make scripting easier in REPL.
-
-You can directly use sf_cli's command methods:
-  $ sf_cli -i
-  > sf.query "SELECT Id, Name FROM Case", target_org: :your_org
-
-Object Model is also available:
-  > use :your_org_name
-  > gen :Account, :Contact, :User  #=> generate 3 Object model classes
-  > acc = Account.find_by Name: 'Hoge Fuga'
-
-There are some other console commands:
-  > query "SELECT Id, Name, ... FROM BazBar__c" # just same as `sf data query` with human readable format
-  > apex "System.debug('abc');"                 # execute Apex code instantly
-
-Type *help* to know all console commands
-
-== Utility
-sf_cli command also have other functions. As of 1.2.0, it can generate Salesforce DX project.
-
-Create a project directory and files including manifest file
-  $ sf_cli -g project YOUR_PROJECT_NAME
-
-Same as above, but the manifest file is built based on the org
-  $ sf_cli -g project YOUR_PROJECT_NAME -o YOUR_TARGET_ORG
-
-Build project and manifest then retreave metadata such as Apex code at once
-  $ sf_cli -g project YOUR_PROJECT_NAME -o YOUR_TARGET_ORG -r