graphql-rails_logger 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5360206a7f3b18baf54a23952d07e4077b6cab50
-  data.tar.gz: 260183fb6d33438017abcbdb1b9acabcfced8948
+  metadata.gz: 718affecc756a81b55c2a9184d6c548d280494d4
+  data.tar.gz: 890ecf5d194cba6d4a032f4bf62838c2d061b9df
 SHA512:
-  metadata.gz: 8518bc3e2ed76277291e6bd18d56585ca75d0319b347017f346a7438d98b1151776b94cf690aab734cb7fc2faad328e2721698318e3cd5ce977867ffa4628e36
-  data.tar.gz: d81606b218890db1dfc985fc396e33a3bddd86f3a97154c1f6a34b072f9bbf6add0a34c030e719cc9a8858c201aff6a9375fb17800f108445353dfc35dcd9e3e
+  metadata.gz: bcc3afed83c469732b55749ff531892aa6d8cca7d311ef67e9a6183a8e480598b98c84b6695865986304cb9b342e0124d22224ca81aefcbcb7170e3935c1253b
+  data.tar.gz: e6b26301123958355ee9a82da0d04a9f30a8697b2693fee5b76ae925cf9a94ce62179b9ec7122274022a2c89422303324503be428ff160d82a3db752418c230d

data/README.md

@@ -23,15 +23,25 @@ And then execute:
 
     $ bundle
 
-## Usage
+## Configuration
 
 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:
+If you want to change this behaviour, add `config/initializers/graphql_rails_logger.rb` file and set proper controller and actions like this:
 ```ruby
-  Rails.application.config.graphql_logger = {
+GraphQL::RailsLogger.configure do |config|
+  config.white_list = {
     'QueriesController' => %w(create)
   }
+end
+```
+
+There is an option to suppress (hide) the GraphQL Introspection Query from the console output. This may be helpful to declutter the console during client testing as these can be rather lengthy.
+
+```ruby
+GraphQL::RailsLogger.configure do |config|
+  config.skip_introspection_query = true
+end
 ```
 
 ## Contributing

data/lib/graphql/rails_logger/configuration.rb

@@ -0,0 +1,16 @@
+module GraphQL
+  module RailsLogger
+    class Configuration
+      attr_accessor :skip_introspection_query, :white_list
+
+      def initialize
+        @skip_introspection_query = nil
+
+        # controller => [actions]
+        @white_list = {
+          'GraphqlController' => %w[execute]
+        }
+      end
+    end
+  end
+end

data/lib/graphql/rails_logger/railtie.rb

@@ -3,11 +3,6 @@ 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

data/lib/graphql/rails_logger/subscriber.rb

@@ -1,8 +1,21 @@
+require 'graphql/rails_logger/configuration'
 require 'action_controller/log_subscriber'
 require 'rouge'
 
 module GraphQL
   module RailsLogger
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
     class Subscriber < ActionController::LogSubscriber
       def start_processing(event)
         return unless logger.info?
@@ -12,14 +25,19 @@ module GraphQL
         format  = payload[:format]
         format  = format.to_s.upcase if format.is_a?(Symbol)
 
+        config = GraphQL::RailsLogger.configuration
+
         info "Processing by #{payload[:controller]}##{payload[:action]} as #{format}"
 
-        if Rails.application.config.graphql_logger.fetch(payload[:controller], []).include?(payload[:action])
+        if config.white_list.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|
+
+            next if config.skip_introspection_query && data['query'].index(/query IntrospectionQuery/)
+
             query = data['query'].lines.map { |line| "  #{line}" }.join.chomp # add indentation
             variables = PP.pp(data['variables'] || {}, '')
             info "  Variables: #{formatter.format(variables_lexer.lex(variables))}"

data/lib/graphql/rails_logger/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module RailsLogger
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-rails_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - JetRuby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
@@ -85,6 +85,7 @@ files:
 - bin/setup
 - graphql-rails_logger.gemspec
 - lib/graphql/rails_logger.rb
+- lib/graphql/rails_logger/configuration.rb
 - lib/graphql/rails_logger/railtie.rb
 - lib/graphql/rails_logger/subscriber.rb
 - lib/graphql/rails_logger/version.rb