sf_cli 0.0.7.beta2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe11b6577f9c950bc7ebe9a602392f843462d2121e4b53bad470ae5fc88d70a
-  data.tar.gz: 7b8be5a7d4d7fe214968a41ed334df490c59fec0c1308c922b98c53d7e6d5bc4
+  metadata.gz: 98f07645a79ccfa6a8f8bbac048a4da5aae6f21bf294445a0888f861d91b8f27
+  data.tar.gz: a608a4eeb21ff2fd065cac874d6834e1a6c8aec83f9a40ada0f73917e4029ffb
 SHA512:
-  metadata.gz: e5dd28989b46ed7044bf01f872197f29a591b005e0d150dd526c97d2c5fdf1e543a7112d3ccdff5867f967800f1673f2073a0585bb06223d8b541f8ac2ae2873
-  data.tar.gz: 25a31b68eed96337d806721c42c24ad1452728c00f2db8577c93f211a2147fab61c9a8b692978f67df8b690ea8aa94bbf21fea5200e8b6ac4c1c2ad71062474b
+  metadata.gz: 9f5949bdba034feb1a7265a79fa9cd41c9e6f9d1402e4cf173fc585b0ab44d904570591382066633f5258f55503f0503410d648fb3700856029471678090efed
+  data.tar.gz: 32a39625a575b1f9e465d9090c1e63a0ec8ee8ed605c4f5c3104b3866121a931780cf7c2f82200ab84ca5924ff798790cf116cf9580280ab1e1e6a26458d1ef4

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 0.0.7 - 2024-09-19
+- NEW: add `sf.apex.run`
 ## 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.

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

@@ -0,0 +1,19 @@
+require_relative '../core/base'
+require_relative './run'
+
+module SfCli
+  module Sf
+    module Apex
+      #
+      # ==== description
+      # The class representing *sf* *apex*.
+      #
+      # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_apex_commands_unified.htm
+      #
+      class Core
+        include ::SfCli::Sf::Core::Base
+        include Run
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/apex/run.rb

@@ -0,0 +1,110 @@
+require 'tempfile'
+require 'stringio'
+
+module SfCli::Sf::Apex
+  module Run
+    #
+    # run apex code and returns its result
+    #
+    # *target_org* --- an alias of paticular org, or username can be used<br>
+    #
+    # *file* --- (1) path to a local file that contains \Apex code. (2) StringIO object
+    #
+    # == Examples
+    # Execute apex code in a file
+    #   result = sf.apex.run file: "path/to/apex"
+    #   result.success # true if the execution succeeds
+    #   result.logs    # execution log
+    #
+    # StringIO is usable instead of file path
+    #   require 'stringio'
+    #
+    #   pseudo_file = StringIO.new <<~EOS
+    #     Account acc = [SELECT Id, Name FROM Account Limit 1];
+    #     System.debug(acc.Name);
+    #   EOS
+    #
+    #   sf.apex.run target_org: :dev, file: pseudo_file
+    #
+    # == Interactive Mode
+    #
+    # If you don't specify *file* argument, it starts interactive mode that may be helpful in IRB environment.
+    #   irb(main:) > sf.apex.run target_org: :dev
+    #
+    #   Account acc = [SELECT Id, Name FROM Account LIMIT 1];
+    #   System.debug(acc.Name);
+    #   <press Ctrl-D>
+    #
+    #   =>
+    #   #<SfCli::Sf::Apex::Run::ApexResult:0x00007437b4e13218
+    #     @column=-1,
+    #     @compile_problem="",
+    #     @compiled=true,
+    #     @exception_message="",
+    #     @exception_stack_trace="",
+    #     @line=-1,
+    #     @logs=
+    #      ["61.0 APEX_CODE,DEBUG;APEX_PROFILING,INFO",
+    #       "Execute Anonymous: Account acc = [SELECT Id, Name FROM Account LIMIT 1];",
+    #       "Execute Anonymous: System.debug(acc.Name);",
+    #      ....]
+    # 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_apex_commands_unified.htm#cli_reference_apex_run_unified]
+    #
+    def run(target_org: nil, file: nil)
+      return run_interactive(target_org) if file.nil?
+      return run_by_io(target_org, file) if file.is_a? StringIO
+
+      return unless file.is_a? String
+
+      flags = {:"target-org" => target_org, :"file" => file}
+
+      json = exec(__method__, flags: flags, redirection: :null_stderr)
+      ApexResult.new(json['result'])
+    end
+
+    private
+
+    def run_by_io(target_org, io)
+      file = Tempfile.open(%w[sf apex]){|f| f.write(io.read); f}
+
+      flags = {:"target-org" => target_org, :"file" => file.path}
+      json = exec(:run, flags: flags, redirection: :null_stderr)
+      ApexResult.new(json['result'])
+    ensure
+      file&.close!
+    end
+
+    def run_interactive(target_org)
+      file = Tempfile.open(%w[sf apex]) do |f|
+               s = $stdin.gets
+               while s
+                 f.puts(s)
+                 s = $stdin.gets
+               end
+               f
+             end
+
+      flags = {:"target-org" => target_org, :"file" => file.path}
+
+      json = exec(:run, flags: flags, redirection: :null_stderr)
+      ApexResult.new(json['result'])
+    ensure
+      file&.close!
+    end
+
+    class ApexResult
+      attr_reader :success, :compiled, :compile_problem, :exception_message, :exception_stack_trace, :line, :column, :logs
+
+      def initialize(attributes)
+        @success = attributes['success']
+        @compiled = attributes['compiled']
+        @compile_problem = attributes['compileProblem']
+        @exception_message = attributes['exceptionMessage']
+        @exception_stack_trace = attributes['exceptionStackTrace']
+        @line = attributes['line']
+        @column = attributes['column']
+        @logs = attributes['logs'].chomp.split("\n")
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/console.rb

@@ -1,6 +1,7 @@
 require 'sf_cli'
 require 'sf_cli/sf/model'
 require 'sf_cli/sf/model/sf_command_connection'
+require 'stringio'
 
 def sf_init(org_alias)
   org_info = sf.org.display target_org: org_alias
@@ -20,7 +21,13 @@ def target_org
   connection.target_org
 end
 
+def apex(apex_code)
+  sf.apex.run target_org: target_org, file: StringIO.new(apex_code)
+end
+
 alias :sfinit :sf_init
 alias :gen    :generate
 alias :conn   :connection
 alias :org    :target_org
+
+sfinit ARGV[0]

data/lib/sf_cli/sf/main.rb

@@ -14,7 +14,7 @@ module SfCli
     class Main
       include Singleton
 
-      OPERATION_CATEGORIES = %w[Org Sobject Data Project]
+      OPERATION_CATEGORIES = %w[Org Sobject Data Project Apex]
 
       OPERATION_CATEGORIES.each do |category|
         require_relative %(#{category.downcase}/core)

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

@@ -123,7 +123,7 @@ module SfCli
           end
 
           def take
-            all.first
+            limit(1).all.first
           end
 
           def select_fields

data/{README.rdoc → rdoc/ObjectModel.rdoc}

@@ -1,53 +1,4 @@
-= 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.
-
-== prerequisite
-Salesforce CLI must be installed.<br>
-As of as of September in 2024, ver.2.56.7 is the development target.
-
-== install
-==== Rubygem
-  $ gem install sf_cli
-
-==== Bundler
-in Gemfile:
-  gem 'sf_cli'
-
-then,
-  $ bundle install
-
-== Examples
-=== Since 0.0.4
-  require 'sf_cli'
-
-  # login to org
-  sf.org.login_web
-
-  # get records
-  sf.data.query 'SELECT Id, Name FROM Account LIMIT 1' # => [{Id: "abc", Name: "account name"}]
-
-  # generate a Salesforce DX project
-  sf.project.generate 'MyProject'
-
-=== Before 0.0.3
-  require 'sf_cli/sf'
-
-  sf = SfCli::Sf.new
-
-  # login to org
-  sf.org.login_web
-
-  # get Account records
-  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
-  
-  # generate a Salesforce DX project
-  sf.project.generate 'MyProject'
-
-== \Object Model support (experimental, since 0.0.4)
+== \Object Model support
 === generate Models
   require 'sf_cli/sf/model'
   require 'sf_cli/sf/model/sf_command_connection'
@@ -130,12 +81,3 @@ then,
   schema = Account.describe
   schema.name # Account
   schema.field_names # [Id, Name, ....]
-
-== Documents
-The following steps generate *doc* directory, which all documents are generated in.
-  $ git clone https://github.com/tmkw/sf_cli.git
-  $ cd sf_cli
-  $ bundle install
-  $ bundle exec rake rdoc
-
-*Or*, you can read the same documents online at {rubygems.org}[https://rubygems.org/gems/sf_cli]

data/rdoc/README.rdoc

@@ -0,0 +1,79 @@
+= 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.
+
+== prerequisite
+Salesforce CLI 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
+== Documents
+Class Library Reference::
+    {Online document}[https://www.rubydoc.info/gems/sf_cli/0.0.7] at rubygems.org
+
+    Or,
+    Generate locally:
+      $ git clone https://github.com/tmkw/sf_cli.git
+      $ cd sf_cli
+      $ bundle install
+      $ bundle exec rake rdoc
+    *As* *of* *0.0.7*, *this* *may* *be* *better* *to* *know* *what* *it* *is* *exactly*.
+Salesforce CLI and Sf command::
+    1. {Salesforce CLI reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm]
+    2. {sf command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm]
+
+== Short Examples
+  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', timeout: 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
+As of now, there is experimental support for object model in Salesforce.
+=== Short examples
+===== 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 with model independently
+  contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
+  contact.Name # Akin Kristen
+For more details, take a look at {the object model section}[link://files/rdoc/ObjectModel_rdoc.html]

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.7.beta2
+  version: 0.0.7
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-09-18 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
+- rdoc/ObjectModel.rdoc
+- rdoc/README.rdoc
 - CHANGELOG.md
 files:
 - CHANGELOG.md
-- README.rdoc
-- bin/sfc
 - lib/sf_cli.rb
+- lib/sf_cli/sf/apex/core.rb
+- lib/sf_cli/sf/apex/run.rb
 - lib/sf_cli/sf/console.rb
 - lib/sf_cli/sf/core/base.rb
 - lib/sf_cli/sf/data/bulk_result_v2.rb
@@ -57,6 +57,8 @@ files:
 - lib/sf_cli/sf/project/core.rb
 - lib/sf_cli/sf/sobject/core.rb
 - lib/sf_cli/sf/sobject/schema.rb
+- rdoc/ObjectModel.rdoc
+- rdoc/README.rdoc
 homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT

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