pg_serializable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ef02b6457601f2d201dc81241644ceeda7914df
-  data.tar.gz: a19b84c078527d28c20e387665efac2830f41c5c
+  metadata.gz: 618fc576fe1ec96d02b3b6745406aaa0921297a3
+  data.tar.gz: 10fcb8a2866501c48f4126cbbb907f76c64c3b26
 SHA512:
-  metadata.gz: e0093725bd655c8f1e9f96f4e3576d639925e52af60402c11d549147b0bfe999a9d2453fb30ecab65300669e3fdaf6b0b60ad20f8f57626cbb8e506b2e951d6a
-  data.tar.gz: 952b1b05a28ce3a1706d8ec7f2f201d6e2d24d025913d75687824279f3c58867e55a7d70c6ca6b402a8d1d50f26d39da01101f1180549ed7827cb854664c3564
+  metadata.gz: c252b339e93bb7e0f544e3bdc80639086a6c2378df48a1d6c7fbf8646c45774048bd0aae5f6177f9485fd7235c7bdedb3ee9c6cd785903b1d044960188ade606
+  data.tar.gz: 0f4d3bd51fcb1255f54cd206477eba8eeeeaddc1bc33194fb5538406233a291d499990f5854f2833fa7599eeff5fe6e694c52c706701c6ec73f39d388bb433d2

data/README.md

@@ -1,8 +1,8 @@
 # PgSerializable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pg_serializable`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is experimental.
 
-TODO: Delete this and the text above, and describe your gem
+Serialize json directly from postgres (9.4+).
 
 ## Installation
 
@@ -22,17 +22,251 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your model:
+```ruby
+require 'pg_serializable'
 
-## Development
+class Product < ApplicationRecord
+  include PgSerializable
+
+  serializable do
+    attributes :name, :id
+    attribute :name, label: :test_name
+  end
+end
+```
+
+You can also include it in your `ApplicationRecord` so all models will be serializable.
+
+In your controller:
+```ruby
+render json: Product.limit(200).order(updated_at: :desc).json
+```
+
+It works with single records:
+```ruby
+render json: Product.find(10).json
+```
+
+### Attributes
+List attributes:
+```ruby
+attributes :name, :id
+```
+results in:
+```json
+[  
+  {
+    "id": 503,
+    "name": "Direct Viewer"
+  },
+  {
+    "id": 502,
+    "name": "Side Disc Bracket"
+  }
+]
+```
+Re-label individual attributes:
+```ruby
+attributes :id
+attribute :name, label: :different_name
+```
+```json
+[
+  {
+    "id": 503,
+    "different_name": "Direct Viewer"
+  },
+  {
+    "id": 502,
+    "different_name": "Side Disc Bracket"
+  }
+]
+```
+
+Wrap attributes in custom sql
+```ruby
+serializable do
+  attributes :id
+  attribute :active, label: :deleted { |v| "NOT #{v}" }
+end
+```
+```json
+[
+  {
+    "id": 503,
+    "deleted": true
+  },
+  {
+    "id": 502,
+    "deleted": true
+  }
+]
+```
+
+
+### Associations
+Supported associations:
+- `belongs_to`
+- `has_many`
+- `has_many :through`
+- `has_one`
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### belongs_to
+```ruby
+serializable do
+  attributes :id, :name
+  belongs_to: :label
+end
+```
+```json
+[
+  {
+    "id": 503,
+    "label": {
+      "name": "Piper",
+      "id": 106
+    }
+  },
+  {
+    "id": 502,
+    "label": {
+      "name": "Sebrina",
+      "id": 77
+    }
+  }
+]
+```
+
+#### has_many
+Works for nested relationships
+```ruby
+class Product < ApplicationRecord
+  serializable do
+    attributes :id, :name
+    has_many: :variations
+  end
+end
+
+class Variation < ApplicationRecord
+  serializable do
+    attributes :id, :hex
+    belongs_to: :color
+  end
+end
+
+class Color < ApplicationRecord
+  serializable do
+    attributes :id, :hex
+  end
+end
+```
+```json
+[
+  {
+    "id": 503,
+    "variations": [
+      {
+        "name": "Cormier",
+        "id": 2272,
+        "color": {
+          "id": 5,
+          "hex": "f4b9c8"
+        }
+      },
+      {
+        "name": "Spencer",
+        "id": 2271,
+        "color": {
+          "id": 586,
+          "hex": "2e0719"
+        }
+      }
+    ]
+  },
+  {
+    "id": 502,
+    "variations": [
+      {
+        "name": "DuBuque",
+        "id": 2270,
+        "color": {
+          "id": 593,
+          "hex": "0b288f"
+        }
+      },
+      {
+        "name": "Berge",
+        "id": 2269,
+        "color": {
+          "id": 536,
+          "hex": "b2bfee"
+        }
+      }
+    ]
+  }
+]
+```
+
+#### has_many :through
+```ruby
+class Product < ApplicationRecord
+  has_many :categories_products
+  has_many :categories, through: :categories_products
+
+  serializable do
+    attributes :id
+    has_many :categories
+  end
+end
+
+class Category < ApplicationRecord
+  serializable do
+    attributes :name, :id
+  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
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+TODO
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pg_serializable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/matthewjf/pg_serializable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/pg_serializable/nodes/attribute.rb

@@ -1,13 +1,24 @@
 module PgSerializable
   module Nodes
     class Attribute < Base
-      def initialize(column_name, label: nil)
+      def initialize(column_name, label: nil, &prc)
         @column_name = column_name
         @label = label || column_name
+        @prc = prc if block_given?
       end
 
       def to_sql(table_alias=nil)
-        ["\'#{@label}\'", "#{table_alias ? table_alias + '.' : ''}#{@column_name}"].join(',')
+        [key, value(table_alias)].join(',')
+      end
+
+      private
+      def key
+        "\'#{@label}\'"
+      end
+
+      def value(tbl)
+        val = "#{tbl && "#{tbl}."}#{@column_name}"
+        @prc ? @prc.call(val) : val
       end
     end
   end

data/lib/pg_serializable/serializer.rb

@@ -13,8 +13,8 @@ module PgSerializable
       end
     end
 
-    def attribute(column_name, label: nil)
-      @attributes << Nodes::Attribute.new(column_name, label: label) if column_exists?(column_name)
+    def attribute(column_name, label: nil, &blk)
+      @attributes << Nodes::Attribute.new(column_name, label: label, &blk) if column_exists?(column_name)
     end
 
     def has_many(association, label: nil)

data/lib/pg_serializable/version.rb

@@ -1,3 +1,3 @@
 module PgSerializable
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_serializable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - matthewjf