soql_builder 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6896103cda585b0692c479836fcd1fa54977a0c376b140cd0106ba02b0f7cf25
-  data.tar.gz: f4c83fbe9aded0e162b0d5685154e3ece6044f92130ac8e8b5f4a8f228f04022
+  metadata.gz: ffcd93c75d97fff1473a54e9e22fb187a8e4196046db8caf74d746ac7187448b
+  data.tar.gz: 1202cc894c24d22f72b697a779377302c8853d3ff30102a2c5d050624773bf2d
 SHA512:
-  metadata.gz: b14707fd25c85dc5f851e69f816b8b4b0b242111a8e9cedb5c7f2f06fa6cc67c5ecb1ad57d26fa923b5dfb4d995b2d690a02b2d4ac84ca2086a123efee970e1b
-  data.tar.gz: 68a972be44ff182ff270f9c06b6d1b3bd60da89a0ce4ab3bc22533fe3e4a1a96f206d685b17b859d9915ef1e9e4d5b9f93125c1ff81e07b478177ee722d09334
+  metadata.gz: f6daed2b7355eef9c0b12ec116a70676f54b1961640aa7ebce9ea6ab66bc80d8a333d794d906213f94af967d396701449ac06ffaf6a9d388b79ad7d95e98f248
+  data.tar.gz: 9a6ee1363f638789810a05de38b95a50cdc84beb6db489252002934074272b064c8a992d9ab8da9a64a768c77b42878ad27d17e45c968de5960fc2c1f6ea7a56

data/README.md

@@ -0,0 +1,80 @@
+# SOQL-BUILDER (BETA)
+
+[![Build Status](https://travis-ci.org/AlexAvlonitis/soql-builder.svg?branch=master)](https://travis-ci.org/AlexAvlonitis/soql-builder)
+
+A ruby SOQL query builder, to build salesforce query strings.
+It doesn't include all the available SOQL queries.
+Contributions are welcome.
+
+## How to use
+
+```ruby
+# ruby
+gem install 'soql_builder'
+
+# rails
+gem 'soql_builder'
+```
+
+```ruby
+require 'soql_builder'
+
+builder = SoqlBuilder.new(type: :select)
+```
+
+**Simple select query**
+```ruby
+# In the fields method you can add parent table fields, an exaple of Contract__r.Name below
+builder.fields(['Name', 'Contract__r.Name'])
+       .from('Account')
+       .where('id = 1')
+
+builder.query
+=> "select Name, Contract__r.Name from Account where id = 1"
+
+# Add a limit
+builder.fields(['Name', 'Contract__r.Name'])
+       .from('Account')
+       .where('id = 1')
+       .limit(1)
+
+builder.query
+=> "select Name, Contract__r.Name from Account where id = 1 limit 1"
+
+```
+
+**Select query with subquery**
+
+```ruby
+builder.fields(['Name', 'Contract__r.Name'])
+       .add_subquery(
+         table: 'Account.Quotes',
+         fields: ['Quotes.Name', 'Quotes.id']
+       )
+       .from('Account')
+       .where('id = 1')
+
+builder.query
+=> "select Name, Contract__r.Name, (select Quotes.Name, Quotes.id from Account.Quotes) from Account where id = 1"
+
+```
+
+**Queries can be added one at a time, instead of chaining**
+
+```ruby
+builder.fields(['Name', 'Contract__r.Name'])
+
+builder.add_subquery(
+         table: 'Account.Quotes',
+         fields: ['Quotes.Name', 'Quotes.id']
+       )
+
+builder.from('Account')
+
+builder.where('id = 1')
+
+builder.query
+=> "select Name, Contract__r.Name, (select Quotes.Name, Quotes.id from Account.Quotes) from Account where id = 1"
+```
+
+

data/lib/soql/query.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Soql
+  class Query
+    attr_accessor :fields, :subquery, :object_table, :where, :limit
+    attr_reader :type
+
+    TYPES = {
+      select: 'select'
+    }.freeze
+
+    def initialize
+      @type = ''
+      @fields = []
+      @subquery = { object_table: '', fields: [] }
+      @object_table = ''
+      @where = ''
+      @limit = ''
+    end
+
+    def type=(type)
+      @type = TYPES[type]
+    end
+
+    def structure_query
+      qs  = type
+      qs += " #{join_fields(fields)}" unless fields.empty?
+      qs += ", (select #{join_fields(subquery[:fields])} from #{subquery[:object_table]})" unless subquery[:fields].empty?
+      qs += " from #{object_table}" unless object_table == ''
+      qs += " where #{where}" unless where == ''
+      qs += " limit #{limit}" unless limit == ''
+      qs
+    end
+
+    private
+
+    def join_fields(fields)
+      fields.join(', ')
+    end
+  end
+end

data/lib/soql/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Soql
+  VERSION = '1.0.5'.freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soql_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Alex Avlonitis
@@ -30,6 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/soql/query.rb
+- lib/soql/version.rb
 - lib/soql_builder.rb
 homepage: https://github.com/AlexAvlonitis/soql-builder
 licenses: