activequery 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 604df6bd427cfff0873ed44e5812adf4fc61584a6c51dbba5ec92fb18f5cac11
-  data.tar.gz: 3b99b1b2cc2b17bbaefcda6e89666dffa5ef9c99b68b6484012318e60cf6a6cb
+  metadata.gz: 72acf6bff5b58b74b7738ac87e50ca9aa520e4186a3d46b85294fc7671e5bce0
+  data.tar.gz: c6dd9784750fa6d6f8cefbe24bc5333c79b8e3d5a063a27f5f5acdbff89b832d
 SHA512:
-  metadata.gz: ce0c3882bd16c514e661ce1942f2f028754e2a1995766a71da3080abfd50ce465619822b853a56b7e7186529cc90870590b70e1b5dc4d54dadc76f915461e958
-  data.tar.gz: 35321a4999149a389919979d7f8363a786bd6f94a7d0fe825b8d36a70ecb8aff3394207fab5969967ee17c2e5ad41e335c937efaf78bd62f4c89015b76647836
+  metadata.gz: 86eaede33b0564252eef9216bdee12f9e62a5ee23417281ffa7aff6326fcd521545dcd2b3670ee9c5f38a0df9a4c891aaa8f80aa934eb4f96d46c3821f23f52b
+  data.tar.gz: 3e7423324da0a9733c87ee8b545b4852f1b20988b170fc1fb3a8aecc519b97d951aefccab7c4ed82fc805866cc25b70a92f52882af480f8819bd7de7970813f6

data/Gemfile.lock

@@ -1,13 +1,16 @@
 PATH
   remote: .
   specs:
-    activequery (0.1.0)
+    activequery (0.2.0)
       strscan (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
     coderay (1.1.2)
+    memory_profiler (0.9.14)
     method_source (0.9.2)
     minitest (5.11.3)
     pg (1.1.4)
@@ -22,6 +25,7 @@ PLATFORMS
 
 DEPENDENCIES
   activequery!
+  benchmark-memory (~> 0.1.2)
   bundler (~> 1.17)
   minitest (~> 5.0)
   pg (~> 1.0)

data/README.md

@@ -2,19 +2,28 @@
 
 [![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)
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 
-### SQL & ruby 	
-Ideal for reports, large queries, separating SQL from code logic, command and query responsibility segregation (CQRS)
+
+### SQL & Ruby 	
+Ideal for reports, large queries, separating SQL from code logic,
+query optimization, 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
+-- name: find_product
+-- example with params 
+SELECT * FROM products 
+WHERE units_in_stock > :units
+AND product_name LIKE ':name';
+
+-- name: insert_category
+INSERT INTO categories (category_id, category_name, description) 
+VALUES(<%= rand 248...599 %>, 'books', 'ruby books');
+
 ```
 
 ```ruby 
@@ -82,6 +91,21 @@ end
 - [ ] Generate CRUD 
 
 
+## Dev Notes:
+```console 
+# create demo database (sudo su postgres)
+rake db:create
+rake db:import
+rake db:drop
+
+# tests 
+rake test:unit
+rake test:integration
+rake test:system
+rake test:bench
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mtunjic/activequery.

data/Rakefile

@@ -1,19 +1,6 @@
 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
+FileList["lib/tasks/*.rake"].each { |f| load f }
 
-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
+task :default => "test:unit"

data/activequery.gemspec

@@ -41,13 +41,13 @@ Gem::Specification.new do |spec|
 
 
   spec.add_runtime_dependency 'strscan', '~> 1.0'
-
+  #spec.add_runtime_dependency 'zscan', '~> 2.0.5' 
 
   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'
-
-
+  spec.add_development_dependency 'benchmark-memory', '~> 0.1.2'
+  
 end

data/lib/active_query.rb

@@ -32,6 +32,16 @@ module ActiveQuery
     PostgresqlAdapter.open(con_str) { |c| c.exec(query) }
   end
 
+  def self.run_params(query, params)
+    if query.is_a? Symbol
+      query = self.send(query)
+    end
+    con_str = ActiveQuery.config.connection
+    PostgresqlAdapter.open(con_str) do |conn| 
+      conn.exec_params(query, params) 
+    end
+  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.
@@ -51,19 +61,6 @@ module ActiveQuery
     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
@@ -72,9 +69,10 @@ module ActiveQuery
   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 
+
+  t.templates.each do |query| 
+    define_singleton_method(:"#{query.name}") do |params=nil|
+      query.query
     end
   end
 
@@ -82,7 +80,5 @@ module ActiveQuery
   rescue ApplicationError => err
       $stderr.puts "%p ::SQLTemplate.load! %s" % [ err.class, err.message ]
 
-end
-
-
 
+end

data/lib/active_query/data_adapters/adapter_base.rb

@@ -7,9 +7,13 @@ module ActiveQuery
         @connection = connection
       end
 			
-      def exec(param)
+      def exec(conn)
         raise "Not implemented"
 			end
+
+      def exec_params(params)
+        raise "Not implemented"
+      end 
 		end
 	end
 end

data/lib/active_query/data_adapters/postgresql_adapter.rb

@@ -11,7 +11,7 @@ module ActiveQuery
           yield(conn)
         rescue PG::Error => err
           $stderr.puts "%p PgConn::open: %s" % [ err.class, err.message ]
-          conn.reset   
+          conn.reset if conn   
         ensure
           conn.close if conn
         end

data/lib/active_query/sql_parser.rb

@@ -1,6 +1,6 @@
 module ActiveQuery
   module SQLParser
-    
+
     require 'strscan'
     class SyntaxError < StandardError; end
 
@@ -9,35 +9,63 @@ module ActiveQuery
     WHITESPACE = /\s+/
     NAME = /^\s*--\s*name\s*:\s*(.+)/
     END_QUERY = /;/
+    PARAMS = /\(\:\s*([^)]+?)\s*\)/
+    ALL_COMMENTS = /(?-m:--.*)|(?m:--\*.--?\*\/)/
+    PARAM = /:\w+/
    
-    def self.parse_file(text)
-      @scanner = StringScanner.new(text)
+    def self.parse_query(query)
+      @scanner = StringScanner.new(query)
       @line = 0
-      @queries = []
+      @query = Query.new 
 
       until @scanner.eos? || @scanner.check_until(END_QUERY).nil? 
         @line += 1
-        @queries << parse_line
+        parse_line
       end
-      @queries
+      @query.query = make_params(@query.query, @query.params)
+      @query
     end
 
     private
     def self.parse_line
-      @scanner.skip(NAME)
+      @query.params = []
       
+      # Query name match: --name
+      @scanner.skip(NAME)
       qname = @scanner.captures
       if qname
-        qname = qname.first
+        @query.name = 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})" 
+      @query.query = @scanner.rest
+      fail SyntaxError unless @query.query
+
+      # All params 
+      until @scanner.check_until(PARAM).nil?
+        @scanner.scan_until(PARAM)
+        @query.params.push @scanner.matched
+      end
+
+      # End of query match: ;
+      @scanner.scan_until(END_QUERY)
+    end
+
+    # and this only work for postgres - split transform from struct
+    def self.make_params(query, params)
+      if params && query
+        params.each_with_index do |param, i| 
+          pos = "$#{i+1}"
+          query.gsub!(param, pos) 
+        end
+        query.strip if query
+      else
+        query.strip if query
       end
-      Query.new(qname, "", "", query) 
     end
+
+
   end
 end
+

data/lib/active_query/sql_template.rb

@@ -15,7 +15,7 @@ module ActiveQuery
 
     def initialize(config = Configuration.new)
       @config = config
-      @templates = {}
+      @templates = []
     end
 		
 		def load!
@@ -25,18 +25,14 @@ module ActiveQuery
 			else 
 				Find.find(template_path) do |path| 
 					if File.basename(path) =~ /sql$/
-						parse_sql(path)
+						@templates << parse_sql(path)
 					end
 				end
 			end
 		end
 
 		def templates
-			@templates ||= Hash.new 
-		end
-
-		def self.get(query)
-			@templates[query.to_s]
+			@templates ||= [] 
 		end
 		
 		private 
@@ -46,8 +42,7 @@ module ActiveQuery
 
 		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 }
+			ActiveQuery::SQLParser.parse_query(sql_template)
 		end
 
 	end

data/lib/active_query/version.rb

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

data/lib/tasks/db.rake

@@ -0,0 +1,33 @@
+namespace :db do 
+  desc "Create test database " 
+  task :create do
+    # or createuser --interactive joe
+    sh "sudo su postgres"
+    sh "dropdb --if-exists northwind"
+    sh "dropuser --if-exists northwind_user"
+    sh "createdb northwind"
+    puts 'The demo db is created.' 
+  end
+
+  desc "Import data "
+  task :import do 
+    cmds = %q{ 
+      psql northwind < ./test/integration/northwind/northwind.sql
+
+      psql --no-psqlrc template1 -c "create user northwind_user;"
+      psql --no-psqlrc template1 -c "alter user northwind_user password 'thewindisblowing';"
+      psql --no-psqlrc template1 -c "grant all on DATABASE northwind to northwind_user;"
+      psql --no-psqlrc northwind -c "GRANT ALL on ALL tables IN SCHEMA public to northwind_user"
+    }
+    sh cmds
+    puts 'The northwind db is imported.' 
+  end
+
+  desc "Drop test database " 
+  task :drop do
+    sh "dropdb --if-exists northwind"
+    sh "dropuser --if-exists northwind_user"
+    puts 'The demo db is droped.' 
+  end
+
+end

data/lib/tasks/test.rake

@@ -0,0 +1,31 @@
+namespace :test do
+  
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/*_test.rb"]
+  end
+
+  desc "Run system tests"
+  Rake::TestTask.new(:system) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/system/*_test.rb"]
+  end
+
+  desc "Run integration tests"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/integration/*_test.rb"]
+  end
+
+  desc "Run benchmark"
+  Rake::TestTask.new(:bench) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList["test/benchmark/*_bench.rb"]
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activequery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strscan
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: Raw sql with ruby - ideal for reports, large queries, separating SQL
   from code logic and CQRS
 email:
@@ -123,6 +137,8 @@ files:
 - lib/active_query/sql_renderer.rb
 - lib/active_query/sql_template.rb
 - lib/active_query/version.rb
+- lib/tasks/db.rake
+- lib/tasks/test.rake
 homepage: https://github.com/mtunjic/activequery
 licenses:
 - MIT