sf_cli 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea26ff0c7b396c91b431caf812ccc8e8cc702433205082ed68891b67bd82a910
-  data.tar.gz: 920c35bc989df4230a76f52256c01a98c13c8c9105e9ea7ea6819dd32ffa49b5
+  metadata.gz: 3d070d17a818ef2dd2030a026e1e3b14a284eb1e4ce1bab9ed46c8f5811c2169
+  data.tar.gz: aa7aafc17f57d6d9df71e6969caad6c756965cfce76ca5583acd73799366b34c
 SHA512:
-  metadata.gz: 995c401c9b9eb0d4fb076b70b6e6e74dde07272dbdb85117a767e746cf3f3995322d27b789ecf2df8a2b077ef7c78f9dac0bc5cf8d2ad5112fe50d4c07a5c7d3
-  data.tar.gz: 82f9bf6f26330c1219de3a9f7660236e8d3db61393957bb476413d86dc0d79d5627d847e0e5d6ed2605ef311efc9961cb6b99e39dac9b0d7c5bb7d4c7c7837a1
+  metadata.gz: ddfd91e3ddd1573938d9dbb9c27749eb8054475cee62d5565222f75ad2867fe1abf3dc3c5cc48a452a79991971532f89b233ddf1db491a83b9f28348fdd53eb0
+  data.tar.gz: 9df1154ec04b5acefddc469429163feed1ee432abd517048b0915d046c29d9d30a5e097153aa50a5774085720f91c68f86cda484ada9d667a6140cd15bcbe6bb

data/README.rdoc

@@ -0,0 +1,50 @@
+= Salesforce CLI library
+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 command line interface.<br>
+Currently only *sf* command is the target of development.
+
+== prerequisite
+Salesforce CLI must be installed.<br>
+As of as of August in 2024, ver.2.54.6 is the development target.
+
+== install
+=== Rubygem
+  $ gem install sf_cli
+
+=== Bundler
+in Gemfile:
+  gem 'sf_cli'
+
+then,
+  $ bundle install
+
+== Examples
+  require 'sf_cli/sf'
+
+  sf = SfCli::Sf.new
+
+  # login to org
+  sf.org.login_web
+  sf.org.login_web target_org: :dev  # name an alias to the org, which you're going to log in, for later use. This is needed when you don't use the default org.
+
+  # get Account records
+  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
+  
+  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
+
+  # generate a Salesforce DX project
+  sf.project.generate 'MyProject'
+
+
+For more command details, see {Salesforce CLI Command Reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm]
+
+== Documents
+  $ git clone https://github.com/tmkw/sf_cli.git
+  $ cd sf_cli
+  $ bundle install
+  $ bundle exec rake rdoc
+
+This generates the documents in doc directory.

data/lib/sf_cli/sf/base.rb

@@ -1,17 +1,34 @@
-require_relative '../helper_methods'
-
-module SfCli
-  class Sf
-    class Base
-      include ::SfCli::HelperMethods
-
-      attr_reader :target_org
-
-      # *target_org* --- an org alias name, which is used for sf command operations (default is nil). If it is nil, the command uses the default org.
-      #
-      def initialize(target_org = nil)
-        @target_org = target_org
-      end
-    end
-  end
-end
+module SfCli
+  class Sf
+    class Base
+      def initialize(_sf)
+        @sf  = _sf
+      end
+
+      private
+
+      def exec(action, flags: {}, switches: {}, redirection: nil)
+        sf.exec(category, action, flags: flags, switches: switches, redirection: redirection)
+      end
+
+      def category
+        self.class.name.split('::').last.downcase
+      end
+
+      def field_value_pairs(hash)
+        return nil if hash.nil?
+        return nil if hash.empty?
+
+        hash.each_with_object([]) do|(k,v), arr|
+          value = v.instance_of?(String) ? %|'#{v}'| : v
+          arr << %(#{k}=#{value})
+        end
+        .join(' ')
+      end
+
+      def sf
+        @sf
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/data.rb

@@ -1,38 +1,148 @@
-require 'json'
-require_relative './base'
-
-module SfCli
-  class Sf
-    #
-    # ==== description
-    # The class representing *sf* *data*
-    #
-    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm
-    #
-    class Data < Base
-
-      # get the object records. It's eqivalent to use *sf* *data* *query*
-      #
-      # *soql* --- SOQL
-      #
-      # *model_class* --- the data model class representing the record object.  
-      #
-      # ==== examples
-      #   sf.data.query('SELECT Id, Name From Account Limit 3') # returns an array of Hash object
-      #
-      #   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
-      #
-      def query(soql, model_class: nil)
-        json = JSON.parse `sf data query --json --query "#{soql}" #{flag :"target-org", target_org} #{null_stderr_redirection}`
-        raise StandardError.new(%|sf data query: failed. (query: "#{soql}")|) if json['status'] != 0
-
-        json['result']['records'].each_with_object([]) do |h, a|
-          h.delete "attributes"
-          a << (model_class ? model_class.new(**h) : h)
-        end
-      end
-    end
-  end
-end
-
+require_relative './base'
+
+module SfCli
+  class Sf
+    #
+    # ==== description
+    # The class representing *sf* *data*
+    #
+    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm
+    #
+    class Data < Base
+
+      # get object records using SQOL. (eqivalent to *sf* *data* *query*)
+      #
+      # *soql* --- SOQL<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      # *model_class* --- the data model class representing the record object.<br> 
+      #
+      # ==== examples
+      #   sf.data.query('SELECT Id, Name From Account Limit 3') # returns an array of Hash object
+      #
+      #   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
+      #
+      def query(soql, target_org: nil, model_class: nil)
+        flags    = {
+          :"query"    => %("#{soql}"),
+          :"target-org" => target_org,
+        }
+        json = exec(__method__, flags: flags, redirection: :null_stderr)
+
+        json['result']['records'].each_with_object([]) do |h, a|
+          h.delete "attributes"
+          a << (model_class ? model_class.new(**h) : h)
+        end
+      end
+
+      # get a object record. (eqivalent to *sf* *data* *get* *record*)
+      #
+      # *object_type* --- Object Type (ex. Account)<br>
+      # *record_id* --- id of the object<br>
+      # *where* --- hash object that is used to identify a record<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      # *model_class* --- the data model class representing the record object.<br> 
+      #
+      # ==== examples
+      #   sf.data.get_record :Account, record_id: 'xxxxxxx'
+      #   sf.data.get_record :Account, where: {Name: 'Jonny B.Good', Country: 'USA'}
+      #
+      #   CustomObject = Struct.new(:Id, :Name)
+      #   sf.data.get_record :TheCustomObject__c, record_id: 'xxxxx', model_class: CustomObject  # returns a CustomObject struct object
+      #
+      def get_record(object_type, record_id: nil, where: nil, target_org: nil, model_class: nil)
+        where_conditions = field_value_pairs(where)
+        flags = {
+          :"sobject"    => object_type,
+          :"record-id"  => record_id,
+          :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
+          :"target-org" => target_org,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        json = exec(action, flags: flags, redirection: :null_stderr)
+
+        result = json['result']
+        result.delete 'attributes'
+
+        model_class ? model_class.new(**result) : result
+      end
+
+      # update a object record. (eqivalent to *sf* *data* *update* *record*)
+      #
+      # *object_type* --- Object Type (ex. Account)<br>
+      # *record_id* --- id of the object<br>
+      # *where* --- field values that is used to identify a record<br>
+      # *values* --- field values for update<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      # ==== examples
+      #   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}
+      #
+      def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil)
+        where_conditions  = field_value_pairs(where)
+        field_values      = field_value_pairs(values)
+        flags = {
+          :"sobject"    => object_type,
+          :"record-id"  => record_id,
+          :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
+          :"values"     => (field_values.nil? ? nil : %|"#{field_values}"|),
+          :"target-org" => target_org,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        json = exec(action, flags: flags, redirection: :null_stderr)
+
+        json['result']['id']
+      end
+
+      # create a object record. (eqivalent to *sf* *data* *create* *record*)
+      #
+      # *object_type* --- Object Type (ex. Account)<br>
+      # *values* --- field values to be assigned<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      # ==== examples
+      #
+      #   sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33} # creating a TheCustomObject record with name and age
+      #
+      def create_record(object_type, values: {}, target_org: nil)
+        field_values = field_value_pairs(values)
+        flags = {
+          :"sobject"    => object_type,
+          :"values"      => (field_values.nil? ? nil : %|"#{field_values}"|),
+          :"target-org" => target_org,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        json = exec(action, flags: flags, redirection: :null_stderr)
+
+        json['result']['id']
+      end
+
+      # delete a object record. (eqivalent to *sf* *data* *delete* *record*)
+      #
+      # *object_type* --- Object Type (ex. Account)<br>
+      # *record_id* --- id of the object<br>
+      # *where* --- hash object that is used to identify a record<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      # ==== examples
+      #   sf.data.delete_record :Hoge__c, record_id: 'xxxxxxx'
+      #   sf.data.delete_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}
+      #
+      #
+      def delete_record(object_type, record_id: nil, where: nil, target_org: nil)
+        where_conditions = field_value_pairs(where)
+        flags = {
+          :"sobject"    => object_type,
+          :"record-id"  => record_id,
+          :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
+          :"target-org" => target_org,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        json = exec(action, flags: flags, redirection: :null_stderr)
+
+        json['result']['id']
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/org.rb

@@ -1,56 +1,49 @@
-require_relative './base'
-
-module SfCli
-  class Sf
-    #
-    # ==== description
-    # The class representing *sf* *org*.
-    #
-    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm
-    #
-    class Org < Base
-      ConnectionInfo = Struct.new(:access_token, :alias, :instance_url, :api_version, :status)
-
-      # login to the org by the browser. It's equivalent to use *sf* *org* *login* *web*
-      #
-      # *instance_url* --- custom login url.
-      #
-      def login_web(instance_url: nil)
-        `sf org login web #{flag :alias, target_org} #{flag :"instance-url", instance_url}`
-      end
-
-      #
-      # returns the org's connection information. It's equivalent to use *sf* *org* *display*.
-      #
-      def display
-        lines = StringIO.new(`sf org display #{flag :"target-org", target_org} #{null_stderr_redirection}`).readlines
-
-        connection_info = ConnectionInfo.new(
-          access_token: nil,
-          alias:        nil,
-          instance_url: nil,
-          api_version:  nil,
-          status:       nil
-        )
-
-        lines.each do |line|
-          case line
-          when /Access Token/
-            connection_info.access_token = line.split(' ')[2]
-          when /Alias/
-            connection_info.alias = line.split(' ')[1]
-          when /Instance Url/
-            connection_info.instance_url = line.split(' ')[2]
-          when /Api Version/
-            connection_info.api_version = line.split(' ')[2]
-          when /Connected Status/
-            connection_info.status = line.split(' ')[2]
-          end
-        end
-
-        connection_info
-      end
-    end
-  end
-end
-
+require_relative './base'
+
+module SfCli
+  class Sf
+    #
+    # ==== description
+    # The class representing *sf* *org*.
+    #
+    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm
+    #
+    class Org < Base
+      ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
+
+      # login to the org by the browser. (equivalent to *sf* *org* *login* *web*)
+      #
+      # *target_org* --- an alias of paticular org, not default one<br>
+      # *instance_url* --- custom login url.
+      #
+      def login_web(target_org: nil, instance_url: nil)
+        flags    = {
+          :"alias"        => target_org,
+          :"instance-url" => instance_url,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        exec(action, flags: flags)
+      end
+
+      #
+      # returns the org's connection information. (equivalent to *sf* *org* *display*)
+      #
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      def display(target_org: nil)
+        flags    = {:"target-org" => target_org}
+        json = exec(__method__, flags: flags, redirection: :null_stderr)
+
+        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']
+        )
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/project.rb

@@ -1,74 +1,68 @@
-require 'pathname'
-require_relative './base'
-
-module SfCli
-  class Sf
-    # ==== description
-    # The class representing *sf* *project*
-    #
-    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm
-    #
-    class Project < Base
-
-      #
-      # generate a Salesforce project. It's equivalent to *sf* *project* *generate*.
-      #
-      # *name*        --- project name
-      #
-      # *template*    --- project template name
-      #
-      # *output_dir*  --- output directory
-      #
-      def generate(name, template: 'standard', output_dir: nil)
-        `sf project generate #{flag :name, name} #{flag :template, template} #{flag :"output-dir", output_dir} --manifest #{null_stderr_redirection}`
-        raise StandardError.new(%|command 'sf project generate' failed.|) unless $?.success?
-      end
-
-      # generate the manifest file of a Salesforce project.  It's equivalent to *sf* *project* *generate* *manifest*
-      #
-      # *metadata*    --- an array that consists of metadata type like CustomObject, Layout and so on.  (default: [])
-      # 
-      # *api_verson*  --- api version (default: nil)
-      # 
-      # *project_dir* --- project directory which you want to create the manifest  (default: nil)
-      # 
-      # *output_dir*  --- manifest's output directory in the project directory. You can use relative path from the project root (default: nil)
-      # 
-      # *from_org*    --- username or alias of the org that contains the metadata components from which to build a manifest (default: nil)
-      # 
-      # *source_dir*  --- paths to the local source files to include in the manifest (default: nil)
-      #
-      # ==== examples
-      #   sf.project.generate_manifest metadata: %w[CustomObject Layout]  # creates a package.xml, which is initialized with CustomObject and Layout
-      #   sf.project.generate_manifest from_org: <org_name>               # creates a package.xml, which is initialized with all metadata types in the org
-      #
-      def generate_manifest(metadata: [], api_version: nil, project_dir: nil, output_dir: nil, from_org: nil, source_dir: nil)
-        raise StandardError.new('Exactly one of the following must be provided: --from-org, --metadata, --source-dir') if metadata.empty? && from_org.nil? && source_dir.nil?
-        base_dir = Dir.pwd
-
-        if project_dir
-          raise StandardError.new('the project directory not found') unless FileTest.exist?(project_dir) && FileTest.directory?(project_dir)
-          Dir.chdir project_dir
-        end
-
-        Dir.mkdir(output_dir) if output_dir && FileTest.exist?(output_dir) == false
-
-        metdata_flags = metadata.empty? ? '' : metadata.map{|md| %|--metadata #{md}|}.join(' ')
-        cmd =
-          %|sf project generate manifest %{metdata} %{output_dir} %{api_version} %{from_org} %{source_dir}| %
-            {
-              metdata: metdata_flags,
-              output_dir:   flag(:"output-dir", output_dir),
-              api_version:  flag(:"api-version", api_version),
-              from_org:     flag(:"from-org", from_org),
-              source_dir:   flag(:"source-dir", source_dir),
-            }
-        `#{cmd} #{null_stderr_redirection}`
-
-        raise StandardError.new(%|command 'sf project generate manifest' failed.|) unless $?.success?
-      ensure 
-        Dir.chdir base_dir
-      end
-    end
-  end
-end
+require_relative './base'
+
+module SfCli
+  class Sf
+    # ==== description
+    # The class representing *sf* *project*
+    #
+    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm
+    #
+    class Project < Base
+      GenerateResult = Struct.new(:output_dir, :files, :raw_output, :warnings)
+
+      #
+      # generate a Salesforce project. (equivalent to *sf* *project* *generate*)
+      #
+      # *name*        --- project name<br>
+      # *template*    --- project template name<br>
+      # *output_dir*  --- output directory<br>
+      # *manifest*    --- switch to create manifest file in the project directory (manifest/package.xml). default: false
+      #
+      def generate(name, manifest: false, template: nil, output_dir: nil)
+        flags    = {
+          :name         => name,
+          :template     => template,
+          :"output-dir" => output_dir,
+        }
+        switches = {
+          manifest: manifest,
+        }
+        json = exec(__method__, flags: flags, switches: switches, redirection: :null_stderr)
+
+        GenerateResult.new(
+          output_dir: json['result']['outputDir'],
+          files:      json['result']['created'],
+          raw_output: json['result']['rawOutput'],
+          warnings:   json['warnings']
+        )
+      end
+
+      # generate the manifest file of a Salesforce project. (equivalent to *sf* *project* *generate* *manifest*)
+      #
+      # *metadata*    --- an array that consists of metadata type like CustomObject, Layout and so on.  (default: [])<br>
+      # *api_verson*  --- api version (default: nil)<br>
+      # *output_dir*  --- manifest's output directory in the project directory. You can use relative path from the project root (default: nil)<br>
+      # *from_org*    --- username or alias of the org that contains the metadata components from which to build a manifest (default: nil)<br>
+      # *source_dir*  --- paths to the local source files to include in the manifest (default: nil)
+      #
+      # ==== examples
+      #   sf.project.generate_manifest metadata: %w[CustomObject Layout]  # creates a package.xml, which is initialized with CustomObject and Layout
+      #   sf.project.generate_manifest from_org: <org_name>               # creates a package.xml, which is initialized with all metadata types in the org
+      #
+      def generate_manifest(name: nil, output_dir: nil, api_version: nil, metadata: [], from_org: nil, source_dir: nil)
+        flags    = {
+          :name           => name,
+          :"metadata"     => (metadata.empty? ? nil : metadata.join(' ')),
+          :"from-org"     => from_org,
+          :"source-dir"   => source_dir,
+          :"output-dir"   => output_dir,
+          :"api-version"  => api_version,
+        }
+        action = __method__.to_s.tr('_', ' ')
+        json = exec(action, flags: flags, redirection: :null_stderr)
+
+        json['result']['path']
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/sobject.rb

@@ -1,36 +1,41 @@
-require 'json'
-require_relative './base'
-
-module SfCli
-  class Sf
-    # ==== description
-    # The class representing *sf* *sobject*
-    #
-    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm
-    #
-    class SObject < Base
-
-      # get the schema information of a Salesforce object and returns a hash object. It's equivalent to use *sf* *sobject* *describe*
-      #
-      # *objectType* --- object type (ex: Account)
-      #
-      def describe(objectType)
-        json = JSON.parse `sf sobject describe --json --sobject #{objectType} #{flag :"target-org", target_org}  #{null_stderr_redirection}`
-        raise StandardError.new(%|sf sobject describe: failed. (sobject: #{objectType})|) if json['status'] != 0
-
-        json['result']
-      end
-
-      # returns a list of Salesforce object name (object's API name). It's equivalent to *sf* *sobject* *list*
-      #
-      # *object_type* --- all or custom (default: all)
-      #
-      def list(object_type: 'all')
-        json = JSON.parse `sf sobject list --json --sobject #{object_type} #{flag :"target-org", target_org} #{null_stderr_redirection}`
-        raise StandardError.new(%|sf sobject list: failed.|) if json['status'] != 0
-
-        json['result']
-      end
-    end
-  end
-end
+require_relative './base'
+
+module SfCli
+  class Sf
+    # ==== description
+    # The class representing *sf* *sobject*
+    #
+    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm
+    #
+    class Sobject < Base
+
+      # returns a hash object containing the Salesforce object schema. (equivalent to *sf* *sobject* *describe*)
+      #
+      # *objectType* --- object type (ex: Account)<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      def describe(object_type, target_org: nil)
+        flags    = {
+          :"sobject"    => object_type,
+          :"target-org" => target_org,
+        }
+        json = exec(__method__, flags: flags, redirection: :null_stderr)
+        json['result']
+      end
+
+      # returns a list of Salesforce object API name. (equivalent to *sf* *sobject* *list*)
+      #
+      # *object_type* --- all or custom<br>
+      # *target_org* --- an alias of paticular org, not default one<br>
+      #
+      def list(object_type, target_org: nil)
+        flags    = {
+          :"sobject"    => (object_type.to_sym == :custom ? :custom : :all),
+          :"target-org" => target_org,
+        }
+        json = exec(__method__, flags: flags, redirection: :null_stderr)
+        json['result']
+      end
+    end
+  end
+end

data/lib/sf_cli/sf.rb

@@ -1,33 +1,87 @@
-require_relative './sf/operations'
-
-module SfCli
-  # ==== description
-  # The main object class of *sf* command.
-  #
-  #
-  # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm
-  #
-  # ==== examples
-  #  sf = SfCli::Sf.new                     # use default org
-  #  sf = SfCli::Sf.new target_org: 'hoge'  # use an alias "hoge" as target org
-  #
-  #  # get the org connection infomation, which is equivalent to the result of 'sf org display'
-  #  sf.org.display 
-  #
-  #  # get Account records (equivalent to 'sf data query')
-  #  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
-  #
-  class Sf
-    attr_reader :target_org, :org, :data, :sobject, :project
-
-    #
-    # *\target_org* --- an org alias name, which is used for sf command operations (default is nil). If it is nil, the command uses the default org.
-    #
-    def initialize(target_org: nil)
-      @org = Org.new(target_org)
-      @data = Data.new(target_org)
-      @sobject = SObject.new(target_org)
-      @project = Project.new
-    end
-  end
-end
+require 'json'
+
+module SfCli
+  # ==== description
+  # The main class of *sf* command.
+  #
+  # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm
+  #
+  # ==== examples
+  #  sf = SfCli::Sf.new # use default org
+  #
+  #  # get the org connection infomation, as same as 'sf org display'
+  #  sf.org.display
+  #
+  #  # get Account records (equivalent to 'sf data query')
+  #  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
+  #
+  class Sf
+    OPERATION_CATEGORIES = %w[Org Sobject Data Project]
+
+    # load each operation class and define as a attribute
+    OPERATION_CATEGORIES.each do |category|
+      require_relative %(sf/#{category.downcase})
+      attr_reader category.downcase.to_sym
+    end
+
+    attr_reader :varbose
+
+    def initialize
+      OPERATION_CATEGORIES.each do |category|
+        instance_variable_set(:"@#{category.downcase}", Object.const_get(%|::SfCli::Sf::#{category}|).new(self))
+      end
+    end
+
+    def exec(category, action, flags: {}, switches: {}, redirection: nil)
+      cmd = %|sf #{category} #{action}#{as_flag_options(flags)}#{as_switch_options(switches)}#{redirect redirection}|
+
+      puts cmd if varbose
+
+      json = JSON.parse `#{cmd}`
+
+      puts json if varbose
+
+      raise StandardError.new(json['message']) if json['status'] != 0
+
+      json
+    end
+
+    private
+
+    def as_flag_options(hash)
+      flag_options   = hash.map{|k,v| flag k, v}.reject(&:nil?).join(' ')
+      flag_options   = ' ' + flag_options unless flag_options.empty?
+
+      flag_options
+    end
+
+    def as_switch_options(hash)
+      ' ' + {json: true}.merge(hash).each_with_object([]){|(k,v), arr| arr << %(--#{k}) if v}.join(' ')
+    end
+
+    def flag(name, arg)
+      arg ? %(--#{name} #{arg}) : nil
+    end
+
+    def os
+      @os ||= ENV['OS']
+    end
+
+    def redirect(option)
+      case option
+      when :null_stderr
+        null_stderr_redirection
+      else
+      end
+    end
+
+    def null_stderr_redirection
+      @null_stderr_redirection ||=
+        if os.eql?('Windows_NT')
+          ' 2>nul'
+        else
+          ' 2> /dev/null'
+        end
+    end
+  end
+end

metadata

@@ -1,35 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-08-25 00:00:00.000000000 Z
 dependencies: []
-description: A thin wrapper classes representing salesforce CLI. Currenty only sf
-  command is implemented, but not all functions are supported.
+description: This is a class library for introducing Salesforce CLI.Currenty only
+  sf command is the target of development.
 email: 
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
+- README.rdoc
 - lib/sf_cli.rb
-- lib/sf_cli/helper_methods.rb
 - lib/sf_cli/sf.rb
 - lib/sf_cli/sf/base.rb
 - lib/sf_cli/sf/data.rb
-- lib/sf_cli/sf/operations.rb
 - lib/sf_cli/sf/org.rb
 - lib/sf_cli/sf/project.rb
 - lib/sf_cli/sf/sobject.rb
 homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_url: https://github.com/tmkw/sf_cli
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -38,15 +39,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- 'Salesforce CLI ( >= 2.54.0): https://developer.salesforce.com/tools/salesforcecli'
 rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
-summary: A wrapper class library for Salesforce CLI
+summary: A library for using Salesforce CLI in Ruby
 test_files: []

data/lib/sf_cli/helper_methods.rb

@@ -1,26 +0,0 @@
-module SfCli
-  module HelperMethods
-    def os
-      @os ||= ENV['OS']
-    end
-
-    def null_stderr_redirection
-      @null_stderr_redirection ||=
-        if os.nil? || os.eql?('Windows_NT')
-          '2>nul'
-        else
-          '2> dev/null'
-        end
-    end
-
-    def flag(name, arg = nil, use_argument: true, long_flag: true)
-      flag_indicator = long_flag ? '--' : '-'
-
-      if use_argument
-        arg ? %(#{flag_indicator}#{name} #{arg}) : ''
-      else
-        %(#{flag_indicator}#{name})
-      end
-    end
-  end
-end

data/lib/sf_cli/sf/operations.rb

@@ -1,4 +0,0 @@
-require_relative './org'
-require_relative './data'
-require_relative './sobject'
-require_relative './project'