graphql-cache 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866eda70401ee7db7847f5b87cf8d0e2a9f26e5d21428c4338ee40ea143e8339
-  data.tar.gz: ebf01aa744da393e9beb14c0dd6f9da20d34752c515b72b2aba08ae295390a4f
+  metadata.gz: 1a17d14d49e48de32188c39c81ce2016de951ea7ba2658dffef14a002b28451c
+  data.tar.gz: 4a5919a8c028d47fdd67220079f9cede029762f2907b998c544ab7769513c79d
 SHA512:
-  metadata.gz: 02a82cb8c0544cfe51fa6fc6e397b402008b851fa3ef31ab28bdfd7effec996ce350052ceb4dcf1e46f25dbba97988e1e39c3f9327788b7514cdf19dadc88a5a
-  data.tar.gz: a7dfbad849adb64e6c401634d32902ec3c78443032737c31961fa97508fc285753e264d0a1c4b856dea53c7d8d6cd32f56e8e70cc62be1a81d9e3dc13e490109
+  metadata.gz: 3ab0efc3d2420acff9f33a06112ff0d46ce77fd9c1336ebe8ce93ba6419f5b8abece70e94440941347ea8fa5ff370b56f6387426930dc1adde8cb030480e963b
+  data.tar.gz: 5ccb7a3be368f870f4773bb28280c32cfb1b308352d58bb4e29efca1c18f9ee35515bb7a10e1e5190f11132b3b989aa282f5e94a6c4a5fa421950a60830da745

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 *.gem
+
+gemfiles/*.gemfile.lock

data/.rubocop.yml

@@ -1,3 +1,4 @@
 AllCops:
+  TargetRubyVersion: '2.2.0'
   Exclude:
     - 'spec/**/*'

data/.travis.yml

@@ -1,12 +1,17 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.5.0
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.10
+gemfile:
+  - gemfiles/graphql_1.8.gemfile
 before_script:
   - gem install bundler
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
   - ./cc-test-reporter before-build
-script: bundle exec rspec
+script: "bundle exec rake"
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--markup=markdown
+--readme=README.md
+--title='GraphQL Cache API documentation'
+'lib/**/*.rb' - '*.md'
+

data/Appraisals

@@ -0,0 +1,3 @@
+appraise "graphql-1.8" do
+  gem 'graphql', '~> 1.8'
+end

data/Gemfile.lock

@@ -2,18 +2,20 @@ PATH
   remote: .
   specs:
     graphql-cache (0.2.2)
-      gemer (~> 0.1)
       graphql (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.0)
-    gemer (0.1.2)
     graphql (1.8.0)
     json (2.1.0)
     method_source (0.9.0)
@@ -39,11 +41,13 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thor (0.20.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
   bundler (~> 1.16)
   codeclimate-test-reporter
   graphql-cache!

data/README.md

@@ -1,4 +1,5 @@
-# GraphQL Cache [![Build Status](https://travis-ci.org/Leanstack/graphql-cache.svg?branch=master)](https://travis-ci.org/Leanstack/graphql-cache) [![Test Coverage](https://api.codeclimate.com/v1/badges/c8560834b10db0618175/test_coverage)](https://codeclimate.com/github/Leanstack/graphql-cache/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/c8560834b10db0618175/maintainability)](https://codeclimate.com/github/Leanstack/graphql-cache/maintainability)
+# GraphQL Cache
+  [![Build Status](https://travis-ci.org/Leanstack/graphql-cache.svg?branch=master)](https://travis-ci.org/Leanstack/graphql-cache) [![Test Coverage](https://api.codeclimate.com/v1/badges/c8560834b10db0618175/test_coverage)](https://codeclimate.com/github/Leanstack/graphql-cache/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/c8560834b10db0618175/maintainability)](https://codeclimate.com/github/Leanstack/graphql-cache/maintainability)
 
   GraphQL Cache is a custom middleware for graphql-ruby providing field-level caching.  It is currently a work in progress and the API is subject to change prior to the release v1.0.0.
 
@@ -55,11 +56,9 @@
 
   When passing a hash in the `cache` parameter the possible options are:
 
-  | Key      | Default | Description                                                |
-  |----------|---------|------------------------------------------------------------|
-  | `expiry` | 5400    | expiration time for this field's key in seconds            |
-  | `force`  | false   | force cache misses on this field                           |
-  | `prefix` |         | cache key prefix (appended after GraphQL::Cache.namespace) |
+  - `expiry`: expiration time for this field's key in seconds (default: 5400)
+  - `force`: for cache misses on this field (default: false)
+  - `prefix`: cache key prefix (appended after GraphQL::Cache.namespace)
 
 ## Development
 

data/gemfiles/graphql_1.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.8"
+
+gemspec path: "../"

data/graphql-cache.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.required_ruby_version = '>= 2.2.0' # bc graphql-ruby requires >= 2.2.0
 
+  s.add_development_dependency 'appraisal'
   s.add_development_dependency 'bundler', '~> 1.16'
   s.add_development_dependency 'codeclimate-test-reporter'
   s.add_development_dependency 'pry'
@@ -28,6 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec',   '~> 3.0'
   s.add_development_dependency 'simplecov'
 
-  s.add_dependency 'gemer', '~> 0.1'
   s.add_dependency 'graphql', '~> 1.8.0'
 end

data/lib/graphql/cache.rb

@@ -1,4 +1,4 @@
-require 'gemer'
+# frozen_string_literal: true
 
 require 'graphql/cache/version'
 require 'graphql/cache/middleware'
@@ -7,16 +7,52 @@ require 'graphql/cache/marshal'
 
 module GraphQL
   module Cache
-    include Gemer::Configurable
-
-    setup_config do |c|
-      c.attr :cache
-      c.attr :expiry, 5400
-      c.attr :force, false, in: [true, false]
-      c.attr :logger
-      c.attr :namespace, 'GraphQL::Cache'
+    class << self
+      # An object that must conform to the same API as ActiveSupport::Cache::Store
+      # @return [Object] Defaults to `Rails.cache` in a Rails environment
+      attr_accessor :cache
+
+      # Global default cache key expiration time in seconds.
+      # @return [Integer] Default: 5400 (90 minutes)
+      attr_accessor :expiry
+
+      # When truthy, override all caching (force evalutaion of resolvers)
+      # @return [Boolean] Default: false
+      attr_accessor :force
+
+      # Logger instance to use when logging cache hits/misses.
+      # @return [Logger]
+      attr_accessor :logger
+
+      # Global namespace for keys
+      # @return [String] Default: "GraphQL::Cache"
+      attr_accessor :namespace
+
+      # Provides for initializer syntax
+      #
+      # ```
+      # GraphQL::Cache.configure do |c|
+      #   c.namespace = 'MyNamespace'
+      # end
+      # ```
+      def configure
+        yield self
+      end
     end
 
+    # Default configuration
+    @expiry    = 5400
+    @force     = false
+    @namespace = 'GraphQL::Cache'
+
+    # Fetches/writes a value for `key` from the cache
+    #
+    # Always evaluates the block unless config[:metadata][:cache] is truthy
+    #
+    # @param key [String] the cache key to attempt to fetch
+    # @param config [Hash] a hash of middleware config values used to marshal cache data
+    # @option config [Hash] :metadata The metadata collected from the field definition
+    # @return [Object]
     def self.fetch(key, config: {}, &block)
       return block.call unless config[:metadata][:cache]
 

data/lib/graphql/cache/builder.rb

@@ -1,13 +1,43 @@
 module GraphQL
   module Cache
+    # GraphQL objects can't be serialized to cache so we have
+    # to maintain an abstraction between the raw cache value
+    # and the GraphQL expected object. This class exposes methods
+    # for both deconstructing an object to be stored in cache
+    # and re-hydrating a GraphQL object from raw cache values
+    #
     class Builder
-      attr_accessor :raw, :method, :config
+      # The raw value to perform actions on. Could be a raw cached value, or
+      # a raw GraphQL Field.
+      #
+      # @return [Object]
+      attr_accessor :raw
 
+      # A flag indicating the type of object construction to
+      # use when building a new GraphQL object. Can be one of
+      # 'array', 'collectionproxy', 'relation'. These values
+      # have been chosen because it is easy to use the class
+      # names of the possible object types for this purpose.
+      #
+      # @return [String] 'array' or 'collectionproxy' or 'relation'
+      attr_accessor :method
+
+      # The middleware config hash describing a field's resolution
+      #
+      # @see GraphQL::Cache::Middleware#initialize
+      # @return [Hash]
+      attr_accessor :config
+
+      # Initializer helper that generates a valid `method` string based
+      # on `raw.class.name`.
+      #
+      # @return [Object] A newly initialized GraphQL::Cache::Builder instance
       def self.[](raw)
         build_method = namify(raw.class.name)
         new(raw, build_method)
       end
 
+      # Ruby-only means of "demodularizing" a string
       def self.namify(str)
         str.split('::').last.downcase
       end
@@ -17,6 +47,9 @@ module GraphQL
         self.method = method
       end
 
+      # Builds a compitable GraphQL object based on the resolution config
+      #
+      # @return [Object] An object suitable for returning from a GraphQL middlware call
       def build(config)
         self.config = config
 
@@ -25,17 +58,17 @@ module GraphQL
         build_object
       end
 
+      # Deconstructs a GraphQL field into a cachable value
+      #
+      # @return [Object] A value suitable for writing to cache
       def deconstruct
-        case self.class.namify(raw.class.name)
-        when 'array'
-          deconstruct_array(raw)
-        when 'relationconnection'
-          raw.nodes
-        else
-          deconstruct_object(raw)
-        end
+        return deconstruct_arra(raw) if raw.class == Array
+        return raw.nodes if raw.class.ancestors.include? GraphQL::Relay::BaseConnection
+
+        deconstruct_object(raw)
       end
 
+      # @private
       def deconstruct_object(raw)
         if raw.respond_to?(:object)
           raw.object
@@ -44,6 +77,7 @@ module GraphQL
         end
       end
 
+      # @private
       def deconstruct_array(raw)
         return [] if raw.empty?
 
@@ -54,8 +88,9 @@ module GraphQL
         end
       end
 
+      # @private
       def build_relation
-        GraphQL::Relay::RelationConnection.new(
+        GraphQL::Relay::BaseConnection.connection_for_nodes(raw).new(
           raw,
           config[:field_args],
           field:   config[:query_context].field,
@@ -64,6 +99,7 @@ module GraphQL
         )
       end
 
+      # @private
       def build_array
         gql_def = config[:field_definition].type.unwrap.graphql_definition
 
@@ -79,6 +115,7 @@ module GraphQL
         end
       end
 
+      # @private
       def build_object
         klass = config[:field_definition].type.unwrap.graphql_definition.metadata[:type_class]
         if klass

data/lib/graphql/cache/marshal.rb

@@ -4,18 +4,31 @@ require 'graphql/cache/builder'
 
 module GraphQL
   module Cache
-    # Used to marshal data to/from cache on cache hits/misses
+    # Used to marshal cache fetches into either writes or reads
     class Marshal
+      # The cache key to marshal around
+      #
+      # @return [String] The cache key
       attr_accessor :key
 
+      # Initializer helper to allow syntax like
+      # `Marshal[key].read(config, &block)`
+      #
+      # @return [GraphQL::Cache::Marshal]
       def self.[](key)
         new(key)
       end
 
+      # Initialize a new instance of {GraphQL::Cache::Marshal}
       def initialize(key)
         self.key = key.to_s
       end
 
+      # Read a value from cache if it exists and re-hydrate it or
+      # execute the block and write it's result to cache
+      #
+      # @param config [Hash] The middleware resolution config
+      # @return [Object]
       def read(config, &block)
         cached = cache.read(key)
 
@@ -28,6 +41,10 @@ module GraphQL
         end
       end
 
+      # Executes the resolution block and writes the result to cache
+      #
+      # @see GraphQL::Cache::Builder#deconstruct
+      # @param config [Hash] The middleware resolution config hash
       def write(config)
         resolved = yield
         document = Builder[resolved].deconstruct
@@ -36,6 +53,7 @@ module GraphQL
         resolved
       end
 
+      # @private
       def expiry(config)
         cache_config = config[:metadata][:cache]
 
@@ -46,14 +64,20 @@ module GraphQL
         end
       end
 
+      # Uses {GraphQL::Cache::Builder} to build a valid GraphQL object
+      # from a cached value
+      #
+      # @return [Object] An object suitable to return from a GraphQL middleware
       def build(cached, config)
         Builder[cached].build(config)
       end
 
+      # @private
       def cache
         GraphQL::Cache.cache
       end
 
+      # @private
       def logger
         GraphQL::Cache.logger
       end

data/lib/graphql/cache/middleware.rb

@@ -7,6 +7,7 @@ module GraphQL
       attr_accessor :parent_type, :parent_object, :object, :cache,
                     :field_definition, :field_args, :query_context
 
+      # Called by graphql-ruby during middleware processing
       def self.call(*args, &block)
         new(*args).call(&block)
       end
@@ -29,6 +30,7 @@ module GraphQL
         self.object = parent_object.object if parent_object.respond_to? :object
       end
 
+      # @private
       def cache_config
         {
           parent_type:      parent_type,
@@ -40,6 +42,7 @@ module GraphQL
         }.merge metadata_hash
       end
 
+      # @private
       def metadata_hash
         {
           metadata: {
@@ -48,6 +51,9 @@ module GraphQL
         }
       end
 
+      # The primary caching entry point
+      #
+      # @return [Object]
       def call(&block)
         GraphQL::Cache.fetch(
           cache_key,
@@ -56,6 +62,7 @@ module GraphQL
         )
       end
 
+      # @private
       def cache_key
         @cache_key ||= [
           GraphQL::Cache.namespace,
@@ -65,12 +72,14 @@ module GraphQL
         ].flatten
       end
 
+      # @private
       def object_key
         return nil unless object
 
         "#{object.class.name}:#{id_from_object}"
       end
 
+      # @private
       def id_from_object
         return object.id if object.respond_to? :id
         return object.fetch(:id, nil) if object.respond_to? :fetch

data/lib/graphql/cache/rails.rb

@@ -2,12 +2,16 @@
 
 module GraphQL
   module Cache
-    class Rails < ::Rails::Engine
-      config.after_initialize do
-        # default values for cache and logger in Rails if not set in initializer
-        GraphQL::Cache.cache  = ::Rails.cache unless GraphQL::Cache.cache
-        GraphQL::Cache.logger = ::Rails.logger unless GraphQL::Cache.logger
+    if defined?(::Rails)
+      # Railtie integration used to default {GraphQL::Cache.cache}
+      # and {GraphQL::Cache.logger} when in a Rails environment.
+      class Rails < ::Rails::Engine
+        config.after_initialize do
+          # default values for cache and logger in Rails if not set already
+          GraphQL::Cache.cache  = ::Rails.cache unless GraphQL::Cache.cache
+          GraphQL::Cache.logger = ::Rails.logger unless GraphQL::Cache.logger
+        end
       end
-    end if defined?(::Rails)
+    end
   end
 end

data/lib/graphql/cache/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module GraphQL
   module Cache
-    VERSION = '0.2.2'.freeze
+    VERSION = '0.2.3'
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: graphql-cache
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: gemer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +134,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
+- Appraisals
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -143,6 +145,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/graphql_1.8.gemfile
 - graphql-cache.gemspec
 - lib/graphql/cache.rb
 - lib/graphql/cache/builder.rb