shared-arguments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e10f487e896de7b6f8be61bb2a9674a2523cc04
+  data.tar.gz: 5c4bd2a1e0609f9022bc01764994ef74bf2e60f2
+SHA512:
+  metadata.gz: 747e521e6ec520dddebcfc3204308170d57f04e1dccce43c4568f546e3bac131f68b3aba4cb34a0a92f905a2489be37e9e70e5d43bca39f76243ba7a8b2bbacd
+  data.tar.gz: 4fedee8bddcdf9b1b9f3c9e1435d61342b32b81e629c85631fcd7965a9a6cffe9dc387794a15becdcd80184823a291cbbc4cdca09208f35dbb091dfa8c332b3c

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+before_install:
+  - gem update --system
+  - gem --version
+rspec:
+  - bundle exec rspec

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 robert.pawlas@daftcode.pl. 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,11 @@
+source 'https://rubygems.org'
+ruby '~> 2.4'
+
+gemspec
+
+gem 'graphql'
+
+group :test do
+  gem 'rspec'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    shared-arguments (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    graphql (1.6.4)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  graphql
+  rake
+  rspec
+  shared-arguments!
+
+RUBY VERSION
+   ruby 2.4.1p111
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Robert
+
+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,106 @@
+# shared-arguments
+
+[![Build Status](https://travis-ci.org/hedselu/shared-arguments.svg?branch=master)](https://travis-ci.org/hedselu/shared-arguments)
+
+Ruby gem for GraphQL arguments sharing within fields
+
+**Sponsored by**
+<br>
+<br>
+<a href="https:///www.indoorway.com/" target="_blank" rel="noopener noreferrer">
+  <img src="images/indoorway_logo.png" height="58" width="170" alt="Sponsored by Indoorway" style="max-width:100%;">
+</a>
+
+## Contents
+<!-- Table of contents generated generated by http://tableofcontent.eu -->
+- [Description](#description)
+- [Installation](#installation)
+- [Setup](#setup)
+- [Sample use case](#sample-use-case)
+
+## Description
+
+Sometimes you want to use the same arguments for multiple fields in custom object type.
+To avoid repeating those declarations and DRY-up your schema, I introduce you shared_arguments field.
+
+This gem is mostly usable when you have:
+ - many fields with few repeating arguments
+ - few fields with many repeating arguments
+ - many fields with many repeating arguments
+
+## Installation
+
+`gem install shared-arguments`
+
+## Setup
+
+Include SharedArguments in your schema
+
+```ruby
+#graphql/your_schema.rb
+
+YourSchema = GraphQL::Schema.define do
+  use GraphQL::SharedArguments.new
+end
+```
+
+## Sample use case
+
+```ruby
+#graphql/types/analytics_type.rb
+
+Types::AnalyticsType = GraphQL::ObjectType.define do
+    name 'Analytics'
+    
+    field :invoices, types.[Types::Invoice] do
+       argument :from, !Types::DateType
+       argument :to, !Types::DateType
+       argument :companyID, types.ID
+    end
+    
+    field :registeredUsers, types.[Types::User] do
+       argument :from, !Types::DateType
+       argument :to, !Types::DateType
+       argument :companyID, types.ID
+    end
+    
+    field :downloadsAmount, types.Int do
+       argument :from, !Types::DateType
+       argument :to, !Types::DateType
+       argument :userAmount, types.ID
+    end
+end
+```
+
+This can be shortened like in below example
+
+```ruby
+#graphql/types/analytics_type.rb
+
+Types::AnalyticsType = GraphQL::ObjectType.define do
+    name 'Analytics'
+    
+    field :invoices, types.[Types::Invoice]
+    
+    field :registeredUsers, types.[Types::User]
+    
+    field :downloadsAmount, types.Int do
+       argument :userAmount, types.ID
+    end
+    
+    shared_arguments do
+       argument :from, !Types::DateType
+       argument :to, !Types::DateType
+    end
+    
+    shared_arguments except: %i(downloadsAmount) do
+       argument :companyID, types.ID
+    end
+end
+```
+
+`shared_arguments` field takes both `except` and `only` keyword with array of symbols so you can omit or select specified fields.
+
+Any contributions/suggestions/opened issues are welcomed.
+
+License: MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/graphql/shared_arguments.rb

@@ -0,0 +1,26 @@
+require 'graphql'
+require 'graphql/shared_arguments/version'
+require 'graphql/shared_arguments/injector'
+require 'graphql/shared_arguments/define/assign_shared_arguments'
+
+GraphQL::ObjectType.accepts_definitions(shared_arguments: GraphQL::SharedArguments::Define::AssignSharedArguments)
+
+module GraphQL
+  class SharedArguments
+    include ::GraphQL::Define::InstanceDefinable
+
+    accepts_definitions :arguments,
+                        :filter,
+                        argument: ::GraphQL::Define::AssignArgument
+
+    ensure_defined :arguments, :filter
+    attr_accessor :arguments, :filter
+
+    def use(_schema_definition); end
+
+    def initialize
+      @filter = nil
+      @arguments = {}
+    end
+  end
+end

data/lib/graphql/shared_arguments/define/assign_shared_arguments.rb

@@ -0,0 +1,13 @@
+module GraphQL
+  class SharedArguments
+    module Define
+      module AssignSharedArguments
+        def self.call(target, filter = {}, &block)
+          shared = GraphQL::SharedArguments.define(filter: filter, &block)
+          shared.define
+          GraphQL::SharedArguments::Injector.new(target, filter, shared.arguments).inject
+        end
+      end
+    end
+  end
+end

data/lib/graphql/shared_arguments/injector.rb

@@ -0,0 +1,36 @@
+module GraphQL
+  class SharedArguments
+    class Injector
+      def initialize(object_definition, filter, new_arguments)
+        @object_fields = object_definition.fields
+        @filter_type = filter.keys.first
+        @filter_fields = filter.values.first
+        @new_arguments = new_arguments
+      end
+
+      def only
+        object_fields.select { |k, _v| filter_fields.include?(k.to_sym) }
+      end
+
+      def except
+        object_fields.reject { |k, _v| filter_fields.include?(k.to_sym) }
+      end
+
+      def inject
+        @selected_fields = object_fields if filter_fields.nil? && filter_type.nil?
+        @selected_fields ||= send(filter_type)
+
+        selected_fields.transform_values do |field|
+          field.arguments.merge!(new_arguments)
+        end
+
+        object_fields.merge!(selected_fields)
+      end
+
+      private
+
+      attr_reader :object_fields, :selected_fields,
+                  :filter_type, :filter_fields, :new_arguments
+    end
+  end
+end

data/lib/graphql/shared_arguments/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  class SharedArguments
+    VERSION = '0.1.0'.freeze
+  end
+end

data/shared-arguments.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/shared_arguments/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shared-arguments'
+  spec.version       = GraphQL::SharedArguments::VERSION
+  spec.authors       = ['Robert Pawlas']
+  spec.email         = ['robert.pawlas@indoorway.com']
+
+  spec.summary       = 'This gem allows you to share arguments between multiple fields while using graphql.'
+  spec.homepage      = 'http://indoorway.com'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: shared-arguments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Pawlas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- robert.pawlas@indoorway.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- images/indoorway_logo.png
+- lib/graphql/shared_arguments.rb
+- lib/graphql/shared_arguments/define/assign_shared_arguments.rb
+- lib/graphql/shared_arguments/injector.rb
+- lib/graphql/shared_arguments/version.rb
+- shared-arguments.gemspec
+homepage: http://indoorway.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.12
+signing_key: 
+specification_version: 4
+summary: This gem allows you to share arguments between multiple fields while using
+  graphql.
+test_files: []