graphql-client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd882791666554b4b6999b5e6e1089187eb06e9a
-  data.tar.gz: 5c1e142aee92b113edef6c34a90484ff32b2fd0e
+  metadata.gz: 9c735cc6d34d7372e777934b15cbf86540cf994a
+  data.tar.gz: 329f6769cf02065e726dd26e9006cb1143f3f8df
 SHA512:
-  metadata.gz: 242cd9508205d68cb2459a78bcd689a986c4317478113923d8fbd23d015bf8c936fd84619410228404699a7c229377f6333f857f216853d9991b32603e34443d
-  data.tar.gz: 74fb38b0777b0df123df5c5a09a6e1caf5f69ec3f5f765c859d041900c58e6403cebd0a59c882095524ba18cf08ab0e04dcfca7164b39c6d2e291e8f845b15f1
+  metadata.gz: fd69bd130b837dff72de557d1b0c51e7a4f0b499af231af00d8b2df65a638116021f45660be83c8695aa27bbf808741db5317d4791e68f6bf0db9f059dbf9273
+  data.tar.gz: 20d75c1fa9d08f56a096328cf499e163eea4b7d13bfc9767f8fa743004e87c9a611d32d6533cbc0f28d72770b41635eff526549baf81bd52cc319ed0437ccb4c

data/lib/graphql/client.rb

@@ -3,9 +3,12 @@ require "active_support/inflector"
 require "active_support/notifications"
 require "graphql"
 require "graphql/client/collocated_enforcement"
+require "graphql/client/definition"
 require "graphql/client/definition_variables"
 require "graphql/client/error"
 require "graphql/client/errors"
+require "graphql/client/fragment_definition"
+require "graphql/client/operation_definition"
 require "graphql/client/query_result"
 require "graphql/client/query_typename"
 require "graphql/client/response"
@@ -88,96 +91,6 @@ module GraphQL
       @enforce_collocated_callers = enforce_collocated_callers
     end
 
-    # Definitions are constructed by Client.parse and wrap a parsed AST of the
-    # query string as well as hold references to any external query definition
-    # dependencies.
-    #
-    # Definitions MUST be assigned to a constant.
-    class Definition < Module
-      def self.for(node:, **kargs)
-        case node
-        when Language::Nodes::OperationDefinition
-          OperationDefinition.new(node: node, **kargs)
-        when Language::Nodes::FragmentDefinition
-          FragmentDefinition.new(node: node, **kargs)
-        else
-          raise TypeError, "expected node to be a definition type, but was #{node.class}"
-        end
-      end
-
-      def initialize(node:, document:, schema:, document_types:, source_location:, enforce_collocated_callers:)
-        @definition_node = node
-        @document = document
-        @schema = schema
-        @document_types = document_types
-        @source_location = source_location
-        @enforce_collocated_callers = enforce_collocated_callers
-      end
-
-      # Internal: Get underlying operation or fragment defintion AST node for
-      # definition.
-      #
-      # Returns OperationDefinition or FragmentDefinition object.
-      attr_reader :definition_node
-
-      # Public: Global name of definition in client document.
-      #
-      # Returns a GraphQL safe name of the Ruby constant String.
-      #
-      #   "Users::UserQuery" #=> "Users__UserQuery"
-      #
-      # Returns String.
-      def definition_name
-        return @definition_name if defined?(@definition_name)
-
-        if name
-          @definition_name = name.gsub("::", "__").freeze
-        else
-          "#{self.class.name}_#{object_id}".gsub("::", "__").freeze
-        end
-      end
-
-      # Public: Get document with only the definitions needed to perform this
-      # operation.
-      #
-      # Returns GraphQL::Language::Nodes::Document with one OperationDefinition
-      # and any FragmentDefinition dependencies.
-      attr_reader :document
-
-      # Internal: Mapping of document nodes to schema types.
-      attr_reader :document_types
-
-      attr_reader :schema
-
-      # Public: Returns the Ruby source filename and line number containing this
-      # definition was not defined in Ruby.
-      #
-      # Returns Array pair of [String, Fixnum].
-      attr_reader :source_location
-
-      attr_reader :enforce_collocated_callers
-
-      def new(*args)
-        type.new(*args)
-      end
-
-      def type
-        # TODO: Fix type indirection
-        @type ||= GraphQL::Client::QueryResult.wrap(self, definition_node, name: "#{name}.type")
-      end
-    end
-
-    # Specific operation definition subtype for queries, mutations or
-    # subscriptions.
-    class OperationDefinition < Definition
-      # Public: Alias for definition name.
-      alias operation_name definition_name
-    end
-
-    # Specific fragment definition subtype.
-    class FragmentDefinition < Definition
-    end
-
     def parse(str, filename = nil, lineno = nil)
       if filename.nil? && lineno.nil?
         location = caller_locations(1, 1).first

data/lib/graphql/client/collocated_enforcement.rb

@@ -3,6 +3,10 @@ require "graphql/client/error"
 
 module GraphQL
   class Client
+
+    # Collcation will not be enforced if a stack trace includes any of these gems.
+    WHITELISTED_GEM_NAMES = %w{pry byebug}
+
     # Raised when method is called from outside the expected file scope.
     class NonCollocatedCallerError < Error; end
 
@@ -30,7 +34,8 @@ module GraphQL
               return super(*args, &block) if Thread.current[:query_result_caller_location_ignore]
 
               locations = caller_locations(1, 1)
-              if locations.first.path != path
+
+              if (locations.first.path != path) && !(caller_locations.any? { |cl| WHITELISTED_GEM_NAMES.any? { |g| cl.path.include?("gems/#{g}") } })
                 error = NonCollocatedCallerError.new("#{method} was called outside of '#{path}' https://git.io/v1syX")
                 error.set_backtrace(caller(1))
                 raise error

data/lib/graphql/client/definition.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+module GraphQL
+  class Client
+    # Definitions are constructed by Client.parse and wrap a parsed AST of the
+    # query string as well as hold references to any external query definition
+    # dependencies.
+    #
+    # Definitions MUST be assigned to a constant.
+    class Definition < Module
+      def self.for(node:, **kargs)
+        case node
+        when Language::Nodes::OperationDefinition
+          OperationDefinition.new(node: node, **kargs)
+        when Language::Nodes::FragmentDefinition
+          FragmentDefinition.new(node: node, **kargs)
+        else
+          raise TypeError, "expected node to be a definition type, but was #{node.class}"
+        end
+      end
+
+      def initialize(node:, document:, schema:, document_types:, source_location:, enforce_collocated_callers:)
+        @definition_node = node
+        @document = document
+        @schema = schema
+        @document_types = document_types
+        @source_location = source_location
+        @enforce_collocated_callers = enforce_collocated_callers
+      end
+
+      # Internal: Get underlying operation or fragment defintion AST node for
+      # definition.
+      #
+      # Returns OperationDefinition or FragmentDefinition object.
+      attr_reader :definition_node
+
+      # Public: Global name of definition in client document.
+      #
+      # Returns a GraphQL safe name of the Ruby constant String.
+      #
+      #   "Users::UserQuery" #=> "Users__UserQuery"
+      #
+      # Returns String.
+      def definition_name
+        return @definition_name if defined?(@definition_name)
+
+        if name
+          @definition_name = name.gsub("::", "__").freeze
+        else
+          "#{self.class.name}_#{object_id}".gsub("::", "__").freeze
+        end
+      end
+
+      # Public: Get document with only the definitions needed to perform this
+      # operation.
+      #
+      # Returns GraphQL::Language::Nodes::Document with one OperationDefinition
+      # and any FragmentDefinition dependencies.
+      attr_reader :document
+
+      # Internal: Mapping of document nodes to schema types.
+      attr_reader :document_types
+
+      attr_reader :schema
+
+      # Public: Returns the Ruby source filename and line number containing this
+      # definition was not defined in Ruby.
+      #
+      # Returns Array pair of [String, Fixnum].
+      attr_reader :source_location
+
+      attr_reader :enforce_collocated_callers
+
+      def new(*args)
+        type.new(*args)
+      end
+
+      def type
+        # TODO: Fix type indirection
+        @type ||= GraphQL::Client::QueryResult.wrap(self, definition_node, name: "#{name}.type")
+      end
+    end
+  end
+end

data/lib/graphql/client/fragment_definition.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "graphql/client/definition"
+
+module GraphQL
+  class Client
+    # Specific fragment definition subtype.
+    class FragmentDefinition < Definition
+    end
+  end
+end

data/lib/graphql/client/operation_definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "graphql/client/definition"
+
+module GraphQL
+  class Client
+    # Specific operation definition subtype for queries, mutations or
+    # subscriptions.
+    class OperationDefinition < Definition
+      # Public: Alias for definition name.
+      alias operation_name definition_name
+    end
+  end
+end

data/lib/graphql/client/query_result.rb

@@ -227,12 +227,16 @@ module GraphQL
       # Returns Errors collection.
       attr_reader :errors
 
-      attr_reader :data
-      alias to_h data
-
       attr_reader :__typename
       alias typename __typename
 
+      # Public: Returns the raw response data
+      #
+      # Returns Hash
+      def to_h
+        @data
+      end
+
       def type_of?(*types)
         types.any? do |type|
           if type = self.class.schema.types.fetch(type.to_s, nil)
@@ -272,7 +276,7 @@ module GraphQL
           raise UnimplementedFieldError, "undefined field `#{e.name}' on #{type} type. https://git.io/v1y3m"
         end
 
-        if data[field.name]
+        if @data[field.name]
           error_class = ImplicitlyFetchedFieldError
           message = "implicitly fetched field `#{field.name}' on #{type} type. https://git.io/v1yGL"
         else

data/lib/graphql/client/view_module.rb

@@ -44,14 +44,14 @@ module GraphQL
       #
       # Returns nothing.
       def eager_load!
-        return unless File.directory?(path)
+        return unless File.directory?(load_path)
 
-        Dir.entries(path).each do |entry|
+        Dir.entries(load_path).each do |entry|
           next if entry == "." || entry == ".."
           name = entry.sub(/(\.\w+)+$/, "").camelize.to_sym
-          if ViewModule.valid_constant_name?(name) && loadable_const_defined?(name)
-            mod = const_get(name, false)
-            mod.eager_load!
+          if ViewModule.valid_constant_name?(name)
+            mod = const_defined?(name, false) ? const_get(name) : load_and_set_module(name)
+            mod.eager_load! if mod
           end
         end
 
@@ -73,76 +73,67 @@ module GraphQL
         name.to_s =~ /^[A-Z][a-zA-Z0-9_]*$/
       end
 
-      # Public: Override constant defined to check if constant name matches a
-      # view directory or template namespace.
-      #
-      # name - String or Symbol constant name
-      # inherit - If the lookup will also search the ancestors (default: true)
-      #
-      # Returns true if definition is found, otherwise false.
-      # def const_defined?(name, inherit = true)
-      #   if super(name.to_sym, inherit)
-      #     true
-      #   elsif const_path(name)
-      #     true
-      #   else
-      #     false
-      #   end
-      # end
-
-      def loadable_const_defined?(name)
-        if const_defined?(name.to_sym, false)
-          true
-        elsif const_path(name)
-          true
-        else
-          false
-        end
-      end
-
-      # Public: Source location that defined the Module.
+      # Public: Directory to retrieve nested GraphQL definitions from.
       #
       # Returns absolute String path under app/views.
-      attr_accessor :path
+      attr_accessor :load_path
+      alias_method :path=, :load_path=
+      alias_method :path, :load_path
 
-      # Internal: Detect source location for constant name.
-      #
-      # name - String or Symbol constant name
+      # Public: if this module was defined by a view
       #
-      # Examples
-      #
-      #   Views.const_path(:Users) #=> "app/views/users"
-      #   Views::Users.const_path(:Show) #=> "app/views/users/show.html.erb"
-      #   Views::Users.const_path(:Profile) #=> "app/views/users/_profile.html.erb"
-      #
-      # Returns String absolute path to file, otherwise nil.
-      def const_path(name)
-        pathname = ActiveSupport::Inflector.underscore(name.to_s)
-        Dir[File.join(path, "{#{pathname},_#{pathname}}{/,.*}")].map { |fn| File.expand_path(fn) }.first
-      end
+      # Returns absolute String path under app/views.
+      attr_accessor :source_path
 
       # Internal: Initialize new module for constant name and load ERB statics.
       #
-      # path - String path of directory or erb file.
+      # name - String or Symbol constant name.
       #
       # Examples
       #
-      #   load_module("app/views/users")
-      #   load_module("app/views/users/show.html.erb")
+      #   Views::Users.load_module(:Profile)
+      #   Views::Users::Profile.load_module(:Show)
       #
       # Returns new Module implementing Loadable concern.
-      def load_module(path)
-        mod = Module.new
+      def load_module(name)
+        pathname = ActiveSupport::Inflector.underscore(name.to_s)
+        path = Dir[File.join(load_path, "{#{pathname},_#{pathname}}{.*}")].map { |fn| File.expand_path(fn) }.first
 
-        if File.extname(path) == ".erb"
-          contents = File.read(path)
-          query, lineno = ViewModule.extract_graphql_section(contents)
-          mod = client.parse(query, path, lineno) if query
-        end
+        return if !path || File.extname(path) != ".erb"
 
+        contents = File.read(path)
+        query, lineno = ViewModule.extract_graphql_section(contents)
+        return unless query
+
+        mod = client.parse(query, path, lineno)
         mod.extend(ViewModule)
+        mod.load_path = File.join(load_path, pathname)
+        mod.source_path = path
         mod.client = client
-        mod.path = path
+        mod
+      end
+
+      def placeholder_module(name)
+        dirname = File.join(load_path, ActiveSupport::Inflector.underscore(name.to_s))
+        return nil unless Dir.exist?(dirname)
+
+        Module.new.tap do |mod|
+          mod.extend(ViewModule)
+          mod.load_path = dirname
+          mod.client = client
+        end
+      end
+
+      def load_and_set_module(name)
+        placeholder = placeholder_module(name)
+        const_set(name, placeholder) if placeholder
+
+        mod = load_module(name)
+        return placeholder unless mod
+
+        remove_const(name) if placeholder
+        const_set(name, mod)
+        mod.unloadable
         mod
       end
 
@@ -152,16 +143,7 @@ module GraphQL
       #
       # Returns module or raises NameError if missing.
       def const_missing(name)
-        path = const_path(name)
-
-        if path
-          mod = load_module(path)
-          const_set(name, mod)
-          mod.unloadable
-          mod
-        else
-          super
-        end
+        load_and_set_module(name) || super
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,6 +158,7 @@ files:
 - README.md
 - lib/graphql/client.rb
 - lib/graphql/client/collocated_enforcement.rb
+- lib/graphql/client/definition.rb
 - lib/graphql/client/definition_variables.rb
 - lib/graphql/client/document_types.rb
 - lib/graphql/client/error.rb
@@ -165,10 +166,12 @@ files:
 - lib/graphql/client/erubi_enhancer.rb
 - lib/graphql/client/erubis.rb
 - lib/graphql/client/erubis_enhancer.rb
+- lib/graphql/client/fragment_definition.rb
 - lib/graphql/client/hash_with_indifferent_access.rb
 - lib/graphql/client/http.rb
 - lib/graphql/client/list.rb
 - lib/graphql/client/log_subscriber.rb
+- lib/graphql/client/operation_definition.rb
 - lib/graphql/client/query_result.rb
 - lib/graphql/client/query_typename.rb
 - lib/graphql/client/railtie.rb
@@ -197,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: GraphQL Client