pg_serializable 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 52b59e980da06293df94c9f2b794587960a3a1bf
-  data.tar.gz: c8b3189b569853a8f0adc30b8f4b1037f0016361
+SHA256:
+  metadata.gz: 2412f2861f08e20be5822ca7db5557e39017a451c1736bf3833aa2358e20812e
+  data.tar.gz: 5e696c9b943484d1eb2b3f19f1797212ac3593a03cd74c191b9ec410c68000ee
 SHA512:
-  metadata.gz: 5dff0d8070efa302ed38f03c081851dcfbb9c0a933e525870d87a75eccd4ec6861676ee9a8771c062df6b11b62ac57eb7d536318a1ea4020511f22501e730de0
-  data.tar.gz: 7d0e69567b8be5aa95038456598f9669cef49410d4acc8bb5cd969768f1e6c856dcc61f43f2940e12f2d3b57b0d3432295a62a827e3fd50f47f6fe1f1a00a2e5
+  metadata.gz: 2885d036b4e2b81e23444aac10b5edadc5f9a2fab31818b1fdea666a600bc026e199e1d856134045782006512bd24abf4fda0dfb6ae0a69ff2eae0078a5f0741
+  data.tar.gz: 13914aff5bc7e29849b94022f84a8af6b70ea3637cb1034f8848c9192d2ce9c84cc4e56d10e9c59c4767cc4abcb5b2a4708d00819c47daa642b7c1ee5b735b79

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/README.md

@@ -41,7 +41,7 @@ class Api::ProductsController < ApplicationController
 end
 ```
 ```shell
-Completed 200 OK in 2521ms (Views: 2431.8ms | ActiveRecord: 45.7ms)
+Completed 200 OK in 2975ms (Views: 2944.2ms | ActiveRecord: 29.9ms)
 ```
 
 Using fast_jsonapi:
@@ -51,12 +51,16 @@ class Api::ProductsController < ApplicationController
     @products = Product.limit(200)
                        .order(updated_at: :desc)
                        .includes(:categories, :label, variations: :color)
-    render json: ProductSerializer.new(@products).serialized_json
+    options = {
+      include: [:categories, :variations, :label, :'variations.color']
+    }
+
+    render json: ProductSerializer.new(@products, options).serialized_json
   end
 end
 ```
 ```shell
-Completed 200 OK in 315ms (Views: 0.2ms | ActiveRecord: 50.3ms)
+Completed 200 OK in 542ms (Views: 0.5ms | ActiveRecord: 29.0ms)
 ```
 
 Using PgSerializable:
@@ -68,14 +72,15 @@ class Api::ProductsController < ApplicationController
 end
 ```
 ```shell
-Completed 200 OK in 109ms (Views: 0.2ms | ActiveRecord: 87.1ms)
+Completed 200 OK in 54ms (Views: 0.1ms | ActiveRecord: 43.0ms)
 ```
 
 Benchmarking `fast_jsonapi` against `pg_serializable` on 100 requests:
 ```shell
                       user     system      total        real
-fast_jsonapi     21.510000   0.700000  22.210000 ( 26.994325)
-pg_serializable   1.470000   0.170000   1.640000 (  9.187275)
+jbuilder        175.620000  70.750000 246.370000 (282.967300)
+fast_jsonapi     37.880000   0.720000  38.600000 ( 48.234853)
+pg_serializable   1.180000   0.080000   1.260000 (  4.150280)
 ```
 
 You'll see the greatest benefits from PgSerializable for deeply nested json objects.
@@ -133,7 +138,7 @@ attributes :name, :id
 ```
 results in:
 ```json
-[  
+[
   {
     "id": 503,
     "name": "Direct Viewer"
@@ -233,6 +238,7 @@ Supported associations:
 - `belongs_to`
 - `has_many`
 - `has_many :through`
+- `has_and_belongs_to_many`
 - `has_one`
 
 #### belongs_to
@@ -240,7 +246,7 @@ Supported associations:
 serializable do
   default do
     attributes :id, :name
-    belongs_to: :label
+    belongs_to :label
   end
 end
 ```
@@ -270,7 +276,7 @@ class Product < ApplicationRecord
   serializable do
     default do
       attributes :id, :name
-      has_many: :variations
+      has_many :variations
     end
   end
 end
@@ -279,7 +285,7 @@ class Variation < ApplicationRecord
   serializable do
     default do
       attributes :id, :name
-      belongs_to: :color
+      belongs_to :color
     end
   end
 end
@@ -392,8 +398,103 @@ end
   }
 ]
 ```
+
+#### has_many_and_belongs_to_many
+```ruby
+class Product < ApplicationRecord
+  has_and_belongs_to_many :categories
+
+  serializable do
+    default do
+      attributes :id
+      has_and_belongs_to_many :categories
+    end
+  end
+end
+
+class Category < ApplicationRecord
+  serializable do
+    default do
+      attributes :name, :id
+    end
+  end
+end
+```
+
+```json
+[
+  {
+    "id": 503,
+    "categories": [
+      {
+        "name": "Juliann",
+        "id": 13
+      },
+      {
+        "name": "Teressa",
+        "id": 176
+      },
+      {
+        "name": "Garret",
+        "id": 294
+      }
+    ]
+  },
+  {
+    "id": 502,
+    "categories": [
+      {
+        "name": "Rossana",
+        "id": 254
+      }
+    ]
+  }
+]
+```
+
 #### has_one
-TODO: write examples
+
+```ruby
+class Product < ApplicationRecord
+  has_one :variation
+
+  serializable do
+    default do
+      attributes :name, :id
+      has_one :variation
+    end
+  end
+end
+```
+
+```json
+[
+  {
+    "name": "GPS Kit",
+    "id": 1003,
+    "variation": {
+      "name": "Gottlieb",
+      "id": 4544,
+      "color": {
+        "id": 756,
+        "hex": "67809b"
+      }
+    }
+  },
+  {
+    "name": "Video Transmitter",
+    "id": 1002,
+    "variation": {
+      "name": "Hessel",
+      "id": 4535,
+      "color": {
+        "id": 111,
+        "hex": "144f9e"
+      }
+    }
+  }
+]
+```
 
 ### Association Traits
 Models:
@@ -431,7 +532,7 @@ Controller:
 ```ruby
 render json: Product.limit(3).json(trait: :with_variations)
 ```
-
+Response:
 ```json
 [
    {

data/lib/pg_serializable/trait.rb

@@ -28,5 +28,9 @@ module PgSerializable
     def has_one(association, label: nil, trait: :default)
       @attribute_nodes << Nodes::Association.new(klass, association, :has_one, label: label, trait: trait)
     end
+
+    def has_and_belongs_to_many(association, label: nil, trait: :default)
+      @attribute_nodes << Nodes::Association.new(klass, association, :has_and_belongs_to_many, label: label, trait: trait)
+    end
   end
 end

data/lib/pg_serializable/version.rb

@@ -1,3 +1,3 @@
 module PgSerializable
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/pg_serializable/visitors/json.rb

@@ -102,6 +102,22 @@ module PgSerializable
         "\'#{subject.label}\', (#{query})"
       end
 
+      def visit_has_and_belongs_to_many(subject, table_alias:, **kwargs)
+        current_alias = next_alias!
+        association = subject.association
+        join_table = association.join_table
+        source = association.source_reflection
+
+        query = visit(association
+          .klass
+          .select("#{source.table_name}.*, #{join_table}.#{source.association_foreign_key}, #{join_table}.#{association.join_primary_key}")
+          .joins("INNER JOIN #{join_table} ON #{join_table}.#{source.association_foreign_key}=#{source.table_name}.#{source.association_primary_key}"), table_alias: current_alias)
+          .where("#{current_alias}.#{association.join_primary_key}=#{table_alias}.#{subject.foreign_key}")
+          .to_sql
+
+        "\'#{subject.label}\', (#{query})"
+      end
+
       def visit_has_one(subject, table_alias:, **kwargs)
         current_alias = next_alias!
         subquery_alias = next_alias!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_serializable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - matthewjf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2019-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: serializes rails models from postgres (9.5+)