graphql-preview 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc975ff4b49ae763232e7658f510a8bac187efa2
-  data.tar.gz: 779d52ef6311effa305f09154353f3996e0859d8
+  metadata.gz: 4dead6d1a5f54b189170b3d4da9cb77d4f31a9d3
+  data.tar.gz: 400454ff941ed04a48bf3ada71a45527c2f3764a
 SHA512:
-  metadata.gz: 887ee46c24ca8613d3dc8af6b0b6ebc5212072dcf5d97b7a02babbb90ef28f4fe61fad47a7a83a6d71f5d93ca341f57444bc0ccbdc6df583ab8161eff968d3c9
-  data.tar.gz: 44ac0b9b7ee55894cb044363bec954e326264bc8ce13bdca8998ed7899938b8af7830c234bb17d7d5d962044eb430a502b857ede3bab46114b8d53bd85a99f5c
+  metadata.gz: f18cea3be7ff3f17632e4a3cc302473025974f0cc72759f9d8971878076f901539ff116573b7b59d289e9d59899fbd5628f7b18f1d27e75e0c0a94eee2b9eb64
+  data.tar.gz: 6e6f0b25d10af928191be4e1ea08c01fe9f078db98121aa247d4552a3038585fa2fa6125085dcacb8ed8e46a900c76ff40ada8b58f0bbb58a4fceba577b464ad

data/README.md

@@ -48,15 +48,15 @@ class TestPreview < GraphQLPreview::SchemaModification
 
   # The parts of your GraphQL schema you want toggled by this preview
   toggled_on [
-    Library::Author, # an object
-    Library::ExtraInfo, # an interface,
-    Library::Author.fields["socialSecurityNumber"], # a field
-    Library::Book.fields["author"].arguments["includeMiddleInitial"], # an argument
-    Library::Likeable, # a union,
-    Library::Cover, # an enum
-    Library::Cover.values["DIGITAL"], # an enum value
-    Library::BookOrder, # an input object
-    Library::AddLike, # a mutation
+    "Author", # an object
+    "ExtraInfo", # an interface,
+    "Author.socialSecurityNumber", # a field
+    "Book.author.includeMiddleInitial", # an argument
+    "Likeable", # a union,
+    "Cover", # an enum
+    "Cover.DIGITAL", # an enum value
+    "BookOrder", # an input object
+    "Mutation.addLike", # a mutation
   ]
 end
 ```
@@ -66,6 +66,17 @@ end
 This gem introduces a new method to apply on your schema, `enabled_previews`. It takes an array,
 and you should pass in the list of preview classes you want enabled on your schema. For example:
 
+``` ruby
+class Schema < GraphQL::Schema
+  query(query_type)
+  enabled_previews [
+    TestPreview
+  ]
+end
+```
+
+If you are using `graphql-ruby`'s `.define` DSL a similar API is provided:
+
 ``` ruby
 GraphQL::Schema.define do
   query(query_type)

data/lib/graphql-preview.rb

@@ -2,10 +2,20 @@ require "graphql"
 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
+  def self.visible?(member, context:)
+    return true unless member.respond_to?(:metadata)
+    return true unless member.metadata[:preview_toggled_by]
 
+    unless context.key?(:schema_previews)
+      raise ArgumentError, "[GraphQLPreview] `:schema_previews` was not provided to the `context`"
+    end
+
+    context[:schema_previews].include?(member.metadata[:preview_toggled_by].toggled_by)
+  end
 end
 
 module GraphQL

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

@@ -9,11 +9,13 @@ module GraphQLPreview
         end
 
         previews.each do |preview|
-          unless preview.ancestors.any? { |ancestor| ancestor == GraphQLPreview::SchemaModification }
-            raise ArgumentError, "One of your `enabled_previews` items does not descend from `GraphQLPreview::SchemaModification`"
+          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
 

data/lib/graphql-preview/mask.rb

@@ -1,13 +1,7 @@
 module GraphQLPreview
   class Mask
     def self.call(member, context)
-      return false unless member.respond_to?(:metadata)
-      return false unless member.metadata.key?(:preview_toggled_by)
-      unless context.key?(:schema_previews)
-        raise ArgumentError, "You are using the `GraphQLPreview::Mask`, but key `:schema_previews` was not provided to the `context`"
-      end
-
-      !context[:schema_previews].include?(member.metadata[:preview_toggled_by].toggled_by)
+      !GraphQLPreview.visible?(member, context: context)
     end
   end
 end

data/lib/graphql-preview/member_from_path.rb

@@ -0,0 +1,135 @@
+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
+      field = type.fields[field_name]
+
+      if field.nil?
+        raise MemberNotFoundError, "Could not find field `#{field_name}` on #{kind} type `#{type}`."
+      end
+
+      return field if path.empty?
+
+      find_in_field(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

data/lib/graphql-preview/schema_modification.rb

@@ -59,34 +59,55 @@ module GraphQLPreview
       @updates
     end
 
-    def self.toggled_on(types = nil)
-      if types
-        types.each do |type|
-          unless type.respond_to?(:metadata)
-            raise MethodError, "`#{type}` cannot have its metadata set"
-          end
-
-          if type.metadata.key?(:preview_toggled_by)
-            raise ArgumentError, "Couldn't add `#{self.toggled_by}` to `#{type.name}`: it's already toggled with `#{type.metadata[:preview_toggled_by].toggled_by}`"
-          end
-
-          type.metadata[:preview_toggled_by] = self
-
-          if type.is_a?(GraphQL::InterfaceType)
-            mark_children(type)
+    def self.toggled_on(member_paths = nil)
+      if member_paths
+        member_paths.each do |path|
+          unless path.is_a?(String)
+            raise ArgumentError, "Provide string paths to `toggled_on`. For example, to toggle on a field called `name` on a type `Author`, use `\"Author.name\"``"
           end
         end
-        @toggled_on = types
+
+        @member_paths = member_paths
       else
-        @toggled_on
+        @member_paths
       end
     end
 
+    def self.unset(schema)
+      set_preview_toggled_by_on_members(schema, nil)
+    end
+
+    def self.apply_to_schema(schema)
+      set_preview_toggled_by_on_members(schema, self)
+    end
+
     private
 
-    def self.mark_children(type)
-      type.fields.each_value do |field|
-        field.metadata[:preview_toggled_by] = self
+    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.each do |member|
+        unless member.respond_to?(:metadata)
+          raise NoMethodError, "`#{member}` cannot have its metadata set"
+        end
+
+        # unless we're unsetting the preview, don't allow adding a new value
+        if value && member.metadata[:preview_toggled_by]
+          raise ArgumentError, "Couldn't add `#{self.toggled_by}` to `#{member.name}`: it's already toggled with `#{member.metadata[:preview_toggled_by].toggled_by}`"
+        end
+
+        member.metadata[:preview_toggled_by] = value
+
+        if member.is_a?(GraphQL::InterfaceType)
+          member.fields.each_value do |field|
+            field.metadata[:preview_toggled_by] = value
+          end
+        end
+
+        if member.respond_to?(:mutation) && member.mutation
+          member.mutation.metadata[:preview_toggled_by] = value
+        end
       end
     end
   end

data/lib/graphql-preview/version.rb

@@ -1,3 +1,3 @@
 module GraphQLPreview
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-preview
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Garen J. Torikian
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -130,6 +130,7 @@ files:
 - lib/graphql-preview.rb
 - lib/graphql-preview/extensions/enabled_previews.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