graphql_rails 1.2.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95b29ebcb8c062456b3709134aca3184037fabc4d1f5dc6e8440f712065b8b9d
-  data.tar.gz: 7b177bb136a4bedffaf9c9836db393713d88d531de3cb302f89ec52c652dc56a
+  metadata.gz: bd5007444af16b72661bd4c9ad03866017b9fbbaadbd4a4bccc5c788c73f95bf
+  data.tar.gz: 884390854d3490c9b323f82c527b922a087a0617a1a862fb5cbcd3d18f31e955
 SHA512:
-  metadata.gz: 6aa73c56c429120d6d6aa534075bee9e36cf4d0fa18d2169e89afb81965eb06e90e3d595f214faf4af1ff91aadcb2fbea9be6ceaf569321be57a9ca654d7bb0f
-  data.tar.gz: 85fbd80f9a00833636e65941c78e14e0696d55a8b1a3b4530d1a143341d86a152ad3f5879dcf2f9f2b308b297a31cdaa1ed144ad9e50533a9b5e244584a35b87
+  metadata.gz: dcc498d22901bfecb649f44b266634ed762d119d0c4d876df04fbe5ae595173e61c3fe53078ea1803000fd5ec6faaa8686e1198aa2037ae6f09b91bf4e20b001
+  data.tar.gz: 58a8ae501e143744082ca85ac0dba51bdcf5883fa949b25d23fd4c5510c28b877c4f5ca9cbc7f0af5d6d19b7c742fa835fa4b6d7afc1ccaaca0b83c153e9aeb9

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,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
 
+## [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.
+
 ## [1.2.3](2021-04-12)
 
 * Fixed: Total count on paginated resources

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (1.2.3)
+    graphql_rails (2.1.0)
       activesupport (>= 4)
       graphql (~> 1.12, >= 1.12.4)
 
@@ -63,7 +63,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+    ast (2.4.2)
     bson (4.11.0)
     builder (3.2.4)
     byebug (11.1.3)
@@ -78,7 +78,7 @@ GEM
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    graphql (1.12.4)
+    graphql (1.13.4)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
@@ -90,9 +90,11 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
     mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.2)
     mongo (2.13.1)
       bson (>= 4.8.2, < 5.0.0)
@@ -100,11 +102,11 @@ GEM
       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)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -144,8 +146,8 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -159,24 +161,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (0.91.0)
+    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-ast (1.5.0)
+      parser (>= 3.0.1.1)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.10.1)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     simplecov (0.19.1)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -211,10 +213,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/other_tools/schema_dump.md

@@ -6,24 +6,24 @@ GraphqlRails includes rake task to allow creating schema snapshots easier:
 rake graphql_rails:schema:dump
 ```
 
-## Dumping non default schema
+## Dumping only selected schema groups
 
-You can have multiple graphql schemas. Read more about this in [routes section](components/routes). In order to generate schema for one of groups, provide optional `name` argument:
+You can specify which schema groups you want to dump. In order to do so, provide groups list as rake task argument and separate group names by comma:
 
 ```bash
-rake graphql_rails:schema:dump['your_group_name']
+rake graphql_rails:schema:dump['your_group_name, your_group_name2']
 ```
 
-or using env variable `SCHEMA_GROUP_NAME`:
+You can do this also by using ENV variable `SCHEMA_GROUP_NAME`:
 
 ```bash
-SCHEMA_GROUP_NAME=your_group_name rake graphql_rails:schema:dump
+SCHEMA_GROUP_NAME="your_group_name, your_group_name2" rake graphql_rails:schema:dump
 ```
 
-## Dumping schema in to non default path
+## Dumping schema in to non default folder
 
-By default schema will be dumped to `spec/fixtures/graphql_schema.graphql` path. If you want different schema path, add `GRAPHQL_SCHEMA_DUMP_PATH` env variable, like this:
+By default schema will be dumped to `spec/fixtures` directory. If you want different schema path, add `GRAPHQL_SCHEMA_DUMP_DIR` env variable, like this:
 
 ```bash
-GRAPHQL_SCHEMA_DUMP_PATH='path/to/my/schema.graphql' rake graphql_rails:schema:dump
+GRAPHQL_SCHEMA_DUMP_DIR='path/to/graphql/dumps' rake graphql_rails:schema:dump
 ```

data/lib/graphql_rails/attributes/attributable.rb

@@ -6,14 +6,14 @@ require 'graphql_rails/attributes/attribute_name_parser'
 module GraphqlRails
   module Attributes
     # contains methods which are shared between various attribute-like classes
-    # expects `initial_name` and `initial_type` to be defined
+    # expects `initial_name` and `type` to be defined
     module Attributable
       def field_name
         attribute_name_parser.field_name
       end
 
       def type_name
-        @type_name ||= initial_type.to_s
+        type.to_s
       end
 
       def name
@@ -23,17 +23,9 @@ module GraphqlRails
       def required?
         return @required unless @required.nil?
 
-        attribute_name_parser.required? || !initial_type.to_s[/!$/].nil? || initial_type.is_a?(GraphQL::Schema::NonNull)
-      end
-
-      def required
-        @required = true
-        self
-      end
-
-      def optional
-        @required = false
-        self
+        (type.nil? && attribute_name_parser.required?) ||
+          type.to_s[/!$/].present? ||
+          type.is_a?(GraphQL::Schema::NonNull)
       end
 
       def graphql_model
@@ -52,7 +44,7 @@ module GraphqlRails
 
       def type_parser
         @type_parser ||= begin
-          type_for_parser = initial_type || attribute_name_parser.graphql_type
+          type_for_parser = type || attribute_name_parser.graphql_type
           TypeParser.new(type_for_parser, paginated: paginated?)
         end
       end

data/lib/graphql_rails/attributes/attribute.rb

@@ -2,6 +2,7 @@
 
 require 'graphql'
 require 'graphql_rails/attributes/attributable'
+require 'graphql_rails/attributes/attribute_configurable'
 require 'graphql_rails/input_configurable'
 
 module GraphqlRails
@@ -9,47 +10,21 @@ module GraphqlRails
     # contains info about single graphql attribute
     class Attribute
       include Attributable
+      include AttributeConfigurable
       include InputConfigurable
 
       attr_reader :attributes
 
-      # rubocop:disable Metrics/ParameterLists
-      def initialize(name, type = nil, description: nil, property: name, required: nil, options: {})
-        @initial_type = type
+      def initialize(name)
         @initial_name = name
-        @options = options
-        @description = description
-        @property = property.to_s
-        @required = required
+        @property = name.to_s
         @attributes ||= {}
       end
-      # rubocop:enable Metrics/ParameterLists
 
-      def type(new_type = nil)
-        return @initial_type if new_type.nil?
+      def property(new_value = NOT_SET)
+        return @property if new_value == NOT_SET
 
-        @initial_type = new_type
-        self
-      end
-
-      def description(new_description = nil)
-        return @description if new_description.nil?
-
-        @description = new_description
-        self
-      end
-
-      def property(new_property = nil)
-        return @property if new_property.nil?
-
-        @property = new_property.to_s
-        self
-      end
-
-      def options(new_options = {})
-        return @options if new_options.blank?
-
-        @options = new_options
+        @property = new_value.to_s
         self
       end
 
@@ -65,7 +40,8 @@ module GraphqlRails
         {
           method: property.to_sym,
           null: optional?,
-          camelize: camelize?
+          camelize: camelize?,
+          groups: groups
         }
       end
 
@@ -82,7 +58,7 @@ module GraphqlRails
 
       protected
 
-      attr_reader :initial_type, :initial_name
+      attr_reader :initial_name
 
       private
 

data/lib/graphql_rails/attributes/attribute_configurable.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/attributes/type_parser'
+require 'graphql_rails/attributes/attribute_name_parser'
+require 'graphql_rails/model/build_enum_type'
+require 'graphql_rails/concerns/chainable_options'
+require 'active_support/concern'
+
+module GraphqlRails
+  module Attributes
+    # Allows to set or get various attribute parameters
+    module AttributeConfigurable
+      extend ActiveSupport::Concern
+
+      included do
+        include GraphqlRails::ChainableOptions
+
+        chainable_option :description
+        chainable_option :options, default: {}
+        chainable_option :type
+      end
+
+      def groups(new_groups = ChainableOptions::NOT_SET)
+        @groups ||= []
+        return @groups if new_groups == ChainableOptions::NOT_SET
+
+        @groups = Array(new_groups).map(&:to_s)
+        self
+      end
+
+      def group(*args)
+        groups(*args)
+      end
+
+      def required(new_value = true) # rubocop:disable Style/OptionalBooleanParameter
+        @required = new_value
+        self
+      end
+
+      def optional(new_value = true) # rubocop:disable Style/OptionalBooleanParameter
+        required(!new_value)
+      end
+    end
+  end
+end

data/lib/graphql_rails/attributes/attribute_name_parser.rb

@@ -5,12 +5,8 @@ module GraphqlRails
     # Parses attribute name and can generates graphql scalar type,
     # grapqhl name and etc. based on that
     class AttributeNameParser
-      attr_reader :name
-
       def initialize(original_name, options: {})
-        name = original_name.to_s
-        @required = !name['!'].nil?
-        @name = name.tr('!', '')
+        @original_name = original_name.to_s
         @options = options
       end
 
@@ -36,12 +32,16 @@ module GraphqlRails
       end
 
       def required?
-        @required
+        original_name['!'].present? || original_name.end_with?('?')
+      end
+
+      def name
+        @name ||= original_name.tr('!', '')
       end
 
       private
 
-      attr_reader :options
+      attr_reader :options, :original_name
 
       def original_format?
         options[:input_format] == :original || options[:attribute_name_format] == :original