hash_sql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da65f98d338f1af5177476ab817339484ea99364
+  data.tar.gz: b10cca603a1a2bd644e70a61589fe98f3d729aab
+SHA512:
+  metadata.gz: 9d25a94ea23473b68915651d151f50988422a8d69650e276a584085287e845a8a01728d335c315bdfd8ccf5d3873b8f8f3ba7959b892500e099db4479306d551
+  data.tar.gz: b779a6ba3e2ef6fd1353ca3cfaf603eebd1da669bd87e680b6e987e48d97f67e37d971cc63d00109186d5e3bdc27888f5d19505c01d9e67a66a61f3db619d7da

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_sql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nick Delos Santos (code@nickdsantos.com)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# HashSql
+
+Create SQL statements using Hashes. 
+*(Currently only supports SELECT statements.)*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_sql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_sql
+
+## Usage
+
+```ruby
+# Basic query
+# Will produce:
+#   SELECT UID,profile.firstName,profile.lastName,profile.email 
+#   FROM accounts 
+#   WHERE profile.email='test05@mailinator.com' 
+#      AND (profile.firstName='Five' AND profile.lastName='Zero')
+#
+query = HashSql.select_statement(:accounts,
+    fields: ['UID', 'profile.firstName', 'profile.lastName', 'profile.email'],
+    filter: {
+      "profile.email" => "='test05@mailinator.com'", 
+      and: { "profile.firstName" => "='Five'", "profile.lastName" => "='Zero'" }
+    }
+)
+
+# Nested conditions
+# Will produce:
+#   SELECT UID,profile.firstName,profile.lastName,profile.email 
+#    FROM accounts 
+#    WHERE profile.email='test05@mailinator.com' 
+#      AND (profile.firstName='Five' 
+#        OR (profile.lastName='Zero' AND isActive=true))
+#
+query = HashSql.select_statement(:accounts,
+    fields: ['UID', 'profile.firstName', 'profile.lastName', 'profile.email'],
+    filter: {
+      "profile.email" => "='test05@mailinator.com'", 
+      and: { "profile.firstName" => "='Five'", or: { "profile.lastName" => "='Zero'", and: { "isActive" => "=true" } } }
+    }
+)
+```
+
+## Filter Hash
+
+### Comparison
+The filter to use for searching accounts. The key is the field name
+to set the filter on, and the value is the concatenation of the
+operator to use for comparison and the value used for comparing.
+Example: 
+```ruby
+{ email: "='test@abc.com'"}
+```
+
+### AND and ORs:
+The logical operations between filters can be AND or OR and the 
+it could be set by setting the key to either "and:" or "or:"
+Example: 
+```ruby
+{ email: "='test@abc.com", and: {firstname: "='Nick'"} }
+```
+Will be translated to: ```email='test@abc.com' AND firstname = 'Nick'```
+
+If multiple entries are placed inside an "and:" or "or:" they will
+"ANDed" or "ORed" together.
+Example: 
+```ruby
+{ email: "='test@abc.com", and: {firstname: "='Nick'", lastname: "='DS'"} }
+```
+Will be translated to ```email='test@abc.com' AND (firstname = 'Nick' AND lastname = 'DS')```
+
+Example: 
+```ruby
+{ email: "='test@abc.com", or: {firstname: "='Nick'", lastname: "='DS'"} }
+```
+Will be translated to ```email='test@abc.com' OR (firstname = 'Nick' OR lastname = 'DS')```
+
+### NESTING
+Example: 
+```ruby
+{ email: "='test@abc.com", and: {firstname: "='Nick'", or: {lastname: "='DS'"}} }
+```
+Will be translated to ```email='test@abc.com' AND (firstname = 'Nick' OR lastname = 'DS') ```
+
+## Contributing
+
+1. Fork it ( https://github.com/nicknux/hash_sql/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/hash_sql.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_sql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_sql"
+  spec.version       = HashSql::VERSION
+  spec.authors       = ["nicknux"]
+  spec.email         = ["code@nickdsantos.com"]
+  spec.summary       = %q{Create SQL statements using Hashes.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec'    
+end

data/lib/hash_sql.rb

@@ -0,0 +1,86 @@
+require "hash_sql/version"
+
+module HashSql
+  # Creates a SQL Select Statement
+  # @param [String] table The table name to select records from  
+  # @param [Hash] options Additional options for the query
+  # @option options [Array] fields An array of field names to return in the seach result 
+  # @option options [Hash] filter 
+  #   The filter to use for searching accounts. The key is the field name
+  #   to set the filter on, and the value is the concatenation of the
+  #   operator to use for comparison and the value used for comparing.
+  #   Example: { email: "='test@abc.com'"}
+  # 
+  #   AND and ORs:
+  #   The logical operations between filters can be AND or OR and 
+  #   it could be set by setting the key to either "and:" or "or:"
+  #   Example: { email: "='test@abc.com", and: {firstname: "='Nick'"} }
+  #   Will be translated to email='test@abc.com' AND firstname = 'Nick'
+  #   
+  #   If multiple entries are placed inside an "and:" or "or:" they will
+  #   "ANDed" or "ORed" together.
+  #   Example: { email: "='test@abc.com", and: {firstname: "='Nick'", lastname: "='DS'"} }
+  #   Will be translated to email='test@abc.com' AND (firstname = 'Nick' AND lastname = 'DS')
+  #
+  #   Example: { email: "='test@abc.com", or: {firstname: "='Nick'", lastname: "='DS'"} }
+  #   Will be translated to email='test@abc.com' OR (firstname = 'Nick' OR lastname = 'DS')
+  #
+  #   NESTING
+  #   Example: { email: "='test@abc.com", and: {firstname: "='Nick'", or: {lastname: "='DS'"}} }
+  #   Will be translated to:
+  #   email='test@abc.com' AND (firstname = 'Nick' OR lastname = 'DS') 
+  # @option options [Hash] :order_by The order in which the results are returned. The key is the
+  #   field to order on, and the value is :ASC or :DESC
+  # @option options [Number] :limit the number of results to return
+  # @return [Hash]
+  #
+  def self.select_statement(table, options={})
+    fields = options[:fields]
+    order_by = options[:order_by]
+    limit = options[:limit]
+    filter = options[:filter]
+    query = "SELECT #{fields.join(',')} FROM #{table}"
+
+    filter_string = " WHERE #{parse_filter(filter, nil, '')}" unless filter.nil?
+    order_string = " ORDER BY #{parse_order_by(order_by)}" unless order_by.nil?
+    limit_string = " LIMIT #{limit}" unless limit.nil?        
+    
+    filter_string ||= ''
+    order_string ||= ''
+    limit_string ||= ''
+
+    query = query + filter_string + order_string + limit_string
+  end
+
+  private
+
+  def self.parse_filter(filter={}, operator, filter_string)        
+    filter.each_with_index do |(k, v), index|          
+      if k == :and || k == :or
+        filter_string += "#{k.to_s.upcase} " unless index == 0                 
+        filter_string += '(' unless v.count == 1
+        filter_string = parse_filter(v, k, filter_string)
+        filter_string += ')' unless v.count == 1            
+      else            
+        filter_string += "#{k}#{v} "            
+        if !operator.nil? && index < filter.count - 1 && filter.values[index + 1].class != Hash              
+          filter_string += "#{operator.to_s.upcase} "
+        end
+      end
+    end        
+    filter_string.rstrip
+  end
+
+  def self.parse_order_by(order_by={})
+    order_string = ''
+    order_by.each_with_index do |(k,v), index|
+      if v != :ASC || v != :DESC
+        v = :ASC
+      end
+      order_string += "#{k} #{v.to_s.upcase}"
+      order_string += ',' unless index == order_by.count - 1
+    end
+
+    order_string
+  end  
+end

data/lib/hash_sql/version.rb

@@ -0,0 +1,3 @@
+module HashSql
+  VERSION = "0.0.1"
+end

data/spec/hash_sql_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe HashSql do
+  describe '#query_basic' do
+    it 'returns a query statement using a simple filter' do
+      query = HashSql.select_statement(:accounts,
+        fields: ['UID', 'profile.firstName', 'profile.lastName', 'profile.email'],
+        filter: {
+          "profile.email" => "='test05@mailinator.com'", 
+          and: { "profile.firstName" => "='Five'", "profile.lastName" => "='Zero'" }
+        }
+      )
+      expect(query).to eq("SELECT UID,profile.firstName,profile.lastName,profile.email FROM accounts WHERE profile.email='test05@mailinator.com' AND (profile.firstName='Five' AND profile.lastName='Zero')")
+    end
+  end
+
+  describe '#query_nested' do
+    it 'returns a query statement using nested filters' do
+      query = HashSql.select_statement(:accounts,
+        fields: ['UID', 'profile.firstName', 'profile.lastName', 'profile.email'],
+        filter: {
+          "profile.email" => "='test05@mailinator.com'", 
+          and: { "profile.firstName" => "='Five'", or: { "profile.lastName" => "='Zero'", and: { "isActive" => "=true" } } }
+        }
+      )
+      expect(query).to eq("SELECT UID,profile.firstName,profile.lastName,profile.email FROM accounts WHERE profile.email='test05@mailinator.com' AND (profile.firstName='Five' OR (profile.lastName='Zero' AND isActive=true))")
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'hash_sql'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: hash_sql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nicknux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- code@nickdsantos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_sql.gemspec
+- lib/hash_sql.rb
+- lib/hash_sql/version.rb
+- spec/hash_sql_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Create SQL statements using Hashes.
+test_files:
+- spec/hash_sql_spec.rb
+- spec/spec_helper.rb