sf_cli 1.0.0.beta2 → 1.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59be3ef9caa559c104e1aeeee112637716428a2eaf573f04aecedef5aab7c58d
-  data.tar.gz: baf6694c9d1b3ab897b381ba053201e839b76bcba97efa69a440270167c26460
+  metadata.gz: a2cc80df9cc280f3fa0eda5ec72a2972ac5f036d3e9e407030668d984eab92c4
+  data.tar.gz: d8cd2eb983c18f81825d8bc83fa7cdee78b6c9c725970873d40ed42b52dd0ce4
 SHA512:
-  metadata.gz: c21e490286e01927720ec9582b99e8d26ac59f8e876a52be1c07adbf100647b802d1abfdbba55cdf1869c2ed21a83940087531bdd99862ac4c2d1c2c397a7fbe
-  data.tar.gz: 770d34b4a20fbf4af0c0525e7ea0af27e9834dea6b4a15251b7b3f87f4744ed789d8d021e79d877e789ed7558bf597df8e4b0e06829ff6f99cbab1d4ff6585dc
+  metadata.gz: 06153a22706b868d9100f7f2f4f980c3847ee73d793f6649574ebaecf4c68f1bf21245217c432382669448a9f23bf6867772fe5853f1795dcafaa4f28a1428a5
+  data.tar.gz: 929bca993b4acf6c6a52d07ebe8adcbaa77dfa4b691ce72049e6a71d00e32a1bd79ee7c6211fe083d8d669959166bf3c82f68e7fa9f72eea7548165f7752e37a

data/lib/sf_cli/console/commands.rb

@@ -8,27 +8,31 @@ module SfCli
   module Console
     #
     # Developer Console commands
-    # @example
-    #  $ bundle exec rake irb[your_target_org]
-    #  irb(main):001> gen :Account, :Contact  # generate Account and Contact class
-    #  => [:Account, :Contact]
-    #
-    #  irb(main):002> Account.describe.label
-    #  => "Account"
-    #
-    #  irb(main):003> apex "System.debug('abc');" # execute Apex code
-    #  => returns the result
     #
     module Commands
       def use(_target_org)
         target_org = _target_org.to_sym == :default ? nil : _target_org
         org_info = sf.org.display target_org: target_org
+        raise "The connection is not ready. Please check by `sf org list`" unless org_info.connected?
+
         conn = SfCli::Sf::Model::SfCommandConnection.new target_org: target_org, instance_url: org_info.instance_url
         SfCli::Sf::Model.set_connection conn
+
+        available_models.each do |model|
+          Object.const_get(model).connection = conn
+        end
+
+        true
+      end
+
+      def available_models
+        @available_models ||= []
       end
 
       def generate(*object_types)
         SfCli::Sf::Model.generate object_types
+        available_models.append(*object_types).flatten
+        object_types
       end
 
       def connection
@@ -45,8 +49,63 @@ module SfCli
         sf.apex.run target_org: target_org, file: StringIO.new(apex_code)
       end
 
+      def query(soql)
+        conf.inspect_mode = false
+        puts sf.data.query(soql, format: :human, target_org: target_org)
+        conf.inspect_mode = true
+      end
+
       alias :gen  :generate
       alias :conn :connection
+
+      def help(command = nil)
+        conf.inspect_mode = false
+        puts <<~HELP
+          Available commands:
+            use   --- set current org
+            gen   --- generate Object model classes
+            query --- Query by SOQL with human readable format
+            apex  --- run Apex code
+            conn  --- show current connection setting
+
+          Syntax:
+            [use]
+              use target-org
+
+              parameters:
+                targat-org --- Username or alias of the org you are going to use.
+
+            [gen]
+              gen object-name, object-name, ...
+              generate object-name, object-name, ...
+
+              parameters:
+                object-name --- Comma separated Names. Symbol or String can be OK. At least 1 object name is required. 
+
+              example:
+                gen :Account, :Contact, :User
+
+            [query]
+              query SOQL
+
+                parameters:
+                  SOQL --- soql
+
+            [apex]
+              apex apex_code
+
+              parameters:
+                apex code --- Apex code you want to execute
+
+              example:
+                apex "System.debug('abc');"
+
+            [conn]
+                conn
+                connection
+        HELP
+        conf.inspect_mode = true
+      end
     end
   end
 end

data/lib/sf_cli/console.rb

@@ -2,4 +2,4 @@ require 'sf_cli/console/commands'
 
 include SfCli::Console::Commands
 
-use ARGV[0]
+use ARGV[0] if ARGV[0]

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

@@ -1,6 +1,10 @@
 module SfCli::Sf::Org
   module Display
-    ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
+    ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status) do
+        def connected?
+          status == 'Connected'
+        end
+      end
 
     #
     # Returns the org's connection information

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Takanobu Maekawa
@@ -14,13 +14,13 @@ description: A class library for introducing Salesforce CLI to Ruby scripting. C
   only sf command is the target of development.
 email:
 executables:
-- sfdc
+- sf_cli
 extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
 - README.rdoc
-- bin/sfdc
+- bin/sf_cli
 - lib/sf_cli.rb
 - lib/sf_cli/console.rb
 - lib/sf_cli/console/commands.rb