RubyGems - graphql_rails - Versions diffs - 1.0.0 → 1.1.0 - Mend

graphql_rails 1.0.0 → 1.1.0

Files changed (39) hide show

checksums.yaml +4 -4
data/.hound.yml +1 -0
data/.rubocop.yml +3 -3
data/.ruby-version +1 -1
data/.travis.yml +2 -2
data/CHANGELOG.md +3 -0
data/Gemfile +3 -2
data/Gemfile.lock +141 -117
data/docs/README.md +2 -2
data/docs/components/controller.md +21 -5
data/docs/components/model.md +43 -3
data/docs/index.html +1 -1
data/graphql_rails.gemspec +5 -5
data/lib/generators/graphql_rails/templates/graphql_router_spec.erb +10 -7
data/lib/graphql_rails/attributes/attributable.rb +2 -4
data/lib/graphql_rails/attributes/attribute.rb +26 -6
data/lib/graphql_rails/attributes/attribute_name_parser.rb +1 -1
data/lib/graphql_rails/attributes/input_attribute.rb +5 -1
data/lib/graphql_rails/concerns/service.rb +6 -2
data/lib/graphql_rails/controller.rb +6 -6
data/lib/graphql_rails/controller/action.rb +5 -1
data/lib/graphql_rails/controller/build_controller_action_resolver.rb +2 -2
data/lib/graphql_rails/controller/request.rb +1 -1
data/lib/graphql_rails/controller/request/format_errors.rb +1 -1
data/lib/graphql_rails/model/add_fields_to_graphql_type.rb +45 -0
data/lib/graphql_rails/model/build_graphql_input_type.rb +1 -1
data/lib/graphql_rails/model/call_graphql_model_method.rb +14 -1
data/lib/graphql_rails/model/configurable.rb +6 -2
data/lib/graphql_rails/model/configuration.rb +9 -4
data/lib/graphql_rails/model/find_or_build_graphql_type.rb +64 -0
data/lib/graphql_rails/model/find_or_build_graphql_type_class.rb +46 -0
data/lib/graphql_rails/router.rb +2 -2
data/lib/graphql_rails/router/resource_routes_builder.rb +8 -8
data/lib/graphql_rails/router/route.rb +3 -7
data/lib/graphql_rails/router/schema_builder.rb +1 -1
data/lib/graphql_rails/rspec_controller_helpers.rb +2 -2
data/lib/graphql_rails/version.rb +1 -1
metadata +21 -14
data/lib/graphql_rails/model/build_graphql_type.rb +0 -53

@@ -17,13 +17,13 @@ end
 ## graphql
-This method must be called inside your model body. `grapqhl` is used for making your model convertible to graphql type.
+This method must be called inside your model body. `graphql` is used for making your model convertible to graphql type.
 ## attribute
 Most commonly you will use `attribute` to make your model methods and attributes visible via graphql endpoint.
-## attribute.type
+### attribute.type
 Some types can be determined by attribute name, so you can skip this attribute:
@@ -54,9 +54,33 @@ class User
 end
 ```
+#### attribute.type: using graphql-ruby objects
+You can also use raw graphql-ruby objects as attribute types. Here is an example:
+```ruby
+# raw graphql-ruby type:
+class AddressType < GraphQL::Schema::Object
+  graphql_name 'Address'
+  field :city, String, null: false
+  field :street_name, String, null: false
+  field :street_number, Integer
+end
+# GraphqlRails model:
+class User
+  include GraphqlRails::Model
+  graphql.attribute :address, type: AddressType, required: true
+end
+```
+Check [graphql-ruby documentation](https://graphql-ruby.org) for more details about graphql-ruby types.
 ### attribute.property
-By default graphql attribute names are expected to be same as model methods/attributes, but if you want to use different name on grapqhl side, you can use `propery` option:
+By default graphql attribute names are expected to be same as model methods/attributes, but if you want to use different name on grapqhl side, you can use `property` option:
 ```ruby
 class User
@@ -86,6 +110,22 @@ class User
 end
 ```
+### attribute.options
+Allows passing options to attribute definition. Available options:
+* `attribute_name_format` - if `:original` value is passed, it will not camelCase attribute name.
+```ruby
+class User
+  include GraphqlRails::Model
+  graphql do |c|
+    c.attribute :first_name # will be accessible as firstName from client side
+    c.attribute :first_name, options: { attribute_name_format: :original } # will be accessible as first_name from client side
+  end
+end
 ### attribute.permit
 To define attributes which are accepted by each model method, you need to call `permit` method, like this:

data/docs/index.html CHANGED

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Document</title>
+  <title>GraphqlRails</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <meta name="description" content="Description">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">

data/graphql_rails.gemspec CHANGED

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Povilas Jurčys']
   spec.email         = ['po.jurcys@gmail.com']
-  spec.summary       = %q{GraphQL server and client for rails}
+  spec.summary       = %q{Rails style structure for GraphQL API.}
   spec.homepage      = 'https://github.com/samesystem/graphql_rails'
   spec.license       = 'MIT'
@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency 'graphql', '>= 1.9.12'
+  spec.add_dependency 'graphql', '~> 1.11', '>= 1.11.6'
   spec.add_dependency 'activesupport', '>= 4'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rails', '~> 5'
+  spec.add_development_dependency 'rails', '~> 6'
 end

data/lib/generators/graphql_rails/templates/graphql_router_spec.erb CHANGED

@@ -3,16 +3,19 @@
 require 'rails_helper'
 RSpec.describe GraphqlRouter do
-  describe '#execute' do
+  subject(:schema) { described_class.graphql_schema }
+  describe '#to_definition' do
+    subject(:to_definition) { schema.to_definition.strip }
+    let(:schema_dump_path) { Rails.root.join('spec', 'fixtures', 'graphql_schema.graphql') }
+    let(:previous_definition) { File.read(schema_dump_path).strip }
     it 'returns correct structure' do
       # if you need to update saved_schema, run rake task:
-      #   $ RAILS_ENV=test rake graphql_rails:schema:dump
-      schema_path = Rails.root.join('spec', 'fixtures', 'graphql_schema.graphql')
-      saved_schema = File.read(schema_path).strip
-      real_schema = described_class.to_definition.strip
+      #   $ RAILS_ENV=test bin/rake graphql_rails:schema:dump
-      expect(real_schema).to eq(saved_schema)
+      expect(to_definition).to eq(previous_definition)
     end
   end
 end

data/lib/graphql_rails/attributes/attributable.rb CHANGED

@@ -46,10 +46,8 @@ module GraphqlRails
         !required?
       end
-      protected
-      def options
-        {}
+      def scalar_type?
+        type_parser.raw_graphql_type? || type_parser.unwrapped_scalar_type.class == GraphQL::ScalarType
       end
       private

data/lib/graphql_rails/attributes/attribute.rb CHANGED

@@ -13,14 +13,17 @@ module GraphqlRails
       attr_reader :attributes
-      def initialize(name, type = nil, description: nil, property: name, required: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(name, type = nil, description: nil, property: name, required: nil, options: {})
         @initial_type = type
         @initial_name = name
+        @options = options
         @description = description
         @property = property.to_s
         @required = required
         @attributes ||= {}
       end
+      # rubocop:enable Metrics/ParameterLists
       def type(new_type = nil)
         return @initial_type if new_type.nil?
@@ -43,18 +46,29 @@ module GraphqlRails
         self
       end
+      def options(new_options = {})
+        return @options if new_options.blank?
+        @options = new_options
+        self
+      end
       def field_args
         [
           field_name,
           type_parser.type_arg,
-          *description,
-          {
-            method: property.to_sym,
-            null: optional?
-          }
+          *description
         ]
       end
+      def field_options
+        {
+          method: property.to_sym,
+          null: optional?,
+          camelize: camelize?
+        }
+      end
       def argument_args
         [
           field_name,
@@ -69,6 +83,12 @@ module GraphqlRails
       protected
       attr_reader :initial_type, :initial_name
+      private
+      def camelize?
+        options[:input_format] != :original && options[:attribute_name_format] != :original
+      end
     end
   end
 end

data/lib/graphql_rails/attributes/attribute_name_parser.rb CHANGED

@@ -44,7 +44,7 @@ module GraphqlRails
       attr_reader :options
       def original_format?
-        options[:input_format] == :original
+        options[:input_format] == :original || options[:attribute_name_format] == :original
       end
       def preprocesed_name

data/lib/graphql_rails/attributes/input_attribute.rb CHANGED

@@ -24,7 +24,11 @@ module GraphqlRails
       def input_argument_args
         type = raw_input_type || input_type_parser.input_type_arg
-        [field_name, type, { required: required?, description: description, camelize: false }]
+        [field_name, type]
+      end
+      def input_argument_options
+        { required: required?, description: description, camelize: false }
       end
       def paginated?

data/lib/graphql_rails/concerns/service.rb CHANGED

@@ -7,8 +7,12 @@ module GraphqlRails
     extend ActiveSupport::Concern
     class_methods do
-      def call(*args, &block)
-        new(*args).call(&block)
+      def call(*args, **kwargs, &block)
+        if kwargs.present?
+          new(*args, **kwargs).call(&block)
+        else
+          new(*args).call(&block)
+        end
       end
     end
   end

data/lib/graphql_rails/controller.rb CHANGED

@@ -18,16 +18,16 @@ module GraphqlRails
         subclass.instance_variable_set(:@controller_configuration, new_config)
       end
-      def before_action(*args, &block)
-        controller_configuration.add_action_hook(:before, *args, &block)
+      def before_action(*args, **kwargs, &block)
+        controller_configuration.add_action_hook(:before, *args, **kwargs, &block)
       end
-      def around_action(*args, &block)
-        controller_configuration.add_action_hook(:around, *args, &block)
+      def around_action(*args, **kwargs, &block)
+        controller_configuration.add_action_hook(:around, *args, **kwargs, &block)
       end
-      def after_action(*args, &block)
-        controller_configuration.add_action_hook(:after, *args, &block)
+      def after_action(*args, **kwargs, &block)
+        controller_configuration.add_action_hook(:after, *args, **kwargs, &block)
       end
       def action(action_name)

data/lib/graphql_rails/controller/action.rb CHANGED

@@ -36,7 +36,11 @@ module GraphqlRails
       end
       def type_args
-        [type_parser.type_arg, null: !type_parser.required?]
+        [type_parser.type_arg]
+      end
+      def type_options
+        { null: !type_parser.required? }
       end
       private

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

@@ -19,13 +19,13 @@ module GraphqlRails
         action = build_action
         Class.new(ControllerActionResolver) do
-          type(*action.type_args)
+          type(*action.type_args, **action.type_options)
           description(action.description)
           controller(action.controller)
           controller_action_name(action.name)
           action.arguments.each do |attribute|
-            argument(*attribute.input_argument_args)
+            argument(*attribute.input_argument_args, **attribute.input_argument_options)
           end
           def self.inspect

data/lib/graphql_rails/controller/request.rb CHANGED

@@ -16,7 +16,7 @@ module GraphqlRails
       end
       def errors=(new_errors)
-        @errors = FormatErrors.call(new_errors)
+        @errors = FormatErrors.call(not_formatted_errors: new_errors)
         @errors.each { |error| context.add_error(error) }
       end

data/lib/graphql_rails/controller/request/format_errors.rb CHANGED

@@ -12,7 +12,7 @@ module GraphqlRails
       class FormatErrors
         include Service
-        def initialize(not_formatted_errors)
+        def initialize(not_formatted_errors:)
           @not_formatted_errors = not_formatted_errors
         end

data/lib/graphql_rails/model/add_fields_to_graphql_type.rb ADDED

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+module GraphqlRails
+  module Model
+    # Adds graphql attributes as graphql fields to given graphql schema object.
+    class AddFieldsToGraphqlType
+      require 'graphql_rails/concerns/service'
+      require 'graphql_rails/model/call_graphql_model_method'
+      include ::GraphqlRails::Service
+      def initialize(klass:, attributes:)
+        @klass = klass
+        @attributes = attributes
+      end
+      def call
+        attributes.each { |attribute| define_graphql_field(attribute) }
+      end
+      private
+      attr_reader :attributes, :klass
+      def define_graphql_field(attribute) # rubocop:disable Metrics/MethodLength)
+        klass.class_eval do
+          field(*attribute.field_args, **attribute.field_options) do
+            attribute.attributes.values.each do |arg_attribute|
+              argument(*arg_attribute.input_argument_args, **arg_attribute.input_argument_options)
+            end
+          end
+          define_method(attribute.field_name) do |**kwargs|
+            CallGraphqlModelMethod.call(
+              model: object,
+              attribute_config: attribute,
+              method_keyword_arguments: kwargs,
+              graphql_context: context
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql_rails/model/build_graphql_input_type.rb CHANGED

@@ -24,7 +24,7 @@ module GraphqlRails
           description(type_description)
           type_attributes.each_value do |type_attribute|
-            argument(*type_attribute.input_argument_args)
+            argument(*type_attribute.input_argument_args, **type_attribute.input_argument_options)
           end
           def self.inspect

data/lib/graphql_rails/model/call_graphql_model_method.rb CHANGED

@@ -31,10 +31,23 @@ module GraphqlRails
         if custom_keyword_arguments.empty?
           model.send(method_name)
         else
-          model.send(method_name, **custom_keyword_arguments)
+          formatted_arguments = formatted_method_input(custom_keyword_arguments)
+          model.send(method_name, **formatted_arguments)
         end
       end
+      def formatted_method_input(keyword_arguments)
+        keyword_arguments.transform_values do |input_argument|
+          formatted_method_input_argument(input_argument)
+        end
+      end
+      def formatted_method_input_argument(argument)
+        return argument.to_h if argument.is_a?(GraphQL::Schema::InputObject)
+        argument
+      end
       def method_name
         attribute_config.property
       end

data/lib/graphql_rails/model/configurable.rb CHANGED

@@ -9,11 +9,15 @@ module GraphqlRails
         @attributes ||= {}
       end
-      def name(type_name = nil)
-        @name = type_name if type_name
+      def name(graphql_name = nil)
+        @name = graphql_name if graphql_name
         @name || default_name
       end
+      def type_name
+        @type_name ||= "#{name.camelize}Type#{SecureRandom.hex}"
+      end
       def description(new_description = nil)
         @description = new_description if new_description
         @description

data/lib/graphql_rails/model/configuration.rb CHANGED

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'graphql_rails/attributes'
-require 'graphql_rails/model/build_graphql_type'
+require 'graphql_rails/model/find_or_build_graphql_type'
 require 'graphql_rails/model/build_enum_type'
 require 'graphql_rails/model/input'
 require 'graphql_rails/model/configurable'
@@ -32,7 +32,9 @@ module GraphqlRails
         attributes[key].tap do |attribute|
           attribute_options.each do |method_name, args|
-            attribute.public_send(method_name, args)
+            send_args = [method_name]
+            send_args << args if attribute.method(method_name).parameters.present?
+            attribute.public_send(*send_args)
           end
           yield(attribute) if block_given?
@@ -54,8 +56,11 @@ module GraphqlRails
       end
       def graphql_type
-        @graphql_type ||= BuildGraphqlType.call(
-          name: name, description: description, attributes: attributes
+        @graphql_type ||= FindOrBuildGraphqlType.call(
+          name: name,
+          description: description,
+          attributes: attributes,
+          type_name: type_name
         )
       end