pragmatic_ql 0.1.0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abdbb2886a7918395b7cffaedfa8c48a50184f6fe0992499faa69a07577df3bb
-  data.tar.gz: c726d0febeceff92b9a8c1c7b5ff87c12e3e3f0496435bce65e17d466958a749
+  metadata.gz: db43534747874c7bc19d631804a18968be7fce6b5b3cacbc29e27f7e4378d4a0
+  data.tar.gz: 21000233f0760251b44b859403e7ab0fe57826bf94062fb46081adac04886f90
 SHA512:
-  metadata.gz: e11c3e951b236f2ff1539c3ddae27cb79d61bb24efc19fc49b759a109d3e159d7f13e6e89af2a6e08112bcc2efc6ee30289812d786183ff6a9d7df8791d0ae36
-  data.tar.gz: c3a3d6911d16e0ac9bc9e82a8e492e0869ace8904c584ba3b80298f4581b266d11137913df16e72f22737abaf7ddd482fe60745a3ffbe45b86013277de843ff1
+  metadata.gz: 37ac077510f771f4a1e993dd153d4426459260218fb138cd017a7c0d9755313fbbfa015146e1afd5ec6cf0d56d7e1aa3f0e18581ed1e07153b7e174c7b063068
+  data.tar.gz: 8c92696e114c518b725c2f75e06baeb7dc94d0b7d7cec34c7c799c451f9f584b748eebeb15a4eeba5e0517616aff9b8695147274fbfb120819100cc530921f67

data/Gemfile.lock

@@ -1,50 +1,49 @@
 PATH
   remote: .
   specs:
-    pragmatic_ql (0.1.0)
+    pragmatic_ql (0.2)
       activesupport (> 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
+    minitest (5.14.4)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (> 2.0)
   pragmatic_ql!
   rake (~> 10.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.17

data/docs/00_philosophy.md

@@ -0,0 +1,116 @@
+## Philosophy
+
+Most critical part is how to implement the tool not the tool itself.
+Incrorectly implemented solution can do more harm so pls read this.
+
+
+### By default return only ID
+
+
+When you don't include anythnig you will get only the ID back
+
+
+`GET /v3/students`
+
+```json
+[
+  { "id": 123 },
+  { "id": 234 },
+  { "id": 456 }
+]
+```
+
+
+`GET /v3/student/123`
+
+```json
+{
+  "id": 123
+}
+```
+
+Even if you require nested associations without any definition you will
+get just their IDs
+
+```json
+{
+  "id": 123,
+  "work_list": [
+    { "id": 111 },
+    { "id": 222 },
+  ]
+}
+```
+
+This is design intention. You want to provide FE with minimum
+information as possible. If FE need more than just `id` FE will ask
+for it.
+
+
+
+### Associations are seperate includes
+
+
+`?include=student.work_list`
+
+```json
+{
+  "id": 123,
+  "work_list": [
+    { "id": 111 },
+    { "id": 222 },
+  ]
+}
+```
+
+
+`?include=student.comment_list`
+
+```json
+{
+  "id": 123,
+  "comment_list": [
+    { "id": 999 },
+    { "id": 888 },
+  ]
+}
+```
+
+If frontend needs multiple it will ask for it:
+
+`?include=student.comment_list,student.work_list`
+
+```json
+{
+  "id": 123,
+  "comment_list": [
+    { "id": 999 },
+    { "id": 888 },
+  ],
+  "work_list": [
+    { "id": 111 },
+    { "id": 222 },
+  ]
+}
+```
+
+**DON'T** wrap muliple associations into one key
+
+
+`?include=student.stuff`  DON'T
+
+```json
+{
+  "id": 123,
+  "comment_list": [
+    { "id": 999 },
+    { "id": 888 },
+  ],
+  "work_list": [
+    { "id": 111 },
+    { "id": 222 },
+  ]
+}
+```
+
+

data/docs/01_stupid_simple_implementation.md

@@ -27,9 +27,9 @@ class StudentsController < ApplicationController
     resp.merge!({
       first_name: student.first_name,
       last_name: student.last_name
-    }) if student_im.include?(:names)
+    }) if student_im.inclusive_of(:names)
 
-    resp.merge!(date_of_birth: student.first_name) if student_im.include?(:dob)
+    resp.merge!(date_of_birth: student.first_name) if student_im.include(:dob)
 
     render json: resp
   end

data/docs/02_serializer_example.md

@@ -23,7 +23,7 @@ end
 
 ```ruby
 # app/model/image.rb
-class image < ApplicationRecord
+class Image < ApplicationRecord
   # model has fields: "id", "priority", "work_id"
 
   belongs_to :work
@@ -82,7 +82,7 @@ class StudentSerializer
 
   private
 
-  # feel free to group multiple fields uder one include key
+  # feel free to group multiple fields uder one include key as long as they make Domain and performance sense
   def name_hash
     {
        first_name: student.first_name,
@@ -306,3 +306,4 @@ When you query `/students/123?include=student.name,student.work_list,student.wor
   ]
 }
 ```
+

data/lib/pragmatic_ql/version.rb

@@ -1,3 +1,3 @@
 module PragmaticQL
-  VERSION = "0.1.0.1"
+  VERSION = "0.2"
 end

data/pragmatic_ql.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", "> 4" # I use goodies like .try?() .blank?()
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragmatic_ql
 version: !ruby/object:Gem::Version
-  version: 0.1.0.1
+  version: '0.2'
 platform: ruby
 authors:
 - Tomas Valent
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -33,16 +33,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/00_philosophy.md
 - docs/01_stupid_simple_implementation.md
 - docs/02_serializer_example.md
 - lib/pragmatic_ql.rb
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Simple query language for JSON based APIs