graphql-cache 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e370da35845b17ceb823cbecbe884402b22b3c17851526ffe8c5d7a554bba809
-  data.tar.gz: 27ff23e0626a5177b9bfbbb78e120b42a0c8c9918f745b4a2af59eee0e77fd45
+  metadata.gz: d858418f7a97b6b74af740be3e490d56da27e8a0aec2aea48b69b1cf1abc728e
+  data.tar.gz: '0281225dfc87aee0914b580b0fed83c57f3b42838ffe01c19778f91784f2b49d'
 SHA512:
-  metadata.gz: 9312f9098b10047fe1d7678f36d34952c6b65668d3f45e79e2a858fb6855897d3e79927326090856c9020ded4983671c5d853509b47118a8ada13426832e626b
-  data.tar.gz: 16256ba378a5205db079042268caa80871fdcc2539165f75e6f12a8c6de9d2e22bee2c71a100c7e9523b4c956c40c22f6256e2574d754e5c33b2419d975c3a01
+  metadata.gz: '0942c0baac595bdfbb336d253653e4343d7f0c6d14b6ffe87a06e9632d475fa3b67d7e613dafe8aac8ef5e14cb81cf952dccdd322a3383f60eac5ee81a5b39e5'
+  data.tar.gz: 9fc08f962f99cef760c95fd8bb1e8389cc1b20222f4c6a7bf53afddefd455597504fcb839f40b5b282edc5c873b0334af329b44c389c10f122cc1782fa28a98e

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+Problem
+-------
+
+Cause (for defects/bugs)
+------------------------
+
+Solution
+--------
+
+Notes
+-----

data/.travis.yml

@@ -2,4 +2,11 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
-before_install: gem install bundler -v 1.16.1
+before_script:
+  - 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
+  - gem install bundler -v 1.16.1
+script: bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+## How to contribute to GraphQL Cache
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Leanstack/graphql-cache/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Leanstack/graphql-cache/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Open an issue on GitHub and label it "Enhancement" so that the community can comment on the feature
+
+* If you have code, by all means, open a pull request!
+
+Thanks again for contirbuting to GraphQL Cache! :tada:
+
+The StackShare Team

data/Gemfile.lock

@@ -1,14 +1,23 @@
 PATH
   remote: .
   specs:
-    graphql-cache (0.1.0)
-      graphql (= 1.8.0.pre11)
+    graphql-cache (0.1.1)
+      graphql (~> 1.8.0.pre10)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    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)
     graphql (1.8.0.pre11)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -23,15 +32,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  codeclimate-test-reporter
   graphql-cache!
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -1,4 +1,4 @@
-# Graphql Cache
+# 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
 
@@ -39,7 +39,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+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
 
@@ -47,4 +47,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/graphql-cache.gemspec

@@ -3,25 +3,29 @@ 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"]
+Gem::Specification.new do |s|
+  s.name          = "graphql-cache"
+  s.version       = GraphQL::Cache::VERSION
+  s.authors       = ["Michael Kelly"]
+  s.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"
+  s.summary       = %q{Caching middleware for graphql-ruby}
+  s.description   = %q{Provides middleware field-level caching for graphql-ruby}
+  s.homepage      = "https://github.com/Leanstack/graphql-cache"
+  s.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.require_paths = ["lib"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 2.2.0" # bc graphql-ruby requires >= 2.2.0
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "codeclimate-test-reporter"
+  s.add_development_dependency "pry"
 
-  spec.add_dependency 'graphql', '~> 1.8.0.pre10'
+  s.add_dependency 'graphql', '~> 1.8.0.pre10'
 end

data/lib/graphql/cache.rb

@@ -1,6 +1,7 @@
 require 'graphql/cache/version'
 require 'graphql/cache/middleware'
 require 'graphql/cache/field'
+require 'graphql/cache/marshal'
 
 module GraphQL
   module Cache
@@ -26,10 +27,6 @@ module GraphQL
     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
@@ -37,61 +34,7 @@ module GraphQL
     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
-        end
-      end
+      Marshal[key].read(config, &block)
     end
   end
 end

data/lib/graphql/cache/builder.rb

@@ -0,0 +1,95 @@
+module GraphQL
+  module Cache
+    class Builder
+      attr_accessor :raw, :method, :config
+
+      def self.[](raw)
+        build_method = namify(raw.class.name)
+        new(raw, build_method)
+      end
+
+      def self.namify(str)
+        str.split('::').last.downcase
+      end
+
+      def initialize(raw, method)
+        self.raw    = raw
+        self.method = method
+      end
+
+      def build(config)
+        self.config = config
+
+        return build_array    if method == 'array'
+        return build_relation if method == 'collectionproxy' || method == 'relation'
+        build_object
+      end
+
+      def deconstruct
+        case self.class.namify(raw.class.name)
+        when 'array'
+          deconstruct_array(raw)
+        when 'relationconnection'
+          raw.nodes
+        else
+          deconstruct_object(raw)
+        end
+      end
+
+      def deconstruct_object(raw)
+        if raw.respond_to?(:object)
+          raw.object
+        else
+          raw
+        end
+      end
+
+      def deconstruct_array(raw)
+        return [] if raw.empty?
+
+        if raw.first.class.ancestors.include? GraphQL::Schema::Object
+          raw.map(&:object)
+        else
+          raw
+        end
+      end
+
+      def build_relation
+        GraphQL::Relay::RelationConnection.new(
+          raw,
+          config[:field_args],
+          field:   config[:query_context].field,
+          parent:  config[:parent_object].object,
+          context: config[:query_context]
+        )
+      end
+
+      def build_array
+        gql_def = config[:field_definition].type.unwrap.graphql_definition
+
+        raw.map do |item|
+          if gql_def.kind.name == 'OBJECT'
+            config[:field_definition].type.unwrap.graphql_definition.metadata[:type_class].new(
+              item,
+              config[:query_context]
+            )
+          else
+            item
+          end
+        end
+      end
+
+      def build_object
+        klass = config[:field_definition].type.unwrap.graphql_definition.metadata[:type_class]
+        if klass
+          klass.new(
+            raw,
+            config[:query_context]
+          )
+        else
+          raw
+        end
+      end
+    end
+  end
+end

data/lib/graphql/cache/field.rb

@@ -1,6 +1,8 @@
+require 'graphql'
+
 module GraphQL
   module Cache
-    class Field < GraphQL::Schema::Field
+    class Field < ::GraphQL::Schema::Field
       # Override #initialize to take a new argument:
       def initialize(
         *args,

data/lib/graphql/cache/marshal.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'graphql/cache/builder'
+
+module GraphQL
+  module Cache
+    class Marshal
+      attr_accessor :key
+
+      def self.[](key)
+        new(key)
+      end
+
+      def initialize(key)
+        self.key = key.to_s
+      end
+
+      def read(config, &block)
+        cached = cache.read(key)
+
+        if cached.nil?
+          logger.debug "Cache miss: (#{key})"
+          write config, &block
+        else
+          logger.debug "Cache hit: (#{key})"
+          build cached, config
+        end
+      end
+
+      def write(config, &block)
+        resolved = block.call
+        expiry = config[:expiry] || GraphQL::Cache.expiry
+
+        document = Builder[resolved].deconstruct
+
+        cache.write(key, document, expires_in: expiry)
+        resolved
+      end
+
+
+      def build(cached, config)
+        Builder[cached].build(config)
+      end
+
+      def cache
+        GraphQL::Cache.cache
+      end
+
+      def logger
+        GraphQL::Cache.logger
+      end
+    end
+  end
+end

data/lib/graphql/cache/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module Cache
-    VERSION = "0.1.1"
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  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: pry
+  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: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -73,10 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -86,7 +130,9 @@ files:
 - bin/setup
 - graphql-cache.gemspec
 - lib/graphql/cache.rb
+- lib/graphql/cache/builder.rb
 - lib/graphql/cache/field.rb
+- lib/graphql/cache/marshal.rb
 - lib/graphql/cache/middleware.rb
 - lib/graphql/cache/rails.rb
 - lib/graphql/cache/version.rb
@@ -102,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="