rubyql 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff161429f1ce9cd5f0aeb8ff0e506709ae916c7c
-  data.tar.gz: 1229bce22970e2730c4fb96e7647ed8ad24aebe9
+  metadata.gz: 7ebe793cb41788c0005aea403a8163ee8e1a3d5e
+  data.tar.gz: 6c055b0202a59cb35f06db26d906dc3ac37f631d
 SHA512:
-  metadata.gz: 76f777f681ed4c59b9715f8c37b3398b5fdaeef6ce33f98bcba94bdd9780f3676fd62bebd51b3ad6166a88117781fa5dd46cc796c84580330ca434382b6d43a3
-  data.tar.gz: 84b2a60a17d0b30aeb2016c69910b4b6f8d3c3a97d0dfd918b3e0604e23dd1966c08a131139ce35dd35ea787c1bea945740012ee6b9e5cb7287e0523dc1dfe5d
+  metadata.gz: a97cc880a462bbb7474d01d6279b51c198af8e1aa9bb2f2c904ccfa0034f961c6bf61c637bc9ae93d7c9175dafa5dc6581ec2e880340e5f54c29d0d12ca85f84
+  data.tar.gz: 9a3c8cf06369b801006ca7601546b7575bcc67281e7a6c068893964296353cc8d677a8cf4f5cb9dda2c867458e9ead26c94e435f568286eadd4b0c3bf54b9905

data/README.md

@@ -0,0 +1,71 @@
+# RubyQL
+## A query language for ruby hashes
+
+RubyQL is a query language designed for very flexible rest apis or plain ruby hashes.
+
+RubyQL loves it when its used together with ActiveRecord 🤤
+
+Example:
+``` ruby
+  require 'rubyql'
+  
+  class UserQuery < RubyQL
+    def query
+      User.find_by(query_params).attributes
+    end
+  end
+```
+
+The class we created overwrites the query method, to provide a custom mechanism which should return a hash. `query_params` is 
+the hash which holds the provided parameter, like `WHERE` in SQL.
+ 
+**IMPORTANT**: `.attributes` is necessary for ActiveRecord, only returning the actual hash, not the ActiveModel object.
+
+Usage:
+```
+  UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+  => {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
+  
+  UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+  => {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
+  
+  UserQuery.new({"lastname"=>"", "email"=>"", "id"=>1}).execute
+  => {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1}
+```
+
+As you can see we left the wanted attributes blank, so rubyql will fill them out, if they exist.
+
+For a better understanding another plain ruby example:
+
+``` ruby
+  require 'rubyql
+  
+  class PlainQuery < RubyQL
+    def query
+      {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
+    end
+  end
+```
+
+The method is only returning a simple hash. Now we can execute queries:
+
+```
+  PlainQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com", "id"=>""}).execute
+  => {"firstname"=>"Hanft", "lastname"=>"Niklas", "email"=>"niklas.hanft@outlook.com", "id"=>1337}
+  
+  PlainQuery.new({"email"=>"niklas.hanft@outlook.com", "id"=>"", "another_attribute"=>""}).execute
+  => {"email"=>"niklas.hanft@outlook.com", "id"=>1337, "another_attribute"=>"Hello World"}
+```
+
+As this is static, it doesn't really make sense, but for understanding it might be ok to use it this way. But mainly it
+should be used with a database orm or some dynamic functions which return hashes.
+
+Advanced usage:
+
+*Coming soon*
+
+
+
+
+
+

data/lib/rubyql.rb

@@ -21,8 +21,6 @@ class RubyQL
     end
   end
 
-  private
-
   def response_attr
     @params.select do |key, value|
       value == '' || value.nil?

data/test/user_query_spectr.rb

@@ -0,0 +1,27 @@
+require 'spectr'
+require_relative '../lib/rubyql'
+
+Spectr.new.test 'Test the queryable class' do |test|
+
+  class UserQuery < RubyQL
+    def query
+      {"username"=>"paradoxxger", "firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}
+    end
+  end
+
+  test.assume('The response is a hash', true) do
+    UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute.is_a?(Hash)
+  end
+
+  test.assume('The response equals the given hash', {"firstname"=>"Niklas", "lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}) do
+    UserQuery.new({"firstname"=>"", "lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+  end
+
+  test.assume('The response equals the given hash, removing some attributes', {"lastname"=>"Hanft", "email"=>"niklas.hanft@outlook.com"}) do
+    UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).execute
+  end
+
+  test.assume('The query_params are only the email', {"email" => "niklas.hanft@outlook.com"}) do
+    UserQuery.new({"lastname"=>"", "email"=>"niklas.hanft@outlook.com"}).query_params
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyql
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Niklas Hanft
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/rubyql.rb
+- test/user_query_spectr.rb
 homepage: https://github.com/ParadoXxGER/rubyql
 licenses:
 - MIT