graphql_rails 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2bd0f0c9f6aaa1808567914c7a1440302a8b7dc828e97937a264dc33cbdd0d5
-  data.tar.gz: eac8327fdf61cbd8bedb9301f261448a48ebeaf0d14ce78a6fd986d5aa752eb9
+  metadata.gz: b1d9d24469554419e5b4b033eb06b1e8f0be82079285d31ee7dbfb1e8e19e825
+  data.tar.gz: 3acc8f452a19ca66421a438103e8da1ed24da263ce551eb7d082ac67458011e8
 SHA512:
-  metadata.gz: e9df5b2875fc19b6a61259938ea99397edb51282c964f7bd511b1709c6625352e7c3d22428eac5ade6617b4a54244fb4b4ffa1574951b8368079fd7428cc5d68
-  data.tar.gz: bb8c01ac692e2137f9f0d3ab39a1b7a562ba337145ea0f90a0dd3325a5a67caf523d9f97c0536008adce4815ad15adda1ae036d8ded6f970c16bd761bc7c9a19
+  metadata.gz: 47974bc6d410ff9ed1215025aa4d06362494f87e20fee0c4259a3186ffa001a38c495b9ec7a9eff2428e966dc32ed52f776129cbab413abf874bc8ecb4334bc2
+  data.tar.gz: aa1f164524942256b310088b0ae046f5d98b90e283f4c17f465c8d3ca64a3ca4b8cd836af78b2fe77332fe062518b00380ed68d22df57b61d6eca824f0f6caff

data/.rubocop.yml

@@ -6,8 +6,6 @@ RSpec/NestedGroups:
 Metrics/LineLength:
   Enabled: true
   Max: 120
-  Exclude:
-    - db/migrate/*
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql_rails (0.3.3)
+    graphql_rails (0.4.0)
       activesupport (>= 4)
       graphql (~> 1)
 

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/samesystem/graphql_rails.svg?branch=master)](https://travis-ci.org/samesystem/graphql_rails)
 [![codecov](https://codecov.io/gh/samesystem/graphql_rails/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/graphql_rails)
+[![Documentation](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://samesystem.github.io/graphql_rails)
 
 Rails style structure for GrapQL API.
 
@@ -170,6 +171,10 @@ RSpec.describe MyGraphqlController, type: :graphql_controller do
 end
 ```
 
+## Detailed documentation
+
+Check https://samesystem.github.io/graphql_rails for more details
+
 
 ## Development
 

data/docs/components/controller.md

@@ -80,7 +80,7 @@ By default return type is determined by controller name. When you want to return
 
 ```ruby
 class UsersController < GraphqlRails::Controller
-  action(:last_order).permit(:id).returns(Order)
+  action(:last_order).permit(:id).returns('Order!') # Order is your model class name
 
   def last_order
     user = User.find(params[:id]).orders.last
@@ -122,6 +122,48 @@ class UsersController < GraphqlRails::Controller
 end
 ```
 
+## *after_action*
+
+You can add `after_action` to run some filters after calling your controller action. Here is an example:
+
+```ruby
+class UsersController < GraphqlRails::Controller
+  after_action :clear_cache
+
+  def create
+    User.create(params)
+  end
+
+  private
+
+  def clear_cache # will run after `UsersController#create` action
+    logger.log('Create action is completed')
+  end
+end
+```
+
+## *around_action*
+
+You can add `around_action` to run some filters before and after calling your controller action. Here is an example:
+
+```ruby
+class UsersController < GraphqlRails::Controller
+  around_action :use_custom_locale
+
+  def create
+    User.create(params)
+  end
+
+  private
+
+  def with_custom_locale
+    I18n.with_locale('it') do
+      yield # yield is mandatory
+    end
+  end
+end
+```
+
 ### *only* and *except* option
 
 `UsersController.before_action` accepts `only` or `except` options which allows to skip filters for some actions.

data/graphql_rails.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'graphql_rails'
   spec.version       = GraphqlRails::VERSION
   spec.authors       = ['Povilas Jurčys']
-  spec.email         = ['bloomrain@gmail.com']
+  spec.email         = ['po.jurcys@gmail.com']
 
   spec.summary       = %q{GrapQL server and client for rails}
   spec.homepage      = 'https://github.com/povilasjurcys/graphql_rails'

data/lib/graphql_rails/attribute.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'graphql'
-require 'graphql_rails/attribute/attribute_type_parser'
+require 'graphql_rails/type_parser'
 
 module GraphqlRails
   # contains info about single graphql attribute
@@ -48,7 +48,7 @@ module GraphqlRails
     end
 
     def parse_type(type)
-      type = AttributeTypeParser.new(type).call
+      type = TypeParser.new(type).call
 
       original_name['!'] ? type.to_non_null_type : type
     end

data/lib/graphql_rails/controller.rb

@@ -4,6 +4,7 @@ require 'active_support/hash_with_indifferent_access'
 require 'graphql_rails/controller/configuration'
 require 'graphql_rails/controller/request'
 require 'graphql_rails/controller/format_results'
+require 'graphql_rails/controller/action_hooks_runner'
 
 module GraphqlRails
   # base class for all graphql_rails controllers
@@ -13,12 +14,20 @@ module GraphqlRails
         controller_configuration.add_before_action(*args)
       end
 
+      def around_action(*args)
+        controller_configuration.add_around_action(*args)
+      end
+
+      def after_action(*args)
+        controller_configuration.add_after_action(*args)
+      end
+
       def action(action_name)
         controller_configuration.action(action_name)
       end
 
       def controller_configuration
-        @controller_configuration ||= Controller::Configuration.new(self)
+        @controller_configuration ||= Controller::Configuration.new
       end
     end
 
@@ -42,7 +51,7 @@ module GraphqlRails
     attr_reader :graphql_request
 
     def render(object_or_errors)
-      errors = grapqhl_errors_from_render_params(object_or_errors)
+      errors = graphql_errors_from_render_params(object_or_errors)
       object = errors.empty? ? object_or_errors : nil
 
       graphql_request.errors = errors
@@ -56,16 +65,15 @@ module GraphqlRails
     private
 
     def call_with_rendering(action_name)
-      before_actions = self.class.controller_configuration.before_actions_for(action_name)
-      before_actions.each { |before_action| send(before_action.name) }
-      response = public_send(action_name)
+      hooks_runner = ActionHooksRunner.new(action_name: action_name, controller: self)
+      response = hooks_runner.call { public_send(action_name) }
 
       render response if graphql_request.no_object_to_return?
     rescue StandardError => error
       render error: error
     end
 
-    def grapqhl_errors_from_render_params(rendering_params)
+    def graphql_errors_from_render_params(rendering_params)
       return [] unless rendering_params.is_a?(Hash)
       return [] if rendering_params.keys.count != 1
 

data/lib/graphql_rails/controller/action_configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/string/filters'
+require 'graphql_rails/type_parser'
 require 'graphql_rails/attribute'
 
 module GraphqlRails
@@ -40,7 +41,7 @@ module GraphqlRails
       end
 
       def returns(new_return_type)
-        @return_type = new_return_type
+        @return_type = TypeParser.new(new_return_type).call
         self
       end
 

data/lib/graphql_rails/controller/{before_action_filter.rb → action_filter.rb}

@@ -3,7 +3,7 @@
 module GraphqlRails
   class Controller
     # stores information about controller filter
-    class BeforeActionFilter
+    class ActionFilter
       attr_reader :name
 
       def initialize(name, only: [], except: [])

data/lib/graphql_rails/controller/action_hooks_runner.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module GraphqlRails
+  class Controller
+    # runs {before/around/after}_action controller hooks
+    class ActionHooksRunner
+      def initialize(action_name:, controller:)
+        @action_name = action_name
+        @controller = controller
+      end
+
+      def call
+        run_before_action_hooks
+        run_around_actions { yield }.tap do
+          run_after_action_hooks
+        end
+      end
+
+      private
+
+      attr_reader :action_name, :controller
+
+      def all_around_actions
+        controller_configuration.around_actions_for(action_name)
+      end
+
+      def controller_configuration
+        controller.class.controller_configuration
+      end
+
+      def run_around_actions(around_actions = all_around_actions, &block)
+        pending_around_actions = around_actions.clone
+        around_action = pending_around_actions.shift
+
+        if around_action
+          controller.send(around_action.name) { run_around_actions(pending_around_actions, &block) }
+        else
+          yield
+        end
+      end
+
+      def run_before_action_hooks
+        before_actions = controller_configuration.before_actions_for(action_name)
+        before_actions.each { |filter| controller.send(filter.name) }
+      end
+
+      def run_after_action_hooks
+        after_actions = controller_configuration.after_actions_for(action_name)
+        after_actions.each { |filter| controller.send(filter.name) }
+      end
+    end
+  end
+end

data/lib/graphql_rails/controller/configuration.rb

@@ -3,25 +3,41 @@
 require 'active_support/core_ext/string/inflections'
 require 'graphql_rails/attribute'
 require 'graphql_rails/controller/action_configuration'
-require 'graphql_rails/controller/before_action_filter'
+require 'graphql_rails/controller/action_filter'
 
 module GraphqlRails
   class Controller
     # stores all graphql_rails contoller specific config
     class Configuration
-      def initialize(controller)
-        @controller = controller
+      def initialize
         @before_actions = {}
+        @around_actions = {}
+        @after_actions = {}
         @action_by_name = {}
       end
 
       def before_actions_for(action_name)
-        before_actions.values.select { |action| action.applicable_for?(action_name) }
+        action_filters_for(action_name, before_actions)
+      end
+
+      def around_actions_for(action_name)
+        action_filters_for(action_name, around_actions)
+      end
+
+      def after_actions_for(action_name)
+        action_filters_for(action_name, after_actions)
+      end
+
+      def add_around_action(name, **options)
+        add_action(name, around_actions, **options)
       end
 
       def add_before_action(name, **options)
-        symbolized_name = name.to_sym
-        before_actions[symbolized_name] = BeforeActionFilter.new(symbolized_name, **options)
+        add_action(name, before_actions, **options)
+      end
+
+      def add_after_action(name, **options)
+        add_action(name, after_actions, **options)
       end
 
       def action(method_name)
@@ -30,7 +46,16 @@ module GraphqlRails
 
       private
 
-      attr_reader :controller, :before_actions
+      attr_reader :before_actions, :around_actions, :after_actions
+
+      def action_filters_for(action_name, action_filters)
+        action_filters.values.select { |filter| filter.applicable_for?(action_name) }
+      end
+
+      def add_action(name, actions_collection, **options)
+        symbolized_name = name.to_sym
+        actions_collection[symbolized_name] = ActionFilter.new(symbolized_name, **options)
+      end
     end
   end
 end

data/lib/graphql_rails/type_parser.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'graphql'
+
+module GraphqlRails
+  # converts string value in to GraphQL type
+  class TypeParser
+    class UnknownTypeError < ArgumentError; end
+
+    TYPE_MAPPING = {
+      'id' => GraphQL::ID_TYPE,
+
+      'int' => GraphQL::INT_TYPE,
+      'integer' => GraphQL::INT_TYPE,
+
+      'string' => GraphQL::STRING_TYPE,
+      'str' => GraphQL::STRING_TYPE,
+      'text' => GraphQL::STRING_TYPE,
+      'time' => GraphQL::STRING_TYPE,
+      'date' =>  GraphQL::STRING_TYPE,
+
+      'bool' => GraphQL::BOOLEAN_TYPE,
+      'boolean' => GraphQL::BOOLEAN_TYPE,
+
+      'float' => GraphQL::FLOAT_TYPE,
+      'double' => GraphQL::FLOAT_TYPE,
+      'decimal' => GraphQL::FLOAT_TYPE
+    }.freeze
+
+    def initialize(unparsed_type)
+      @unparsed_type = unparsed_type
+    end
+
+    def call
+      return unparsed_type if raw_graphql_type?
+
+      if list?
+        parsed_list_type
+      else
+        parsed_inner_type
+      end
+    end
+
+    private
+
+    attr_reader :unparsed_type
+
+    def parsed_list_type
+      list_type = parsed_inner_type.to_list_type
+
+      if required_list_type?
+        list_type.to_non_null_type
+      else
+        list_type
+      end
+    end
+
+    def parsed_inner_type
+      if required_inner_type?
+        type_by_name.to_non_null_type
+      else
+        type_by_name
+      end
+    end
+
+    def required_inner_type?
+      !!unparsed_type[/\w!/] # rubocop:disable Style/DoubleNegation
+    end
+
+    def list?
+      unparsed_type.to_s.include?(']')
+    end
+
+    def required_list_type?
+      unparsed_type.to_s.include?(']!')
+    end
+
+    def raw_graphql_type?
+      unparsed_type.is_a?(GraphQL::BaseType) ||
+        unparsed_type.is_a?(GraphQL::ObjectType) ||
+        (defined?(GraphQL::Schema::Member) && unparsed_type.is_a?(Class) && unparsed_type < GraphQL::Schema::Member)
+    end
+
+    def inner_type_name
+      unparsed_type.to_s.downcase.tr('[]!', '')
+    end
+
+    def type_by_name
+      TYPE_MAPPING.fetch(inner_type_name) do
+        dynamicly_defined_type || raise(
+          UnknownTypeError,
+          "Type #{unparsed_type.inspect} is not supported. Supported scalar types are: #{TYPE_MAPPING.keys}." \
+          ' All the classes that includes `GraphqlRails::Model` are also supported as types.'
+        )
+      end
+    end
+
+    def dynamicly_defined_type
+      type_class = inner_type_name.capitalize.safe_constantize
+      return unless type_class.respond_to?(:graphql)
+
+      type_class.graphql.graphql_type
+    end
+  end
+end

data/lib/graphql_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlRails
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Povilas Jurčys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -82,7 +82,7 @@ dependencies:
         version: '3.0'
 description: 
 email:
-- bloomrain@gmail.com
+- po.jurcys@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -114,11 +114,11 @@ files:
 - graphql_rails.gemspec
 - lib/graphql_rails.rb
 - lib/graphql_rails/attribute.rb
-- lib/graphql_rails/attribute/attribute_type_parser.rb
 - lib/graphql_rails/controller.rb
 - lib/graphql_rails/controller/action.rb
 - lib/graphql_rails/controller/action_configuration.rb
-- lib/graphql_rails/controller/before_action_filter.rb
+- lib/graphql_rails/controller/action_filter.rb
+- lib/graphql_rails/controller/action_hooks_runner.rb
 - lib/graphql_rails/controller/configuration.rb
 - lib/graphql_rails/controller/controller_function.rb
 - lib/graphql_rails/controller/format_results.rb
@@ -136,6 +136,7 @@ files:
 - lib/graphql_rails/router/route.rb
 - lib/graphql_rails/router/schema_builder.rb
 - lib/graphql_rails/rspec_controller_helpers.rb
+- lib/graphql_rails/type_parser.rb
 - lib/graphql_rails/version.rb
 homepage: https://github.com/povilasjurcys/graphql_rails
 licenses:

data/lib/graphql_rails/attribute/attribute_type_parser.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-require 'graphql'
-
-module GraphqlRails
-  class Attribute
-    # converts string value in to GraphQL type
-    class AttributeTypeParser
-      class UnknownTypeError < ArgumentError; end
-
-      TYPE_MAPPING = {
-        'id' => GraphQL::ID_TYPE,
-
-        'int' => GraphQL::INT_TYPE,
-        'integer' => GraphQL::INT_TYPE,
-
-        'string' => GraphQL::STRING_TYPE,
-        'str' => GraphQL::STRING_TYPE,
-        'text' => GraphQL::STRING_TYPE,
-        'time' => GraphQL::STRING_TYPE,
-        'date' =>  GraphQL::STRING_TYPE,
-
-        'bool' => GraphQL::BOOLEAN_TYPE,
-        'boolean' => GraphQL::BOOLEAN_TYPE,
-
-        'float' => GraphQL::FLOAT_TYPE,
-        'double' => GraphQL::FLOAT_TYPE,
-        'decimal' => GraphQL::FLOAT_TYPE
-      }.freeze
-
-      def initialize(unparsed_type)
-        @unparsed_type = unparsed_type
-      end
-
-      def call
-        return unparsed_type if raw_graphql_type?
-
-        if list?
-          parsed_list_type
-        else
-          parsed_inner_type
-        end
-      end
-
-      private
-
-      attr_reader :unparsed_type
-
-      def parsed_list_type
-        list_type = parsed_inner_type.to_list_type
-
-        if required_list_type?
-          list_type.to_non_null_type
-        else
-          list_type
-        end
-      end
-
-      def parsed_inner_type
-        if required_inner_type?
-          type_by_name.to_non_null_type
-        else
-          type_by_name
-        end
-      end
-
-      def required_inner_type?
-        !!unparsed_type[/\w!/] # rubocop:disable Style/DoubleNegation
-      end
-
-      def list?
-        unparsed_type.to_s.include?(']')
-      end
-
-      def required_list_type?
-        unparsed_type.to_s.include?(']!')
-      end
-
-      def raw_graphql_type?
-        unparsed_type.is_a?(GraphQL::BaseType) ||
-          unparsed_type.is_a?(GraphQL::ObjectType) ||
-          (defined?(GraphQL::Schema::Member) && unparsed_type.is_a?(Class) && unparsed_type < GraphQL::Schema::Member)
-      end
-
-      def inner_type_name
-        unparsed_type.to_s.downcase.tr('[]!', '')
-      end
-
-      def type_by_name
-        TYPE_MAPPING.fetch(inner_type_name) do
-          dynamicly_defined_type || raise(
-            UnknownTypeError,
-            "Type #{unparsed_type.inspect} is not supported. Supported scalar types are: #{TYPE_MAPPING.keys}." \
-            ' All the classes that includes `GraphqlRails::Model` are also supported as types.'
-          )
-        end
-      end
-
-      def dynamicly_defined_type
-        type_class = inner_type_name.capitalize.safe_constantize
-        return unless type_class.respond_to?(:graphql)
-
-        type_class.graphql.graphql_type
-      end
-    end
-  end
-end