sf_cli 0.0.7.beta2 → 0.0.8

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

@@ -1,82 +1,20 @@
 require_relative '../core/base'
+require_relative './generate'
+require_relative './generate_manifest'
 
 module SfCli
   module Sf
+    #
+    # Project Commands
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm command reference
+    #
     module Project
-      # ==== 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
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
-
-        GenerateResult = Struct.new(:output_dir, :files, :raw_output, :warnings)
-
-        #
-        # generate a Salesforce project
-        #
-        # *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
-        #
-        # For more command details, see the {reference document}[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]
-        #
-        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
-        #
-        # *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)
-        #
-        # ======
-        #  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
-        #
-        # For more command details, see the {reference document}[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]
-        #
-        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
+        include Generate
+        include GenerateManifest
       end
     end
   end

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

@@ -0,0 +1,35 @@
+module SfCli::Sf::Project
+  module Generate
+    GenerateResult = Struct.new(:output_dir, :files, :raw_output, :warnings)
+
+    #
+    # Generate a Salesforce project
+    # @param name       [Symbol,String] project name
+    # @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)
+    #
+    # @return [GenerateResult] 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)
+      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
+  end
+end

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

@@ -0,0 +1,31 @@
+module SfCli::Sf::Project
+  module GenerateManifest
+    # Generate the manifest file of a Salesforce DX project
+    # @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)
+    # @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)
+    #
+    # @example
+    #  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
+    #
+    # @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)
+      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

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

@@ -1,57 +1,20 @@
 require_relative '../core/base'
-require_relative './schema'
+require_relative './describe'
+require_relative './list'
 
 module SfCli
   module Sf
+    #
+    # SObject Commands
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm command reference
+    #
     module Sobject
-      # ==== 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
-      #
+      # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
-
-        # returns a schema object containing the Salesforce object schema
-        #
-        # *objectType* --- object type (ex: Account)<br>
-        #
-        # *target_org* --- an alias of paticular org, or username can be used<br>
-        #
-        # ======
-        #   schema = sf.sobject.describe :Account
-        #   schema.name  # Account
-        #   schema.label # Account
-        #   schema.field_names # [:Id, :Name, ....]
-        #   schema.fields[:Name] # => {"aggregatable"=>true, "aiPredictionField"=>false, "autoNumber"=>false,...}
-        #
-        # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_describe_unified]
-        #
-        def describe(object_type, target_org: nil)
-          flags    = {
-            :"sobject"    => object_type,
-            :"target-org" => target_org,
-          }
-          json = exec(__method__, flags: flags, redirection: :null_stderr)
-          Schema.new(json['result'])
-        end
-
-        # returns a list of Salesforce object name
-        #
-        # *object_type* --- all or custom<br>
-        #
-        # *target_org* --- an alias of paticular org, or username can be used<br>
-        #
-        # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_list_unified]
-        #
-        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
+        include Describe
+        include List
       end
     end
   end

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

@@ -0,0 +1,29 @@
+require_relative './schema'
+
+module SfCli::Sf::Sobject
+  module Describe
+    # Returns a schema object containing the 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
+    #
+    # @return [Schema] a schema object that represents the object schema
+    #
+    # @example
+    #   schema = sf.sobject.describe :Account
+    #   schema.name  # Account
+    #   schema.label # Account
+    #   schema.field_names # [:Id, :Name, ....]
+    #   schema.fields[:Name] # => {"aggregatable"=>true, "aiPredictionField"=>false, "autoNumber"=>false,...}
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_describe_unified command reference
+    #
+    def describe(object_type, target_org: nil)
+      flags    = {
+        :"sobject"    => object_type,
+        :"target-org" => target_org,
+      }
+      json = exec(__method__, flags: flags, redirection: :null_stderr)
+      Schema.new(json['result'])
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module SfCli::Sf::Sobject
+  module List
+    # Returns a list of Salesforce object name
+    # @param object_type [Symbol,String] 'all' or 'custom'
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_list_unified command reference
+    #
+    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

data/lib/sf_cli.rb

@@ -1,18 +1,11 @@
 require 'sf_cli/sf/main'
-#
-# the global method that represents *sf* command.
+
+# The global method that represents *sf* command.
 #
 # With method chaining, you can use similar syntax as original command.
-#
-# == examples
-#
-# ======
-#   sf.org.display # => returns the org information object
-#
-# ======
-#   sf.data.query "SELECT Name FROM Account" # => [{"Name"=>"Aethna Home Products"}]
-#
-# For details of sf command, see the {reference guide}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm]
+# @example
+#   sf.org.display                           # returns the org information object
+#   sf.data.query "SELECT Name FROM Account" # [{"Name"=>"Aethna Home Products"}]
 #
 def sf
   SfCli::Sf::Main.instance

metadata

@@ -1,30 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.7.beta2
+  version: 0.0.8
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies: []
 description: This is a class library for introducing Salesforce CLI to Ruby scripting.
   Currenty only sf command is the target of development.
 email:
-executables:
-- sfc
+executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
-- CHANGELOG.md
 files:
-- CHANGELOG.md
 - README.rdoc
-- bin/sfc
 - lib/sf_cli.rb
-- lib/sf_cli/sf/console.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/data/bulk_result_v2.rb
 - lib/sf_cli/sf/data/core.rb
@@ -55,7 +54,11 @@ files:
 - lib/sf_cli/sf/org/list.rb
 - lib/sf_cli/sf/org/login.rb
 - lib/sf_cli/sf/project/core.rb
+- lib/sf_cli/sf/project/generate.rb
+- lib/sf_cli/sf/project/generate_manifest.rb
 - lib/sf_cli/sf/sobject/core.rb
+- lib/sf_cli/sf/sobject/describe.rb
+- lib/sf_cli/sf/sobject/list.rb
 - lib/sf_cli/sf/sobject/schema.rb
 homepage: https://github.com/tmkw/sf_cli
 licenses:

data/CHANGELOG.md

@@ -1,55 +0,0 @@
-## 0.0.6 - 2024-09-16
-- NEW: Object Model Support renewal;
-  - `SfCli::Sf::Model.connection` represents the connection to Salesforce. It can be set by `set_connection` class method in the module. As of now there is only `SfCommandConnection`, which is based on sf command, as connection adapter. After the connection is set by `set_connection`, it is also automatically set to classes when `SfCli::Sf::Model.generate` method is called.
-  - Each object model class has `create` class method for creating a new record.
-  - Each object model has `#save` and `#delete` instance methods to create, update and delete the record it represents.
-  - Each object class has query interface such as `where`, `select`, `limit` and `order` methods that can be chainable.
-  - Each object class has query interface such as `find`, `all`, `take` and `pluck`.
-- CHANGE: `sf.sobject.describe` changed to return `schema` object.
-## 0.0.5 - 2024-09-08
-- CHANGE: target CLI version is changed: from 2.54.6 to 2.56.7
-- NEW: new command features are added;
-  - `--bulk` option to `sf.data.query`
-  - `sf.data.query_resume`
-  - `sf.data.upsert_bulk`
-  - `sf.data.upsert_resume`
-  - `sf.data.delete_bulk`
-  - `sf.data.delete_resume`
-  - `sf.data.resume`
-  - `sf.data.search`
-  - `sf.org.list`
-  - `sf.login_access_token`
-  - `--browser` option to `sf.login_web`
-## 0.0.4 - 2024-09-02
-- breaking change:
-  - Sf class doesn't exist anymore. You can not write like `sf = SfCli::Sf.new`. Instead of that,  global `sf` method is introduced. You can directly type like `sf.org.display`, which is as almost same usability as the original command. 
-- sf data query:
-  - support child-parent relationship
-  - support parent-children relationship
-  - add `--result-format` option
-- auto generation of \Object Model (experimental)
-  - generates SF \Object Classes automatically
-  - relationship is supported
-
-## 0.0.3 - 2024-08-25
-add command operations:
-
-- sf data get record
-- sf data create record
-- sf data update record
-- sf data delete record
-
-## 0.0.2 - 2024-08-18
-this version up was made by mistake.
-nothing was changed.
-
-## 0.0.1 - 2024-08-18
-support some command operations:
-
-- sf org login web
-- sf display
-- sf data query
-- sf sobject describe
-- sf sobject list
-- sf project generate
-- sf project generate manifest

data/bin/sfc

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rake'
-
-Rake.application.init
-Rake.application.define_task(Rake::Task, :default) { system('irb -r sf_cli/sf/console') }
-Rake.application.top_level

data/lib/sf_cli/sf/console.rb

@@ -1,26 +0,0 @@
-require 'sf_cli'
-require 'sf_cli/sf/model'
-require 'sf_cli/sf/model/sf_command_connection'
-
-def sf_init(org_alias)
-  org_info = sf.org.display target_org: org_alias
-  conn = SfCli::Sf::Model::SfCommandConnection.new target_org: org_alias, instance_url: org_info.instance_url
-  SfCli::Sf::Model.set_connection conn
-end
-
-def generate(*object_types)
-  SfCli::Sf::Model.generate object_types
-end
-
-def connection
-  SfCli::Sf::Model.connection
-end
-
-def target_org
-  connection.target_org
-end
-
-alias :sfinit :sf_init
-alias :gen    :generate
-alias :conn   :connection
-alias :org    :target_org