sf_cli 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f20d5801d3a2c887f01fa3fb3ab8775153d78b27d760ac2c6b148dac749a4945
-  data.tar.gz: 9295c01a6eab70749c2a0367a99d29f90ac3e7dafd65c49315ac521820362506
+  metadata.gz: 283b8eacee628f3be4e587040bd604bdbb669b8f0139e5f5a8963690f2f7605a
+  data.tar.gz: 9d2303cefa7684784a9505df8692cd0bbce74951f53ec28bd520d1f8c61c5041
 SHA512:
-  metadata.gz: 31b95e54526b884b83e19e6b870b99b148114b99692b92e4c01ea092a9068d4e779d708beba850fd60471bf44821ffcf859a00e094573e7ea8e2b70b46a341f9
-  data.tar.gz: 68637d5bd35140a9dc851176e9e22ae341c8c1029d451f63dfc0d076d5ea103f50b6f743d2c98743d121277b59cbb335933e6f98f74484509c1fe74bd02ed33b
+  metadata.gz: 2abcf466629177011a6d4847e3646cb033cdb34fdf40c9792ea9844678f5de0fdcd2f930cb12ad9e132300aa88ab33d59762caac39322d784af06fc768b6d51d
+  data.tar.gz: 4304ff0ee17be410ce5970dd917726e51a1013dfb7e9c7553df0848c4c780f9a4dbbaa4fee0f2eac33907732e37865188cfc0afbd36caa9506828d0d1ceed149

data/lib/sf_cli/command_exec_error.rb

@@ -0,0 +1,4 @@
+module SfCli
+  class CommandExecError < StandardError
+  end
+end

data/lib/sf_cli/console/commands.rb

@@ -1,4 +1,5 @@
 require 'sf_cli'
+require 'byebug'
 require 'sf_cli/sf/model'
 require 'sf_cli/sf/model/query_condition'
 require 'sf_cli/sf/model/sf_command_connection'

data/lib/sf_cli/sf/core/base.rb

@@ -1,24 +1,22 @@
 require 'json'
 require 'tempfile'
 
+require_relative '../../command_exec_error'
+
 module SfCli
   module Sf
     # @private :nodoc: just for developers
     module Core
       module Base
-        attr_reader :varbose
-
         private
 
         def exec(action, flags: {}, switches: {}, redirection: nil, raw_output: false, format: :json) # :doc:
           cmd = %|sf #{category} #{action}#{as_flag_options(flags)}#{as_switch_options(switches, format)}#{redirect redirection}|
-          puts cmd if varbose
 
           return `#{cmd}` if raw_output
 
           json = JSON.parse `#{cmd}`
-          puts json if varbose
-          raise StandardError.new(json['message']) if json['status'] != 0
+          raise ::SfCli::CommandExecError.new(json['message']) if json['status'] != 0
 
           json
         end

data/lib/sf_cli/sf/core/org_base.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+module SfCli::Sf::Core
+  module OrgBase
+    include Base
+
+    def org_exec(action, flags: {}, switches: {}, redirection: nil, raw_output: false)
+      fmt = raw_output ? :human : :json
+      redirect_type = raw_output ? nil : :null_stderr
+      exec(action, flags: flags, switches: switches, redirection: redirect_type, raw_output: raw_output, format: fmt)
+    end
+  end
+end

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

@@ -55,9 +55,10 @@ module SfCli::Sf::Data
         bulk: bulk,
       }
       raw_output = format ? true : false
+      redirect_type = raw_output ? nil : :null_stderr
       format = format&.to_sym || :json
 
-      exec_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: redirect_type, raw_output: raw_output, format: format)
 
       results = return_result(exec_result, raw_output, bulk, model_class)
 

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

@@ -1,4 +1,4 @@
-require_relative '../core/base'
+require_relative '../core/org_base'
 require_relative './login'
 require_relative './display'
 require_relative './list'
@@ -16,7 +16,7 @@ module SfCli
     module Org
       # @private :nodoc: just for developers
       class Core
-        include ::SfCli::Sf::Core::Base
+        include ::SfCli::Sf::Core::OrgBase
         include Login
         include Display
         include List

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

@@ -10,6 +10,7 @@ module SfCli::Sf::Org
     # Returns the org's connection information
     # @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
+    # @param raw_output  [Boolian]       return the original command's output.
     #
     # @note this function returns the org information including security sensitive things such as access token, username and so on.
     # @return [ConnectionInfo] the org's connection information
@@ -29,18 +30,19 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified command reference
     #
-    def display(target_org: nil, api_version: nil)
+    def display(target_org: nil, api_version: nil, raw_output: false)
       flags    = {:"target-org" => target_org, :"api-version" => api_version}
-      json = exec(__method__, flags: flags, redirection: :null_stderr)
+      output = org_exec(__method__, flags: flags, redirection: :null_stderr, raw_output: raw_output)
+      return output if raw_output
 
       ConnectionInfo.new(
-        id:           json['result']['id'],
-        access_token: json['result']['accessToken'],
-        alias:        json['result']['alias'],
-        instance_url: json['result']['instanceUrl'],
-        user_name:    json['result']['username'],
-        api_version:  json['result']['apiVersion'],
-        status:       json['result']['connectedStatus']
+        id:           output['result']['id'],
+        access_token: output['result']['accessToken'],
+        alias:        output['result']['alias'],
+        instance_url: output['result']['instanceUrl'],
+        user_name:    output['result']['username'],
+        api_version:  output['result']['apiVersion'],
+        status:       output['result']['connectedStatus']
       )
     end
   end

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

@@ -32,6 +32,7 @@ module SfCli::Sf::Org
     # List orgs you’ve created or authenticated to
     #
     # @note this function returns org information including security sensitive things such as access token, username and so on.
+    # @param raw_output  [Boolian] return the original command's output.
     # @return [Array] the org configulations
     #
     # @example
@@ -48,17 +49,19 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_unified command reference
     #
-    def list
+    def list(raw_output: false)
       flags = {
         # reserved for later option addition
       }
-      json = exec(__method__, flags: flags, redirection: :null_stderr)
+      output = org_exec(__method__, flags: flags, redirection: :null_stderr, raw_output: raw_output)
 
-      others = json['result']['other'].map{|config| OrgConfig.new(**config)}
-      sandboxes = json['result']['sandboxes'].map{|config| OrgConfig.new(**config)}
-      non_scratch_orgs = json['result']['nonScratchOrgs'].map{|config| OrgConfig.new(**config)}
-      devhubs = json['result']['devHubs'].map{|config| OrgConfig.new(**config)}
-      scratch_orgs = json['result']['scratchOrgs'].map{|config| OrgConfig.new(**config)}
+      return output if raw_output
+
+      others = output['result']['other'].map{|config| OrgConfig.new(**config)}
+      sandboxes = output['result']['sandboxes'].map{|config| OrgConfig.new(**config)}
+      non_scratch_orgs = output['result']['nonScratchOrgs'].map{|config| OrgConfig.new(**config)}
+      devhubs = output['result']['devHubs'].map{|config| OrgConfig.new(**config)}
+      scratch_orgs = output['result']['scratchOrgs'].map{|config| OrgConfig.new(**config)}
       
       (others + sandboxes + non_scratch_orgs + devhubs + scratch_orgs).uniq{|config| config.alias}
     end

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

@@ -4,6 +4,7 @@ module SfCli::Sf::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
+    # @param raw_output  [Boolian]       return the original command's output.
     #
     # @return [Limits] the list of limit information
     #
@@ -14,15 +15,17 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_limits_unified command reference
     #
-    def list_limits(target_org: nil, api_version: nil)
+    def list_limits(target_org: nil, api_version: nil, raw_output: false)
       flags    = {
         :"target-org"    => target_org,
         :"api-version"   => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
-      json = exec(action, flags: flags, redirection: :null_stderr)
+      output = org_exec(action, flags: flags, redirection: :null_stderr, raw_output: raw_output)
 
-      Limits.new(json['result'])
+      return output if raw_output
+
+      Limits.new(output['result'])
     end
 
     Limit = Data.define(:name, :remaining, :max)

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

@@ -7,6 +7,7 @@ module SfCli::Sf::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
     # @param output_file [String]        pathname of the file in which to write the results
+    # @param raw_output  [Boolian]       return the original command's output.
     #
     # @return [MetadataList] the list of metadata, which contains its name, its source file path and so on
     #
@@ -17,7 +18,7 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_metadata_unified command reference
     #
-    def list_metadata(metadata, folder: nil, target_org: nil, api_version: nil, output_file: nil)
+    def list_metadata(metadata, folder: nil, target_org: nil, api_version: nil, output_file: nil, raw_output: false)
       flags    = {
         :"metadata-type" => metadata,
         :"folder"        => folder,
@@ -26,9 +27,10 @@ module SfCli::Sf::Org
         :"output-file"   => output_file,
       }
       action = __method__.to_s.tr('_', ' ')
-      json = exec(action, flags: flags, redirection: :null_stderr)
+      output = org_exec(action, flags: flags, redirection: :null_stderr, raw_output: raw_output)
+      return output if raw_output
 
-      MetadataList.new(json['result'])
+      MetadataList.new(output['result'])
     end
 
     Metadata = Data.define(

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

@@ -5,6 +5,7 @@ module SfCli::Sf::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
     # @param output_file [String]        pathname of the file in which to write the results
+    # @param raw_output  [Boolian]       return the original command's output.
     #
     # @return [Result] the command's output
     #
@@ -14,20 +15,21 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_metadata-types_unified command reference
     #
-    def list_metadata_types(target_org: nil, api_version: nil, output_file: nil)
+    def list_metadata_types(target_org: nil, api_version: nil, output_file: nil, raw_output: false)
       flags    = {
         :"target-org" => target_org,
         :"api-version" => api_version,
         :"output-file" => output_file,
       }
       action = __method__.to_s.tr('_', '-').sub('-', ' ')
-      json = exec(action, flags: flags, redirection: :null_stderr)
+      output = org_exec(action, flags: flags, redirection: :null_stderr, raw_output: raw_output)
+      return output if raw_output
 
       Result.new(
-        metadata_objects:       MetadataObjects.new(json['result']['metadataObjects']),
-        organization_namespace: json['result']['organizationNamespace'],
-        partial_save_allowed:   json['result']['partialSaveAllowed'],
-        test_required:          json['result']['testRequired']
+        metadata_objects:       MetadataObjects.new(output['result']['metadataObjects']),
+        organization_namespace: output['result']['organizationNamespace'],
+        partial_save_allowed:   output['result']['partialSaveAllowed'],
+        test_required:          output['result']['testRequired']
       )
     end
 

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

@@ -8,12 +8,13 @@ module SfCli::Sf::Project
     # @param template   [Symbol,String] project template name
     # @param output_dir [String]        output directory
     # @param manifest   [Boolian]       switch to create manifest file in the project directory (manifest/package.xml)
+    # @param raw_output [Boolian]       output what original command shows
     #
     # @return [Result] the retsult of project generation
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_generate_unified command reference
     #
-    def generate(name, manifest: false, template: nil, output_dir: nil)
+    def generate(name, manifest: false, template: nil, output_dir: nil, raw_output: false)
       flags    = {
         :name         => name,
         :template     => template,
@@ -22,13 +23,16 @@ module SfCli::Sf::Project
       switches = {
         manifest: manifest,
       }
-      json = exec(__method__, flags: flags, switches: switches, redirection: :null_stderr)
+      command_output_format = raw_output ? :human : :json
+      redirect_type = raw_output ? nil : :null_stderr
+      output = exec(__method__, flags: flags, switches: switches, redirection: redirect_type, raw_output: raw_output, format: command_output_format)
+      return output if raw_output
 
       Result.new(
-        output_dir: json['result']['outputDir'],
-        files:      json['result']['created'],
-        raw_output: json['result']['rawOutput'],
-        warnings:   json['warnings']
+        output_dir: output['result']['outputDir'],
+        files:      output['result']['created'],
+        raw_output: output['result']['rawOutput'],
+        warnings:   output['warnings']
       )
     end
   end

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

@@ -6,6 +6,7 @@ module SfCli::Sf::Project
     # @param output_dir  [String]  manifest's output directory in the project directory. You can use relative path from the project root (default: nil)
     # @param from_org    [String]  username or alias of the org that contains the metadata components from which to build a manifest (default: nil)
     # @param source_dir  [String]  paths to the local source files to include in the manifest (default: nil)
+    # @param raw_output [Boolian]  output what original command shows
     #
     # @example
     #  sf.project.generate_manifest metadata: %w[CustomObject Layout] # creates a package.xml, which is initialized with CustomObject and Layout
@@ -13,7 +14,7 @@ module SfCli::Sf::Project
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_generate_manifest_unified command reference
     #
-    def generate_manifest(name: nil, output_dir: nil, api_version: nil, metadata: [], from_org: nil, source_dir: nil)
+    def generate_manifest(name: nil, output_dir: nil, api_version: nil, metadata: [], from_org: nil, source_dir: nil, raw_output: false)
       flags    = {
         :name           => name,
         :"metadata"     => (metadata.empty? ? nil : metadata.join(' ')),
@@ -23,9 +24,12 @@ module SfCli::Sf::Project
         :"api-version"  => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
-      json = exec(action, flags: flags, redirection: :null_stderr)
+      command_output_format = raw_output ? :human : :json
+      redirect_type = raw_output ? nil : :null_stderr
+      output = exec(action, flags: flags, redirection: redirect_type, raw_output: raw_output, format: command_output_format)
+      return output if raw_output
 
-      json['result']['path']
+      output['result']['path']
     end
   end
 end

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

@@ -23,12 +23,13 @@ module SfCli::Sf::Project
     # @param unzip               [Boolian]       number of minutes to wait for command to complete
     # @param target_metadata_dir [String]        indicates that the zip file points to a directory structure for a single package
     # @param zip_file_name       [String]        file name to use for the retrieved zip file
+    # @param raw_output          [Boolian]       output what original command shows
     #
     # @return [Result] the retsult of the command
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_retrieve_start_unified command reference
     #
-    def retrieve_start(metadata: nil, manifest: nil,  source_dir: nil, package_name: nil, target_org: nil, output_dir: nil,
+    def retrieve_start(metadata: nil, manifest: nil,  source_dir: nil, package_name: nil, target_org: nil, output_dir: nil, raw_output: false,
       api_version: nil, wait: nil, target_metadata_dir: nil, zip_file_name: nil, ignore_conflicts: false, single_package: false, unzip: false)
 
       flags = {
@@ -49,16 +50,19 @@ module SfCli::Sf::Project
         :"unzip" => unzip,
       }
       action = __method__.to_s.tr('_', ' ')
-      json = exec(action, flags: flags, switches: switches, redirection: :null_stderr)
+      command_output_format = raw_output ? :human : :json
+      redirect_type = raw_output ? nil : :null_stderr
+      output = exec(action, flags: flags, switches: switches, redirection: redirect_type, raw_output: raw_output, format: command_output_format)
+      return output if raw_output
 
       Result.new(
-        done:            json['result']['done'],
-        file_properties: json['result']['fileProperties'].map{|fp| create_file_property(fp)},
-        id:              json['result']['id'],
-        status:          json['result']['status'],
-        success:         json['result']['success'],
-        messages:        json['result']['messages'],
-        files:           json['result']['files'].map{|f| create_retrieved_file(f)}
+        done:            output['result']['done'],
+        file_properties: output['result']['fileProperties'].map{|fp| create_file_property(fp)},
+        id:              output['result']['id'],
+        status:          output['result']['status'],
+        success:         output['result']['success'],
+        messages:        output['result']['messages'],
+        files:           output['result']['files'].map{|f| create_retrieved_file(f)}
       )
     end
 

data/lib/sf_cli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-11-02 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.
@@ -20,11 +20,13 @@ extra_rdoc_files: []
 files:
 - bin/sf_cli
 - lib/sf_cli.rb
+- lib/sf_cli/command_exec_error.rb
 - lib/sf_cli/console.rb
 - lib/sf_cli/console/commands.rb
 - lib/sf_cli/sf/apex/core.rb
 - lib/sf_cli/sf/apex/run.rb
 - lib/sf_cli/sf/core/base.rb
+- lib/sf_cli/sf/core/org_base.rb
 - lib/sf_cli/sf/data/bulk_result_v2.rb
 - lib/sf_cli/sf/data/core.rb
 - lib/sf_cli/sf/data/create_record.rb
@@ -69,7 +71,7 @@ homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT
 metadata:
-  homepage_url: https://github.com/tmkw/sf_cli
+  homepage_uri: https://github.com/tmkw/sf_cli
 post_install_message:
 rdoc_options: []
 require_paths: