sf_cli 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c83fc3297315182771f73c3ff599bfdd9abcff1c72a401d69bc8a734e9c7cd17
-  data.tar.gz: 8ed2425d43258abcc43e7ba9ec0dadf1cc18474d47ea286b38998b564cd68e6d
+  metadata.gz: 415eb0ebdf5cd6f1ca904271f4e0f15eef2a99342259d46a9eb7dd32b5e59024
+  data.tar.gz: 754bca7f1db6ecbd376e49e20f659d8dd9c06185cfe1f19d08b783baf028e744
 SHA512:
-  metadata.gz: f97ab229a3000ac570e2d46ccaf393a6f64fd5717587449dede15c149286624b2b37356f7ef5bbe23772a8e8f14519d291b3addfab0114b5963c5831d7f3d604
-  data.tar.gz: fb431e461147f16d9a2bac7cf13970f011dc53d77f936dd09a60ed47b2b28259722c3457f435136bfae03673d4bb8df6099ff234852fd03d16c221cf284fe481
+  metadata.gz: 296de6697a2e850a5971a7c338c508154e6f640a4573be0240dd66cf6485b5209bfd6844c69362a6c9611e6519839825f38e76eabbcc64ea32d1036dbc523b96
+  data.tar.gz: ea6ce0fce6cbfae46ffcf54a79c22065ffc97f5bd061e6f761337391dbafb16ee04fe4cd110d77505422820c88b8e11a386ac69f22cd1c00862e5b0884cbd53e

data/README.rdoc

@@ -79,4 +79,4 @@ 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` for the help of all console commands
+Type *help* to know all console commands

data/lib/sf_cli/console/commands.rb

@@ -54,6 +54,12 @@ module SfCli
         conf.inspect_mode = true
       end
 
+      def orgs
+        conf.inspect_mode = false
+        system 'sf org list'
+        conf.inspect_mode = true
+      end
+
       alias :gen  :generate
       alias :conn :connection
 
@@ -66,6 +72,7 @@ module SfCli
             query --- Query by SOQL with human readable format
             apex  --- run Apex code
             conn  --- show current connection setting
+            orgs  --- show the list of org
 
           Syntax:
             [use]
@@ -74,6 +81,9 @@ module SfCli
               parameters:
                 targat-org --- Username or alias of the org you are going to use. If you are not sure about them, check by `sf org list`.
 
+              example:
+                use :your_org_alias
+
             [gen]
               gen object-name, object-name, ...
               generate object-name, object-name, ...
@@ -88,13 +98,16 @@ module SfCli
               query SOQL
 
                 parameters:
-                  SOQL --- soql
+                  SOQL --- soql.You must quote it like "SELECT ...."
+
+              example:
+                query "SELECT Id, Name FROM Account LIMIT 3"
 
             [apex]
               apex apex_code
 
               parameters:
-                apex code --- Apex code you want to execute
+                apex code --- Apex code you want to execute.You must quote the code.
 
               example:
                 apex "System.debug('abc');"
@@ -102,6 +115,9 @@ module SfCli
             [conn]
                 conn
                 connection
+
+            [orgs]
+                orgs
         HELP
         conf.inspect_mode = true
       end

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

@@ -2,6 +2,9 @@ require_relative '../core/base'
 require_relative './login'
 require_relative './display'
 require_relative './list'
+require_relative './list_metadata_types'
+require_relative './list_metadata'
+require_relative './list_limits'
 
 module SfCli
   module Sf
@@ -17,6 +20,9 @@ module SfCli
         include Login
         include Display
         include List
+        include ListMetadataTypes
+        include ListMetadata
+        include ListLimits
       end
     end
   end

data/lib/sf_cli/sf/org/display.rb

@@ -8,8 +8,8 @@ module SfCli::Sf::Org
 
     #
     # Returns the org's connection information
-    # @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
+    # @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
     #
     # @note this function returns the org information including security sensitive things such as access token, username and so on.
     # @return [ConnectionInfo] the org's connection information

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

@@ -32,21 +32,21 @@ module SfCli::Sf::Org
     # List orgs you’ve created or authenticated to
     #
     # @note this function returns org information including security sensitive things such as access token, username and so on.
-    # @return [OrgConfig] the org configulation
+    # @return [Array] the org configulations
     #
     # @example
-    #   org_config_list = sf.org.list        # returns a list of OrgConfig
+    #   org_configs = sf.org.list        # returns a list of OrgConfig
     #
-    #   org_config.first.accesstoken         # returns the access token
-    #   org_config.first.instance_url        # returns the org's url
+    #   org_configs.first.accesstoken         # returns the access token
+    #   org_configs.first.instance_url        # returns the org's url
     #
-    #   org_config.first.conncected?         # check the connection status
-    #   org_config.first.devhub?             # check if the org is devhub or not
-    #   org_config.first.scratch?            # check if the org is scratch or not
-    #   org_config.first.default?            # check if the org is default or not
-    #   org_config.first.default_devhub?     # check if the org is devhub default or not
+    #   org_configs.first.conncected?         # check the connection status
+    #   org_configs.first.devhub?             # check if the org is devhub or not
+    #   org_configs.first.scratch?            # check if the org is scratch or not
+    #   org_configs.first.default?            # check if the org is default or not
+    #   org_configs.first.default_devhub?     # check if the org is devhub default or not
     #
-    # 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_org_commands_unified.htm#cli_reference_org_list_unified]
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_unified command reference
     #
     def list
       flags = {

data/lib/sf_cli/sf/org/list_limits.rb

@@ -0,0 +1,56 @@
+module SfCli::Sf::Org
+  module ListLimits
+    #
+    # Returns the metadata types that are enabled for 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
+    #
+    # @return [Limits] the list of limit information
+    #
+    # @example
+    #  limits = sf.org.list_limits
+    #  limits.names                   #=> ["ActiveScratchOrgs","AnalyticsExternalDataSizeMB", ...]
+    #  limits.find :ActiveScratchOrgs #=> <Limit: name="ActiveScratchOrgs", remaining=3, max=3>
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_limits_unified command reference
+    #
+    def list_limits(target_org: nil, api_version: nil)
+      flags    = {
+        :"target-org"    => target_org,
+        :"api-version"   => api_version,
+      }
+      action = __method__.to_s.tr('_', ' ')
+      json = exec(action, flags: flags, redirection: :null_stderr)
+
+      Limits.new(json['result'])
+    end
+
+    Limit = Data.define(:name, :remaining, :max)
+
+    class Limits
+      include Enumerable
+
+      def initialize(list)
+        @list = list.map {|limit| Limit.new(**limit)}
+      end
+
+      def each(&block)
+        list.each(&block)
+      end
+
+      def names
+        list.map(&:name)
+      end
+
+      def find(name)
+        list.find{|m| m.name == name.to_s}
+      end
+
+      private
+
+      def list
+        @list
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/org/list_metadata.rb

@@ -0,0 +1,91 @@
+module SfCli::Sf::Org
+  module ListMetadata
+    #
+    # Returns the metadata types that are enabled for your org.
+    # @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
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
+    # @param output_file [String]        pathname of the file in which to write the results
+    #
+    # @return [MetadataList] the list of metadata, which contains its name, its source file path and so on
+    #
+    # @example
+    #  list = sf.org.list_metadata :ApexClass
+    #  list.names                        #=> ["CommunitiesLandingController","SiteLoginControllerTest", ...]
+    #  list.find :MyProfilePageController #=> <Metadata: full_name="MyProfilePageController" ...>
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_metadata_unified command reference
+    #
+    def list_metadata(metadata, folder: nil, target_org: nil, api_version: nil, output_file: nil)
+      flags    = {
+        :"metadata-type" => metadata,
+        :"folder"        => folder,
+        :"target-org"    => target_org,
+        :"api-version"   => api_version,
+        :"output-file"   => output_file,
+      }
+      action = __method__.to_s.tr('_', ' ')
+      json = exec(action, flags: flags, redirection: :null_stderr)
+
+      MetadataList.new(json['result'])
+    end
+
+    Metadata = Data.define(
+      :created_by_id,
+      :created_by_name,
+      :created_date,
+      :file_name,
+      :full_name,
+      :id,
+      :last_modified_by_id,
+      :last_modified_by_name,
+      :last_modified_date,
+      :manageable_state,
+      :type) do
+        def name
+          full_name
+        end
+      end
+
+    class MetadataList
+      include Enumerable
+
+      def initialize(metadata_list)
+        @list = metadata_list.map do |m|
+          Metadata.new(
+            created_by_id:         m['createdById'],
+            created_by_name:       m['createdByName'],
+            created_date:          m['createdDate'],
+            file_name:             m['fileName'],
+            full_name:             m['fullName'],
+            id:                    m['id'],
+            last_modified_by_id:   m['lastModifiedById'],
+            last_modified_by_name: m['lastModifiedByName'],
+            last_modified_date:    m['lastModifiedDate'],
+            manageable_state:      m['manageableState'],
+            type:                  m['type']
+          )
+        end
+      end
+
+      def each(&block)
+        list.each(&block)
+      end
+
+      def names
+        list.map(&:name)
+      end
+
+      def find(name)
+        list.find{|m| m.name == name.to_s}
+      end
+
+      private
+
+      def list
+        @list
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/org/list_metadata_types.rb

@@ -0,0 +1,85 @@
+module SfCli::Sf::Org
+  module ListMetadataTypes
+    #
+    # Returns the metadata types that are enabled for 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
+    # @param output_file [String]        pathname of the file in which to write the results
+    #
+    # @return [Result] the command's output
+    #
+    # @example
+    #  result = sf.org.list_metadata_types target_org: :dev
+    #  result.metadata_objects.names #=> ["InstalledPackage","CustomLabels", ...]
+    #
+    # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_list_metadata-types_unified command reference
+    #
+    def list_metadata_types(target_org: nil, api_version: nil, output_file: nil)
+      flags    = {
+        :"target-org" => target_org,
+        :"api-version" => api_version,
+        :"output-file" => output_file,
+      }
+      action = __method__.to_s.tr('_', '-').sub('-', ' ')
+      json = exec(action, flags: flags, redirection: :null_stderr)
+
+      Result.new(
+        metadata_objects:       MetadataObjects.new(json['result']['metadataObjects']),
+        organization_namespace: json['result']['organizationNamespace'],
+        partial_save_allowed:   json['result']['partialSaveAllowed'],
+        test_required:          json['result']['testRequired']
+      )
+    end
+
+    MetadataObject = Data.define(:directory_name, :in_folder, :meta_file, :suffix, :xml_name, :child_xml_names) do
+        def name
+          xml_name
+        end
+
+        def in_folder?
+          in_folder
+        end
+
+        def meta_file?
+          meta_file
+        end
+      end
+
+    Result = Data.define(:metadata_objects, :organization_namespace, :partial_save_allowed, :test_required)
+
+    class MetadataObjects
+      include Enumerable
+
+      def initialize(metadata_objects)
+        @metadata_objects = metadata_objects.map do |mo|
+          MetadataObject.new(
+            directory_name:  mo['directoryName'],
+            in_folder:       mo['inFolder'],
+            meta_file:       mo['metaFile'],
+            suffix:          mo['suffix'],
+            xml_name:        mo['xmlName'],
+            child_xml_names: mo['childXmlNames']
+          )
+        end
+      end
+
+      def each(&block)
+        metadata_objects.each(&block)
+      end
+
+      def names
+        metadata_objects.map(&:name)
+      end
+
+      def find(name)
+        metadata_objects.find{|mo| mo.name == name.to_s}
+      end
+
+      private
+
+      def metadata_objects
+        @metadata_objects
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/org/login.rb

@@ -21,28 +21,31 @@ module SfCli::Sf::Org
       exec(action, flags: flags)
     end
 
+    # @note This method doesn't support user interactive mode, so *SF_ACCESS_TOKEN* environment variable must be set before calling this method.
     # Login to the org by access token.
-    # @note This method doesn't support user interactive mode, so *SF_ACCESS_TOKEN* environment variable must be set before call this method.
+    #
+    # If you don't set *SF_ACCESS_TOKEN* in the code, you have to set it outside of the script:
+    #
+    # In Unix/mac
+    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx'
+    #   $ ruby app_using_sfcli.rb
+    # OR
+    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx' ruby app_using_sfcli.rb
+    #
+    # In Windows
+    #   > set SF_ACCESS_TOKEN=xxxxxxxxxx
+    #   > ruby app_using_sfcli.rb
     #
     # @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.
     #
     # @example
-    #  ENV['SF_ACCESS_TOKEN'] = 'xxxxxxxxxx'
-    #  sf.org.login_access_token instance_url: https://hoge.bar.baz.salesforce.com
-    #
-    # How to set env variable outside of Ruby::
-    #   In Unix/mac::
-    #     $ SF_ACCESS_TOKEN='xxxxxxxxxx'
-    #     $ ruby app_using_sfcli.rb
-    #   OR
-    #     $ SF_ACCESS_TOKEN='xxxxxxxxxx' ruby app_using_sfcli.rb
-    #   In Windows::
-    #     $ set SF_ACCESS_TOKEN=xxxxxxxxxx
-    #     $ ruby app_using_sfcli.rb
+    #   ENV['SF_ACCESS_TOKEN'] = 'xxxxxxxxxx'
+    #   sf.org.login_access_token instance_url: 'https://hoge.bar.baz.salesforce.com'
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_access-token_unified command reference
     #
+    #
     def login_access_token(instance_url:, target_org: nil)
       flags = {
         :"instance-url" => instance_url,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-09-29 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.
@@ -54,6 +54,9 @@ files:
 - lib/sf_cli/sf/org/core.rb
 - lib/sf_cli/sf/org/display.rb
 - lib/sf_cli/sf/org/list.rb
+- lib/sf_cli/sf/org/list_limits.rb
+- lib/sf_cli/sf/org/list_metadata.rb
+- lib/sf_cli/sf/org/list_metadata_types.rb
 - lib/sf_cli/sf/org/login.rb
 - lib/sf_cli/sf/project/core.rb
 - lib/sf_cli/sf/project/generate.rb