sf_cli 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 415eb0ebdf5cd6f1ca904271f4e0f15eef2a99342259d46a9eb7dd32b5e59024
-  data.tar.gz: 754bca7f1db6ecbd376e49e20f659d8dd9c06185cfe1f19d08b783baf028e744
+  metadata.gz: e9e80b705227bf6cc0a20eb798294a8179ac417b70ee1720626c34ede61c57f9
+  data.tar.gz: a47fae091fde1fa337f11a3265dc27703a14642ad3dc287dfb400f41f3e0fcdb
 SHA512:
-  metadata.gz: 296de6697a2e850a5971a7c338c508154e6f640a4573be0240dd66cf6485b5209bfd6844c69362a6c9611e6519839825f38e76eabbcc64ea32d1036dbc523b96
-  data.tar.gz: ea6ce0fce6cbfae46ffcf54a79c22065ffc97f5bd061e6f761337391dbafb16ee04fe4cd110d77505422820c88b8e11a386ac69f22cd1c00862e5b0884cbd53e
+  metadata.gz: c4f31ede06a4efd8e9bf8e257712ffa2f5be05e0b7a06e79d7d5a056671480d06eaaaace79c5b2896ae4037ae53de46620a5337841b8e9c415397c70fffc9f59
+  data.tar.gz: 24a8d99be40d9f0df743dbe0839dd25c31c6d3870123f50f2b806d580c588e37578a7d2341c2eb8a73f3003748e8ddc0ef44f7315467a2e8c67841e0b65189c3

data/README.rdoc

@@ -67,7 +67,7 @@ Doing the same thing independently:
 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
+  $ sf_cli -i
   > sf.query "SELECT Id, Name FROM Case", target_org: :your_org
 
 Object Model is also available:
@@ -80,3 +80,15 @@ There are some other console commands:
   > 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

data/bin/sf_cli

@@ -1,7 +1,35 @@
 #!/usr/bin/env ruby
 
-require 'rake'
+require 'optparse'
+require 'sf_cli'
+require 'sf_cli/version'
 
-Rake.application.init
-Rake.application.define_task(Rake::Task, :default) { system('irb -r sf_cli/console') }
-Rake.application.top_level
+def generate_project(project_name, params)
+  base_dir        = Dir.pwd
+  target_org      = params[:"target-org"]
+  retrieve_source = params[:retrieve]
+
+  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.retrieve_start manifest: 'manifest/package.xml', target_org: target_org if retrieve_source
+ensure
+  Dir.chdir base_dir
+end
+
+params = {}
+opt = OptionParser.new
+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.parse!(ARGV, into: params)
+
+if params[:generate] == 'project'
+  generate_project(ARGV[0], params)
+end

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

@@ -1,6 +1,7 @@
 require_relative '../core/base'
 require_relative './generate'
 require_relative './generate_manifest'
+require_relative './retrieve_start'
 
 module SfCli
   module Sf
@@ -9,13 +10,13 @@ module SfCli
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm command reference
     #
-    # @private :nodoc: just for developers
     module Project
       # @private :nodoc: just for developers
       class Core
         include ::SfCli::Sf::Core::Base
         include Generate
         include GenerateManifest
+        include RetrieveStart
       end
     end
   end

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

@@ -1,6 +1,6 @@
 module SfCli::Sf::Project
   module Generate
-    GenerateResult = Struct.new(:output_dir, :files, :raw_output, :warnings)
+    Result = Struct.new(:output_dir, :files, :raw_output, :warnings)
 
     #
     # Generate a Salesforce project
@@ -9,7 +9,7 @@ module SfCli::Sf::Project
     # @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
+    # @return [Result] 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
     #
@@ -24,7 +24,7 @@ module SfCli::Sf::Project
       }
       json = exec(__method__, flags: flags, switches: switches, redirection: :null_stderr)
 
-      GenerateResult.new(
+      Result.new(
         output_dir: json['result']['outputDir'],
         files:      json['result']['created'],
         raw_output: json['result']['rawOutput'],

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

@@ -0,0 +1,92 @@
+module SfCli::Sf::Project
+  module RetrieveStart
+    Result = Data.define(:done, :file_properties, :id, :status, :success, :messages, :files) do
+        def success?
+          success
+        end
+      end
+    FileProperty = 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)
+    RetrievedFile = Data.define(:full_name, :type, :state, :file_path)
+
+    # Retrieve metadata from an org to your local project.
+    # @param manifest            [String]        path of the manifest file(package.xml) that specifies the components to retrieve
+    # @param metadata            [Array]         metadata names that specifies the components to retrieve
+    # @param source_dir          [String]        file or directory path to retrieve from the org.
+    # @param package_name        [Array]         package names to retrieve
+    # @param target_org          [Symbol,String] an alias of paticular org, or username can be used
+    # @param output_dir          [String]        directory root for the retrieved source files
+    # @param api_version         [Numeric]       override the api version used for api requests made by this command
+    # @param wait                [Integer]       number of minutes to wait for command to complete
+    # @param ignore_conflicts    [Boolean]       ignore conflicts and retrieve and save files to your local filesystem
+    # @param single_package      [Boolean]       indicates that the zip file points to a directory structure for a single package
+    # @param unzip               [Boolian]       number of minutes to wait for command to complete
+    # @param target_metadata_dir [String]        indicates that the zip file points to a directory structure for a single package
+    # @param zip_file_name       [String]        file name to use for the retrieved zip file
+    #
+    # @return [Result] the retsult of the command
+    #
+    # @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_retrieve_start_unified command reference
+    #
+    def retrieve_start(metadata: nil, manifest: nil,  source_dir: nil, package_name: nil, target_org: nil, output_dir: nil,
+      api_version: nil, wait: nil, target_metadata_dir: nil, zip_file_name: nil, ignore_conflicts: false, single_package: false, unzip: false)
+
+      flags = {
+        :manifest              => manifest,
+        :metadata              => metadata&.join(' '),
+        :"source-dir"          => source_dir,
+        :"package-name"        => package_name&.join(' '),
+        :"target-org"          => target_org,
+        :"output-dir"          => output_dir,
+        :"api-version"         => api_version,
+        :"wait"                => wait,
+        :"target-metadata-dir" => target_metadata_dir,
+        :"zip-file-name"       => zip_file_name,
+      }
+      switches = {
+        :"ignore-conflicts" => ignore_conflicts,
+        :"single-package" => single_package,
+        :"unzip" => unzip,
+      }
+      action = __method__.to_s.tr('_', ' ')
+      json = exec(action, flags: flags, switches: switches, redirection: :null_stderr)
+
+      Result.new(
+        done:            json['result']['done'],
+        file_properties: json['result']['fileProperties'].map{|fp| create_file_property(fp)},
+        id:              json['result']['id'],
+        status:          json['result']['status'],
+        success:         json['result']['success'],
+        messages:        json['result']['messages'],
+        files:           json['result']['files'].map{|f| create_retrieved_file(f)}
+      )
+    end
+
+    private
+
+    def create_file_property(hash)
+      FileProperty.new(
+        created_by_id:         hash['createdById'],
+        created_by_name:       hash['createdByName'],
+        created_date:          hash['createdDate'],
+        file_name:             hash['fileName'],
+        full_name:              hash['fullName'],
+        id:                    hash['id'],
+        last_modified_by_id:   hash['lastModifiedById'],
+        last_modified_by_name: hash['lastModifiedByName'],
+        last_modified_date:    hash['lastModifiedDate'],
+        manageable_state:      hash['manageableState'],
+        type:                  hash['type']
+      )
+    end
+
+    def create_retrieved_file(hash)
+      RetrievedFile.new(
+        full_name: hash['fullName'],
+        type:      hash['type'],
+        state:     hash['state'],
+        file_path: hash['filePath']
+      )
+    end
+  end
+end

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

@@ -395,8 +395,18 @@ module SfCli
             field["permissionable"]
           end
 
+          PicklistValue = Data.define(:active, :default_value, :label, :valid_for, :value)
+
           def picklist_values
-            field["picklistValues"]
+            field["picklistValues"].map do |value|
+              PicklistValue.new(
+                active:        value['active'],
+                default_value: value['defaultValue'],
+                label:         value['label'],
+                valid_for:     value['validFor'],
+                value:         value['value'],
+              )
+            end
           end
 
           def polymorphic_foreign_key?

data/lib/sf_cli/version.rb

@@ -0,0 +1,3 @@
+module SfCli
+  VERSION = '1.2.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 2024-10-01 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.
@@ -61,10 +61,12 @@ files:
 - 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/project/retrieve_start.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
+- lib/sf_cli/version.rb
 homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT