sobjectmodel 0.1.2

data/lib/sobject_model/schema.rb

@@ -0,0 +1,553 @@
+require 'json'
+
+module SObjectModel
+  #
+  # sObject Schema
+  #
+  class Schema
+    def initialize(schema_hash)
+      @schema = schema_hash
+    end
+
+    def name
+      @name = schema['name']
+    end
+
+    def label
+      @label = schema['label']
+    end
+
+    def fields
+      @fields ||= Fields.new(schema)
+    end
+
+    def field_names
+      @field_names ||= fields.map{|f| f.name.to_sym}.sort
+    end
+
+    def field_labels
+      @field_labels ||= fields.map{|f| f.label}.sort
+    end
+
+    def child_relations
+     @child_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
+      @parent_relations ||= fields.select{|f| !(f.relationship_name.nil? || f.reference_to.nil?) && f.reference_to.size > 0}
+                              .map{|f| {name: f.relationship_name.to_sym, field: f.name.to_sym, class_name: f.reference_to.first.to_sym} }
+    end
+
+    def relations
+      @relations = Relations.new(child_relations + parent_relations)
+    end
+
+    def relation_names
+      relations.names
+    end
+
+    def to_h
+      schema
+    end
+
+    def action_overrides
+      schema["actionOverrides"]
+    end
+
+    def activateable?
+      schema["activateable"]
+    end
+
+    def associateEntityType
+      schema["associateEntityType"]
+    end
+
+    def associateParentEntity
+      schema["associateParentEntity"]
+    end
+
+    def compact_layoutable?
+      schema["compactLayoutable"]
+    end
+
+    def createable?
+      schema["createable"]
+    end
+
+    def custom?
+      schema["custom"]
+    end
+
+    def custom_setting?
+      schema["customSetting"]
+    end
+
+    def deep_cloneable?
+      schema["deepCloneable"]
+    end
+
+    def default_implementation
+      schema["defaultImplementation"]
+    end
+
+    def deletable?
+      schema["deletable"]
+    end
+
+    def deprecated_and_hidden?
+      schema["deprecatedAndHidden"]
+    end
+
+    def extended_by
+      schema["extendedBy"]
+    end
+
+    def extends_interfaces
+      schema["extendsInterfaces"]
+    end
+
+    def feed_enabled?
+      schema["feedEnabled"]
+    end
+
+    def has_subtypes?
+      schema["hasSubtypes"]
+    end
+
+    def implemented_by
+      schema["implementedBy"]
+    end
+
+    def implements_interfaces
+      schema["implementsInterfaces"]
+    end
+
+    def interface?
+      schema["isInterface"]
+    end
+
+    def subtype?
+      schema["isSubtype"]
+    end
+
+    def key_prefix
+      schema["keyPrefix"]
+    end
+
+    def label_plural
+      schema["labelPlural"]
+    end
+
+    def layoutable?
+      schema["layoutable"]
+    end
+
+    def listviewable?
+      schema["listviewable"]
+    end
+
+    def lookup_layoutable
+      schema["lookupLayoutable"]
+    end
+
+    def mergeable?
+      schema["mergeable"]
+    end
+
+    def mruEnabled
+      schema["mruEnabled"]
+    end
+
+    def named_layouts
+      schema["namedLayoutInfos"]
+    end
+
+    def network_scope_field_name
+      schema["networkScopeFieldName"]
+    end
+
+    def queryable?
+      schema["queryable"]
+    end
+
+    def record_types
+      @record_types = schema["recordTypeInfos"].map{|rt| RecordType.new(**rt)}
+    end
+
+    def replicateable?
+      schema["replicateable"]
+    end
+
+    def retrieveable?
+      schema["retrieveable"]
+    end
+
+    def search_layoutable?
+      schema["searchLayoutable"]
+    end
+
+    def searchable?
+      schema["searchable"]
+    end
+
+    def sobject_describe_option
+      schema["sobjectDescribeOption"]
+    end
+
+    def supported_scopes
+      schema["supportedScopes"]
+    end
+
+    def triggerable?
+      schema["triggerable"]
+    end
+
+    def undeletable?
+      schema["undeletable"]
+    end
+
+    def updateable?
+      schema["updateable"]
+    end
+
+    def urls
+      schema["urls"]
+    end
+
+    private
+
+    def schema
+      @schema
+    end
+
+    Relation = Struct.new(:name, :field, :class_name)
+    RecordType = Struct.new(:active, :available, :defaultRecordTypeMapping, :developerName, :master, :name, :recordTypeId, :urls)
+
+    class Relations
+      include Enumerable
+
+      def initialize(relations)
+        @relations = relations.map{|r| Relation.new(name: r[:name], field: r[:field], class_name: r[:class_name])}
+      end
+
+      def each(&block)
+        relations.each(&block)
+      end
+
+      def names
+        map(&:name).sort
+      end
+
+      def find(name)
+        relations.find{|r| r.name == name.to_sym}
+      end
+
+      private
+
+      def relations
+        @relations
+      end
+    end
+
+    class Fields
+      include Enumerable
+
+      def initialize(schema)
+        @fields = schema['fields'].map{|h| Field.new(**h)}
+      end
+
+      def each(&block)
+        fields.each &block
+      end
+
+      def to_a
+        fields
+      end
+
+      def find_by(name: nil, label: nil)
+        return nil if name.nil? && label.nil?
+
+        attr_name = name.nil? ? :label : :name
+        val       = name || label
+
+        find do |field|
+          attr_val = field.__send__(attr_name.to_sym)
+          attr_val == val.to_s
+        end
+      end
+
+      def name_and_labels
+        map{|field| [field.name, field.label]}
+      end
+
+      def names
+        map(&:name)
+      end
+
+      def labels
+        map(&:label)
+      end
+
+      private
+
+      def fields
+        @fields
+      end
+    end
+
+    class Field
+      def initialize(field)
+        @field = field
+      end
+
+      def aggregatable?
+        field["aggregatable"]
+      end
+
+      def ai_prediction_field?
+        field["aiPredictionField"]
+      end
+
+      def autoNumber?
+        field["autoNumber"]
+      end
+
+      def byteLength
+        field["byteLength"]
+      end
+
+      def calculated?
+        field["calculated"]
+      end
+
+      def calculated_formula
+        field["calculatedFormula"]
+      end
+
+      def cascade_delete?
+        field["cascadeDelete"]
+      end
+
+      def case_sensitive
+        field["caseSensitive"]
+      end
+
+      def compound_field_name
+        field["compoundFieldName"]
+      end
+
+      def controller_name
+        field["controllerName"]
+      end
+
+      def createable?
+        field["createable"]
+      end
+
+      def custom?
+        field["custom"]
+      end
+
+      def default_value
+        field["defaultValue"]
+      end
+
+      def default_value_formula
+        field["defaultValueFormula"]
+      end
+
+      def defaulted_on_create?
+        field["defaultedOnCreate"]
+      end
+
+      def dependent_picklist?
+        field["dependentPicklist"]
+      end
+
+      def deprecated_and_hidden?
+        field["deprecatedAndHidden"]
+      end
+
+      def digits
+        field["digits"]
+      end
+
+      def display_location_in_decimal?
+        field["displayLocationInDecimal"]
+      end
+
+      def encrypted?
+        field["encrypted"]
+      end
+
+      def external_id?
+        field["externalId"]
+      end
+
+      def extra_type_info
+        field["extraTypeInfo"]
+      end
+
+      def filterable?
+        field["filterable"]
+      end
+
+      def filtered_lookup_info
+        field["filteredLookupInfo"]
+      end
+
+      def formula_treat_null_number_as_zero?
+        field["formulaTreatNullNumberAsZero"]
+      end
+
+      def groupable?
+        field["groupable"]
+      end
+
+      def high_scale_number?
+        field["highScaleNumber"]
+      end
+
+      def html_formatted?
+        field["htmlFormatted"]
+      end
+
+      def id_lookup?
+        field["idLookup"]
+      end
+
+      def inline_help_text
+        field["inlineHelpText"]
+      end
+
+      def label
+        field["label"]
+      end
+
+      def length
+        field["length"]
+      end
+
+      def mask
+        field["mask"]
+      end
+
+      def mask_type
+        field["maskType"]
+      end
+
+      def name
+        field["name"]
+      end
+
+      def name_field?
+        field["nameField"]
+      end
+
+      def name_pointing?
+        field["namePointing"]
+      end
+
+      def nillable?
+        field["nillable"]
+      end
+
+      def permissionable?
+        field["permissionable"]
+      end
+
+      PicklistValue = Data.define(:active, :default_value, :label, :valid_for, :value)
+
+      def picklist_values
+        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?
+        field["polymorphicForeignKey"]
+      end
+
+      def precision
+        field["precision"]
+      end
+
+      def query_by_distance?
+        field["queryByDistance"]
+      end
+
+      def reference_target_field
+        field["referenceTargetField"]
+      end
+
+      def reference_to
+        field["referenceTo"]
+      end
+
+      def relationship_name
+        field["relationshipName"]
+      end
+
+      def relationship_order
+        field["relationshipOrder"]
+      end
+
+      def restricted_delete
+        field["restrictedDelete"]
+      end
+
+      def restricted_picklist?
+        field["restrictedPicklist"]
+      end
+
+      def scale
+        field["scale"]
+      end
+
+      def search_prefilterable?
+        field["searchPrefilterable"]
+      end
+
+      def soapType
+        field["soapType"]
+      end
+
+      def sortable?
+        field["sortable"]
+      end
+
+      def type
+        field["type"]
+      end
+
+      def unique?
+        field["unique"]
+      end
+
+      def updateable?
+        field["updateable"]
+      end
+
+      def write_Requires_Master_Read?
+        field["writeRequiresMasterRead"]
+      end
+
+      def to_h
+        field
+      end
+
+      private
+
+      def field
+        @field
+      end
+    end
+  end
+end

data/lib/sobject_model/support/console.rb

@@ -0,0 +1,63 @@
+require 'sf_cli'
+require 'sobject_model'
+
+def use(target_org)
+  config = sf.org.display target_org: target_org
+  SObjectModel.connect(
+    :rest,
+    instance_url: config.instance_url,
+    access_token: config.access_token,
+    api_version:  config.api_version
+  )
+  unless config.connected?
+    sf.org.login_web target_org: target_org, instance_url: config.instance_url
+  end
+
+  available_models.each do |model|
+    Object.const_get(model).connection = conn
+  end
+
+  @current_org = config
+
+  true
+end
+
+def available_models
+  @available_models ||= []
+end
+
+def generate(*object_types)
+  SObjectModel.generate(*object_types)
+  available_models.append(*object_types).flatten.uniq
+  object_types
+end
+
+def connection
+  SObjectModel.connection
+end
+
+def target_org
+  current_org.alias
+end
+
+def current_org
+  @current_org
+end
+
+def query(_soql)
+  soql = _soql.is_a?(SObjectModel::QueryMethods::QueryCondition) ? _soql.to_soql : _soql
+  conf.inspect_mode = false
+  puts sf.data.query(soql, format: :human, target_org: target_org)
+  conf.inspect_mode = true
+end
+
+def orgs
+  conf.inspect_mode = false
+  system 'sf org list'
+  conf.inspect_mode = true
+end
+
+alias :gen  :generate
+alias :conn :connection
+
+use ARGV[0] if ARGV[0]

data/lib/sobject_model.rb

@@ -0,0 +1,29 @@
+require 'sobject_model/rest/client'
+require 'sobject_model/adapter/rest'
+require 'sobject_model/adapter/sf'
+require 'sobject_model/generator'
+
+module SObjectModel
+  def self.connect(api_type, options = {})
+    @connection = case api_type.to_s.upcase
+                  when 'REST'
+                    client = Rest::Client.new(**options)
+                    Adapter::Rest.new(client)
+                  when 'CLI/SF'
+                    Adapter::Sf.new(sf, **options)
+                  end
+  end
+
+  def self.connection
+    @connection
+  end
+
+  def self.connection=(connector)
+    @connection = connector
+  end
+
+  def self.generate(*sobject_types)
+    generator = Generator.new(connection)
+    generator.generate(*sobject_types)
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: sobjectmodel
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Takanobu Maekawa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-04 00:00:00.000000000 Z
+dependencies: []
+description: Saleforce sObject class library
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sobject_model.rb
+- lib/sobject_model/adapter/base.rb
+- lib/sobject_model/adapter/rest.rb
+- lib/sobject_model/adapter/sf.rb
+- lib/sobject_model/base_methods.rb
+- lib/sobject_model/class_definition.rb
+- lib/sobject_model/dml_methods.rb
+- lib/sobject_model/generator.rb
+- lib/sobject_model/query_condition.rb
+- lib/sobject_model/query_methods.rb
+- lib/sobject_model/rest/client.rb
+- lib/sobject_model/rest/errors.rb
+- lib/sobject_model/rest/http.rb
+- lib/sobject_model/rest/query_result.rb
+- lib/sobject_model/schema.rb
+- lib/sobject_model/support/console.rb
+homepage: https://github.com/tmkw/sobjectmodel
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/tmkw/sobjectmodel
+  source_code_uri: https://github.com/tmkw/sobjectmodel
+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: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Saleforce sObject class library
+test_files: []