graphql_query_argument 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bafa6da3f6713eee15690ff2d483e6e5681c1c13781f465cfb67b8edb8b0546
-  data.tar.gz: 395735019ff60d6c11a7c73e63d95219f48152816ff27e2a85d3e9fded700d5f
+  metadata.gz: 30fa1d9843e491992f2505e94eed4496300257303878d00c320ed3d0117d3e96
+  data.tar.gz: bb067d7c66aa00191b04c98724ce640d1d6baff1fe1e7b2861d59d356188dc07
 SHA512:
-  metadata.gz: 6bbacc624e7f88acb5b1eb31e0435310a05c5b78cbe817132ab11def16a68d08c4939bd32b3b1df72143fb44d9a917953480df369358dbb8c0cb715ae9ed056a
-  data.tar.gz: 6602a3415b97045f7b965fa6d815b0bc9495a928226a443ea7e1f42d332e3f49dfb9b01eaa8ac587d8d2ac8705dfad3177115427ce07866f1896468ed84fdaaf
+  metadata.gz: 8896bbc0007c24e03f3c6c0a21858471d8cdabbe48e7a5c818f9ecf27299e07e2dec3b857694b66cb3716266112ee70bada3456b6d036b72a60fec30f7e96b7a
+  data.tar.gz: 6d574c85f1404925c4af46525c0f849990e6b958de6f8773e1509b86d945406430a8c7ff4eb7eb9c6b9e7d9fb8f3c4d8cbe554c704984f46c6ccaf7e7e68f2f3

data/README.md

@@ -0,0 +1,59 @@
+# GraphQL::QueryArgument
+A simple query argument for resolver module
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql_query_argument'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install graphql_query_argument
+```
+## Usage
+```ruby
+require 'graphql/query_argument'
+
+# In your field resolver
+# `Products < Resolvers::Base` & a CategoryQueryInputs & a `CompanyType` GraphQL type:
+#
+module Resolvers
+  class Products < Resolvers::Base
+    include GraphQL::QueryArgument
+
+    type [Types::ProductType], null: false
+
+    query_argument :name, type: [String], required: false do |scope, value|
+      scope.where(name: value)
+    end
+    query_argument :categories, type: Types::CategoryQueryInputs, required: false do |scope, value|
+      scope.joins(:categories).where(categieies: { **value })
+    end
+  end
+end
+```
+```ruby
+# `CompanyType`
+class CompanyType < Types::BaseObject
+  field :products, null: false, resolver: Resolvers::Products
+
+  def products
+    object.products
+  end
+end
+```
+```ruby
+# `CategoryQueryInputs`
+module Types
+  class CategoryQueryInputs < Types::BaseInputObject
+    argument :name, [String], required: false
+  end
+end
+```

data/graphql_query_argument.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'graphql_query_argument'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.summary     = 'Graphql query argument'
   s.description = 'For Graphql custom query argument module'
   s.authors     = ['Shang']

data/lib/graphql/query_argument/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module QueryArgument
+    VERSION = '0.0.1'
+  end
+end

data/lib/graphql/query_argument.rb

@@ -0,0 +1,41 @@
+module GraphQL
+  module QueryArgument
+    def self.included(base)
+      base.extend ClassMethods
+      base.instance_eval do
+        @config = {
+          query_arguments: {}
+        }
+      end
+    end
+
+    def initialize(object:, context:, field:)
+      puts field.name.class
+      @scope = context[:current_object].send(field.name.underscore)
+      @query_arguments = self.class.config[:query_arguments]
+      super object: object, context: context, field: field
+    end
+
+    def resolve(**args)
+      args.inject(@scope) do |scope, (name, value)|
+        return scope unless @query_arguments[name]
+
+        instance_exec scope, value, &@query_arguments[name]
+      end
+    end
+
+    module ClassMethods
+      attr_reader :config
+
+      def inherited(base)
+        base.instance_variable_set '@config', @config
+        super(base)
+      end
+
+      def query_argument(name, options = {}, &block)
+        argument(name, options)
+        config[:query_arguments][name] = block
+      end
+    end
+  end
+end

data/spec/graphql/query_argument_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe GraphQL::QueryArgument do
+  class GraphQLSchema < GraphQL::Schema
+    class QueryType < GraphQL::Schema::Object
+      field :products, resolver: ProductsResolver
+
+      def products
+        [OpenStruct.new(name: 'Product A'),
+         OpenStruct.new(name: 'Product B'),
+         OpenStruct.new(name: 'Product C')]
+      end
+    end
+
+    query(QueryType)
+  end
+
+  context 'query products' do
+    it 'returns specify products' do
+      query_str = <<-GRAPHQL
+      query {
+        products(names: ["Product B", "Product C"]) {
+          name
+        }
+      }
+      GRAPHQL
+      result = GraphQLSchema.execute(query_str)
+      expect(result['data']['products']).to eq([
+        { 'name' => 'Product B' }, { 'name' => 'Product C'}
+      ])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'graphql'
+require 'graphql/query_argument'
+require 'support/graphql_schema'
+
+class String
+  def underscore
+    word = self.dup
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/spec/support/graphql_schema.rb

@@ -0,0 +1,21 @@
+require 'graphql'
+require 'graphql/query_argument'
+
+class ProductType < GraphQL::Schema::Object
+  field :id, ID
+  field :name, String
+
+  def name
+    object.name
+  end
+end
+
+class ProductsResolver < GraphQL::Schema::Resolver
+  include GraphQL::QueryArgument
+
+  type [ProductType], null: true
+
+  query_argument :names, type: [String], required: false do |scope, value|
+    scope.select { |product| value.include?(product.name) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql_query_argument
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shang
@@ -44,9 +44,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - graphql_query_argument.gemspec
-- lib/graphql/resolvers/query_argument.rb
-- lib/graphql/resolvers/query_argument/version.rb
+- lib/graphql/query_argument.rb
+- lib/graphql/query_argument/version.rb
+- spec/graphql/query_argument_spec.rb
+- spec/spec_helper.rb
+- spec/support/graphql_schema.rb
 homepage: https://github.com/shangweilin7/graphql_query_argument
 licenses:
 - MIT

data/lib/graphql/resolvers/query_argument/version.rb

@@ -1,7 +0,0 @@
-module GraphQL
-  module Resolvers
-    module QueryArgument
-      VERSION = '0.0.1'
-    end
-  end
-end

data/lib/graphql/resolvers/query_argument.rb

@@ -1,42 +0,0 @@
-module Graphql
-  module Resolvers
-    module QueryArgument
-      def self.included(base)
-        base.extend ClassMethods
-        base.instance_eval do
-          @config = {
-            query_arguments: {}
-          }
-        end
-      end
-
-      def initialize(object:, context:, field:)
-        @scope = context[:current_object].send(field.name.underscore)
-        @query_arguments = self.class.config[:query_arguments]
-        super object: object, context: context, field: field
-      end
-
-      def resolve(**args)
-        args.inject(@scope) do |scope, (name, value)|
-          return scope unless @query_arguments[name]
-
-          instance_exec scope, value, &@query_arguments[name]
-        end
-      end
-
-      module ClassMethods
-        attr_reader :config
-
-        def inherited(base)
-          base.instance_variable_set '@config', @config
-          super(base)
-        end
-
-        def query_argument(name, options = {}, &block)
-          argument(name, options)
-          config[:query_arguments][name] = block
-        end
-      end
-    end
-  end
-end