gql_serializer 2.2.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ef6a4b4e09bd19bb6251565854da46012a5533284d9bcfddb973070c4c1d9b
-  data.tar.gz: 3b0c65709fc44fad328cb5958ff4e8165e99de934d00441c7e93e8631ab478b9
+  metadata.gz: b04f7b52a385c2deb726e1449dec990107e7030c2cd9dd3bee7df90e82a23369
+  data.tar.gz: 61119b12d003535f652e2e7bded7318c4d6ffcfc9478a9f68f17b19675a528f9
 SHA512:
-  metadata.gz: 42d01de7bd41e4c5291077d1b43556ae797fea616690560c340aca7186470bd22f18b6310501d65488f16de4d1ee6759f82c94ebf5048ffca6105a1a06e050a6
-  data.tar.gz: a3a9f3976fe48529903442531eb9861c8e63c9f15e23d5cd3262d5cdbd67a64ccb4dffe12de30a0f6bd4514a2bb08cfe896e5a9f12f0aa51cca874378fad578a
+  metadata.gz: 63eb3361a7d64b0c41ed45296e2db79a1447386665101bd1b0757734c97702475320923a0356afc8c379ca4c93459a21fcf0158aedbe08e2167bedb0baae3ba7
+  data.tar.gz: f4e88b31cfc4496aab946670f507c853b6a3a1fd102efd0aaab9842ddfae51ae30e494cc15253ff1a3f47f87af13e0fd6227f4859efb0bc422245056a2b6d477

data/.github/workflows/ruby.yml

@@ -9,25 +9,31 @@ name: Ruby
 
 on:
   push:
-    branches: [ master ]
+    branches: [ "master" ]
   pull_request:
-    branches: [ master ]
+    branches: [ "master" ]
+
+permissions:
+  contents: read
 
 jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2.2']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
       with:
-        ruby-version: 2.6
-    - name: Install dependencies
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Bundle install
       run: bundle install
     - name: Run tests
-      run: rspec
+      run: bundle exec rake

data/.gitignore

@@ -1,17 +1,17 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.idea
-.byebug_history
-test.db
-
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea
+.byebug_history
+test.db
+
 *.gem

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
---color
---require spec_helper
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+ruby-3.2.8

data/.travis.yml

@@ -1,6 +1,6 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,5 +1,5 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in gql_serializer.gemspec
-gemspec
-
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gql_serializer.gemspec
+gemspec
+

data/Gemfile.lock

@@ -1,49 +1,69 @@
 PATH
   remote: .
   specs:
-    gql_serializer (2.2.1)
-      activerecord (>= 5.2, < 8.0)
+    gql_serializer (3.0.1)
+      activerecord (>= 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activerecord (7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activesupport (7.0.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.10.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.15.0)
-    pry (0.13.1)
+    logger (1.7.0)
+    method_source (1.1.0)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    securerandom (0.4.1)
+    sqlite3 (2.7.2)
+      mini_portile2 (~> 2.8.0)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.3)
 
 PLATFORMS
   ruby
@@ -51,10 +71,10 @@ PLATFORMS
 
 DEPENDENCIES
   gql_serializer!
-  pry (~> 0.13.1)
+  pry (~> 0.15)
   rake (~> 12.0)
   rspec (~> 3.0)
-  sqlite3 (~> 1.4.2)
+  sqlite3 (~> 2.7)
 
 BUNDLED WITH
    2.1.4

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Andrew Scullion
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2020 Andrew Scullion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,146 +1,189 @@
-# GqlSerializer
-
-GqlSerializer is a gem that makes it easy to serialize ActiveRecord objects into json using a short syntax similar to GraphQL instead of the more verbose syntax used by the `as_json` method.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'gql_serializer'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install gql_serializer
-
-## Basic Usage
-
-Say you have the following `User` class
-
-```ruby
-class User < ActiveRecord::Base
-  attribute :email_address, :string
-  attribute :name, :string
-  def encoded_id
-    "User-#{id}"
-  end
-end
-```
-
-and you create a user
-
-```ruby
-user = User.create(name: 'Test User', email_address: 'user@test.com')
-```
-
-You can call `as_gql` with no arguments to get:
-
-```ruby
-user.as_gql
-=> {
-  "id"=>1,
-  "name"=>"Test User",
-  "email_address"=>"user@test.com"
-}
-```
-
-By default, all attributes are included in the serialized form but you can create you want with the right arguments and include methods. 
-
-```ruby
-user.as_gql('name encoded_id')
-=> {
-  "name" => "Test User",
-  "encoded_id" => "User-1"
-}
-```
-
-## Advanced Usage
-
-Here's where the library becomes more powerful. The GraphQL-esque syntax allows for aliasing and digging into nested objects.
-
-```ruby
-class User < ActiveRecord::Base
-  attribute :email_address, :string
-  attribute :name, :string
-  has_many :orders
-  def encoded_id
-    "User-#{id}"
-  end
-end
-
-class Order < ActiveRecord::Base
-  belongs_to :user
-  attribute :total, :float
-  attribute :placed_at, :date_time
-end
-
-user = User.create(name: 'Test User', email_address: 'user@test.com')
-order = Order.create(user: user, total: 3.50, placed_at: DateTime.now)
-
-user.as_gql('name orders')
-=> {
-  "name" => "Test User",
-  "orders" => [{
-    "id" => 1,
-    "total" => 3.5,
-    "placed_at" => "2020-12-23T08:30:00Z"
-  }]
-}
-
-order.as_gql('user { email_address encoded_id:real_id }')
-=> {
-  "id" => 1,
-  "total" => 3.5,
-  "placed_at" => "2020-12-23T08:30:00Z",
-  "user" => {
-    "email_address" => "user@test.com",
-    "real_id" => "User-1"
-  }
-}
-```
-
-It's also possible to automatically convert the case of the keys into either camel case or snake case. We recommend that you configure this globally (see Configuration section) but it can be done using an optional second argument.
-
-```ruby
-user.as_gql('email_address name:full_name', {case: GqlSerializer::Configuration::CAMEL_CASE})
-=> {
-  "emailAddress" => "user@test.com",
-  "fullName" => "Test User"
-}
-```
-
-## Configuration
-
-In a Rails application, the configuration can be added to an initializer in `config/initalizers/gql_serializer.rb`. The following is the default configuration (no change):
-
-```ruby
-GqlSerializer.configure do |config|
-  # no case conversion
-  config.case = GqlSerializer::Configuration::NONE_CASE 
-  # set to true to avoid additional query in some cases. 
-  # The default of false avoids a potential breaking change from version 2.1 to 2.2
-  config.preload = false 
-end
-```
-
-The options for `case` are: `NONE_CASE, CAMEL_CASE, SNAKE_CASE`.
-
-## Development
-
-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.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/TheDro/gql_serializer.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# GqlSerializer
+
+GqlSerializer is a gem that makes it easy to serialize ActiveRecord objects, hashes and arrays into JSON using a short syntax similar to GraphQL instead of the more verbose syntax used by the `as_json` method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gql_serializer'
+```
+
+And then run:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gql_serializer
+
+## Basic Usage
+
+Say you have the following `User` class
+
+```ruby
+class User < ActiveRecord::Base
+  attribute :email_address, :string
+  attribute :name, :string
+  def encoded_id
+    "User-#{id}"
+  end
+end
+```
+
+and you create a user
+
+```ruby
+user = User.create(name: 'Test User', email_address: 'user@test.com')
+```
+
+You can call `as_gql` with no arguments to get:
+
+```ruby
+user.as_gql
+=> {
+  "id"=>1,
+  "name"=>"Test User",
+  "email_address"=>"user@test.com"
+}
+```
+
+By default, all attributes are included in the serialized form but you can create you want with the right arguments and include methods. 
+
+```ruby
+user.as_gql('name encoded_id')
+=> {
+  "name" => "Test User",
+  "encoded_id" => "User-1"
+}
+```
+
+## Advanced Usage
+
+Here's where the library becomes more powerful. The GraphQL-esque syntax allows for aliasing and digging into nested objects.
+
+```ruby
+class User < ActiveRecord::Base
+  attribute :email_address, :string
+  attribute :name, :string
+  has_many :orders
+  def encoded_id
+    "User-#{id}"
+  end
+end
+
+class Order < ActiveRecord::Base
+  belongs_to :user
+  attribute :total, :float
+  attribute :placed_at, :date_time
+end
+
+user = User.create(name: 'Test User', email_address: 'user@test.com')
+order = Order.create(user: user, total: 3.50, placed_at: DateTime.now)
+
+user.as_gql('name orders')
+=> {
+  "name" => "Test User",
+  "orders" => [{
+    "id" => 1,
+    "total" => 3.5,
+    "placed_at" => "2020-12-23T08:30:00Z"
+  }]
+}
+
+order.as_gql('user { email_address encoded_id:real_id }')
+=> {
+  "id" => 1,
+  "total" => 3.5,
+  "placed_at" => "2020-12-23T08:30:00Z",
+  "user" => {
+    "email_address" => "user@test.com",
+    "real_id" => "User-1"
+  }
+}
+```
+
+It's also possible to automatically convert the case of the keys into either camel case or snake case. We recommend that you configure this globally (see Configuration section) but it can be done using an optional second argument.
+
+```ruby
+user.as_gql('email_address name:full_name', {case: GqlSerializer::Configuration::CAMEL_CASE})
+=> {
+  "emailAddress" => "user@test.com",
+  "fullName" => "Test User"
+}
+```
+
+As of version 3, you can use as_gql on hashes. Optionally, objects can also be serialized.
+
+```ruby
+class Item
+  attr_accessor :name, :price
+  def initialize(name, price)
+    @name = name
+    @price = price
+  end
+  
+  def display
+    name + ': ' + ("%.2f" % price)
+  end
+end
+
+hash = {
+  id: 1, 
+  total_price: 11.50, 
+  items: [
+    Item.new('Thing', 6.00), Item.new('Stuff', 5.50)
+  ]
+}
+
+hash.as_gql('total_price items { name:item_name display }')
+=> {
+  "total_price" => 11.5,
+  "items" => [{
+    "item_name" => "Thing",
+    "display" => "Thing: 6.00"
+  },{
+    "item_name" => "Stuff",
+    "display" => "Stuff: 5.50"
+  }]
+}
+
+```
+
+## Configuration
+
+In a Rails application, the configuration can be added to an initializer in `config/initalizers/gql_serializer.rb`. The following is the default configuration (no change):
+
+```ruby
+GqlSerializer.configure do |config|
+  # no case conversion
+  config.case = GqlSerializer::Configuration::NONE_CASE 
+  # avoids an additional query in some cases. 
+  # Set to false for compatibility with version <= 2.1
+  config.preload = true 
+end
+# Optionally add the `as_gql` method to all objects:
+# Object.include GqlSerializer::Object
+```
+
+The options for `case` are: `NONE_CASE, CAMEL_CASE, SNAKE_CASE`.
+
+## Compatibility
+
+The current version of this gem has been tested on Rails version up to 8.0, but likely works with newer versions as well.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TheDro/gql_serializer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "gql_serializer"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gql_serializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)