sf_cli 0.0.7 → 0.0.8

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 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.
@@ -16,15 +16,14 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- rdoc/ObjectModel.rdoc
-- rdoc/README.rdoc
-- CHANGELOG.md
+- README.rdoc
 files:
-- CHANGELOG.md
+- README.rdoc
 - lib/sf_cli.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/console.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,10 +54,12 @@ 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
-- rdoc/ObjectModel.rdoc
-- rdoc/README.rdoc
 homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT

data/CHANGELOG.md

@@ -1,57 +0,0 @@
-## 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.
-  - 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/lib/sf_cli/sf/console.rb

@@ -1,33 +0,0 @@
-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
-  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
-
-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/rdoc/ObjectModel.rdoc

@@ -1,83 +0,0 @@
-== \Object Model support
-=== generate Models
-  require 'sf_cli/sf/model'
-  require 'sf_cli/sf/model/sf_command_connection'
-
-  # first, you must prepare the connection
-  conn = SfCli::Sf::Model::SfCommandConnection.new target_org: your_org, instance_url: your_org_url
-
-  # then set it to Model module
-  SfCli::Sf::Model.set_connection conn
-
-  # generates some model classes (for example, Account and Contact)
-  SfCli::Sf::Model.generate %w[Account Contact]
-=== apply to sf command
-  rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
-
-  # the array object contains Contact object instances
-  rows.size  # 1
-  rows.first # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
-  rows.first.Name # Akin Kristen
-
-=== using models Independently
-==== initialize and save a record
-  c = Contact.new(:Name => "John Smith")
-  c.Name # "John Smith"
-  c.save
-
-==== find and update a record
-  # find by record ID and update
-  c2 = Contact.find(c.id)
-  c2.Name = "Johnny Smith"
-  c2.save # update
-
-==== delete a record
-  c2 = Contact.find(c.id)
-  c2.delete
-
-==== query and get a record
-  contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
-  contact # => #<Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
-  contact.Name # Akin Kristen
-
-  # these 2 example are the same meaning
-  Contact.select(Name).where(Name: 'John Smith', LastModifiedDate: :Yesterday).take
-  Contact.select(Name).where(Name: 'John Smith').where(LastModifiedDate: :Yesterday).take
-
-==== query and get records
-  contacts = Contact.select(:Id, :Name).where(LastModifiedDate: :Yesterday).all # get all records that is modified yesterday
-
-==== child-parent relationship
-  contact = Contact.select(:Id, :Name, "Account.Name").where(Name: 'Akin Kristen').take
-  contact # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen", @Account= #<Account @Name="Aethna Home Products">>
-  contact.Account.Name # Aethna Home Products
-
-==== parent-children relationship
-  account = Account.select(:Id, :Name, "(SELECT Name FROM Contacts)").take
-  account # <Account @Contacts=[#<Contact @Name="Akin Kristen">], @Id="0015j00001dsDuhAAE", @Name="Aethna Home Products">
-  account.Name             # Aethna Home Products
-  rows.Contacts            # [#<Contact @Name="Akin Kristen">]
-  rows.Contacts.first.Name # Akin Kristen
-
-==== get all fields in a record
-  # just by not using 'select' method
-  contact = Contact.find(record_id) # <Contact @Id="...", @Name="...", other fields...>
-
-==== time keywords such as 'yesterday' or 'LAST_N_DAYS:N' with symbol style
-  Contact.select(:Name).where(LastModifiedDate: :Yesterday).take       # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = Yesterday"
-  Contact.select(:Name).where(LastModifiedDate: :"LAST_N_DAYS:5").take # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = LAST_N_DAYS:5"
-
-==== array for 'IN' keyword
-  Contact.select(:Name).where(Name: ['Jonny Good', 'John Smith']).all # same as "SELECT Name FROM Contact WHERE Name IN ('Jonny Good', 'John Smith')"
-
-==== using partial soql directly
-  Contact.select("Id, Name").where("LastModifiedDate = LAST_N_DAYS:5").all
-
-==== ternary style
-  Contact.select(:Id, :Name).where(:LastModifiedDate, :>=, :"LAST_N_DAYS:5").all # SELECT Id, Name FROM Contact WHERE LastModifiedDate >= LAST_N_DAYS:5
-  Account.select(:Id, :Name).where(:Name, :LIKE, "%OIL%").all                    # SELECT Id, Name FROM Account WHERE Name LIKE '%OIL%'
-
-==== get schema
-  schema = Account.describe
-  schema.name # Account
-  schema.field_names # [Id, Name, ....]