activequery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 604df6bd427cfff0873ed44e5812adf4fc61584a6c51dbba5ec92fb18f5cac11
+  data.tar.gz: 3b99b1b2cc2b17bbaefcda6e89666dffa5ef9c99b68b6484012318e60cf6a6cb
+SHA512:
+  metadata.gz: ce0c3882bd16c514e661ce1942f2f028754e2a1995766a71da3080abfd50ce465619822b853a56b7e7186529cc90870590b70e1b5dc4d54dadc76f915461e958
+  data.tar.gz: 35321a4999149a389919979d7f8363a786bd6f94a7d0fe825b8d36a70ecb8aff3394207fab5969967ee17c2e5ad41e335c937efaf78bd62f4c89015b76647836

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activequery.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    activequery (0.1.0)
+      strscan (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pg (1.1.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    strscan (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activequery!
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pg (~> 1.0)
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marko
+
+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,91 @@
+# ActiveQuery
+
+[![Build Status](https://travis-ci.org/mtunjic/activequery.svg?branch=master)](https://travis-ci.org/mtunjic/activequery)
+[![Gem Version](https://badge.fury.io/rb/activequery.svg)](https://badge.fury.io/rb/activequery)
+
+### SQL & ruby 	
+Ideal for reports, large queries, separating SQL from code logic, command and query responsibility segregation (CQRS)
+
+> Ruby is a great language for writing DSLs, but we don't need a new one. SQL is already a mature DSL. 
+> (Don't agree? Wait until this extra syntax layer breaks down and you start wrestling with a (raw-sql) function.)
+> ~ Kris Jenkins (yesql)
+
+```SQL
+-- name: users_by_country
+SELECT *
+FROM users
+WHERE country_code = :country_code
+```
+
+```ruby 
+ActiveQuery.users_by_country              # return raw sql 
+# You use symbols as params 
+ActiveQuery.run(:users_by_country)        # run query as full-scan 
+# async call, stream the results Postgres only
+ActiveQuery.async_run(:all_users) {|u| puts u["name"] }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activequery'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activequery
+
+## Usage
+
+ Create template dir inside your app
+
+```console
+mkdir -p app/sqltemplates
+touch app/sqltemplates/my_query.sql
+```
+
+Add created path to config 
+For Rails users: 
+
+```console
+activequery rails
+```
+
+Configure:
+
+```ruby 
+ActiveQuery.configure do |config|
+  config.template_path = "."
+  config.adapter = :postgres
+  config.connection = "dbname=rails6pg_development user=dev"
+end
+```
+
+### TODO:
+- [x] Ruby On Rails easy integration
+- [x] PostgreSQL Adapter
+- [x] Ruby erb inside sql template files 
+- [x] Async/Stream results (ideal for realtime reporting/analytics)
+- [ ] Named parameters, and ?-style positional parameters 
+- [ ] class: MyClass param to create or extend ruby class with 
+- [ ] Import/Export to Materialized Views 
+- [ ] Retrieving SQL templates from custom stores (Redis, Riak)
+- [ ] Add connection pooling. (If you use this with Rails ActiveRecord has its own connection pool)
+- [ ] Add Actors/Workers
+- [ ] MySQL and SQLite providers
+- [ ] Generate CRUD 
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mtunjic/activequery.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+namespace :active_query do 
+  desc "Create config file for Rails" 
+  task :setup do
+    rails_initializer_path = 'config/initializers/active_query.rb'
+    open(rails_initializer_path, 'w') { |f| f << "This file contains great truths.\n" }
+    puts 'The config file is created to config/initializers.' 
+  end
+end
+
+task :default => :test

data/activequery.gemspec

@@ -0,0 +1,53 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_query/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activequery"
+  spec.version       = ActiveQuery::VERSION
+  spec.authors       = ["Marko"]
+  spec.email         = ["marko.tunjic@live.com"]
+
+  spec.summary       = %q{A Ruby library for using SQL (Streaming, CQRS)}
+  spec.description   = %q{Raw sql with ruby - ideal for reports, large queries, separating SQL from code logic and CQRS}
+  spec.homepage      = "https://github.com/mtunjic/activequery"
+  spec.license       = "MIT"
+
+  spec.files        = Dir["CHANGELOG.md", "MIT-LICENSE", "README.rdoc", "lib/**/*"]
+  spec.require_path = "lib"
+
+  # spec.extra_rdoc_files = %w(README.rdoc)
+  # spec.rdoc_options.concat ["--main",  "README.rdoc"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["activequery"]
+  spec.require_paths = ["lib"]
+
+
+  spec.add_runtime_dependency 'strscan', '~> 1.0'
+
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'pg', '~> 1.0'
+
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activequery"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/activequery

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# TODO: use Railtie for rails rake tasks
+
+CONFIG_FILE = 
+%q{
+require 'active_query'
+TEMPLATE_PATH = Rails.root.join('app', 'templates')
+# Adapters: postgres, sqlite, mysql
+ActiveQuery.configure do |config|
+  config.template_path = TEMPLATE_PATH.to_s
+  config.adapter = :postgres
+  #config.connection = "dbname=test user=dev"
+end
+}.strip
+
+def create_config_file
+  rails_initializer_path = 'config/initializers/active_query.rb'
+  open(rails_initializer_path, 'w') { |f| f << CONFIG_FILE }
+  puts 'The config file is created to config/initializers.' 
+end
+
+if ARGV[0] == "rails"
+  create_config_file
+else 
+  puts "Usage: activequery rails"
+end

data/lib/active_query/config.rb

@@ -0,0 +1,14 @@
+require_relative "configuration"
+
+module ActiveQuery
+  module Config
+
+    TEMPLATE_PATH = File.expand_path('../../test/templates', __dir__)
+    puts TEMPLATE_PATH
+    ActiveQuery.configure do |config|
+    	config.template_path = TEMPLATE_PATH
+    	config.adapter = :postgres
+    	config.connection = "host=localhost port=5432 dbname=rails6pg_development connect_timeout=10 user=dev"
+    end
+  end
+end

data/lib/active_query/configuration.rb

@@ -0,0 +1,14 @@
+module ActiveQuery
+  class Configuration
+    attr_accessor :template_path, :adapter, :connection
+
+    def initialize(options = {}, &block)
+      @template_path = ""
+      @adapter = ""
+      @connection = ""
+      options.each { |k,v| send("#{k}=", v) }
+      instance_eval(&block) if block_given?
+    end
+
+  end
+end

data/lib/active_query/data_adapters/adapter_base.rb

@@ -0,0 +1,15 @@
+module ActiveQuery
+	module DataAdapters
+		class AdapterBase
+      
+      def initialize(connection, logger = nil, config = {}) 
+        super()
+        @connection = connection
+      end
+			
+      def exec(param)
+        raise "Not implemented"
+			end
+		end
+	end
+end

data/lib/active_query/data_adapters/postgresql_adapter.rb

@@ -0,0 +1,22 @@
+module ActiveQuery
+	module DataAdapters
+    require_relative "adapter_base"
+
+		class PostgresqlAdapter < AdapterBase
+
+      def self.open(params)
+        begin 
+          conn = PG::connect(params)
+          return conn unless block_given?
+          yield(conn)
+        rescue PG::Error => err
+          $stderr.puts "%p PgConn::open: %s" % [ err.class, err.message ]
+          conn.reset   
+        ensure
+          conn.close if conn
+        end
+      end
+		end #PostgresqlAdapter
+
+	end
+end

data/lib/active_query/sql_parser.rb

@@ -0,0 +1,43 @@
+module ActiveQuery
+  module SQLParser
+    
+    require 'strscan'
+    class SyntaxError < StandardError; end
+
+    Query = Struct.new(:name, :params, :comment, :query) 
+  
+    WHITESPACE = /\s+/
+    NAME = /^\s*--\s*name\s*:\s*(.+)/
+    END_QUERY = /;/
+   
+    def self.parse_file(text)
+      @scanner = StringScanner.new(text)
+      @line = 0
+      @queries = []
+
+      until @scanner.eos? || @scanner.check_until(END_QUERY).nil? 
+        @line += 1
+        @queries << parse_line
+      end
+      @queries
+    end
+
+    private
+    def self.parse_line
+      @scanner.skip(NAME)
+      
+      qname = @scanner.captures
+      if qname
+        qname = qname.first
+      else
+        fail SyntaxError, "error on line #{@line} (pos. #{@scanner.pos})"
+      end
+
+      query = @scanner.scan_until(END_QUERY)
+      unless query
+        fail SyntaxError, "error on line #{@line} (pos. #{@scanner.pos})" 
+      end
+      Query.new(qname, "", "", query) 
+    end
+  end
+end

data/lib/active_query/sql_renderer.rb

@@ -0,0 +1,15 @@
+module ActiveQuery
+
+  class SQLRenderer
+    require "erb"
+
+    def initialize(template)
+      @template = template
+    end
+
+    def render
+      ERB.new(@template).result(binding)
+    end
+  end
+
+end

data/lib/active_query/sql_template.rb

@@ -0,0 +1,54 @@
+module ActiveQuery
+
+	class ApplicationError < StandardError; end
+	class TemplatePathError < ApplicationError; end
+	class ScannerError < ApplicationError; end
+
+	class SQLTemplate
+
+		require_relative "sql_parser" 
+		require 'erb'
+		require 'find'
+
+		attr_accessor :config
+		attr_reader :templates
+
+    def initialize(config = Configuration.new)
+      @config = config
+      @templates = {}
+    end
+		
+		def load!
+			template_path = @config.template_path
+			unless File.directory?(template_path) 
+				raise TemplatePathError, "error: #{template_path} template path is invalid, please make sure it exists."
+			else 
+				Find.find(template_path) do |path| 
+					if File.basename(path) =~ /sql$/
+						parse_sql(path)
+					end
+				end
+			end
+		end
+
+		def templates
+			@templates ||= Hash.new 
+		end
+
+		def self.get(query)
+			@templates[query.to_s]
+		end
+		
+		private 
+		def read_sql_file(path:)
+			open(path, "r") { |t| ERB.new(t.read).result(binding) } 
+		end
+
+		def parse_sql(path)
+			sql_template = read_sql_file(path: path)
+			sql = ActiveQuery::SQLParser.parse_file(sql_template)
+			sql.each {|q| @templates[q.name] = q.query.strip }
+		end
+
+	end
+end

data/lib/active_query/version.rb

@@ -0,0 +1,3 @@
+module ActiveQuery
+  VERSION = "0.1.0"
+end

data/lib/active_query.rb

@@ -0,0 +1,88 @@
+require "active_query/version"
+require "active_query/configuration"
+require "active_query/sql_template"
+require "active_query/data_adapters/postgresql_adapter"
+require 'pg'
+module ActiveQuery
+  include ActiveQuery::DataAdapters
+  # Configuration
+  class << self
+    attr_writer :config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.reset
+    @config = Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+  
+  # runners... 
+  # Full-Scan
+  def self.run(query)
+    if query.is_a? Symbol
+      query = self.send(query)
+    end
+    con_str = ActiveQuery.config.connection
+    PostgresqlAdapter.open(con_str) { |c| c.exec(query) }
+  end
+
+  # async_exec(sql) {|pg_result| block } 
+  # This function has the same behavior as sync_exec, but is implemented using the
+  # asynchronous command processing API of libpq.
+  def self.async_run(query, &block)
+    con_str = ActiveQuery.config.connection
+   
+    if query.is_a? Symbol
+      query = self.send(query)
+    end
+
+    PostgresqlAdapter.open(con_str) do |conn| 
+      conn.send_query(query)
+      conn.set_single_row_mode
+      conn.get_result.stream_each do |row|
+         yield(row)
+      end
+    end
+  end
+
+  def self.reload!
+    #t = ActiveQuery::SQLTemplate.new(ActiveQuery.config)
+    t = ActiveQuery::SQLTemplate.new(self.config)
+    t.load!
+    t.templates.each do |qname, query| 
+      define_singleton_method("#{qname}") do  
+        query 
+      end
+    end
+  rescue ApplicationError => err
+    $stderr.puts "%p ::SQLTemplate.load! %s" % [ err.class, err.message ]
+  end
+
+  # WIP Init config 
+  require "active_query/config"
+  include ActiveQuery::Config
+  # Build heleper methods for query names
+  #fail TemplatePathError, "templates path missing" if self.config.template_path.empty?
+  puts "Loading SQL templates from #{self.config.template_path}" 
+  t = ActiveQuery::SQLTemplate.new(self.config)
+  t.load!
+  t.templates.each do |qname, query| 
+    define_singleton_method("#{qname}") do  
+      query 
+    end
+  end
+
+  puts "SQL templates loaded." 
+  rescue ApplicationError => err
+      $stderr.puts "%p ::SQLTemplate.load! %s" % [ err.class, err.message ]
+
+end
+
+
+

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: activequery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: strscan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Raw sql with ruby - ideal for reports, large queries, separating SQL
+  from code logic and CQRS
+email:
+- marko.tunjic@live.com
+executables:
+- activequery
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activequery.gemspec
+- bin/console
+- bin/setup
+- exe/activequery
+- lib/active_query.rb
+- lib/active_query/config.rb
+- lib/active_query/configuration.rb
+- lib/active_query/data_adapters/adapter_base.rb
+- lib/active_query/data_adapters/postgresql_adapter.rb
+- lib/active_query/sql_parser.rb
+- lib/active_query/sql_renderer.rb
+- lib/active_query/sql_template.rb
+- lib/active_query/version.rb
+homepage: https://github.com/mtunjic/activequery
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mtunjic/activequery
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby library for using SQL (Streaming, CQRS)
+test_files: []