graphql_rails 1.2.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fde3149c0119edc09198e27b61c428ed666ea2bb4582b428142db31a58749c4
-  data.tar.gz: d9faa17f35d1ac01400b829983d6a2b16230c62971bb6ed0178b9a6bf4b1c0bd
+  metadata.gz: 1909c3b76c9addab63bcc0337232c147ceebde0d1f2252da93606b48d1843c64
+  data.tar.gz: 6b405941e4bae0e98abbcc07b93ac1a95fa22bcbdfcaa962d241740a15453ba7
 SHA512:
-  metadata.gz: ee735c639cf392c7a4261db07791bb953942977fd4c001fcb101fd3e4a7009db58fb27520d0227e2b3254fdbc5d2dc52043d892597e99d4526ad18fc8919de30
-  data.tar.gz: 80e3a427bb04a91332230460638d7f866afc843dbebfd9e9211454869154c32459e9c1d3c2dcaa97e06bd767792bc6ff742b871ded561094354bc4beab2517a1
+  metadata.gz: f5292647cd5c49c51bec7f9f1df33be882637ac83bd54fb23259fc2b5c6d8f351f3501c5db23f0ff7c10daafafed531b4026ff3790ff281cfd71890ff2b2c007
+  data.tar.gz: 054adf43e83c54be23fb33547ee521e17ae8f180f5f4c05bf3a7b78f554367e6531483d9bf66af75fe4567940f2931c56f93c2adc6af412efba8e644043af8bc

data/.github/workflows/ruby.yml

@@ -0,0 +1,18 @@
+name: Ruby
+on: [push, pull_request]
+jobs:
+  specs:
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    runs-on: ubuntu-latest
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/.hound.yml

@@ -1,4 +1,4 @@
 rubocop:
   config_file: .rubocop.yml
-  version: 0.91.0
+  version: 1.5.2
 fail_on_violations: true

data/.rubocop.yml

@@ -3,6 +3,9 @@ require: rubocop-rspec
 RSpec/NestedGroups:
   Enabled: false
 
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: true
   Max: 120
@@ -35,6 +38,7 @@ Style/ClassAndModuleChildren:
     - spec/**/*_spec.rb
 
 AllCops:
+  NewCops: disable # TODO: enable
   TargetRubyVersion: 2.7
   Exclude:
     - bin/*

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.1

data/CHANGELOG.md

@@ -9,6 +9,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+## [2.2.0](2022-01-25)
+
+* Added: support for subscription type
+* Fixed: correctly detect all graphql-ruby objects when using stringified types
+* Added: make code compatible with newer graphql-ruby version
+
+## [2.1.0](2022-01-12)
+
+* Added: decorated relations now can be called using "find", "empty?" and "find_by" methods
+* Fixed: allow to define graphql-ruby enum classes as strings.
+* Added: add "groups" to attributes.
+* Changed: `date` type is now alias for `GraphQL::Types::ISO8601Date`, also added aliases for other common graphql-graphql types.
+
+## [2.0.0](2021-12-03)
+
+* Added: support for generating multiple schema dumps with `rake graphql_rails:schema:dump`.
+* Added: support for using chainable syntax for input attributes.
+* Changed: changed default `predicate method type from `Boolean` to `Boolean!`
+* Changed: changed error message when trying to paginate not supported types
+* Added: support defining graphql-ruby types as strings.
+
 ## [1.2.4](2021-05-05)
 
 * Fixed: Dynamic types definition where type A references type B referencing type A.

data/Gemfile

@@ -5,9 +5,9 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 group :development do
-  gem 'rubocop', '0.91.0'
-  gem 'rubocop-performance', '~> 1.8', '>= 1.8.1'
-  gem 'rubocop-rspec', '~> 1.44', '>= 1.44.1'
+  gem 'rubocop', '1.5.2'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,112 +1,111 @@
 PATH
   remote: .
   specs:
-    graphql_rails (1.2.3)
+    graphql_rails (2.2.0)
       activesupport (>= 4)
       graphql (~> 1.12, >= 1.12.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.4)
-      actionpack (= 6.0.3.4)
+    actioncable (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionmailbox (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activejob (= 6.1.4.4)
+      activerecord (= 6.1.4.4)
+      activestorage (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      actionview (= 6.1.4.4)
+      activejob (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4.4)
+      actionview (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actiontext (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activerecord (= 6.1.4.4)
+      activestorage (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.1.4.4)
+      activesupport (= 6.1.4.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.1.4.4)
+      activesupport (= 6.1.4.4)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activestorage (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.4)
+    activemodel (6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activerecord (6.1.4.4)
+      activemodel (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+    activestorage (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activejob (= 6.1.4.4)
+      activerecord (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    bson (4.11.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    bson (4.14.0)
     builder (3.2.4)
     byebug (11.1.3)
-    codecov (0.2.12)
-      json
-      simplecov
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    erubi (1.9.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    graphql (1.12.4)
-    i18n (1.8.5)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    graphql (1.13.6)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    loofah (2.7.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.10)
-      nokogiri (~> 1)
-      rake
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
-    minitest (5.14.2)
-    mongo (2.13.1)
+    mini_mime (1.1.2)
+    mini_portile2 (2.7.1)
+    minitest (5.15.0)
+    mongo (2.17.0)
       bson (>= 4.8.2, < 5.0.0)
-    mongoid (7.1.4)
-      activemodel (>= 5.1, < 6.1)
-      mongo (>= 2.7.0, < 3.0.0)
-    nio4r (2.5.4)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    mongoid (7.3.3)
+      activemodel (>= 5.1, < 6.2)
+      mongo (>= 2.10.5, < 3.0.0)
+      ruby2_keywords (~> 0.0.5)
+    nio4r (2.5.8)
+    nokogiri (1.13.1)
+      mini_portile2 (~> 2.7.0)
       racc (~> 1.4)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -114,91 +113,93 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.4)
-      actioncable (= 6.0.3.4)
-      actionmailbox (= 6.0.3.4)
-      actionmailer (= 6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actiontext (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activerecord (= 6.0.3.4)
-      activestorage (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.4)
+    rails (6.1.4.4)
+      actioncable (= 6.1.4.4)
+      actionmailbox (= 6.1.4.4)
+      actionmailer (= 6.1.4.4)
+      actionpack (= 6.1.4.4)
+      actiontext (= 6.1.4.4)
+      actionview (= 6.1.4.4)
+      activejob (= 6.1.4.4)
+      activemodel (= 6.1.4.4)
+      activerecord (= 6.1.4.4)
+      activestorage (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
+    railties (6.1.4.4)
+      actionpack (= 6.1.4.4)
+      activesupport (= 6.1.4.4)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.8.2)
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     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-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (0.91.0)
+    rspec-support (3.10.3)
+    rubocop (1.5.2)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.8.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.8.1)
-      rubocop (>= 0.87.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.19.1)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.1)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby
@@ -213,10 +214,10 @@ DEPENDENCIES
   rails (~> 6)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (= 0.91.0)
-  rubocop-performance (~> 1.8, >= 1.8.1)
-  rubocop-rspec (~> 1.44, >= 1.44.1)
+  rubocop (= 1.5.2)
+  rubocop-performance
+  rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.28

data/docs/README.md

@@ -1,6 +1,6 @@
 # GraphqlRails
 
-[![Build Status](https://travis-ci.org/samesystem/graphql_rails.svg?branch=master)](https://travis-ci.org/samesystem/graphql_rails)
+![Build Status](https://github.com/samesystem/graphql_rails/workflows/Ruby/badge.svg?branch=master)
 [![codecov](https://codecov.io/gh/samesystem/graphql_rails/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/graphql_rails)
 [![Documentation](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://samesystem.github.io/graphql_rails)
 

data/docs/components/model.md

@@ -27,33 +27,54 @@ Most commonly you will use `attribute` to make your model methods and attributes
 
 Some types can be determined by attribute name, so you can skip this attribute:
 
-* attributes which ends with name `*_id` has `ID` type
-* attributes which ends with `?` has `Boolean` type
+* attributes which ends with name `*_id` has `ID!` type
+* attributes which ends with `?` has `Boolean!` type
 * all other attributes without type are considered to be `String`
 
-available types are:
-
-* ID: `'id'`
-* String: `'string'`, `'str'`, `'text'`
-* Boolean: `'bool'`, `'boolean'`
-* Float: `'float'`, `'double'`, `'decimal'`
-
-usage example:
+Usage example:
 
 ```ruby
 class User
   include GraphqlRails::Model
 
   graphql do |c|
-    c.attribute :shop_id # ID type
+    c.attribute :shop_id # ID! type
     c.attribute :full_name # String type
-    c.attribute :admin? # Boolean type
+    c.attribute :admin? # Boolean! type
     c.attribute :level, type: 'integer'
     c.attribute :money, type: 'float'
   end
 end
 ```
 
+You can also use some build in aliases for types, such as:
+
+* `'id'` is alias for `GraphQL::Types::ID`
+* `'integer'`, `'int'` are aliases for `GraphQL::Types::Int`
+* `'bigint'`, `'big_int'` are aliases for `GraphQL::Types::BigInt`
+* 'float', 'double', 'decimal' are aliases for `GraphQL::Types::Float`
+* `'bool'`, `'boolean'` are aliases for GraphQL::Types::Boolean
+* String: `'string'`, `'str'`, `'text'`
+* 'date' is alias for `GraphQL::Types::ISO8601Date`
+* 'time', 'datetime', 'date_time' are aliases for `GraphQL::Types::ISO8601DateTime`
+* 'json' is alias for `GraphQL::Types::JSON`
+
+Usage example:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.attribute(:about_me).type(:text)
+    c.attribute(:active).type('bool!')
+    c.attribute(:created_at).type(:datetime!)
+    c.attribute(:data).type(:json!)
+    c.attribute(:login_dates).type('[date!]!')
+  end
+end
+```
+
 #### attribute.type: using graphql-ruby objects
 
 You can also use raw graphql-ruby objects as attribute types. Here is an example:
@@ -72,7 +93,7 @@ end
 class User
   include GraphqlRails::Model
 
-  graphql.attribute :address, type: AddressType, required: true
+  graphql.attribute :address, type: 'AddressType!', required: true
 end
 ```
 
@@ -110,6 +131,45 @@ class User
 end
 ```
 
+### attribute.groups
+
+Groups are handy feature when you want to have multiple schemas. For example, you want to have public graphql endpoint and internal graphql endpoint where each group has some unique nodes. If attribute has `groups` set, then this attribute will be visible only in appropriate group schemas.
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    # visible in all schemas (default):
+    c.attribute(:email)
+
+    # visible in "internal" and "beta" schemas only:
+    c.attribute(:admin_id).groups(%i[internal beta])
+
+    # visible in "external" schema only:
+    c.attribute(:nickname).groups(%i[external])
+  end
+end
+```
+
+### attribute.group
+
+Alias for Attribute#groups.
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    # visible in all schemas (default):
+    c.attribute(:email)
+
+    # visible in "external" schema only:
+    c.attribute(:nickname).group(:external)
+  end
+end
+```
+
 ### attribute.options
 
 Allows passing options to attribute definition. Available options:
@@ -243,6 +303,24 @@ class User
 end
 ```
 
+### attribute.with
+
+When you want to define some options dynamically, it's quite handy to use "Attribute#with" method:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql do |c|
+    c.attribute(:shop_id).with(type: 'ID', description: 'references to shop')
+    # same as:
+    # c.attribute(:shop_id, type: 'ID', description: 'references to shop')
+    # also same as:
+    # c.attribute(:shop_id).type('ID').description('references to shop')
+  end
+end
+```
+
 ### "attribute" configuration with chainable methods
 
 If your attribute definition is complex, you can define attribute in more eye-friendly chainable way with:
@@ -361,6 +439,22 @@ class User
 end
 ```
 
+### "input.attribute" configuration with chainable methods
+
+If your input attribute definition is complex, you can define attribute in more eye-friendly chainable way with:
+
+```ruby
+class User
+  include GraphqlRails::Model
+
+  graphql.input do |c|
+    c.attribute(:friends_count)
+      .type(:integer!)
+      .description('Can not be zero or less')
+  end
+end
+```
+
 #### required type
 
 There are few ways how to mark field as required.

data/docs/components/routes.md

@@ -73,14 +73,15 @@ end
 
 This will generate `userDetails` field on GraphQL side.
 
-## _query_ and _mutation_
+## _query_ and _mutation_ & _subscription_
 
-in case you want to have non-CRUD controller with custom actions you can define your own `query`/`mutation` actions like this:
+in case you want to have non-CRUD controller with custom actions you can define your own `query`/`mutation`/`subscription` actions like this:
 
 ```ruby
 MyGraphqlSchema = GraphqlRails::Router.draw do
   mutation :logIn, to: 'sessions#login'
-  query :me, to 'users#current_user'
+  query :me, to: 'users#current_user'
+  subscribtion :new_message, to: 'messages#created'
 end
 ```