Initial version 0.1.0

fuelen · fuelen · commit cdf22d9742eb · 2017-12-20T21:59:23.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
diff --git a/CODE_OF_CONDUCT.md b/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 ifuelen@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/
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'rouge' # highlight graphql queries in logs
+gemspec
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JetRuby Agency
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,58 @@
+# GraphQL::RailsLogger
+
+## About
+This gem allows you to inspect graphql queries in a more readable format.
+
+This...
+
+![screenshot_before](misc/screenshot_before.png)
+
+becomes this ...
+
+![screenshot_after](misc/screenshot_after.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-rails_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+By default this gem formats params only for `GraphqlController#execute`.
+
+If you want to change this behaviour, add `config/initializes/graphql_logger.rb` file and set proper controller and actions like this:
+```ruby
+  Rails.application.config.graphql_logger = {
+    'QueriesController' => %w(create)
+  }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jetruby/graphql-rails_logger. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GraphQL::RailsLogger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jetruby/graphql-rails_logger/blob/master/CODE_OF_CONDUCT.md).
+
+## About JetRuby
+
+GraphQL::RailsLogger is maintained and founded by JetRuby Agency.
+
+We love open source software!
+See [our projects][portfolio] or
+[contact us][contact] to design, develop, and grow your product.
+
+[portfolio]: http://jetruby.com/portfolio/
+[contact]: http://jetruby.com/#contactUs
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec
diff --git a/bin/console b/bin/console
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphql/rails_logger'
+
+# 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__)
diff --git a/bin/setup b/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
diff --git a/graphql-rails_logger.gemspec b/graphql-rails_logger.gemspec
@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/rails_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-rails_logger'
+  spec.version       = GraphQL::RailsLogger::VERSION
+  spec.authors       = ['JetRuby']
+  spec.email         = ['engineering@jetruby.com']
+
+  spec.summary       = 'Pretty logger for Rails + GraphQL applications.'
+  spec.description   = 'Display GraphQL queries in a more readable format.'
+  spec.homepage      = 'https://github.com/jetruby/graphql-rails_logger'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rouge', '~> 3.0'
+  spec.add_dependency 'rails', '~> 5.0' # 5 because not tested with 4
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end
diff --git a/lib/graphql/rails_logger.rb b/lib/graphql/rails_logger.rb
@@ -0,0 +1,3 @@
+require 'graphql/rails_logger/version'
+require 'graphql/rails_logger/subscriber'
+require 'graphql/rails_logger/railtie'
diff --git a/lib/graphql/rails_logger/railtie.rb b/lib/graphql/rails_logger/railtie.rb
@@ -0,0 +1,17 @@
+require 'graphql/rails_logger/subscriber'
+
+module GraphQL
+  module RailsLogger
+    class Railtie < Rails::Railtie
+      # Allowed controllers and actions
+      config.graphql_logger = {
+        'GraphqlController' => %w[execute]
+      }
+
+      initializer 'graphql.unsubscribe_default_logger' do
+        ActiveSupport::Notifications.unsubscribe 'start_processing.action_controller'
+        Subscriber.attach_to :action_controller
+      end
+    end
+  end
+end
diff --git a/lib/graphql/rails_logger/subscriber.rb b/lib/graphql/rails_logger/subscriber.rb
@@ -0,0 +1,34 @@
+require 'action_controller/log_subscriber'
+require 'rouge'
+
+module GraphQL
+  module RailsLogger
+    class Subscriber < ActionController::LogSubscriber
+      def start_processing(event)
+        return unless logger.info?
+
+        payload = event.payload
+        params  = payload[:params].except(*INTERNAL_PARAMS)
+        format  = payload[:format]
+        format  = format.to_s.upcase if format.is_a?(Symbol)
+
+        info "Processing by #{payload[:controller]}##{payload[:action]} as #{format}"
+
+        if Rails.application.config.graphql_logger.fetch(payload[:controller], []).include?(payload[:action])
+          formatter = Rouge::Formatters::Terminal256.new
+          query_lexer = Rouge::Lexers::GraphQL.new
+          variables_lexer = Rouge::Lexers::Ruby.new
+
+          (params['_json'] || [params.slice('query', 'variables')]).each do |data|
+            query = data['query'].lines.map { |line| "  #{line}" }.join.chomp # add indentation
+            variables = PP.pp(data['variables'] || {}, '')
+            info "  Variables: #{formatter.format(variables_lexer.lex(variables))}"
+            info formatter.format(query_lexer.lex(query))
+          end
+        else
+          info "  Parameters: #{params.inspect}" unless params.empty?
+        end
+      end
+    end
+  end
+end
diff --git a/lib/graphql/rails_logger/version.rb b/lib/graphql/rails_logger/version.rb
@@ -0,0 +1,5 @@
+module GraphQL
+  module RailsLogger
+    VERSION = '0.1.0'.freeze
+  end
+end
diff --git a/misc/screenshot_after.png b/misc/screenshot_after.png
diff --git a/misc/screenshot_before.png b/misc/screenshot_before.png

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+require 'bundler/gem_tasks'`
	`2`	`+task default: :spec`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+require 'graphql/rails_logger/version'`
	`2`	`+require 'graphql/rails_logger/subscriber'`
	`3`	`+require 'graphql/rails_logger/railtie'`