sf_cli 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c53d056727e589cb48d79aced7900a9419015ad0840e59b5f4d25361a31468ad
-  data.tar.gz: 491d45e9ce3907f931d07526eb37f9698e8c5b4cd95ffb3f38317244d99ea656
+  metadata.gz: 1996a0f93b6d2f48ea8762961526eab00df5601c902f2ec81f21331382973e56
+  data.tar.gz: da4da9fe6855d6f44f7995d932e6f658565b6e41091bd4c908e651a8286ece95
 SHA512:
-  metadata.gz: a49220a708a8cab60b8ae22f09b4ac805c6b405c3ae0821809012d0cb4d3b34bfd66f69a3429ae4ed70799a0a6cd793c9edcd52e71b2811aaf7a887bdb8db075
-  data.tar.gz: dc8d5efe8ea8001212d448ca71fe874b61625960a6daea6163d459d9603c0d5ccbbf1b8c4795694495e4b1b963100113dd02e9dba56160322e3ab27ebcada2b3
+  metadata.gz: 36743c7b02fbdf21626a4dcf7ce299bdce68d99e0281bac62b08180ac48792b112b130402e3b75d589f13e57acdf33b33d139db00237818b784b6ab1cd37aef4
+  data.tar.gz: d4008513bbbf74b24de5c94f0cfc868367b37c9d2d876806e8eb2f546669768db94c5c1f981dbad732214c16ca26ee969eeb7027c59abda23d49a6e7b8e038fa

data/CHANGELOG.md

@@ -1,19 +1,25 @@
+## 0.0.6 - 2024-09-16
+- NEW: Object Model Support renewal;
+  - `SfCli::Sf::Model.connection` represents the connection to Salesforce. It can be set by `set_connection` class method in the module. As of now there is only `SfCommandConnection`, which is based on sf command, as connection adapter. After the connection is set by `set_connection`, it is also automatically set to classes when `SfCli::Sf::Model.generate` method is called.
+  - Each object model class has `create` class method for creating a new record.
+  - Each object model has `#save` and `#delete` instance methods to create, update and delete the record it represents.
+  - Each object class has query interface such as `where`, `select`, `limit` and `order` methods that can be chainable.
+  - Each object class has query interface such as `find`, `all`, `take` and `pluck`.
+- CHANGE: `sf.sobject.describe` changed to return `schema` object.
 ## 0.0.5 - 2024-09-08
-- target CLI version is changed: from 2.54.6 to 2.56.7
-- sf data:
-  - add `--bulk` option to query
-  - add query resume
-  - add upsert bulk
-  - add upsert resume
-  - add delete bulk
-  - add delete resume
-  - add resume
-  - add search
-- sf org:
-  - add list
-  - add login access-token
-  - add `--browser` option to login web
-
+- CHANGE: target CLI version is changed: from 2.54.6 to 2.56.7
+- NEW: new command features are added;
+  - `--bulk` option to `sf.data.query`
+  - `sf.data.query_resume`
+  - `sf.data.upsert_bulk`
+  - `sf.data.upsert_resume`
+  - `sf.data.delete_bulk`
+  - `sf.data.delete_resume`
+  - `sf.data.resume`
+  - `sf.data.search`
+  - `sf.org.list`
+  - `sf.login_access_token`
+  - `--browser` option to `sf.login_web`
 ## 0.0.4 - 2024-09-02
 - breaking change:
   - Sf class doesn't exist anymore. You can not write like `sf = SfCli::Sf.new`. Instead of that,  global `sf` method is introduced. You can directly type like `sf.org.display`, which is as almost same usability as the original command. 

data/README.rdoc

@@ -1,4 +1,4 @@
-= Salesforce CLI library
+= Salesforce CLI library for Ruby
 https://badge.fury.io/rb/sf_cli.png
 
 This is a class library for introducing {Salesforce CLI}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_top.htm] to Ruby scripting.<br>
@@ -10,10 +10,10 @@ Salesforce CLI must be installed.<br>
 As of as of September in 2024, ver.2.56.7 is the development target.
 
 == install
-=== Rubygem
+==== Rubygem
   $ gem install sf_cli
 
-=== Bundler
+==== Bundler
 in Gemfile:
   gem 'sf_cli'
 
@@ -48,19 +48,88 @@ then,
   sf.project.generate 'MyProject'
 
 == \Object Model support (experimental, since 0.0.4)
-  require 'sf_cli'
+=== generate Models
   require 'sf_cli/sf/model'
+  require 'sf_cli/sf/model/sf_command_connection'
 
-  # generates Model Class for Contact and Account
-  SfCli::Sf::Model.generate %w[Contact Account]
+  # first, you must prepare the connection
+  conn = SfCli::Sf::Model::SfCommandConnection.new target_org: your_org, instance_url: your_org_url
 
-  c = Contact.new(:Name => "John Smith")
-  c.Name # => "John Smith"
+  # then set it to Model module
+  SfCli::Sf::Model.set_connection conn
+
+  # generates some model classes (for example, Account and Contact)
+  SfCli::Sf::Model.generate %w[Account Contact]
+=== apply to sf command
+  rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
 
-  rows = sf.data.query 'SELECT Id, Name, Account.Name From Contact Limit 3', model_class: Contact
-  rows.size # => 3
-  rows.first.Name # => Name of the Contact
-  rows.first.Account.Name # => Name of the Account
+  # the array object contains Contact object instances
+  rows.size  # 1
+  rows.first # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
+  rows.first.Name # Akin Kristen
+
+=== using models Independently
+==== initialize and save a record
+  c = Contact.new(:Name => "John Smith")
+  c.Name # "John Smith"
+  c.save
+
+==== find and update a record
+  # find by record ID and update
+  c2 = Contact.find(c.id)
+  c2.Name = "Johnny Smith"
+  c2.save # update
+
+==== delete a record
+  c2 = Contact.find(c.id)
+  c2.delete
+
+==== query and get a record
+  contact = Contact.select(:Id, :Name).where(Name: 'Akin Kristen').take
+  contact # => #<Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">
+  contact.Name # Akin Kristen
+
+==== query and get records
+  contacts = Contact.select(:Id, :Name).where(LastModifiedDate: :Yesterday).all # get all records that is modified yesterday
+
+  # these 2 example are the same meaning
+  Contact.select(Name).where(Name: 'John Smith', LastModifiedDate: :Yesterday).take
+  Contact.select(Name).where(Name: 'John Smith').where(LastModifiedDate: :Yesterday).take
+
+==== child-parent relationship
+  contact = Contact.select(:Id, :Name, "Account.Name").where(Name: 'Akin Kristen').take
+  contact # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen", @Account= #<Account @Name="Aethna Home Products">>
+  contact.Account.Name # Aethna Home Products
+
+==== parent-children relationship
+  account = Account.select(:Id, :Name, "(SELECT Name FROM Contacts)").take
+  account # <Account @Contacts=[#<Contact @Name="Akin Kristen">], @Id="0015j00001dsDuhAAE", @Name="Aethna Home Products">
+  account.Name             # Aethna Home Products
+  rows.Contacts            # [#<Contact @Name="Akin Kristen">]
+  rows.Contacts.first.Name # Akin Kristen
+
+==== get all fields in a record
+  # just by not using 'select' method
+  contact = Contact.find(record_id) # <Contact @Id="...", @Name="...", other fields...>
+
+==== time keywords such as 'yesterday' or 'LAST_N_DAYS:N' with symbol style
+  Contact.select(:Name).where(LastModifiedDate: :Yesterday).take       # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = Yesterday"
+  Contact.select(:Name).where(LastModifiedDate: :"LAST_N_DAYS:5").take # "SELECT Id, Name FROM Contact WHERE LastModifiedDate = LAST_N_DAYS:5"
+
+==== array for 'IN' keyword
+  Contact.select(:Name).where(Name: ['Jonny Good', 'John Smith']).all # same as "SELECT Name FROM Contact WHERE Name IN ('Jonny Good', 'John Smith')"
+
+==== using partial soql directly
+  Contact.select("Id, Name").where("LastModifiedDate = LAST_N_DAYS:5").all
+
+==== ternary style
+  Contact.select(:Id, :Name).where(:LastModifiedDate, :>=, :"LAST_N_DAYS:5").all # SELECT Id, Name FROM Contact WHERE LastModifiedDate >= LAST_N_DAYS:5
+  Account.select(:Id, :Name).where(:Name, :LIKE, "%OIL%").all                    # SELECT Id, Name FROM Account WHERE Name LIKE '%OIL%'
+
+==== get schema
+  schema = Account.describe
+  schema.name # Account
+  schema.field_names # [Id, Name, ....]
 
 == Documents
 The following steps generate *doc* directory, which all documents are generated in.

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

@@ -1,3 +1,5 @@
+require 'json'
+
 module SfCli
   module Sf
     module Core

data/lib/sf_cli/sf/model/base_methods.rb

@@ -0,0 +1,62 @@
+module SfCli
+  module Sf
+    module Model
+      module BaseMethods
+        def self.included(c)
+          c.extend ClassMethods
+        end
+
+        module ClassMethods
+          def connection
+            @connection
+          end
+
+          def connection=(conn)
+            @connection = conn
+          end
+
+          def describe
+            connection.describe(name.to_sym)
+          end
+        end
+
+        def initialize(attributes = {})
+          @original_attributes = {}
+          @current_attributes = {}
+          @updated_attributes = {}
+
+          attributes.each do |k, v|
+            field_name = k.to_sym
+            if self.class.field_names.include?(field_name)
+              @original_attributes[field_name] = v
+              __send__ (field_name.to_s + '='), v
+            elsif self.class.parent_relations.find{|r| r[:name] == field_name}
+              __send__ (field_name.to_s + '='), v
+            elsif self.class.children_relations.find{|r| r[:name] == field_name}
+              __send__ (field_name.to_s + '='), (v.nil? ? [] : v)
+            end
+          end
+        end
+
+        def to_h(keys: nil)
+          self.class.field_names.each_with_object({}) do |name, hash|
+            if keys&.instance_of?(Array)
+              hash[name] = __send__(name) if keys.include?(name)
+            else
+              hash[name] = __send__(name)
+            end
+          end
+        end
+
+        def new_record?
+          self.Id.nil?
+        end
+
+        def persisted?
+          new_record? == false
+        end
+      end
+    end
+  end
+end
+

data/lib/sf_cli/sf/model/class_definition.rb

@@ -1,4 +1,6 @@
-require_relative './schema'
+require_relative './base_methods'
+require_relative './dml_methods'
+require_relative './query_methods'
 
 module SfCli
   module Sf
@@ -7,60 +9,27 @@ module SfCli
         attr_reader :schema
 
         def initialize(schema)
-          @schema = Schema.new(schema)
+          @schema = schema
         end
 
         def to_s
           <<~Klass
             Class.new do
-              #{ class_methods }
+              include ::SfCli::Sf::Model::BaseMethods
+              include ::SfCli::Sf::Model::DmlMethods
+              include ::SfCli::Sf::Model::QueryMethods
 
-              field_names.each do |name|
-                attr_accessor name
-              end
+              attr_reader :original_attributes, :current_attributes, :updated_attributes
+
+              #{ class_methods }
 
+              #{ field_attribute_methods  }
               #{ parent_relation_methods }
               #{ children_relation_methods }
-
-              #{ define_initialize }
-
-              #{ define_to_h }
             end
           Klass
         end
 
-        def define_initialize
-          <<~EOS
-            def initialize(attributes = {})
-              attributes.each do |k, v|
-                field_name = k.to_sym
-                if self.class.field_names.include?(field_name)
-                  #instance_variable_set ('@' + field_name.to_s).to_sym, v
-                  __send__ (field_name.to_s + '='), v
-                elsif self.class.parent_relations.find{|r| r[:name] == field_name}
-                  __send__ (field_name.to_s + '='), v
-                elsif self.class.children_relations.find{|r| r[:name] == field_name}
-                  __send__ (field_name.to_s + '='), (v.nil? ? [] : v)
-                end
-              end
-            end
-          EOS
-        end
-
-        def define_to_h
-          <<~EOS
-            def to_h(keys: nil)
-              self.class.field_names.each_with_object({}) do |name, hash|
-                if keys&.instance_of?(Array)
-                  hash[name] = __send__(name) if keys.include?(name)
-                else
-                  hash[name] = __send__(name)
-                end
-              end
-            end
-          EOS
-        end
-
         def class_methods
           <<~EOS
             class << self
@@ -79,6 +48,28 @@ module SfCli
           EOS
         end
 
+        def field_attribute_methods
+          schema.field_names.each_with_object('') do |name, s|
+            s << <<~EOS
+              def #{name}
+                @#{name}
+              end
+
+              def #{name}=(value)
+                @#{name} = value
+                return if %i[Id LastModifiedDate IsDeleted SystemModstamp CreatedById CreatedDate LastModifiedById].include?(:#{name})
+
+                current_attributes[:#{name}] = value
+                if current_attributes[:#{name}] == original_attributes[:#{name}]
+                  updated_attributes[:#{name}] = nil
+                else
+                  updated_attributes[:#{name}] = value
+                end
+              end
+            EOS
+          end
+        end
+
         def parent_relation_methods
           schema.parent_relations.each_with_object('') do |r, s|
             s << <<~EOS
@@ -87,7 +78,7 @@ module SfCli
               end
 
               def #{r[:name]}=(attributes)
-                @#{r[:name]} = #{r[:class_name]}.new(attributes)
+                @#{r[:name]} = attributes.nil? ? nil : #{r[:class_name]}.new(attributes)
               end
             EOS
           end

data/lib/sf_cli/sf/model/dml_methods.rb

@@ -0,0 +1,36 @@
+module SfCli
+  module Sf
+    module Model
+      module DmlMethods
+        def self.included(c)
+          c.extend ClassMethods
+        end
+
+        def save
+          if new_record?
+            self.Id = self.class.connection.create(self.class.name.to_sym, current_attributes.reject{|_,v| v.nil?})
+          else
+            self.class.connection.update(self.class.name.to_sym, self.Id, updated_attributes.reject{|_,v| v.nil?})
+          end
+
+          @original_attributes = current_attributes.dup
+          @updated_attributes = {}
+
+          self.Id
+        end
+
+        def delete
+          return if self.Id.nil?
+
+          self.class.connection.delete(self.class.name.to_sym, self.Id)
+        end
+
+        module ClassMethods
+          def create(values = {})
+            connection.create(name.to_sym, values, Object.const_get(name.to_sym))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/model/generator.rb

@@ -1,25 +1,26 @@
-require_relative '../sobject/core'
 require_relative './class_definition'
 
 module SfCli
   module Sf
     module Model
       class Generator
-        attr_reader :sf_sobject, :target_org
+        attr_reader :sf_sobject, :connection
 
-        def initialize(target_org: nil)
-          @sf_sobject = ::SfCli::Sf::Sobject::Core.new
-          @target_org = target_org
+        def initialize(connection)
+          @connection = connection
         end
 
         def generate(object_name)
-          class_definition = ClassDefinition.new(describe object_name)
+          schema = describe(object_name)
+          class_definition = ClassDefinition.new(schema)
 
           instance_eval "::#{object_name} = #{class_definition}"
+          klass = Object.const_get object_name.to_sym
+          klass.connection = connection
         end
 
         def describe(object_name)
-          sf_sobject.describe object_name, target_org: target_org
+          connection.describe object_name
         end
       end
     end

data/lib/sf_cli/sf/model/query_condition.rb

@@ -0,0 +1,136 @@
+require 'date'
+
+module SfCli
+  module Sf
+    module Model
+      module QueryMethods
+        class QueryCondition
+          attr_reader :connection, :object_name, :all_field_names, :fields, :conditions, :limit_num, :row_order
+
+          def initialize(connection, object_name, field_names)
+            @object_name = object_name
+            @all_field_names = field_names 
+            @connection = connection
+            @fields = []
+            @conditions = [] 
+            @limit_num = nil
+            @row_order = nil
+          end
+
+          def where(*expr)
+            return self if expr&.empty?
+            return self if expr.map{|o| (o == '' || o == {} || o == []) ? nil : o}.compact.size.zero?
+            return self unless [Hash, Symbol, String].any?{|klass| expr.first.instance_of? klass}
+
+            if expr.size > 1
+              return self if expr.size < 3
+
+              value = case expr[2].class.name.to_sym
+                      when :String
+                        %|'#{expr[2]}'|
+                      when :Time
+                        expr[2].to_datetime
+                      when :Array
+                        candidates = expr[2].map do |o|
+                            case o.class.name.to_sym
+                            when :String
+                              %|'#{o}'|
+                            when :Time
+                              o.to_datetime
+                            else
+                              o
+                            end
+                          end
+                        %|IN (#{candidates.join(', ')})|
+                      else
+                        expr[2]
+                      end
+              conditions << %|#{expr[0]} #{expr[1]} #{value}|
+
+              return self
+            end
+
+            if expr[0].instance_of? String
+              conditions << expr[0]
+              return self
+            end
+
+            new_conditions =
+              expr[0].map do |k,v| 
+                case v.class.name.to_sym
+                when :String
+                  %|#{k} = '#{v}'|
+                when :Time
+                  %|#{k} = #{v.to_datetime}|
+                when :Array
+                  candidates = v.map do |o|
+                      case o.class.name.to_sym
+                      when :String
+                        %|'#{o}'|
+                      when :Time
+                        %|#{o.to_datetime}|
+                      else
+                        o
+                      end
+                    end
+                  %|#{k} IN (#{candidates.join(', ')})|
+                else
+                  "#{k} = #{v}"
+                end
+              end
+            conditions.append new_conditions
+            return self
+          end
+
+          def select(*expr)
+            return self if expr&.empty?
+
+            if expr.size > 1
+              @fields = self.fields + expr
+            else
+              self.fields << expr.first
+            end
+            return self
+          end
+
+          def limit(num)
+            @limit_num = num
+            return self
+          end
+
+          def order(*fields)
+            return self if fields&.empty?
+
+            @row_order = fields
+            return self
+          end
+
+          def to_soql
+            base   = 'SELECT %{select} FROM %{object}' % {select: select_fields, object: object_name}
+            where  = conditions.size.zero?  ? nil : 'WHERE %{where}'    % {where: conditions.flatten.join(' AND ')}
+            _order = row_order.nil?         ? nil : 'ORDER BY %{order}' % {order: row_order.join(', ')}
+            limit  = limit_num.nil?         ? nil : 'LIMIT %{limit}'    % {limit: limit_num} 
+
+            [base, where, _order, limit].compact.join(' ')
+          end
+
+          def all
+            connection.query(to_soql, Object.const_get(object_name.to_sym))
+          end
+
+          def pluck(field_name)
+            all.map{|record| record.__send__(field_name.to_sym)}
+          end
+
+          def take
+            all.first
+          end
+
+          def select_fields
+            (fields.empty? ? all_field_names : fields).join(', ')
+          end 
+        end
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/model/query_methods.rb

@@ -0,0 +1,58 @@
+require_relative './query_condition'
+
+module SfCli
+  module Sf
+    module Model
+      module QueryMethods
+        def self.included(c)
+          c.extend ClassMethods
+        end
+
+        module ClassMethods
+          def where(*expr)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.where(*expr)
+            return qc
+          end
+
+          def select(*fields)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.select(*fields)
+            return qc
+          end
+
+          def find(id)
+            connection.find(name.to_sym, id, Object.const_get(name.to_sym))
+          end
+
+          def limit(num)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.limit(num)
+            qc
+          end
+
+          def order(*field_names)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.order(*field_names)
+            qc
+          end
+
+          def all
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.all
+          end
+
+          def pluck(field_name)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.pluck(field_name)
+          end
+
+          def take
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.take
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/model/sf_command_connection.rb

@@ -0,0 +1,60 @@
+require_relative '../sobject/core'
+require_relative '../data/core'
+require_relative '../org/core'
+
+module SfCli
+  module Sf
+    module Model
+      class SfCommandConnection
+        attr_reader :sf_data, :sf_org, :sf_sobject, :target_org, :instance_url
+
+        def initialize(target_org: nil, instance_url: nil)
+          @sf_org = ::SfCli::Sf::Org::Core.new
+          @sf_data = ::SfCli::Sf::Data::Core.new
+          @sf_sobject = ::SfCli::Sf::Sobject::Core.new
+          @target_org = target_org
+          @instance_url = instance_url
+        end
+
+        def open
+          if ENV['SF_ACCESS_TOKEN']
+            sf_org.login_access_token target_org: target_org, instance_url: instance_url
+          else
+            sf_org.login_web target_org: target_org, instance_url: instance_url
+          end
+        end
+
+        def find(object_type, id, klass)
+          sf_data.get_record object_type, record_id: id, target_org: target_org, model_class: klass
+        end
+
+        def create(object_type, values, klass = nil)
+          id = sf_data.create_record object_type, values: values, target_org: target_org
+          return id if klass.nil?
+
+          find(object_type, id, klass)
+        end
+
+        def update(object_type, id, values)
+          sf_data.update_record object_type, record_id: id, where: nil, values: values, target_org: target_org
+        end
+
+        def delete(object_type, id)
+          sf_data.delete_record object_type, record_id: id, where: nil, target_org: target_org
+        end
+
+        def query(soql, klass)
+          sf_data.query soql, target_org: target_org, model_class: klass
+        end
+
+        def exec_query(soql, format: nil, bulk: false, timeout: nil, model_class: nil)
+          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, timeout: timeout, model_class: model_class)
+        end
+
+        def describe(object_type)
+          sf_sobject.describe(object_type, target_org: target_org)
+        end
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/model.rb

@@ -9,8 +9,16 @@ module SfCli
     # see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
     #
     module Model
-      def self.generate(object_names, target_org: nil)
-        generator = Generator.new(target_org: target_org)
+      def self.connection
+        @@connection
+      end
+
+      def self.set_connection(conn)
+        @@connection = conn
+      end
+
+      def self.generate(object_names)
+        generator = Generator.new(connection)
 
         object_names.each do |object_name|
           generator.generate(object_name)

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

@@ -1,4 +1,5 @@
 require_relative '../core/base'
+require_relative './schema'
 
 module SfCli
   module Sf
@@ -11,12 +12,19 @@ module SfCli
       class Core
         include ::SfCli::Sf::Core::Base
 
-        # returns a hash object containing the Salesforce object schema
+        # returns a schema object containing the Salesforce object schema
         #
         # *objectType* --- object type (ex: Account)<br>
         #
         # *target_org* --- an alias of paticular org, or username can be used<br>
         #
+        # ======
+        #   schema = sf.sobject.describe :Account
+        #   schema.name  # Account
+        #   schema.label # Account
+        #   schema.field_names # [:Id, :Name, ....]
+        #   schema.fields[:Name] # => {"aggregatable"=>true, "aiPredictionField"=>false, "autoNumber"=>false,...}
+        #
         # 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_sobject_commands_unified.htm#cli_reference_sobject_describe_unified]
         #
         def describe(object_type, target_org: nil)
@@ -25,7 +33,7 @@ module SfCli
             :"target-org" => target_org,
           }
           json = exec(__method__, flags: flags, redirection: :null_stderr)
-          json['result']
+          Schema.new(json['result'])
         end
 
         # returns a list of Salesforce object name

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

@@ -0,0 +1,47 @@
+module SfCli
+  module Sf
+    module Sobject
+      class Schema
+        attr_reader :schema
+
+        def initialize(schema)
+          @schema = schema
+        end
+
+        def all
+          schema
+        end
+
+        def name
+          @name ||= schema['name']
+        end
+
+        def label
+          @label ||= schema['label']
+        end
+
+        def field_names
+          @field_names ||= schema['fields'].map{|f| f['name'].to_sym}
+        end
+
+        def fields
+          @field_map ||= schema['fields'].each_with_object({}) do |f, h|
+            h[f['name'].to_sym] = f
+          end
+        end
+
+        def children_relations
+          schema['childRelationships']
+            .select{|r| r['relationshipName'].nil? == false}
+            .map{|r| {name: r['relationshipName'].to_sym, field: r['field'].to_sym, class_name: r['childSObject'].to_sym}}
+        end
+
+        def parent_relations
+          schema['fields']
+            .select{|f| f['relationshipName'].nil? == false && f['referenceTo']&.size > 0}
+            .map{|f| {name: f['relationshipName'].to_sym, field: f['name'].to_sym, class_name: f['referenceTo'].first.to_sym}}
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-08 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies: []
 description: This is a class library for introducing Salesforce CLI to Ruby scripting.
   Currenty only sf command is the target of development.
@@ -40,15 +40,20 @@ files:
 - lib/sf_cli/sf/data/upsert_resume.rb
 - lib/sf_cli/sf/main.rb
 - lib/sf_cli/sf/model.rb
+- lib/sf_cli/sf/model/base_methods.rb
 - lib/sf_cli/sf/model/class_definition.rb
+- lib/sf_cli/sf/model/dml_methods.rb
 - lib/sf_cli/sf/model/generator.rb
-- lib/sf_cli/sf/model/schema.rb
+- lib/sf_cli/sf/model/query_condition.rb
+- lib/sf_cli/sf/model/query_methods.rb
+- lib/sf_cli/sf/model/sf_command_connection.rb
 - 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/login.rb
 - lib/sf_cli/sf/project/core.rb
 - lib/sf_cli/sf/sobject/core.rb
+- lib/sf_cli/sf/sobject/schema.rb
 homepage: https://github.com/tmkw/sf_cli
 licenses:
 - MIT

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

@@ -1,33 +0,0 @@
-module SfCli
-  module Sf
-    module Model
-      class Schema
-        attr_reader :schema
-
-        def initialize(schema)
-          @schema = schema
-        end
-
-        def name
-          schema['name']
-        end
-
-        def field_names
-          schema['fields'].map{|f| f['name'].to_sym}
-        end
-
-        def children_relations
-          schema['childRelationships']
-            .select{|r| r['relationshipName'].nil? == false}
-            .map{|r| {name: r['relationshipName'].to_sym, class_name: r['childSObject'].to_sym}}
-        end
-
-        def parent_relations
-          schema['fields']
-            .select{|f| f['relationshipName'].nil? == false && f['referenceTo']&.size > 0}
-            .map{|f| {name: f['relationshipName'].to_sym, class_name: f['referenceTo'].first.to_sym}}
-        end
-      end
-    end
-  end
-end