alet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd98bfc5b916cdb44ed82a989ff245b3d9beb2d1a718b041daa04aec1c80d702
+  data.tar.gz: 63022319f768a23d3b8a263510e76ed9e757d5108141a8fd0998fc1c50c8b52b
+SHA512:
+  metadata.gz: eddff301a4933e57d9f319131926936fc7de7f6aef2cba066bc136d7233a43b34a49978ba8ef24729ccda52f0cdef96b954e8e381a3c17ae1e6c2639789d88d2
+  data.tar.gz: b931f8e9185e58c9ea0a4dd6285af06ec2fb0c2f3e2ab24eaf1d080438dcadbb15540d42eab82bea764fdee7fb5966dff751f4b9567485f4558e6b7eef79062e

data/bin/alet

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'alet/app'
+
+Alet::App.run(ARGV)

data/lib/alet/app.rb

@@ -0,0 +1,77 @@
+require 'gli'
+require 'irb'
+require 'alet/config'
+require 'alet/utils/irb'
+require 'alet/generate/project'
+require 'alet/version'
+require 'i18n'
+
+#
+# i18n settings
+#
+I18n.load_path += Alet.config.i18n.load_path
+I18n.default_locale = :en
+I18n.locale = /jp|JP|ja|ja_JP/.match?(ENV['LANG']) ? :ja : :en
+
+def t(indicator)
+  I18n.t(indicator)
+end
+
+module Alet
+  class App
+    extend GLI::App
+
+    using IRBUtils
+
+    program_desc t('cli.desc')
+    version Alet::VERSION
+
+    desc t('cli.target_org')
+    flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
+
+
+    desc t('cli.irb.desc')
+    command :irb do |c|
+      c.desc desc t('cli.target_org')
+      c.flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
+
+      c.example "alet", desc: t('cli.irb.example.default')
+      c.example "alet -o org", desc: t('cli.irb.example.target_org')
+
+      c.action do |global_options, options, args|
+        Alet.config.cli_options[:"target-org"] = global_options['target-org'] || options['target-org']
+        IRB.start(__FILE__, ['-r', 'alet/irb', '--noscript', global_options['target-org']])
+      end
+    end
+
+    desc t('cli.generate.desc')
+    command [:generate, :g] do |c|
+      c.desc desc t('cli.generate.project.desc')
+      c.arg_name 'project_name'
+      c.command :project do |prj|
+        prj.desc t('cli.generate.project.target_org')
+        prj.flag [:o, 'target-org'], default_value: nil, arg_name: 'org'
+
+        prj.desc t('cli.generate.project.manifest')
+        prj.switch [:m, :manifest], negatable: false
+
+        prj.desc t('cli.generate.project.open_editor')
+        prj.switch [:e, 'editor-open'], negatable: false
+
+        prj.desc t('cli.generate.project.retrieve')
+        prj.switch [:r, 'retrieve'], negatable: false
+
+        prj.example "alet generate project MyProject", desc: t('cli.generate.project.example.default')
+        prj.example "alet generate project MyProject -m", desc: t('cli.generate.project.example.manifest')
+        prj.example "alet generate project MyProject -m -o org", desc: t('cli.generate.project.example.from_org')
+        prj.example "alet generate project MyProject -mr -o org", desc:t('cli.generate.project.example.retrieve')
+
+        prj.action do |_, options, args|
+          Alet::Project.generate(args.first, **options)
+        end
+      end
+    end
+
+    default_command :irb
+  end
+end

data/lib/alet/config/locales/en.yml

@@ -0,0 +1,103 @@
+en:
+  cli:
+    desc:            A Ruby-styled Salesforce console utility
+    target_org:      Username or alias of the target org
+    irb:
+      desc:          start irb session(if there is no subcommand specified, irb gets default)
+      example:
+        default:     start irb session
+        target_org:  start irb session with specifying target org
+    generate:
+      desc:          generate resources that are related to Salesforce DX project
+      project:
+        desc:        generate salesforce DX project
+        target_org:  Username or alias of the target org, which the manifest and source files are generated based on
+        manifest:    Generate a manifest (package.xml)
+        retrieve:    Retrieve source files from org
+        open_editor: open editor(vs code) to edit the project
+        example:
+          default:   create a Salesfore DX project
+          manifest:  create a Salesfore DX project with manifest file (package.xml)
+          from_org:  The manifest file is built based on org
+          retrieve:  The manifest file and medadata source files are built based on org. This option is only available with -o option.
+  connection:
+    description: Current connection with Salesforce
+  apex:
+    description: Execute Apex code
+  gen:
+    description: Generate sObject classes
+    help: |
+      ## Name
+      gen
+
+      ## SYNOPSIS
+      gene sObjectType...
+
+      ## DESCRIPTION
+      generate sObject classes
+
+      ## ARGUMENTS
+      **sObjectType** sObject type
+
+      ## EXAMPLES
+      ```shell
+      gen Account Contact User
+  query:
+    description: Query by SOQL
+    help: |
+      ## NAME
+      query
+
+      ## SYNOPSIS
+      query SOQL
+
+      ## DESCRIPTION
+      query by SOQL
+
+      ## ARGUMENTS
+      **SOQL** - a SOQL query (SELECT statement)
+
+      ## EXAMPLE
+      ```shell
+      query SELECT Id, Name FROM Account Name LIKE '%hoge%'
+      ```
+  sh:
+    description: Excute shell command
+    help: |
+      ## NAME
+      sh
+
+      ## SYNOPSIS
+      sh [command]
+
+      ## DESCRIPTION
+      excute shell command
+
+      ## ARGUMENTS
+      **command** - shell command
+
+      If no command is specified, it starts interactive mode. To escape interactive mode, press CTRL-D
+
+      ## EXAMPLE
+      ```shell
+      sh ls -aF
+      ```
+  export:
+    description: Export sObject records
+    help: |
+      ## NAME
+      export
+
+      ## SYNOPSIS
+      export SOQL
+
+      ## DESCRIPTION
+      export sObject records. If it succeeds, a csv file is created.
+
+      ## ARGUMENTS
+      **SOQL** SOQL(SELECT statement)
+
+      ## EXAMPLE
+      ```shell
+      export SELECT Id, Name FROM Account
+      ```

data/lib/alet/config/locales/ja.yml

@@ -0,0 +1,104 @@
+ja:
+  cli:
+    desc:            RubyスタイルのSalesforceコンソールユーティリティ
+    target_org:      ユーザー名またはSF組織の別名
+    irb:
+      desc:          irbセッションを開始
+      example:
+        default:     irbセッションを開始.
+        target_org:  SF組織の別名またはログインユーザー名を指定してirbを起動
+    generate:
+      desc:          Salesforce DXプロジェクトに関連した資材を生成する
+      project:
+        desc:        salesforce DX projectを生成する
+        target_org:  マニフェストファイルとソースファイルの読み込み先となるSF組織の別名またはその組織のユーザー名
+        manifest:    マニフェストファイル(package.xml)を生成する
+        retrieve:    マニフェストファイルの内容を元にSF組織からソースファイルを取得する
+        open_editor: プロジェクト構築完了後、そのプロジェクトをカレントディレクトとしてvs codeを起動する
+        example:
+          default:   a Salesfore DXプロジェクトのディレクトリを作成する
+          manifest:  プロジェクトディレクトリにマニフェストファイル(package.xml)を含める
+          from_org:  接続組織のメタデータ情報を元にマニフェストファイルの内容を書き込む.
+          retrieve:  メタデータのソースファイルをDXプロジェクト内に生成する
+  connection:
+    description: 現在のSalesforce組織との接続情報
+  apex:
+    description: Apexコードを実行する
+  gen:
+    description: 1つ以上のsObjectクラスを生成する
+    help: |
+      ## Name
+      gen
+
+      ## SYNOPSIS
+      gen sObjectType...
+
+      ## DESCRIPTION
+      1つ以上のsObjectクラスを生成する
+
+      ## ARGUMENTS
+      **sObjectType** sObjectの型名
+
+      ## EXAMPLES
+      ```shell
+      gen Account Contact User
+      ```
+  query:
+    description: SOQLを使ってレコードを検索する 
+    help: |
+      ## NAME
+      query
+
+      ## SYNOPSIS
+      query SOQL
+
+      ## DESCRIPTION
+      SOQLを使ってレコードを検索する
+
+      ## ARGUMENTS
+      **SOQL** - SOQL(SELECT 構文)
+
+      ## EXAMPLE
+      ```shell
+      query SELECT Id, Name FROM Account Name LIKE '%hoge%'
+      ```
+  sh:
+    description: シェルコマンドを実行する
+    help: |
+      ## NAME
+      sh
+
+      ## SYNOPSIS
+      sh [command]
+
+      ## DESCRIPTION
+      シェルコマンドを実行する
+
+      ## ARGUMENTS
+      **command** - 実行するコマンドライン
+
+      コマンドを指定せずにEnterを押すとインタラクティブモードに移行する。インタラクティブモードから抜けるにはCTR-Dを押す
+
+      ## EXAMPLE
+      ```shell
+      sh ls -aF
+      ```
+  export:
+    description: レコードをエクスポートする
+    help: |
+      ## NAME
+      export
+
+      ## SYNOPSIS
+      export SOQL
+
+      ## DESCRIPTION
+      レコードをエクスポートする.正常に終了するとカレントディレクトリにCSVファイルが生成される.
+
+      ## ARGUMENTS
+      **SOQL** SOQL(SELECT構文)
+
+      ## EXAMPLE
+      ```shell
+      export SELECT Id, Name FROM Account
+      ```

data/lib/alet/config.rb

@@ -0,0 +1,31 @@
+module Alet
+  def self.config
+    @config ||= Config.new
+  end
+
+  class Config
+    def connection
+      @connection
+    end
+    alias conn connection
+
+    def connection=(conn)
+      @connection = conn
+    end
+    alias conn= connection=
+
+    def cli_options
+      @cli_options ||= {}
+    end
+
+    def i18n
+      @i18n ||= I18nConfig.new
+    end
+
+    class I18nConfig
+      def load_path
+        Dir[File.expand_path("../config/locales", __FILE__) + "/*.yml"]
+      end
+    end
+  end
+end

data/lib/alet/generate/project.rb

@@ -0,0 +1,22 @@
+require 'sf_cli'
+
+module Alet
+  module Project
+    def self.generate(project_name, params)
+      base_dir        = Dir.pwd
+      target_org      = params[:"target-org"]
+      retrieve_source = params[:retrieve]
+      editor          = params[:"editor-open"]
+
+      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
+      system 'code .' if editor
+    ensure
+      Dir.chdir base_dir
+    end
+  end
+end

data/lib/alet/irb/command/export.rb

@@ -0,0 +1,24 @@
+class Export < IRB::Command::Base
+  category "Alet"
+  description t('export.description')
+  help_message TTY::Markdown.parse t('export.help')
+
+  def execute(arg)
+    soql =
+      if /\ASELECT/.match?(arg.strip.upcase)
+        arg
+      else
+        object = eval(arg)
+        object.to_soql if object&.instance_of? Yamori::QueryMethods::QueryCondition
+      end
+
+    return if soql.nil?
+
+    csv = sf.data.query(soql, format: :csv, target_org: ::Alet.config.connection.alias)
+
+    filename = "#{Time.now.strftime('%Y%m%d%H%M%S')}_export.csv"
+    File.open(filename, 'w'){|f| f.write(csv) }
+
+    puts filename
+  end
+end

data/lib/alet/irb/command/generate_model.rb

@@ -0,0 +1,10 @@
+class GenerateModel < IRB::Command::Base
+  category "Alet"
+  description t('gen.description')
+  help_message TTY::Markdown.parse t('gen.help')
+
+  def execute(arg)
+    object_types = arg.split(' ').map{|s| s.tr(' ', '')}
+    Yamori.generate(*object_types)
+  end
+end

data/lib/alet/irb/command/query.rb

@@ -0,0 +1,21 @@
+require 'yamori/query_condition'
+
+class Query < IRB::Command::Base
+  category "Alet"
+  description t('query.description')
+  help_message TTY::Markdown.parse t('query.help')
+
+  def execute(arg)
+    soql =
+      if /\ASELECT/.match?(arg.strip.upcase)
+        arg
+      else
+        object = eval(arg)
+        object.to_soql if object&.instance_of? Yamori::QueryMethods::QueryCondition
+      end
+
+    return if soql.nil?
+
+    puts sf.data.query(soql, format: :human, target_org: ::Alet.config.connection.alias)
+  end
+end

data/lib/alet/irb/command/sh.rb

@@ -0,0 +1,18 @@
+class Shell < IRB::Command::Base
+  category "Alet"
+  description t('sh.description')
+  help_message TTY::Markdown.parse t('sh.help')
+
+  def execute(arg)
+    ::IRB.conf[:INSPECT_MODE] = false
+    return puts `#{arg}` if arg.size > 0
+
+    s = $stdin.gets
+    while s
+      puts `#{s}`
+      s = $stdin.gets
+    end
+  ensure
+    ::IRB.conf[:INSPECT_MODE] = true
+  end
+end

data/lib/alet/irb/helper_methods.rb

@@ -0,0 +1,45 @@
+require 'irb/helper_method/base'
+
+class CurrentConnection < IRB::HelperMethod::Base
+  description t('connection.description')
+
+  def execute
+    info = Alet.config.connection
+    table =
+      TTY::Table.new(rows: [
+        [:id, info.id],
+        [:alias, info.alias],
+        [:user_name, info.user_name],
+        [:status, info.status],
+        [:instance_url, info.instance_url],
+        [:api_version, info.api_version],
+        [:access_token, info.access_token]
+      ])
+    puts table.render :unicode
+  end
+end
+
+class Apex < IRB::HelperMethod::Base
+  description t('apex.description')
+
+  def execute(apex_code = nil, verbose: false)
+    result =
+      if apex_code
+        sf.apex.run target_org: Alet.config.conn.alias, file: StringIO.new(apex_code)
+      else
+        sf.apex.run target_org: Alet.config.conn.alias
+      end
+
+    IRB.conf[:INSPECT_MODE] = false
+    if verbose
+      result.logs.each{|line| puts line }
+    else
+      pastel = Pastel.new
+      result.logs.select{|line| line.include? "USER_DEBUG"}.each do |line|
+        match_result = /USER_DEBUG\|.+DEBUG\|(.+)\Z/.match(line)
+        puts pastel.cyan(match_result[1])
+      end
+    end
+    IRB.conf[:INSPECT_MODE] = true
+  end
+end

data/lib/alet/irb.rb

@@ -0,0 +1,48 @@
+require 'sf_cli'
+require 'yamori'
+require 'alet/config'
+require 'irb/command/base'
+require 'tty-markdown'
+require 'tty-table'
+require 'pastel'
+require 'i18n'
+
+I18n.locale = IRB.conf[:LC_MESSAGES].lang.to_sym
+
+#
+# load commands
+#
+require_relative 'irb/command/generate_model'
+require_relative 'irb/command/query'
+require_relative 'irb/command/sh'
+require_relative 'irb/command/export'
+
+IRB::Command.register :gen, GenerateModel
+IRB::Command.register :query, Query
+IRB::Command.register :export, Export
+IRB::Command.register :sh, Shell
+
+#
+# load helper methods
+#
+require_relative 'irb/helper_methods'
+
+IRB::HelperMethod.register(:conn, CurrentConnection)
+IRB::HelperMethod.register(:apex, Apex)
+
+
+#
+# set connection
+#
+conn = sf.org.display target_org: Alet.config.cli_options[:"target-org"]
+
+Alet.config.connection = conn
+
+sf.org.login_web target_org: conn.alias, instance_url: conn.instance_url unless conn.connected?
+
+Yamori.connect(
+  :rest,
+  instance_url: conn.instance_url,
+  access_token: conn.access_token,
+  api_version:  conn.api_version
+)

data/lib/alet/utils/irb.rb

@@ -0,0 +1,19 @@
+module IRBUtils
+  refine IRB do
+    def IRB.start(ap_path, argv)
+      STDOUT.sync = true
+      $0 = File::basename(ap_path, ".rb") if ap_path
+
+      setup(ap_path, argv: argv)
+
+      @CONF[:USE_COLORIZE] = false
+
+      if @CONF[:SCRIPT]
+        irb = ::IRB::Irb.new(nil, @CONF[:SCRIPT])
+      else
+        irb = ::IRB::Irb.new
+      end
+      irb.run(@CONF)
+    end
+  end
+end

data/lib/alet/version.rb

@@ -0,0 +1,3 @@
+module Alet
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: alet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takanobu Maekawa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.5
+- !ruby/object:Gem::Dependency
+  name: sf_cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: yamori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+description: Salesforce console utility for Ruby users
+email:
+executables:
+- alet
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/alet
+- lib/alet/app.rb
+- lib/alet/config.rb
+- lib/alet/config/locales/en.yml
+- lib/alet/config/locales/ja.yml
+- lib/alet/generate/project.rb
+- lib/alet/irb.rb
+- lib/alet/irb/command/export.rb
+- lib/alet/irb/command/generate_model.rb
+- lib/alet/irb/command/query.rb
+- lib/alet/irb/command/sh.rb
+- lib/alet/irb/helper_methods.rb
+- lib/alet/utils/irb.rb
+- lib/alet/version.rb
+homepage: https://github.com/tmkw/alet
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/tmkw/alet
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'Salesforce CLI ( >= 2.56.7): https://developer.salesforce.com/tools/salesforcecli'
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Ruby-styled Salesforce console utility
+test_files: []