alet 0.1.2 → 0.2.0

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

@@ -7,41 +7,48 @@ ja:
       example:
         default:     irbセッションを開始.
         target_org:  SF組織の別名またはログインユーザー名を指定してirbを起動
-    generate:
-      desc:          Salesforce DXプロジェクトに関連した資材を生成する
-      project:
+    project:
+      desc:          Salesforce DXプロジェクトの生成・更新を行う
+      open_editor: プロジェクト構築/更新完了後、そのプロジェクトをカレントディレクトとしてvs codeを起動する
+      generate:
         desc:        salesforce DX projectを生成する
         target_org:  マニフェストファイルとソースファイルの読み込み先となるSF組織の別名またはその組織のユーザー名
         manifest:    マニフェストファイル(package.xml)を生成する
         retrieve:    マニフェストファイルの内容を元にSF組織からソースファイルを取得する
-        open_editor: プロジェクト構築完了後、そのプロジェクトをカレントディレクトとしてvs codeを起動する
         example:
-          default:   a Salesfore DXプロジェクトのディレクトリを作成する
+          default:   Salesfore DXプロジェクトのディレクトリを作成する
           manifest:  プロジェクトディレクトリにマニフェストファイル(package.xml)を含める
           from_org:  接続組織のメタデータ情報を元にマニフェストファイルの内容を書き込む.
           retrieve:  メタデータのソースファイルをDXプロジェクト内に生成する
-  connection:
-    description: 現在のSalesforce組織との接続情報
+      update:
+        desc:        現在接続中のSF組織の内容でマニフェストとソースファイルを更新する
   apex:
     description: Apexコードを実行する
-  gen:
-    description: 1つ以上のsObjectクラスを生成する
+  model:
+    description: 生成済みモデルクラスの表示.またはsobjectクラスの生成
+    list:
+      noclass:     現セッション内で生成済みのSObjectModelクラスはありません
+      title:       【生成済みのSObjectModelクラス】
     help: |
       ## Name
-      gen
+      model
 
       ## SYNOPSIS
-      gen sObjectType...
+      model [list|load sObjectType...]
 
       ## DESCRIPTION
-      1つ以上のsObjectクラスを生成する
+      1. セッション内で既に生成済みのsobjectクラスの一覧表示
+      2. 1つ以上のsobjectクラスを生成する
 
       ## ARGUMENTS
-      **sObjectType** sObjectの型名
+      **list** sobjectクラスの一覧表示.何も引数を指定しない場合はこの挙動を実行する.
+      **load sObjectType...** 1つ以上のsObjectクラスを生成する(sObjectTypeはsobjectの型名)
 
       ## EXAMPLES
       ```shell
-      gen Account Contact User
+      model  # 生成済みsobjectクラスの一覧表示
+      model list # 同上
+      model load Account Contact User # 取引先、取引先責任者およびユーザーオブジェクトのモデルクラスを生成
       ```
   query:
     description: SOQLを使ってレコードを検索する 
@@ -103,3 +110,244 @@ ja:
       ```shell
       export SELECT Id, Name FROM Account
       ```
+  org:
+    description: 現在のSalesforce組織との接続情報
+    help: |
+      ## NAME
+      org
+
+      ## SYNOPSIS
+      org
+
+      ## DESCRIPTION
+      現在のSalesforce組織との接続情報を表示する
+  grep:
+    description: オブジェクト(sObject)を探す
+    help: |
+      ## NAME
+      grep
+
+      ## SYNOPSIS
+      grep [-ln] regexp
+
+      ## DESCRIPTION
+      ラベルもしくはAPI名のどちらかでオブジェクト(sObject)の存在を探す。
+      sObjectであれば全てが検索対象となる。
+
+      ## ARGUMENTS
+      **regexp** オブジェクトのラベルまたはAPI名を示す正規表現
+
+      ## OPTIONS
+      **-l, [---label]**    ラベル名のみで探す
+      **-n, [---api-name]** API名のみで探す
+
+      ## EXAMPLE
+      ```shell
+      grep Account
+      grep -n Account*
+      ```
+  desc:
+    description: オブジェクトの概要を表示する
+    table:
+      field: 【項目】
+      relation: 【参照関係】
+      record_type: 【レコードタイプ】
+    column:
+      label: ラベル
+      name:  API名
+      type:  データ型
+      relation_name:  リレーション名
+      relation_type:  種別
+      relation_class: クラス名
+      relation_field: 項目名
+      record_type_name: レコードタイプ名
+      record_type_id:   レコードタイプID
+      record_type_developer_name: developer name
+    relation_type:
+      parent: 子-親
+      child: 親-子
+    error:
+      notfound: 該当するオブジェクトがありません
+    help: |
+      ## NAME
+      desc
+
+      ## SYNOPSIS
+      desc [-rta] object-name
+
+      ## DESCRIPTION
+      オブジェクトの概要を表示する
+
+      ## ARGUMENTS
+      **object-name** オブジェクト名(API名)
+
+      ## OPTIONS
+      **-r, [---relation]** リレーションを表示
+      **-t, [---record-type]** レコードタイプを表示
+      **-a, [---all]** 全ての概要を表示
+
+      もし何もオプションが指定されなければ各項目の概要を表示する
+
+      ## EXAMPLE
+      ```shell
+      desc Account     # 取引先の項目を表示する
+      desc -r Account  # 取引先のリレーションを表示する
+      ```
+  conn:
+    description: SF組織に対する接続設定の表示または設定
+    invalid_subcommand: 指定されたサブコマンドは利用できません
+    help: |
+      ## NAME
+      conn
+
+      ## SYNOPSIS
+      conn [reset]
+
+      ## DESCRIPTION
+      引数なしで呼び出したときは各種接続設定を表示する。
+      resetサブコマンドが指定されたときは、現在接続しているSF組織への接続を更新する。
+  gen:
+    description: Salesforce DXプロジェクトの資材を生成する
+    error:
+      no_subcommand: サブコマンドを指定してください
+      invalid_subcommand: 利用できないサブコマンドです
+      file_duplicated: 同名のコンポーネントがあります。ファイルを作成できません。
+    help: |
+      ## NAME
+      gen
+
+      ## SYNOPSIS
+      `gen sub-command ...`
+
+      ## DESCRIPTION
+      Salesforce DXプロジェクトの資材を生成する
+
+      ## ARGUMENTS
+      サブコマンドを指定する。サブコマンドごとに必要な引数は異なる。
+      **apex** ApexクラスまたはApexトリガーのソースファイルを生成する
+      **lwc** LWCのソースファイルを生成する
+
+      ### apex サブコマンド
+
+      #### SYNOPSIS
+      `gen apex [-t|-e event1,event2,...|-o object-name] name`
+
+      #### DESCRIPTION
+      ApexクラスまたはApexトリガーのソースファイルを生成する。Salesforce DXプロジェクトのルートディレクトリで実行した場合、所定のディレクトリにファイルを生成する.
+
+      #### ARGUMENTS
+      `name` ApexクラスまたはApexトリガーの名前
+
+      #### OPTIONS
+      `-t`, `--trigger` トリガーのソースファイルを生成する
+      `-o`, `--sobject` トリガーが機能するオブジェクト
+      `-e`, `--event` トリガーが機能するイベント。複数のイベントを指定する場合はカンマでつなぐこと。スペースを入れてはならない(例: bi,bu)。
+
+      ##### eventで利用可能な値
+
+      |値|意味|
+      |bi|before insert|
+      |ai|after insert|
+      |bu|before update|
+      |au|after update|
+      |bd|before delete|
+      |ad|after delete|
+      |aud|after undelete|
+
+      #### EXAMPLE
+      ```shell
+      gen apex MyClass1 # MyClassという名前のApexクラスのソースファイルを生成
+      gen apex MyTrigger --trigger # MyTriggerという名前のトリガーのソースファイルを生成
+      gen apex -t MyTrigger -o Account # トリガーのオブジェクトにAccount(取引先)オブジェクトを指定
+      gen apex -t MyTrigger --event bi,au # トリガーのイベントに before insertとafter update を指定
+      ```
+
+      ### lwc サブコマンド
+
+      #### SYNOPSIS
+      `gen lwc [-l label|-d description|-e|-t target1,target2,...|-o object1,object2,...] name`
+
+      #### DESCRIPTION
+      LWC(Lightning Web Component)を構成するファイルをローカルプロジェクト内に生成する。
+      Salesforce DXプロジェクトのルートディレクトリで実行することが前提で、それ以外の場所で実行すると基本的にエラーとなる。
+
+      #### ARGUMENTS
+      `name` LWCの名前
+
+      #### OPTIONS
+      `-l`, `--label` LWC設定ファイルの`masterLabel`セクションの内容を指定する
+      `-d`, `--description` LWC設定ファイルの`description`セクションの内容を指定する
+      `-e`, `--exposed` LWC設定ファイルの`isExposed`セクションの内容を指定する。デフォルトはfalse。
+      `-t`, `--target` LWC設定ファイルの`targets`セクションの内容を指定する。複数設定する場合はカンマ区切りで指定すること。
+      `-o`, `--object` LWC設定ファイルの`object`セクションの内容を指定する。`target`に**record**を指定したときにのみ有効。複数設定する場合はカンマ区切りで指定すること。
+
+      ##### targetオプションの値
+
+      |値    |意味                   |
+      |app   |lightning__AppPage     |
+      |flow  |lightning__FlowScreen  |
+      |home  |lightning__HomePage    |
+      |action|lightning__RecordAction|
+      |record|lightning__RecordPage  |
+      |tab   |lightning__Tab         |
+      |bar   |lightning__UtilityBar  |
+
+      #### EXAMPLE
+      ```shell
+      gen lwc LWC1 # LWC1という名前のLWCソースファイルを生成
+      gen lwc LWC1 -l "my first LWC"
+      gen lwc LWC1 -d "this is my first LWC"
+      gen lwc LWC1 -t app,home,record # LWCの利用可能範囲をアプリケーションページ、ホームページ、レコードページに指定
+      gen lwc LWC1 -o Account -t record # LWCの利用可能範囲をAccountのレコードページに指定
+      ```
+
+      #### SEE ALSO
+      [XML設定ファイルの要素](https://developer.salesforce.com/docs/platform/ja-jp/lwc/guide/reference-configuration-tags.html)
+  deploy:
+    description: プロジェクトの資材をSalesforce組織にアップロードする
+    error:
+      no_arguments: 引数を指定してください
+    help: |
+      ## NAME
+      deploy
+
+      ## SYNOPSIS
+      `deploy [-d|-t test1,test2...|-l test-level] component-type component-name...`
+
+      ## DESCRIPTION
+      ローカルプロジェクトの資材をSF組織にアップロードする
+
+      ## ARGUMENTS
+      `component-type` コンポーネントの種類。`file` かそれ以外を指定する。`file`以外で指定できる値は各メタデータタイプ名もしくは短縮名。
+      `component-name` コンポーネントの名前。コンポーネントの種類が`file`の場合、この名前はファイルパスまたはディレクトリパスである必要がある。コンポーネントの種類が`file`以外ならワイルドカード(*)も使用できる。
+
+      ### コンポーネント短縮名の一覧
+
+      |短縮名|メタデータタイプ名|
+      |apex|ApexClass|
+      |trigger|ApexTrigger|
+      |lwc|LightningComponentBundle|
+
+      メタデータタイプ名はsfコマンドで確認できる。(`sf org list metadata-type`)
+
+      ## OPTIONS
+      `-d`, `--dryrun`　実際にアップロードはせず、アップロードの検証のみ行う
+      `-l`, `--test-level` アップロード時に実行するApexテストの種類を指定する。
+      `-t`, `--tests` アップロード時に実行するテスト。`test-level`が`RunSpecifiedTests`のときにのみ有効。複数指定するときはカンマ区切りでつなぐこと。
+      `-m`, `--manifest` マニフェストファイルの内容に従ってプロジェクトのファイルをアップロードする。`component-type`が`file`のときのみ有効。このオプションが指定されると`component-name`は無視される。
+
+      ### test-levelで利用可能な値
+
+      |値|意味|
+      |RunSpecifiedTests|指定された個別のテストのみ実行|
+      |RunLocalTests|managed packageを除く組織内のテストを全て実行|
+      |RunLocalTests|managed packageを含む全ての組織内テストを実行|
+
+      ## EXAMPLE
+      ```shell
+      deploy apex MyClass1
+      deploy lwc myLWC
+      deploy apex MyClass --test-level RunSpecifiedTests --tests test1,test2
+      deploy file -m manifest/package.xml
+      deploy file force-app/main/default/class/MyClass1.cls
+      ```

data/lib/alet/config.rb

@@ -1,18 +1,12 @@
 module Alet
-  def self.config
-    @config ||= Config.new
-  end
-
   class Config
-    def connection
-      @connection
+    def org
+      @org
     end
-    alias conn connection
 
-    def connection=(conn)
-      @connection = conn
+    def org=(org)
+      @org = org
     end
-    alias conn= connection=
 
     def cli_options
       @cli_options ||= {}

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

@@ -0,0 +1,25 @@
+require_relative '../shared_functions'
+
+class Conn < IRB::Command::Base
+  category "Alet"
+  description t('conn.description')
+  help_message TTY::Markdown.parse t('conn.help')
+
+  def execute(arg)
+    argv = arg.split(' ')
+    if argv.empty?
+      puts '【Current Org settings】'
+      show_org_settings
+      puts '【Rest Client settings】'
+      show_rest_client_settings
+      return
+    end
+
+    case argv.first
+    when 'reset'
+      reset_connection
+    else
+      puts t('conn.invalid_subcommand')+ ": #{argv.first}"
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'optparse'
+require 'shellwords'
+
+class Deploy < IRB::Command::Base
+  category "Alet"
+  description t('deploy.description')
+  help_message TTY::Markdown.parse t('deploy.help')
+
+  def execute(arg)
+    pastel = Pastel.new
+    argv = Shellwords.shellsplit(arg)
+
+    opts = OptionParser.new
+    opts.on('-m manifest-file', '--manifest')
+    opts.on('-d', '--dryrun')
+    opts.on('-l test-level', '--test-level')
+    opts.on('-t test1,test2,...', '--tests')
+
+    if argv.empty?
+      puts pastel.red(t('deploy.error.no_arguments'))
+      return
+    end
+
+    params = {}
+    opts.parse!(argv, into: params)
+    component_type = argv.shift
+
+    options = {
+      dry_run: params[:dryrun] || false,
+      tests: params[:tests]&.split(','),
+      test_level: params[:"test-level"]
+    }
+
+    puts component_type # for debug
+    puts argv           # for debug
+    puts params         # for debug
+    puts options        # for debug
+
+    if component_type == 'file'
+      deploy_file(argv, params[:manifest], options)
+    else
+      deploy_component(component_type, argv, options)
+    end
+  rescue => e
+    puts pastel.red(e.message)
+  end
+
+  def deploy_file(argv, manifest, options)
+    if manifest
+      sf.project.deploy_start manifest: manifest, target_org: Alet.config.org.alias, raw_output: true, **options
+    else
+      sf.project.deploy_start source_dir: argv.first, target_org: Alet.config.org.alias, raw_output: true, **options
+    end
+  end
+
+  def deploy_component(component_type, argv, options)
+    return if argv.empty?
+
+    type_alias = {
+      'apex' => 'ApexClass',
+      'trigger' => 'ApexTrigger',
+      'lwc' => 'LightningComponentBundle',
+    }
+
+    metadata_names =
+      argv.map do |name|
+        metadata_type = type_alias[component_type] || component_type
+        %|"#{metadata_type}:#{name}"|
+      end
+
+    sf.project.deploy_start metadata: metadata_names, target_org: Alet.config.org.alias, raw_output: true, **options
+  end
+end

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

@@ -0,0 +1,131 @@
+require 'optparse'
+require 'stringio'
+require 'irb/pager'
+require 'sobject_model/schema'
+
+class Describe < IRB::Command::Base
+  category "Alet"
+  description t('desc.description')
+  help_message TTY::Markdown.parse t('desc.help')
+
+  def execute(arg)
+    pastel = Pastel.new
+    argv = arg.split(' ')
+    opt = OptionParser.new
+    opt.on '-r', '--relation'
+    opt.on '-t', '--record-type'
+    opt.on '-a', '--all'
+
+    params = {}
+    opt.parse(argv, into: params)
+
+    object_type = argv.first
+
+    schema = SObjectModel::Schema.new(Alet.describe(object_type.to_sym))
+
+    if params.has_key?(:relation)
+      show_relations(schema)
+    elsif params.has_key?(:"record-type")
+      show_record_types(schema)
+    elsif params.has_key?(:all)
+      show_all(schema)
+    else
+      show_fields(schema)
+    end
+  rescue SObjectModel::Rest::RequestError => e
+    puts pastel.red(e.message)
+  rescue SObjectModel::Rest::RecordNotFoundError => e
+    puts pastel.red(t('desc.error.notfound'))
+  end
+
+  def show_fields(schema)
+    table = create_field_table(schema)
+    sio = StringIO.new
+    sio << t('desc.table.field')
+    sio << "\n"
+    sio << table.render(:unicode)
+    IRB::Pager.page_content(sio.string)
+  end
+
+  def show_relations(schema)
+    table = crate_relation_table(schema)
+    sio = StringIO.new
+    sio << t('desc.table.relation')
+    sio << "\n"
+    sio << table.render(:unicode)
+    IRB::Pager.page_content(sio.string)
+  end
+
+  def show_record_types(schema)
+    table = create_record_type_table(schema)
+    sio = StringIO.new
+    sio << t('desc.table.record_type')
+    sio << "\n"
+    sio << table.render(:unicode)
+    IRB::Pager.page_content(sio.string)
+  end
+
+  def show_all(schema)
+    field_table = create_field_table(schema)
+    relation_table = crate_relation_table(schema)
+    record_type_table = create_record_type_table(schema)
+
+    sio = StringIO.new
+    sio << t('desc.table.field')
+    sio << "\n"
+    sio << field_table.render(:unicode)
+    sio << "\n"
+    sio << "\n"
+    sio << t('desc.table.relation')
+    sio << "\n"
+    sio << relation_table.render(:unicode)
+    sio << "\n"
+    sio << "\n"
+    sio << t('desc.table.record_type')
+    sio << "\n"
+    sio << record_type_table.render(:unicode)
+    IRB::Pager.page_content(sio.string)
+  end
+
+  def create_field_table(schema)
+    rows = []
+    schema.fields.each do |f|
+      if f.picklist_values.empty?
+        rows << [f.label, f.name, f.type, '']
+      else
+        f.picklist_values.each_with_index do |pv, i|
+          next unless pv.active
+          if i == 0
+            rows << [f.label, f.name, f.type, %|#{f.label}/#{pv.value}|]
+          else
+            rows << ['', '', '', %|#{f.label}/#{pv.value}|]
+          end
+        end
+      end
+    end
+
+    TTY::Table.new(
+      [t('desc.column.label'), t('desc.column.name'), t('desc.column.type'), ''],
+      rows)
+  end
+
+  def crate_relation_table(schema)
+    rows =
+      schema.parent_relations.map{|r| [r[:name], t('desc.relation_type.parent'), r[:class_name], r[:field]]} +
+      schema.child_relations.map{|r| [r[:name], t('desc.relation_type.child'), r[:class_name], r[:field]]}
+
+    TTY::Table.new(
+      [t('desc.column.relation_name'), t('desc.column.relation_type'), t('desc.column.relation_class'), t('desc.column.relation_field')],
+      rows)
+  end
+
+  def create_record_type_table(schema)
+    rows  = schema.record_types
+            .select{|rt| rt.active && rt.available}
+            .map{|rt| [rt.name, rt.recordTypeId, rt.developerName]}
+
+    TTY::Table.new(
+      [t('desc.column.record_type_name'), t('desc.column.record_type_id'), t('desc.column.record_type_developer_name')],
+      rows)
+  end
+end

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

@@ -14,7 +14,7 @@ class Export < IRB::Command::Base
 
     return if soql.nil?
 
-    csv = sf.data.query(soql, format: :csv, target_org: ::Alet.config.connection.alias)
+    csv = sf.data.query(soql, format: :csv, target_org: ::Alet.config.org.alias)
 
     filename = "#{Time.now.strftime('%Y%m%d%H%M%S')}_export.csv"
     File.open(filename, 'w'){|f| f.write(csv) }

data/lib/alet/irb/command/gen/apex.rb

@@ -0,0 +1,36 @@
+def gen_apex(argv, params)
+  return if argv.empty?
+
+  name = argv.first
+
+  base_dir = Dir.pwd
+  dx_dir = 'force-app/main/default'
+  dir = if FileTest.exist?(%|#{base_dir}/#{dx_dir}|)
+          %|#{base_dir}/#{dx_dir}/#{params[:trigger] ? 'triggers' : 'classes'}|
+        else
+          base_dir
+        end
+
+  if FileTest.exist?(%|#{dir}/#{name}#{params[:trigger] ? '.trigger' : '.cls'}|)
+    pastel = Pastel.new
+    puts pastel.red(t('gen.error.file_duplicated'))
+    return
+  end
+
+  if params[:trigger]
+    event_map = {
+      'bi' => 'before insert',
+      'bu' => 'before update',
+      'bd' => 'before delete',
+      'ai' => 'after insert',
+      'au' => 'after update',
+      'ad' => 'after delete',
+      'aud' => 'after undelete',
+    }
+    events = params[:event]&.split(',')&.map{|e| event_map[e]}&.compact
+    sf.apex.generate_trigger name, output_dir: dir, sobject: params[:sobject], event: events
+  else
+    sf.apex.generate_class name, output_dir: dir
+    sf.apex.generate_class %|#{name}Test|, output_dir: dir, template: :ApexUnitTest
+  end
+end