graphql-decorate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5fc5dae438847027d85bbbad840e06d7e988262d131942f22896ef6eccc0bc37
+  data.tar.gz: c3a678357eba0122ae55d4a9b810bc157b496c8116c4156ca6c215f39379b0c3
+SHA512:
+  metadata.gz: 377a02d6883de6e5ae2508fc8f157a16c53beb1ea219e058e6a06b9b692176a1ea808046f156b99c8cd9aa1f8f0462be5b0f5adf2eb57eac3a70f28b255f8089
+  data.tar.gz: 182faddf5c006dd2518accbfd87f6be489b700d467412d3f8016748b0a60370f082ddad47572097518f57b0b15185cde07144d8a111396c5efa55eaa9b99ccac

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea/
+/.ruby-version
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-decorate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 bbrook
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# GraphQL Decorate
+
+`graphql-decorate` adds an easy-to-use interface for decorating types in `graphql-ruby`. It lets 
+you move logic out of your type files and keep them declarative. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-decorate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-decorate
+
+Once the gem is installed, you need to add the integrations to your base type and field classes. 
+```ruby
+class BaseType < GraphQL::Schema::Object
+  extend GraphQL::Decorate::ObjectIntegration
+end
+
+class BaseField < GraphQL::Schema::Field
+  include GraphQL::Decorate::FieldIntegration
+end
+```
+
+## Usage
+
+### Basic use case
+```ruby
+class Rectangle
+  attr_reader :length
+
+  def initialize(length)
+    @length = length
+  end
+end
+
+class RectangleDecorator < BaseDecorator
+  def area
+    length * 2
+  end
+end
+
+class Rectangle < GraphQL::Schema::Object
+  decorate_with RectangleDecorator
+  
+  field :area, Int, null: false
+end
+```
+In this example, the `Rectangle` type is being decorated with a `RectangleDecorator`. Whenever a 
+`Rectangle` gets resolved in the graph, the underlying object will be wrapped with a 
+`RectangleDecorator`. All of the methods on the decorator are accessible on the type.
+
+### Decorators
+By default, `graphql-decorate` is set up to work with Draper-style decorators. These decorators 
+provide a `decorate` method that wraps the original object and returns an instance of the 
+decorator. They can also take in an additional context hash.
+```ruby
+RectangleDecorator.decorate(rectangle, context)
+```
+If you are using a different decorator pattern then you can override this default behavior in 
+the configuration.
+```ruby
+GraphQL::Decorate.configure do |config|
+  config.decorate do |decorator_class, object, _context|
+    decorator_class.decorate_differently(object)
+  end
+end
+```
+
+### Types
+Three methods are made available on your type classes
+#### decorate_with
+`decorate_with` accepts a decorator class that will decorate every instance of your type.
+```ruby
+class Rectangle < GraphQL::Schema::Object
+  decorate_with RectangleDecorator
+end
+```
+
+#### decorate_when
+`decorate_when` accepts a block which yields the underlying object. If you have multiple 
+possible decorator classes you can return the one intended for the underling object.
+```ruby
+class Rectangle < GraphQL::Schema::Object
+  decorate_when do |object|
+    if object.length == object.width
+      SquareDecorator
+    else
+      RectangleDecorator
+    end
+  end
+end
+```
+
+#### decorator_context
+`decorator_context` accepts a block which yields the underlying object. If your decorator pattern 
+allows additional context being passed into the decorators, you can define it here.
+```ruby
+class Rectangle < GraphQL::Schema::Object
+  decorator_context do |object|
+    {
+      name: object.name
+    }
+  end
+end
+```
+`RectangleDecorator` will be initialized with a context of `{ name: <object_name> }`. 
+
+#### Combinations
+You can mix and match these methods to suit your needs. Note that if `decorate_with` and 
+`decorate_when` are both provided that `decorate_with` will take precedence.
+```ruby
+class Rectangle < GraphQL::Schema::Object
+  decorate_with RectangleDecorator
+  decorator_context do |object|
+    {
+      name: object.name
+    }
+  end
+end
+```
+
+### Collections
+By default `graphql-decorate` recognizes `Array` and `ActiveRecord::Relation` object types and 
+decorates every element in the collection. If you have other collection types that should have 
+their elements decorated, you can add them in the configuration.
+```ruby
+GraphQL::Decorate.configure do |config|
+  config.custom_collection_classes = [Mongoid::Relations::Targets::Enumerable]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/decorate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-decorate.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/decorate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-decorate"
+  spec.version       = GraphQL::Decorate::VERSION
+  spec.authors       = ["Ben Brook"]
+  spec.email         = ["bbrook@truecar.com"]
+
+  spec.summary       = 'A decorator integration for the GraphQL gem'
+  spec.homepage      = 'https://git.corp.tc/bbrook/graphql-decorate'
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "graphql", ">= 1.3", "< 2"
+
+  spec.add_development_dependency "bundler", ">= 2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/graphql/decorate.rb

@@ -0,0 +1,27 @@
+require 'graphql'
+require_relative 'decorate/version'
+require_relative 'decorate/configuration'
+require_relative 'decorate/object_integration'
+require_relative 'decorate/field_integration'
+require_relative 'decorate/field_extension'
+require_relative 'decorate/resolution'
+require_relative 'decorate/type_attributes'
+
+module GraphQL
+  module Decorate
+    # @return [Configuration] Returns a new instance of GraphQL::Decorate::Configuration.
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # @yield [configuration] Gives the configuration to the block.
+    def self.configure
+      yield(configuration)
+    end
+
+    # @return [Configuration] Resets the configuration to its defaults.
+    def self.reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/graphql/decorate/configuration.rb

@@ -0,0 +1,24 @@
+module GraphQL
+  module Decorate
+    class Configuration
+      # @return [Proc] Proc that decorates a given object and context with a given decorator class.
+      attr_reader :evaluate_decorator
+
+      # @return [Array] Controls which classes are treated as collections to be decorated.
+      attr_accessor :custom_collection_classes
+
+      def initialize
+        @evaluate_decorator = lambda do |decorator_class, object, context|
+          decorator_class.decorate(object, context: context)
+        end
+        @custom_collection_classes = []
+      end
+
+      # @yield [decorator_class, object, decorator_context] Override default decoration behavior with the given block.
+      # @return [Void]
+      def decorate(&block)
+        @evaluate_decorator = block
+      end
+    end
+  end
+end

data/lib/graphql/decorate/field_extension.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module GraphQL
+  module Decorate
+    class FieldExtension < GraphQL::Schema::FieldExtension
+      # Extension to be called after lazy loading.
+      # @param context [GraphQL::Query::Context] The current GraphQL query context.
+      # @param value [Object, GraphQL::Schema::Object] The object being decorated. Can be a schema object if the field hasn't been resolved yet.
+      # @return [Object] Decorated object.
+      def after_resolve(context:, value:, **_rest)
+        return if value.nil?
+
+        collection = collection_classes.any? { |c| value.is_a?(c) }
+        if collection
+          value.map { |item| decorate(item, context) }
+        else
+          decorate(value, context)
+        end
+      end
+
+      private
+
+      def collection_classes
+        klasses = [Array] + GraphQL::Decorate.configuration.custom_collection_classes
+        klasses << ::ActiveRecord::Relation if defined?(ActiveRecord::Relation)
+        klasses
+      end
+
+      def decorate(object, context)
+        GraphQL::Decorate::Resolution.new(object, context, options).resolve
+      end
+    end
+  end
+end

data/lib/graphql/decorate/field_integration.rb

@@ -0,0 +1,34 @@
+module GraphQL
+  module Decorate
+    module FieldIntegration
+      # Overridden field initializer
+      # @param type [GraphQL::Schema::Object] The type to add the extension to.
+      # @return [Void]
+      def initialize(type:, **rest, &block)
+        super
+        field_type = [type].flatten(1).first
+        extension_options = get_extension_options(field_type)
+        extend_with_decorator(extension_options) if extension_options
+      end
+
+      private
+
+      def get_extension_options(type)
+        type_attributes = GraphQL::Decorate::TypeAttributes.new(type)
+        {
+          decorator_class: type_attributes.decorator_class,
+          decorator_evaluator: type_attributes.decorator_evaluator,
+          decorator_context_evaluator: type_attributes.decorator_context_evaluator,
+          unresolved_type: type_attributes.unresolved_type
+        }
+      end
+
+      def extend_with_decorator(options)
+        ext = GraphQL::Decorate::FieldExtension.new(field: self, options: options)
+        @extensions = @extensions.dup
+        @extensions.unshift(ext)
+        @extensions.freeze
+      end
+    end
+  end
+end

data/lib/graphql/decorate/object_integration.rb

@@ -0,0 +1,40 @@
+module GraphQL
+  module Decorate
+    module ObjectIntegration
+      # Decorate the type with a decorator class.
+      # @param klass [Class] Class the object should be decorated with.
+      def decorate_with(klass)
+        @decorator_class = klass
+      end
+
+      # Dynamically choose the decorator class based on the underlying object.
+      # @yield [object] Gives the underlying object to the block.
+      # @return [Proc] Proc to evaluate decorator class. Proc should return a decorator class.
+      def decorate_when(&block)
+        @decorator_evaluator = block
+      end
+
+      # Pass additional data to the decorator context (if supported).
+      # @yield [object] Gives the underlying object to the block.
+      # @return [Proc] Proc to evaluate decorator context. Proc should return Hash.
+      def decorator_context(&block)
+        @decorator_context_evaluator = block
+      end
+
+      # @return [Class, nil] Gets the currently set decorator class.
+      def decorator_class
+        @decorator_class
+      end
+
+      # @return [Proc, nil] Gets the currently set decorator evaluator.
+      def decorator_evaluator
+        @decorator_evaluator
+      end
+
+      # @return [Proc, nil] Gets the currently set decorator context evaluator.
+      def decorator_context_evaluator
+        @decorator_context_evaluator
+      end
+    end
+  end
+end

data/lib/graphql/decorate/resolution.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+module GraphQL
+  module Decorate
+    class Resolution
+      # @param object [Object] Object being resolved.
+      # @param graphql_context [GraphQL::Query::Context] CurrentGraphQL query context.
+      # @param extension_options [Hash] Options provided from the field extension.
+      def initialize(object, graphql_context, extension_options)
+        @object = object
+        @graphql_context = graphql_context
+        @extension_options = extension_options
+        @default_decorator_context = { graphql: true }
+      end
+
+      # Resolve the object with decoration.
+      # @return [Object] Decorated object if possible, otherwise the original object.
+      def resolve
+        if decorator_class
+          GraphQL::Decorate.configuration.evaluate_decorator.call(decorator_class, object, decorator_context)
+        else
+          object
+        end
+      end
+
+      private
+
+      attr_reader :object, :graphql_context, :extension_options, :default_decorator_context
+
+      def decorator_class
+        if extension_options[:decorator_class]
+          extension_options[:decorator_class]
+        elsif extension_options[:decorator_evaluator]
+          extension_options[:decorator_evaluator].call(object)
+        else
+          resolve_decorator_class
+        end
+      end
+
+      def decorator_context_evaluator
+        extension_options[:decorator_context_evaluator] || resolve_decorator_context_evaluator
+      end
+
+      private
+
+      def evaluate_decoration_context
+        decorator_context_evaluator ? decorator_context_evaluator.call(object) : {}
+      end
+
+      def decorator_context
+        evaluate_decoration_context.merge(default_decorator_context)
+      end
+
+      def resolve_decorator_class
+        type = resolve_type
+        if type.respond_to?(:decorator_class) && type.decorator_class
+          type.decorator_class
+        end
+      end
+
+      def resolve_decorator_context_evaluator
+        type = resolve_type
+        if type.respond_to?(:decorator_context_evaluator) && type.decorator_context_evaluator
+          type.decorator_context_evaluator
+        end
+      end
+
+      def resolve_type
+        extension_options[:unresolved_type]&.resolve_type(object, graphql_context)
+      end
+    end
+  end
+end

data/lib/graphql/decorate/type_attributes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module GraphQL
+  module Decorate
+    class TypeAttributes
+      attr_reader :type
+
+      def initialize(type)
+        @type = type
+      end
+
+      def decorator_class
+        get_attribute(:decorator_class)
+      end
+
+      def decorator_evaluator
+        get_attribute(:decorator_evaluator)
+      end
+
+      def decorator_context_evaluator
+        get_attribute(:decorator_context_evaluator)
+      end
+
+      def unresolved_type
+        unresolved_type? ? type : nil
+      end
+
+      def unresolved_type?
+        type.respond_to?(:resolve_type)
+      end
+
+      def resolved_type?
+        !unresolved_type?
+      end
+
+      def connection?
+        resolved_type? && type.respond_to?(:node_type)
+      end
+
+      private
+
+      def get_attribute(name)
+        if connection?
+          type.node_type.respond_to?(name) && type.node_type.public_send(name)
+        elsif resolved_type?
+          type.respond_to?(name) && type.public_send(name)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/decorate/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Decorate
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: graphql-decorate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Brook
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- bbrook@truecar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-decorate.gemspec
+- lib/graphql/decorate.rb
+- lib/graphql/decorate/configuration.rb
+- lib/graphql/decorate/field_extension.rb
+- lib/graphql/decorate/field_integration.rb
+- lib/graphql/decorate/object_integration.rb
+- lib/graphql/decorate/resolution.rb
+- lib/graphql/decorate/type_attributes.rb
+- lib/graphql/decorate/version.rb
+homepage: https://git.corp.tc/bbrook/graphql-decorate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.11
+signing_key: 
+specification_version: 4
+summary: A decorator integration for the GraphQL gem
+test_files: []