graphql-functions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d540a69a12fee13eb1031809c05c9597dbb30dd1
+  data.tar.gz: 2471e588c8fb973ee297ce8edbaa3eb68e559580
+SHA512:
+  metadata.gz: bb57a24ba4df58d1d5ef4f59779222758c77953a6ab78957b7aaf73a52af3862ccfa22c2d63505cb95b6691b9691d16f745d19bbfb5b237f7f92df7874829654
+  data.tar.gz: 812abcd4ad410039265a56ceeab95fc11400d3d180098ec41f3a270bcdb10c5f789d64e132e9053adf7c372ffa9d284122e43e21cdf0ab0c2f81301d628db0e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+.rubocop-https---raw-githubusercontent-com-comparaonline-ruby-lint-master-rubocop-yml

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from:
+    - https://raw.githubusercontent.com/comparaonline/ruby-lint/master/rubocop.yml
+
+AllCops:
+  Exclude:
+    - '**'
+    - 'bin/**/*'
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in graphql-functions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Joaquín Moreira
+
+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,160 @@
+# graphql-functions
+
+Ruby gem made to simplify the standard query creation of the [graphql](http://graphql-ruby.org) gem in your `Active Record` models with predefined **functions**.
+
+Using the provided functions your graphql **types** will gain standard and generic **query arguments** to limit the amount of rows, use an offset, or filter by an specific id among others; supporting queries like the following:
+
+```graphql
+{
+  people(limit: 2) {
+    id,
+    first_name
+  }  
+}
+```
+
+```graphql
+{
+  people(ids: [1, 4, 9]) {
+    id,
+    age
+  }
+}
+```
+
+```graphql
+{
+  person(id: 3) {
+    id,
+    last_name
+  }
+}
+```
+
+The full list of features is shown [here](#features).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-functions'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install graphql-functions
+```
+
+Please note that you should also have installed the base [graphql](http://graphql-ruby.org) gem.
+
+## Usage
+
+First of all you have to honor the following files structure convention:
+
+```
+app\
+--controllers\
+--models\
+----person.rb
+--graphql\
+----types\
+------query_type.rb
+------person_type.rb
+----mutations\
+----functions\
+------person.rb
+------people.rb
+----schema.rb
+```
+
+To help getting started is useful to use the `graphql` [generator](http://graphql-ruby.org/schema/generators#graphqlinstall).
+
+Then you should use one of the two provided functions to the `query type` definition:
+
+```ruby
+# app/graphql/types/query_type.rb
+module Types
+  QueryType = GraphQL::ObjectType.define do
+    name "Query"
+
+    field :person, function: GraphQL::Functions::Element
+    field :people, function: GraphQL::Functions::Array
+  end
+end
+```
+
+If more specific logic is needed you may create a custom class with an inheritance from `GraphQL::Functions::Element` or `GraphQL::Functions::Array` like:
+
+```ruby
+# app/graphql/functions/people.rb
+module Functions
+  class People < GraphQL::Functions::Array
+    model ::Person
+    argument :country_code, types.String
+
+    def call(obj, args, ctx)
+      query = super(obj, args, ctx)
+      query.where(country_code: args[:countryCode]) if args[:countryCode]
+      query
+    end
+  end
+end
+```
+
+```ruby
+# app/graphql/types/query_type.rb
+module Types
+  QueryType = GraphQL::ObjectType.define do
+    name "Query"
+
+    field :person, function: GraphQL::Functions::Element
+    field :people, function: Functions::People
+  end
+end
+```
+
+Above changes will in addition to the base query capabilities from `graphql-functions` allow the query to filter by countryCode like:
+
+```
+{
+  query(countryCode: 'us', limit: 2, offset: 5) {
+    id,
+    first_name,
+    last_name
+  }
+}
+```
+
+## Features
+
+### Element
+Element function is intended to be used with a query with a single field output like `person` in the example: The only available argument is id:
+- `id: Int`. Filter by the specified id.
+
+### Array
+Array function add filters-like arguments to the query:
+- `offset: Int`). Skip the specified argument of records.
+- `limit: Int`). Do not return more rows than the argument.
+- `ìds: [Int]`). Filter by the specified ids.
+
+
+## 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-functions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/functions"
+
+# 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/circle.yml

@@ -0,0 +1,3 @@
+database:
+  override:
+    - echo "Skipping database section."

data/graphql-functions.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/functions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-functions"
+  spec.version       = GraphQL::Functions::VERSION
+  spec.authors       = ["Joaquín Moreira", "Daniel Ortega"]
+  spec.email         = ["jmoreira@comparaonline.com", "dortega@comparaonline.com"]
+
+  spec.summary       = %q{Collection of GraphQL functions to give basic active record like support for graphql queries}
+  spec.description   = %q{GraphQL functions made to simplify the standard query creation of the graphql gem in your Active Record models.
+    Using the provided functions your graphql types will gain standard and generic query arguments to limit the amount of rows, use an offset, or filter by an specific id among others.}
+  spec.homepage      = "https://github.com/comparaonline/graphql-ruby-functions"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.2'
+
+  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.2"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "activerecord", "~> 5.1"
+  spec.add_dependency "graphql", "~> 1.5"
+end

data/lib/graphql/functions.rb

@@ -0,0 +1,8 @@
+require 'graphql/functions/version'
+require 'graphql/functions/element'
+require 'graphql/functions/array'
+
+module GraphQL
+  module Functions
+  end
+end

data/lib/graphql/functions/array.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module GraphQL
+  module Functions
+    class Array < Base
+      argument :ids, types[types.ID]
+      argument :limit, types.Int
+      argument :offset, types.Int
+
+      def call(_, args, _)
+        query = args[:ids] ? @model_class.where(id: args[:ids]) : @model_class.all
+        query = query.offset(args[:offset]) if args[:offset]
+        query = query.limit(args[:limit]) if args[:limit]
+        query
+      end
+
+      def type
+        @type ||= self.class.types[!type_class]
+      end
+
+      def type_class
+        "Types::#{@model_class}Type".constantize
+      end
+    end
+  end
+end

data/lib/graphql/functions/base.rb

@@ -0,0 +1,42 @@
+require 'graphql'
+require 'active_record'
+
+module GraphQL
+  module Functions
+    class Base < ::GraphQL::Function
+      class << self
+        def create
+          fail_on_model_not_set unless @model
+          new(@model)
+        end
+
+        def model(model)
+          fail_on_wrong_class_model unless model < ActiveRecord::Base
+          @model = model
+        end
+
+        private
+
+        def fail_on_model_not_set
+          raise(
+            ArgumentError,
+            "'model' not set. Forgot to add 'model ::ModelClass' ?"
+          )
+        end
+
+        def fail_on_wrong_class_model
+          raise(
+            ArgumentError,
+            "'model' superclass mismatch. It must be 'ActiveRecord::Base'"
+          )
+        end
+      end
+
+      private
+
+      def initialize(model_class)
+        @model_class = model_class
+      end
+    end
+  end
+end

data/lib/graphql/functions/element.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+module GraphQL
+  module Functions
+    class Element < Base
+      argument :id, !types.ID
+
+      def call(_, args, _)
+        @model_class.find(args[:id])
+      end
+
+      def type
+        @type ||= "Types::#{@model_class}Type".constantize
+      end
+    end
+  end
+end

data/lib/graphql/functions/version.rb

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: graphql-functions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joaquín Moreira
+- Daniel Ortega
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: |-
+  GraphQL functions made to simplify the standard query creation of the graphql gem in your Active Record models.
+      Using the provided functions your graphql types will gain standard and generic query arguments to limit the amount of rows, use an offset, or filter by an specific id among others.
+email:
+- jmoreira@comparaonline.com
+- dortega@comparaonline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- graphql-functions.gemspec
+- lib/graphql/functions.rb
+- lib/graphql/functions/array.rb
+- lib/graphql/functions/base.rb
+- lib/graphql/functions/element.rb
+- lib/graphql/functions/version.rb
+homepage: https://github.com/comparaonline/graphql-ruby-functions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: Collection of GraphQL functions to give basic active record like support
+  for graphql queries
+test_files: []