graphql-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a6471af94c883d9025dc2e18513cbbef183e0631b5f925e26c0e79a36fc34cf
+  data.tar.gz: 6123889054b69975e2c62a2bd697f371fc933b45fe3e26f1a13474a6eec430c1
+SHA512:
+  metadata.gz: 0c5836a00c4550885deaa4c26c429dd9701aae84695bc8761c85f0fdc9637a0fe8851ada50df115c3d43faf0a5f1542026a8865ec9245468fcfec7e28c6196af
+  data.tar.gz: e6856c09ac0576dc7dc40d1040d915f5857142bd07b5f90a439f40b65750c53b0b3b42850a0c65e149102f1725b3f53edc34f93093d10f5cbd52f23957d0325d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at michaelkelly322@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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-cache.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    graphql-cache (0.1.0)
+      graphql (= 1.8.0.pre11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    graphql (1.8.0.pre11)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  graphql-cache!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Kelly
+
+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,50 @@
+# Graphql Cache
+
+  GraphQL Cache is a custom middleware for graphql-ruby providing field-level caching
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ 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
+
+## Usage
+
+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
+```
+
+## 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.
+
+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/[USERNAME]/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).
+
+## 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/[USERNAME]/graphql-cache/blob/master/CODE_OF_CONDUCT.md).

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/cache"
+
+# 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-cache.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-cache"
+  spec.version       = GraphQL::Cache::VERSION
+  spec.authors       = ["Michael Kelly"]
+  spec.email         = ["michaelkelly322@gmail.com"]
+
+  spec.summary       = %q{Caching middleware for graphql-ruby}
+  spec.description   = %q{Provides middleware field-level caching for graphql-ruby}
+  spec.homepage      = "https://github.com/Leanstack/graphql-cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'graphql', '~> 1.8.0.pre10'
+end

data/lib/graphql/cache.rb

@@ -0,0 +1,101 @@
+require 'graphql/cache/version'
+require 'graphql/cache/middleware'
+require 'graphql/cache/field'
+
+module GraphQL
+  module Cache
+    ConfigurationError = Class.new(StandardError)
+
+    @@expiry = 5400 # 90 minutes
+    def self.expiry; @@expiry; end
+    def self.expiry=(obj); @@expiry=obj; end
+
+    @@force = false
+    def self.force; @@force; end
+    def self.force=(obj); @@force=obj; end
+
+    @@namespace = self.name
+    def self.namespace; @@namespace; end
+    def self.namespace=(obj); @@namespace=obj; end
+
+    @@cache = nil
+    def self.cache; @@cache; end
+    def self.cache=(obj); @@cache=obj; end
+
+    @@logger = nil
+    def self.logger; @@logger; end
+    def self.logger=(obj); @@logger=obj; end
+
+    @@log_level = nil
+    def self.log_level; @@log_level; end
+    def self.log_level=(obj); @@log_level=obj; @@logger.try(:level=, obj); end
+
+    def self.configure
+      yield self
+    end
+
+    def self.fetch(key, config: {}, &block)
+      return block.call unless config[:cache]
+
+      cached = cache.read(key)
+
+      if cached.nil?
+        logger.debug "Cache miss: (#{key})"
+        marshal_to_cache(key, config, &block)
+      else
+        logger.debug "Cache hit: (#{key})"
+        marshal_from_cache(cached, config)
+      end
+    end
+
+    def self.marshal_to_cache(key, config, &block)
+      raw = block.call
+
+      marshaled = case raw.class.name
+                  when 'Array'
+                    raw.map(&:object)
+                  when 'GraphQL::Relay::RelationConnection'
+                    raw.nodes
+                  else
+                    raw.try(:object) || raw
+                  end
+
+      cache.write(key, marshaled, expires_in: config[:expiry] || GraphQL::Cache.expiry)
+      raw
+    end
+
+    def self.marshal_from_cache(cached, config = {})
+      case cached.class.name
+      when 'Array'
+        cached.map do |raw|
+          config[:field_definition].type.unwrap.graphql_definition.metadata[:type_class].new(
+            raw,
+            config[:query_context]
+          )
+        end
+      when 'ActiveRecord::Associations::CollectionProxy'
+        GraphQL::Relay::RelationConnection.new(
+          cached,
+          config[:field_args],
+          field:   config[:query_context].field,
+          parent:  config[:parent_object].object,
+          context: config[:query_context]
+        )
+      else
+        klass = config[:field_definition].type.unwrap.graphql_definition.metadata[:type_class]
+        if klass
+          new(
+            cached,
+            config[:query_context]
+          )
+        else
+          cached.class.new(
+            cached
+          )
+        end
+      end
+    end
+  end
+end
+
+require 'graphql/cache/rails' if defined?(::Rails::Engine)

data/lib/graphql/cache/field.rb

@@ -0,0 +1,26 @@
+module GraphQL
+  module Cache
+    class Field < GraphQL::Schema::Field
+      # Override #initialize to take a new argument:
+      def initialize(
+        *args,
+        cache: false,
+        expiry: nil,
+        **kwargs,
+        &block
+      )
+        @cache_config = {
+          cache: cache,
+          expiry: expiry
+        }
+        super(*args, **kwargs, &block)
+      end
+
+      def to_graphql
+        field_defn = super # Returns a GraphQL::Field
+        field_defn.metadata[:cache_config] = @cache_config
+        field_defn
+      end
+    end
+  end
+end

data/lib/graphql/cache/middleware.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Cache
+    class Middleware
+      attr_accessor :parent_type, :parent_object, :object, :cache,
+        :field_definition, :field_args, :query_context,
+
+        def self.call(*args, &block)
+          new(*args).call(&block)
+      end
+
+      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.cache            = ::GraphQL::Cache.cache
+      end
+
+      def cache_config
+        {
+          parent_type:      parent_type,
+          parent_object:    parent_object,
+          field_definition: field_definition,
+          field_args:       field_args,
+          query_context:    query_context,
+          object:           object
+        }.merge(field_definition.metadata[:cache_config] || {})
+      end
+
+      def call(&block)
+        GraphQL::Cache.fetch(
+          cache_key,
+          config: cache_config,
+          &block
+        )
+      end
+
+      def cache_key
+        @cache_key ||= [
+          GraphQL::Cache.namespace,
+          object_key,
+          field_definition.name,
+          field_args.keys
+        ].flatten
+      end
+
+      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
+    end
+  end
+end

data/lib/graphql/cache/rails.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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
+      end
+    end if defined?(::Rails)
+  end
+end

data/lib/graphql/cache/version.rb

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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: graphql-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0.pre10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0.pre10
+description: Provides middleware field-level caching for graphql-ruby
+email:
+- michaelkelly322@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-cache.gemspec
+- lib/graphql/cache.rb
+- lib/graphql/cache/field.rb
+- lib/graphql/cache/middleware.rb
+- lib/graphql/cache/rails.rb
+- lib/graphql/cache/version.rb
+homepage: https://github.com/Leanstack/graphql-cache
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Caching middleware for graphql-ruby
+test_files: []