sf_cli 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e80b705227bf6cc0a20eb798294a8179ac417b70ee1720626c34ede61c57f9
-  data.tar.gz: a47fae091fde1fa337f11a3265dc27703a14642ad3dc287dfb400f41f3e0fcdb
+  metadata.gz: c6cc1ab1222fe6f4c19b78853eed5a06c7e7f9047146b5f59a08a888fb369a54
+  data.tar.gz: f73f3784ed62def6460450fc6780f13fae73ae5d64ee7652b60379d50fcbc3e5
 SHA512:
-  metadata.gz: c4f31ede06a4efd8e9bf8e257712ffa2f5be05e0b7a06e79d7d5a056671480d06eaaaace79c5b2896ae4037ae53de46620a5337841b8e9c415397c70fffc9f59
-  data.tar.gz: 24a8d99be40d9f0df743dbe0839dd25c31c6d3870123f50f2b806d580c588e37578a7d2341c2eb8a73f3003748e8ddc0ef44f7315467a2e8c67841e0b65189c3
+  metadata.gz: 80a77af9028ef5fed8b195d79356c0df6fc3b304a5eab26b8d094333d9148097cabb51b21592091815dc1ae0b768a3f1dbd35b88d01921d02986e5ee9b43add4
+  data.tar.gz: 1dbc012a4c8b0895f00ac1f741c1262d6b7319de72c08ef5d92f61204acdbb4f052755dd596883a989addaae35589039623d3d82ca9eace7a3ca97ae38a8e291

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/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

@@ -42,6 +42,22 @@ module SfCli
           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

data/lib/sf_cli/version.rb

@@ -1,3 +1,3 @@
 module SfCli
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 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.1
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 2024-10-04 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