graphql-preview 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f776f673b6e49488b7dc1d7e084b5f0db26a61fe
-  data.tar.gz: 76f1a9da05f10d2b6811d44d76c01fb1b49c9981
+  metadata.gz: 1be4eeeab76bb2658d11526964813f5aa5235b30
+  data.tar.gz: 695ec9a606222425d366e4cb3360930500f79a89
 SHA512:
-  metadata.gz: e3ba889288790d70f731eb0fb6974f92808178e9bee5c0b0f92cbbfe3690294088b07010e113fad891f45d31204927a4e6261ae0fa3021dd667006abd00cf531
-  data.tar.gz: cfc1768f142bef1f959f390eb0a675f5a91c6297af8509cbe0a9eaeccfa76905daec2b028c11ded78ffca79a0346cf1c934eae66e5981f9242c06fe8e72fd3c2
+  metadata.gz: cf0f46b715be0f0634def0fed28a51063d9a4991da8f28847e8f33bc129737283232b9f073d4f544fc343fad83593936723e32afd69a38f7f31f59650188d324
+  data.tar.gz: 65d9959b521f07f18391aed52021d155182d103ece6eb07c7a54d396d3ac4aca149ec12f0c3bc241fbfc07a92c63059dfc5c6e916bc1ed63090dab356aea8f5d

data/graphql-preview.gemspec

@@ -20,7 +20,7 @@ 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.7"
+  spec.add_dependency "graphql", "~> 1.8.0.pre6"
 
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "bundler", "~> 1.14"

data/lib/graphql-preview.rb

@@ -1,8 +1,8 @@
 require "graphql"
+require "graphql-preview/instrumenter"
 require "graphql-preview/version"
 require "graphql-preview/schema_modification"
 require "graphql-preview/mask"
-require "graphql-preview/member_from_path"
 require "graphql-preview/extensions/enabled_previews"
 
 module GraphQLPreview
@@ -16,16 +16,27 @@ module GraphQLPreview
 
     context[:schema_previews].include?(member.metadata[:preview_toggled_by].toggled_by)
   end
+
+  def self.use(schema_def, enabled_previews: [])
+    unless enabled_previews.is_a?(Array)
+      raise ArgumentError, "Expected `enabled_previews` to be an array, but it was `#{enabled_previews.class}`"
+    end
+
+    enabled_previews.each do |preview|
+      unless preview < GraphQLPreview::SchemaModification
+        raise ArgumentError, "Preview #{preview} must inherit from `GraphQLPreview::SchemaModification`"
+      end
+    end
+
+    schema = schema_def.target
+    schema_def.instrument(:field, Instrumenter.new(enabled_previews))
+    enabled_previews.each { |preview| preview.apply_to_schema(schema) }
+    schema.metadata[:enabled_previews] = enabled_previews
+  end
 end
 
 module GraphQL
   Schema.class_eval do
-    # To support `graphql-ruby`'s `.define` based API
-    include GraphQLPreview::Extensions::EnabledPreviews
-
-    accepts_definitions \
-      enabled_previews: -> (schema, previews = nil) { schema.enabled_previews(previews) }
-
     # To support `graphql-ruby`'s class-based API
     extend GraphQLPreview::Extensions::EnabledPreviews
   end

data/lib/graphql-preview/extensions/enabled_previews.rb

@@ -1,26 +1,8 @@
 module GraphQLPreview
   module Extensions
     module EnabledPreviews
-      def enabled_previews(previews = nil)
-        return @enabled_previews if previews.nil?
-
-        unless previews.is_a?(Array)
-          raise ArgumentError, "Expected `enabled_previews` to be an array, but it was `#{previews.class}`"
-        end
-
-        previews.each do |preview|
-          unless preview < GraphQLPreview::SchemaModification
-            raise ArgumentError, "Preview #{preview} must inherit from `GraphQLPreview::SchemaModification`"
-          end
-        end
-
-        previews.each { |preview| preview.apply_to_schema(self) }
-
-        @enabled_previews = previews
-      end
-
-      def enabled_previews=(previews)
-        enabled_previews(previews)
+      def enabled_previews
+        metadata[:enabled_previews]
       end
     end
   end

data/lib/graphql-preview/instrumenter.rb

@@ -0,0 +1,37 @@
+module GraphQLPreview
+  # Modify each field & argument in the schema so that
+  # its metadata contains the preview, if there is one.
+  class Instrumenter
+    def initialize(enabled_previews)
+      @enabled_previews = enabled_previews
+    end
+
+    def instrument(type, field)
+      # Maybe get an isolated copy that we can modify
+      field_dup = nil
+
+      if (preview = enabled_previews.find { |prev| prev.toggled_on.include?("#{type.name}.#{field.name}")})
+        field_dup = field.dup
+        assign_preview(field_dup, preview)
+      end
+
+      # Return the modified copy if we made one,
+      # otherwise return the original
+      field_dup || field
+    end
+
+    private
+
+    attr_reader :enabled_previews
+
+    def assign_preview(obj, preview)
+      if obj.metadata[:preview_toggled_by]
+        raise ArgumentError, "Couldn't add `#{preview}` to `#{obj.name}`: it's already toggled with `#{obj.metadata[:preview_toggled_by].toggled_by}`"
+      end
+      obj.metadata[:preview_toggled_by] = preview
+      if obj.respond_to?(:mutation) && (mut = obj.mutation)
+        mut.metadata[:preview_toggled_by] = preview
+      end
+    end
+  end
+end

data/lib/graphql-preview/schema_modification.rb

@@ -84,10 +84,14 @@ module GraphQLPreview
     private
 
     def self.set_preview_toggled_by_on_members(schema, value)
-      member_from_path = GraphQLPreview::MemberFromPath.new(schema)
-      members = @member_paths.map { |path| member_from_path.find(path) }
+      members = @member_paths.map { |path| schema.find(path) }
 
       members.each do |member|
+        if member.is_a?(GraphQL::Field)
+          # Let fields pass; we'll apply it during instrumentation
+          next
+        end
+
         unless member.respond_to?(:metadata)
           raise NoMethodError, "`#{member}` cannot have its metadata set"
         end

data/lib/graphql-preview/version.rb

@@ -1,3 +1,3 @@
 module GraphQLPreview
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-preview
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Garen J. Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.8.0.pre6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.8.0.pre6
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +129,8 @@ files:
 - graphql-preview.gemspec
 - lib/graphql-preview.rb
 - lib/graphql-preview/extensions/enabled_previews.rb
+- lib/graphql-preview/instrumenter.rb
 - lib/graphql-preview/mask.rb
-- lib/graphql-preview/member_from_path.rb
 - lib/graphql-preview/schema_modification.rb
 - lib/graphql-preview/version.rb
 - script/single_test

data/lib/graphql-preview/member_from_path.rb

@@ -1,135 +0,0 @@
-module GraphQLPreview
-  class MemberFromPath
-    class MemberNotFoundError < ArgumentError; end
-
-    def initialize(schema)
-      @schema = schema
-    end
-
-    def find(path)
-      path = path.split(".")
-      type_or_directive = path.shift
-
-      if type_or_directive.start_with?("@")
-        directive = schema.directives[type_or_directive[1..-1]]
-
-        if directive.nil?
-          raise MemberNotFoundError, "Could not find directive `#{type_or_directive}` in schema."
-        end
-
-        return directive if path.empty?
-
-        find_in_directive(directive, path: path)
-      else
-        type = schema.types[type_or_directive]
-
-        if type.nil?
-          raise MemberNotFoundError, "Could not find type `#{type_or_directive}` in schema."
-        end
-
-        return type if path.empty?
-
-        find_in_type(type, path: path)
-      end
-    end
-
-    private
-
-    attr_reader :schema
-
-    def find_in_directive(directive, path:)
-      argument_name = path.shift
-      argument = directive.arguments[argument_name]
-
-      if argument.nil?
-        raise MemberNotFoundError, "Could not find argument `#{argument_name}` on directive #{directive}."
-      end
-
-      argument
-    end
-
-    def find_in_type(type, path:)
-      case type
-      when GraphQL::ObjectType
-        find_in_fields_type(type, kind: "object", path: path)
-      when GraphQL::InterfaceType
-        find_in_fields_type(type, kind: "interface", path: path)
-      when GraphQL::InputObjectType
-        find_in_input_object(type, path: path)
-      when GraphQL::UnionType
-        # Error out if path that was provided is too long
-        # i.e UnionType.PossibleType.aField
-        # Use PossibleType.aField instead.
-        if invalid = path.first
-          raise MemberNotFoundError, "Cannot select union possible type `#{invalid}`. Select the type directly instead."
-        end
-      when GraphQL::EnumType
-        find_in_enum_type(type, path: path)
-      end
-    end
-
-    def find_in_fields_type(type, kind:, path:)
-      field_name = path.shift
-      instrumented_field = schema.get_field(type, field_name)
-
-      if instrumented_field.nil?
-        raise MemberNotFoundError, "Could not find field `#{field_name}` on #{kind} type `#{type}`."
-      end
-
-      return instrumented_field if path.empty?
-
-      find_in_field(instrumented_field, path: path)
-    end
-
-    def find_in_field(field, path:)
-      argument_name = path.shift
-      argument = field.arguments[argument_name]
-
-      if argument.nil?
-        raise MemberNotFoundError, "Could not find argument `#{argument_name}` on field `#{field.name}`."
-      end
-
-      # Error out if path that was provided is too long
-      # i.e Type.field.argument.somethingBad
-      if invalid = path.first
-        raise MemberNotFoundError, "Cannot select member `#{invalid}` on a field."
-      end
-
-      argument
-    end
-
-    def find_in_input_object(input_object, path:)
-      field_name = path.shift
-      input_field = input_object.input_fields[field_name]
-
-      if input_field.nil?
-        raise MemberNotFoundError, "Could not find input field `#{field_name}` on input object type `#{input_object}`."
-      end
-
-      # Error out if path that was provided is too long
-      # i.e InputType.inputField.bad
-      if invalid = path.first
-        raise MemberNotFoundError, "Cannot select member `#{invalid}` on an input field."
-      end
-
-      input_field
-    end
-
-    def find_in_enum_type(enum_type, path:)
-      value_name = path.shift
-      enum_value = enum_type.values[value_name]
-
-      if enum_value.nil?
-        raise MemberNotFoundError, "Could not find enum value `#{value_name}` on enum type `#{enum_type}`."
-      end
-
-      # Error out if path that was provided is too long
-      # i.e Enum.VALUE.wat
-      if invalid = path.first
-        raise MemberNotFoundError, "Cannot select member `#{invalid}` on an enum value."
-      end
-
-      enum_value
-    end
-  end
-end