graphql_rails 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d635269612ec07a541e7adebb01a9da7420f74511d8bbc4a30c60cea2eadc3f
-  data.tar.gz: 5d8e87e2d4c22bcf679645fa0de355b5c2a1765d357e28ba00560e83279462a0
+  metadata.gz: bd5007444af16b72661bd4c9ad03866017b9fbbaadbd4a4bccc5c788c73f95bf
+  data.tar.gz: 884390854d3490c9b323f82c527b922a087a0617a1a862fb5cbcd3d18f31e955
 SHA512:
-  metadata.gz: 4bdbac43bd69d1ace6bc7b29d6cfba07225950ff9a583f269310eed608fc5554afa934e2e34d4f2001349bdc8385fe4d94b6dc1b8844cb20f5d850276b5c9576
-  data.tar.gz: 9bdf1be49c697610f584def6bb016b5bd60455eb813c5b4884b491c39cb7df7c29d277efe56e45e79bc24089c3cf1befa9c178471396fe6eb6ca52c2ec49bffc
+  metadata.gz: dcc498d22901bfecb649f44b266634ed762d119d0c4d876df04fbe5ae595173e61c3fe53078ea1803000fd5ec6faaa8686e1198aa2037ae6f09b91bf4e20b001
+  data.tar.gz: 58a8ae501e143744082ca85ac0dba51bdcf5883fa949b25d23fd4c5510c28b877c4f5ca9cbc7f0af5d6d19b7c742fa835fa4b6d7afc1ccaaca0b83c153e9aeb9

data/.rubocop.yml

@@ -3,6 +3,9 @@ require: rubocop-rspec
 RSpec/NestedGroups:
   Enabled: false
 
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: true
   Max: 120

data/CHANGELOG.md

@@ -9,6 +9,13 @@ 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`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (2.0.0)
+    graphql_rails (2.1.0)
       activesupport (>= 4)
       graphql (~> 1.12, >= 1.12.4)
 
@@ -78,7 +78,7 @@ GEM
     erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    graphql (1.12.10)
+    graphql (1.13.4)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)

data/docs/components/model.md

@@ -31,14 +31,7 @@ Some types can be determined by attribute name, so you can skip this attribute:
 * 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
@@ -54,6 +47,34 @@ class User
 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:
@@ -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:

data/lib/graphql_rails/attributes/attribute.rb

@@ -40,7 +40,8 @@ module GraphqlRails
         {
           method: property.to_sym,
           null: optional?,
-          camelize: camelize?
+          camelize: camelize?,
+          groups: groups
         }
       end
 

data/lib/graphql_rails/attributes/attribute_configurable.rb

@@ -20,6 +20,18 @@ module GraphqlRails
         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

data/lib/graphql_rails/attributes/input_attribute.rb

@@ -25,7 +25,7 @@ module GraphqlRails
       end
 
       def input_argument_options
-        { required: required?, description: description, camelize: false }
+        { required: required?, description: description, camelize: false, groups: groups }
       end
 
       def paginated?

data/lib/graphql_rails/attributes/type_parseable.rb

@@ -16,18 +16,27 @@ module GraphqlRails
         'int' => GraphQL::Types::Int,
         'integer' => GraphQL::Types::Int,
 
+        'big_int' => GraphQL::Types::BigInt,
+        'bigint' => GraphQL::Types::BigInt,
+
+        'float' => GraphQL::Types::Float,
+        'double' => GraphQL::Types::Float,
+        'decimal' => GraphQL::Types::Float,
+
+        'bool' => GraphQL::Types::Boolean,
+        'boolean' => GraphQL::Types::Boolean,
+
         'string' => GraphQL::Types::String,
         'str' => GraphQL::Types::String,
         'text' => GraphQL::Types::String,
-        'time' => GraphQL::Types::String,
-        'date' => GraphQL::Types::String,
 
-        'bool' => GraphQL::Types::Boolean,
-        'boolean' => GraphQL::Types::Boolean,
+        'date' => GraphQL::Types::ISO8601Date,
 
-        'float' => GraphQL::Types::Float,
-        'double' => GraphQL::Types::Float,
-        'decimal' => GraphQL::Types::Float
+        'time' => GraphQL::Types::ISO8601DateTime,
+        'datetime' => GraphQL::Types::ISO8601DateTime,
+        'date_time' => GraphQL::Types::ISO8601DateTime,
+
+        'json' => GraphQL::Types::JSON
       }.freeze
 
       WRAPPER_TYPES = [
@@ -43,10 +52,16 @@ module GraphqlRails
         GraphQL::InputObjectType
       ].freeze
 
+      PARSEABLE_RAW_GRAPHQL_TYPES = [
+        GraphQL::Schema::Object,
+        GraphQL::Schema::Scalar,
+        GraphQL::Schema::Enum
+      ].freeze
+
       RAW_GRAPHQL_TYPES = (WRAPPER_TYPES + GRAPHQL_BASE_TYPES).freeze
 
       def unwrapped_scalar_type
-        TYPE_MAPPING[nullable_inner_name.downcase.downcase]
+        TYPE_MAPPING[nullable_inner_name.downcase]
       end
 
       def raw_graphql_type?
@@ -88,7 +103,7 @@ module GraphqlRails
       def graphql_type_object?(type_class)
         return false unless type_class.is_a?(Class)
 
-        type_class < GraphQL::Schema::Object || type_class < GraphQL::Schema::Scalar
+        PARSEABLE_RAW_GRAPHQL_TYPES.any? { |parent_type| type_class < parent_type }
       end
 
       def applicable_graphql_type?(type)

data/lib/graphql_rails/controller/build_controller_action_resolver/controller_action_resolver.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'graphql_rails/controller/request'
+require 'graphql_rails/types/argument_type'
 
 module GraphqlRails
   class Controller
@@ -8,6 +9,8 @@ module GraphqlRails
       # Resolver which includes controller specific methods.
       # Used to simplify resolver build for each controller action
       class ControllerActionResolver < GraphQL::Schema::Resolver
+        argument_class(GraphqlRails::Types::ArgumentType)
+
         def self.controller(controller_class = nil)
           @controller = controller_class if controller_class
           @controller

data/lib/graphql_rails/decorator/relation_decorator.rb

@@ -5,7 +5,7 @@ module GraphqlRails
     # wrapps active record relation and returns decorated object instead
     class RelationDecorator
       delegate :map, :each, to: :to_a
-      delegate :limit_value, :offset_value, :count, :size, to: :relation
+      delegate :limit_value, :offset_value, :count, :size, :empty?, to: :relation
 
       def self.decorates?(object)
         (defined?(ActiveRecord) && object.is_a?(ActiveRecord::Relation)) ||
@@ -24,7 +24,7 @@ module GraphqlRails
         end
       end
 
-      %i[first second last].each do |method_name|
+      %i[first second last find find_by].each do |method_name|
         define_method method_name do |*args, &block|
           decoratable_object_method(method_name, *args, &block)
         end

data/lib/graphql_rails/model/build_graphql_input_type.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require 'graphql_rails/types/argument_type'
+require 'graphql_rails/concerns/service'
+
 module GraphqlRails
   module Model
     # stores information about model specific config, like attributes and types
     class BuildGraphqlInputType
-      require 'graphql_rails/concerns/service'
-
       include ::GraphqlRails::Service
 
       def initialize(name:, description: nil, attributes:)
@@ -20,6 +21,7 @@ module GraphqlRails
         type_attributes = attributes
 
         Class.new(GraphQL::Schema::InputObject) do
+          argument_class(GraphqlRails::Types::ArgumentType)
           graphql_name(type_name)
           description(type_description)
 

data/lib/graphql_rails/model/find_or_build_graphql_type_class.rb

@@ -5,6 +5,7 @@ module GraphqlRails
     # Initializes class to define graphql type and fields.
     class FindOrBuildGraphqlTypeClass
       require 'graphql_rails/concerns/service'
+      require 'graphql_rails/types/object_type'
 
       include ::GraphqlRails::Service
 
@@ -32,7 +33,7 @@ module GraphqlRails
         graphql_type_name = name
         graphql_type_description = description
 
-        graphql_type_klass = Class.new(GraphQL::Schema::Object) do
+        graphql_type_klass = Class.new(GraphqlRails::Types::ObjectType) do
           graphql_name(graphql_type_name)
           description(graphql_type_description)
         end

data/lib/graphql_rails/query_runner.rb

@@ -8,12 +8,13 @@ module GraphqlRails
 
     include ::GraphqlRails::Service
 
-    def initialize(group: nil, params:, schema: nil, router: nil, **schema_options)
+    def initialize(params:, context: {}, schema: nil, router: nil, group: nil, **schema_options) # rubocop:disable Metrics/ParameterLists
       @group = group
       @graphql_schema = schema
       @params = params
-      @schema_options = schema_options
       @router = router
+      @initial_context = context
+      @schema_options = schema_options
     end
 
     def call
@@ -21,13 +22,18 @@ module GraphqlRails
         params[:query],
         variables: variables,
         operation_name: params[:operationName],
+        context: context,
         **schema_options
       )
     end
 
     private
 
-    attr_reader :schema_options, :params, :group
+    attr_reader :schema_options, :params, :group, :initial_context
+
+    def context
+      initial_context.merge(graphql_group: group)
+    end
 
     def variables
       ensure_hash(params[:variables])

data/lib/graphql_rails/tasks/dump_graphql_schema.rb

@@ -18,13 +18,18 @@ module GraphqlRails
     end
 
     def call
-      File.write(schema_path, schema.to_definition)
+      File.write(schema_path, schema_dump)
     end
 
     private
 
     attr_reader :router, :group
 
+    def schema_dump
+      context = { graphql_group: group }
+      schema.to_definition(context: context)
+    end
+
     def schema
       @schema ||= router.graphql_schema(group.presence)
     end

data/lib/graphql_rails/types/argument_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/types/hidable_by_group'
+
+module GraphqlRails
+  module Types
+    # Base argument type for all GraphqlRails inputs
+    class ArgumentType < GraphQL::Schema::Argument
+      include GraphqlRails::Types::HidableByGroup
+    end
+  end
+end

data/lib/graphql_rails/types/field_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/types/argument_type'
+require 'graphql_rails/types/hidable_by_group'
+
+module GraphqlRails
+  module Types
+    # Base field for all GraphqlRails model fields
+    class FieldType < GraphQL::Schema::Field
+      include GraphqlRails::Types::HidableByGroup
+      argument_class(GraphqlRails::Types::ArgumentType)
+    end
+  end
+end

data/lib/graphql_rails/types/hidable_by_group.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/types/argument_type'
+
+module GraphqlRails
+  module Types
+    # Add visibility option based on groups
+    module HidableByGroup
+      def initialize(*args, groups: [], **kwargs, &block)
+        super(*args, **kwargs, &block)
+
+        @groups = groups.map(&:to_s)
+      end
+
+      def visible?(context)
+        super && visible_in_context_group?(context)
+      end
+
+      private
+
+      def groups
+        @groups
+      end
+
+      def visible_in_context_group?(context)
+        group = context[:graphql_group] || context['graphql_group']
+
+        group.nil? || groups.empty? || groups.include?(group.to_s)
+      end
+    end
+  end
+end

data/lib/graphql_rails/types/object_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'graphql_rails/types/field_type'
+
+module GraphqlRails
+  module Types
+    # Base graphql type class for all GraphqlRails models
+    class ObjectType < GraphQL::Schema::Object
+      field_class(GraphqlRails::Types::FieldType)
+    end
+  end
+end

data/lib/graphql_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlRails
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-03 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -230,6 +230,10 @@ files:
 - lib/graphql_rails/tasks/dump_graphql_schema.rb
 - lib/graphql_rails/tasks/dump_graphql_schemas.rb
 - lib/graphql_rails/tasks/schema.rake
+- lib/graphql_rails/types/argument_type.rb
+- lib/graphql_rails/types/field_type.rb
+- lib/graphql_rails/types/hidable_by_group.rb
+- lib/graphql_rails/types/object_type.rb
 - lib/graphql_rails/version.rb
 homepage: https://github.com/samesystem/graphql_rails
 licenses: