graphql_rails 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab765aab19541db1305cc192a5654bb804e16ddfd9d32f7bbb6ea79e6b679c4
-  data.tar.gz: f76c484cc5205b4e3a16cefe7d5a8a4fbac9f87eec54895316df35fc33e076a5
+  metadata.gz: 20a26e41a67193a0518f0883d6437afccaca80ccfdad3d633e8b75b101f386e5
+  data.tar.gz: c8731427ea2d337ab81032558b4838a27dfb3e90eca7fdf7b77ccd30df2795fd
 SHA512:
-  metadata.gz: ac72dfbe00f7586cff4f194c7e6efb4d78e3dc25ba10e31dae92ea482b35a70ccfdf6eb87e8f57b147c88914cbda1dc39d31bba7313074f76d0f3f587e955d9b
-  data.tar.gz: 2008679abf3acc2874c1564db1ebf022892e23189240a7ca9602beab323748620661c19d39bd41ca8441104c01101409ff5cd196be62ff25fcfcc1c7bf835f4a
+  metadata.gz: 04d7c8d897f828cfab27a7f55dc894689dd67fc06512d9f8a9ae2a2f45615fbcdbbebf4b6ed3e3314c514f5ad74aadb0816b11f25dbb36f74a54685e9ed7173c
+  data.tar.gz: 66a91e7cf1fe70cf4e604aad2660a3907ab65e57f68d40273ced867b2e2623f77ccb7d806c687e4a7dbb35b1b0dd8de93e76e0b33973594ce827a1b1451208dc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (0.2.2)
+    graphql_rails (0.2.3)
       activesupport (>= 4)
       graphql (~> 1)
 

data/lib/graphql_rails/attribute.rb

@@ -6,20 +6,17 @@ require 'graphql_rails/attribute/attribute_type_parser'
 module GraphqlRails
   # contains info about single graphql attribute
   class Attribute
-    attr_reader :name, :graphql_field_type, :property, :type_name
+    attr_reader :name, :graphql_field_type, :property, :type_name, :description
 
-    def initialize(name, type = nil, hidden: false, property: name)
-      @name = name.to_s
+    def initialize(name, type = nil, description: nil, property: name)
+      @original_name = name.to_s
+      @name = @original_name.tr('!', '')
       @type_name = type.to_s
       @graphql_field_type = parse_type(type || type_by_attribute_name)
-      @hidden = hidden
+      @description = description
       @property = property.to_s
     end
 
-    def hidden?
-      @hidden
-    end
-
     def field_name
       field =
         if name.end_with?('?')
@@ -31,17 +28,26 @@ module GraphqlRails
       field.camelize(:lower)
     end
 
+    def field_args
+      [field_name, graphql_field_type, { property: property.to_sym, description: description }]
+    end
+
     private
 
+    attr_reader :original_name
+
     def type_by_attribute_name
-      case name
-      when 'id', /_id\Z/
-        GraphQL::ID_TYPE
-      when /\?\Z/
-        GraphQL::BOOLEAN_TYPE
-      else
-        GraphQL::STRING_TYPE
-      end
+      type = \
+        case name
+        when 'id', /_id\Z/
+          GraphQL::ID_TYPE
+        when /\?\Z/
+          GraphQL::BOOLEAN_TYPE
+        else
+          GraphQL::STRING_TYPE
+        end
+
+      original_name['!'] ? type.to_non_null_type : type
     end
 
     def parse_type(type)

data/lib/graphql_rails/controller/action.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/string/inflections'
+require 'graphql_rails/errors/error'
+require 'graphql_rails/model'
 require_relative 'request'
 
 module GraphqlRails
   class Controller
     # analyzes route and extracts controller action related data
     class Action
+      class MissingConfigurationError < GraphqlRails::Error; end
+
       def initialize(route)
         @route = route
       end
@@ -27,11 +31,17 @@ module GraphqlRails
         @name ||= action_relative_path.split('#').last
       end
 
+      def description
+        action_config.description
+      end
+
       private
 
       attr_reader :route
 
       def default_inner_return_type
+        raise_missing_return_type_error if model_graphql_type.nil?
+
         if action_config.can_return_nil?
           model_graphql_type
         else
@@ -39,6 +49,15 @@ module GraphqlRails
         end
       end
 
+      def raise_missing_return_type_error
+        error_message = \
+          "Return type for #{route.path.inspect} is not defined. " \
+          "To do so, add `action(:#{name}).returns(YourType)` in #{controller.name} " \
+          "or make sure that you have model named #{namespaced_model_name}"
+
+        raise MissingConfigurationError, error_message
+      end
+
       def default_type
         type = default_inner_return_type
         type = type.to_list_type.to_non_null_type if route.collection?
@@ -62,7 +81,7 @@ module GraphqlRails
       end
 
       def action_model
-        namespace = namespaced_controller_name.singularize.classify.split('::')
+        namespace = namespaced_model_name.split('::')
         model_name = namespace.pop
         model = nil
 
@@ -71,7 +90,7 @@ module GraphqlRails
           namespace.pop
         end
 
-        model || model_name.constantize
+        model || namespaced_model(namespace, model_name)
       end
 
       def namespaced_model(namespace, model_name)
@@ -81,7 +100,14 @@ module GraphqlRails
         nil
       end
 
+      def namespaced_model_name
+        namespaced_controller_name.singularize.classify
+      end
+
       def model_graphql_type
+        return unless action_model
+        return unless action_model < GraphqlRails::Model
+
         action_model.graphql.graphql_type
       end
     end

data/lib/graphql_rails/controller/action_configuration.rb

@@ -20,6 +20,15 @@ module GraphqlRails
         self
       end
 
+      def description(new_description = nil)
+        if new_description
+          @description = new_description
+          self
+        else
+          @description
+        end
+      end
+
       def can_return_nil
         @can_return_nil = true
         self

data/lib/graphql_rails/controller/controller_function.rb

@@ -20,19 +20,23 @@ module GraphqlRails
       def self.from_route(route)
         action = Action.new(route)
 
-        action_function = Class.new(self) do
-          action.arguments.each do |attribute|
-            argument(attribute.field_name, attribute.graphql_field_type)
-          end
-        end
-
-        action_function.new(
+        action_function_class(action).new(
           controller: action.controller,
           action_name: action.name,
           type: action.return_type
         )
       end
 
+      def self.action_function_class(action)
+        Class.new(self) do
+          description(action.description)
+
+          action.arguments.each do |attribute|
+            argument(attribute.field_name, attribute.graphql_field_type)
+          end
+        end
+      end
+
       def call(object, inputs, ctx)
         request = Request.new(object, inputs, ctx)
         controller.new(request).call(action_name)

data/lib/graphql_rails/errors/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module GraphqlRails
+  class Error < StandardError
+  end
+end

data/lib/graphql_rails/model/configuration.rb

@@ -18,12 +18,19 @@ module GraphqlRails
         @name ||= type_name
       end
 
-      def description(description = nil)
-        @description ||= description
+      def description(new_description = nil)
+        @description = new_description if new_description
+        @description
       end
 
-      def attribute(attribute_name, type: nil, hidden: false, property: attribute_name)
-        attributes[attribute_name.to_s] = Attribute.new(attribute_name, type, hidden: hidden, property: property)
+      def attribute(attribute_name, type: nil, description: nil, property: attribute_name)
+        attributes[attribute_name.to_s] = \
+          Attribute.new(
+            attribute_name,
+            type,
+            description: description,
+            property: property
+          )
       end
 
       def graphql_type

data/lib/graphql_rails/model/graphql_type_builder.rb

@@ -13,14 +13,14 @@ module GraphqlRails
       def call
         type_name = name
         type_description = description
-        type_attributes = visible_attributes
+        type_attributes = attributes
 
         GraphQL::ObjectType.define do
           name(type_name)
           description(type_description)
 
           type_attributes.each_value do |attribute|
-            field(attribute.field_name, attribute.graphql_field_type, property: attribute.property.to_sym)
+            field(*attribute.field_args)
           end
         end
       end
@@ -28,10 +28,6 @@ module GraphqlRails
       private
 
       attr_reader :model_configuration, :attributes, :name, :description
-
-      def visible_attributes
-        attributes.reject { |_name, attribute| attribute.hidden? }
-      end
     end
   end
 end

data/lib/graphql_rails/router/resource_routes_builder.rb

@@ -63,7 +63,7 @@ module GraphqlRails
       end
 
       def build_route(builder, action, prefix: action, on: :member, **custom_options)
-        action_options = options.merge(custom_options)
+        action_options = options.merge(custom_options).merge(on: on)
         action_name = [prefix, resource_name(on)].reject(&:empty?).join('_')
         builder.new(action_name, to: "#{name}##{action}", **action_options)
       end

data/lib/graphql_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -111,6 +111,7 @@ files:
 - lib/graphql_rails/controller/configuration.rb
 - lib/graphql_rails/controller/controller_function.rb
 - lib/graphql_rails/controller/request.rb
+- lib/graphql_rails/errors/error.rb
 - lib/graphql_rails/errors/execution_error.rb
 - lib/graphql_rails/errors/validation_error.rb
 - lib/graphql_rails/model.rb