graphql-cache 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7dbe70f22e89be24185d79bed0ee9e60c7bad3b5e50ea69be106ab582a3308a
-  data.tar.gz: 52da222074c2f41ea81430b228352abb66c7c7419b102ad62ae7e0b65a7cac2a
+  metadata.gz: d20a6abf5bff1dee85af2a7fe01ca15513e4553f87f255f4c4cea9f1166bfeaa
+  data.tar.gz: 55c93f0e7fcf6f072dbd8728bddffe082fb006863786cba6d1c8cdb47a0abd75
 SHA512:
-  metadata.gz: da22a68c8a8c621dfe65bd9019e22c94fbcd2285794eae28f5ef896663c362630158208f43b81411dac933bae200e8db3fb0a14071b74724d1da3a7678e8354e
-  data.tar.gz: 40199213530274dd3d8860ef317516ba3908a965e700d50e85be8e1364f817b155410ce34c590ece2ee359ad9970d5b02b63c4e594d0fe6d3d6321d8e99ade4c
+  metadata.gz: 8f586d9f2b11cf724fbf4df6f5af9a2b839a4a527029a3c67b4786da7fe30acc45d0f0889657e4df7b38e5c21b792459c56a82fcf09dc6e2d39972ea1a117a65
+  data.tar.gz: '0669f17df94d9ecef5d14db5821c927f4747c826e87b737730e83653b2925df2834a3075d7cc635420179fe2daa493af38772744c05bbb06b7ac206132f58788'

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-cache (0.1.3)
+    graphql-cache (0.2.0)
       graphql (~> 1.8.0.pre10)
 
 GEM

data/README.md

@@ -1,50 +1,80 @@
-# 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
+  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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+  Add this line to your application's Gemfile:
 
-```ruby
-gem 'graphql-cache'
-```
+  ```ruby
+  gem 'graphql-cache'
+  ```
 
-And then execute:
+  And then execute:
 
-    $ bundle
+      $ bundle
 
-Or install it yourself as:
+  Or install it yourself as:
 
-    $ gem install graphql-cache
+      $ gem install graphql-cache
 
 ## Setup
 
   1. Add `middleware GraphQL::Cache::Middleware` to your schema
   2. Add `field_class GraphQL::Cache::Field` to your base object type
 
+## Configuration
+
+  GraphQL Cache can be configured in an initializer:
+
+  ```ruby
+  # config/initializers/graphql_cache.rb
+
+  GraphQL::Cache.configure do |config|
+    config.namespace = 'GraphQL::Cache' # Cache key prefix for keys generated by graphql-cache
+    config.cache     = Rails.cache      # The cache object to use for caching
+    config.logger    = Rails.logger     # Logger to receive cache-related log messages
+    config.expiry    = 5400             # 90 minutes (in seconds)
+    config.force     = false            # Cache override, when true no caching takes place
+  end
+  ```
+
 ## Usage
 
-Any object, list, or connection field can be cached by simply adding `cache: true` to the field definition:
+  Any object, list, or connection field can be cached by simply adding `cache: true` to the field definition:
+
+  ```ruby
+  field :calculated_field, Int, cache: true
+  ```
+
+  By default all keys will have an expiration of `GraphQL::Cache.expiry` which defaults to 90 minutes.  If you want to set a field-specific expiration time pass a hash to the `cache` parameter like this:
+
+  ```ruby
+  field :calculated_field, Int, cache: { expiry: 10800 } # expires key after 180 minutes
+  ```
+
+  When passing a hash in the `cache` parameter the possible options are:
 
-```ruby
-field :calculated_field, Int, cache: true
-```
+  | 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) |
 
 ## 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.
+  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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Leanstack/graphql-cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+  Bug reports and pull requests are welcome on GitHub at https://github.com/Leanstack/graphql-cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Graphql::Cache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Leanstack/graphql-cache/blob/master/CODE_OF_CONDUCT.md).
+  Everyone interacting in the Graphql::Cache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Leanstack/graphql-cache/blob/master/CODE_OF_CONDUCT.md).

data/lib/graphql/cache.rb

@@ -32,7 +32,7 @@ module GraphQL
     end
 
     def self.fetch(key, config: {}, &block)
-      return block.call unless config[:cache]
+      return block.call unless config[:metadata][:cache]
 
       Marshal[key].read(config, &block)
     end

data/lib/graphql/cache/field.rb

@@ -7,20 +7,20 @@ module GraphQL
       def initialize(
         *args,
         cache: false,
-        expiry: nil,
         **kwargs,
         &block
       )
-        @cache_config = {
-          cache: cache,
-          expiry: expiry
-        }
+        @cache_config = if cache.is_a? Hash
+                          cache
+                        else
+                          { cache: cache }
+                        end
         super(*args, **kwargs, &block)
       end
 
       def to_graphql
         field_defn = super # Returns a GraphQL::Field
-        field_defn.metadata[:cache_config] = @cache_config
+        field_defn.metadata[:cache] = @cache_config
         field_defn
       end
     end

data/lib/graphql/cache/marshal.rb

@@ -4,6 +4,7 @@ require 'graphql/cache/builder'
 
 module GraphQL
   module Cache
+    # Used to marshal data to/from cache on cache hits/misses
     class Marshal
       attr_accessor :key
 
@@ -27,9 +28,9 @@ module GraphQL
         end
       end
 
-      def write(config, &block)
-        resolved = block.call
-        expiry = config[:expiry] || GraphQL::Cache.expiry
+      def write(config)
+        resolved = yield
+        expiry = config[:metadata][:expiry] || GraphQL::Cache.expiry
 
         document = Builder[resolved].deconstruct
 
@@ -37,7 +38,6 @@ module GraphQL
         resolved
       end
 
-
       def build(cached, config)
         Builder[cached].build(config)
       end

data/lib/graphql/cache/middleware.rb

@@ -2,21 +2,26 @@
 
 module GraphQL
   module Cache
+    # graphql-ruby middleware to wrap resolvers for caching
     class Middleware
       attr_accessor :parent_type, :parent_object, :object, :cache,
-        :field_definition, :field_args, :query_context,
+                    :field_definition, :field_args, :query_context
 
-        def self.call(*args, &block)
-          new(*args).call(&block)
+      def self.call(*args, &block)
+        new(*args).call(&block)
       end
 
-      def initialize(parent_type, parent_object, field_definition, field_args, query_context)
+      def initialize(parent_type,
+                     parent_object,
+                     field_definition,
+                     field_args,
+                     query_context)
         self.parent_type      = parent_type
         self.parent_object    = parent_object
         self.field_definition = field_definition
         self.field_args       = field_args
         self.query_context    = query_context
-        self.object           = parent_object.try(:object)
+        self.object           = parent_object.object if parent_object
         self.cache            = ::GraphQL::Cache.cache
       end
 
@@ -28,7 +33,15 @@ module GraphQL
           field_args:       field_args,
           query_context:    query_context,
           object:           object
-        }.merge(field_definition.metadata[:cache_config] || {})
+        }.merge metadata_hash
+      end
+
+      def metadata_hash
+        {
+          metadata: {
+            cache: field_definition.metadata[:cache] || {}
+          }
+        }
       end
 
       def call(&block)
@@ -51,10 +64,14 @@ module GraphQL
       def object_key
         return nil unless object
 
-        id_from_object = object.try(:id) || object.try(:fetch, :id, nil) || object.try(:fetch, 'id', nil)
-
         "#{object.class.name}:#{id_from_object}"
       end
+
+      def id_from_object
+        return object.id if object.respond_to? :id
+        return object.fetch(:id, nil) if object.respond_to? :fetch
+        return object.fetch('id', nil) if object.respond_to? :fetch
+      end
     end
   end
 end

data/lib/graphql/cache/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Cache
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md