groovestack-base 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f511d14b324b1513d61cb1975c54c31db2cb58eed2b771bdc25207a822ffe1
-  data.tar.gz: d3bc0ef6415c0f45c31d84ee605b9c03cd8c0ac0126069c2eab15012a5e61a76
+  metadata.gz: 682c6b2dbb33593bd71df11b9228987c66bcbcabc4525b2a4f59c2240f4980b5
+  data.tar.gz: e791bf96b84082d0b2c9f5bdbc378203d74db1a0cc13d5b963dca120d46cfd5c
 SHA512:
-  metadata.gz: 6a82e1038408222eb47775c2cd8a2b0b1053fb96e7eed4cba30c07ea78ac73b95574cddacc3c2b740d641a93e6e77b6dec6c926ce9b034cd804834bfd2761ea6
-  data.tar.gz: e423738794d1f80cf1c328d24e1392480fab3b822f40fdbc0619039b9b266da0aea602029cce504e8ddb9ffd4fe2f7cf8e3d5fe99217d2a99dcf87b78d260f5d
+  metadata.gz: '0852f44c5f4b5c1cb725175917d0f8dac6ddd088574c233a4f207ba821f6ce675b10348b6fb17b4aabcefe3b6eba717bc20ce2d04b593cb22b909d5298a40e56'
+  data.tar.gz: 7d0a44e103a9ae986f7fb91f273c8366f0b62a9a84edfc6b95f4d6b26e4c14d65d824dbb52835a115c0970c37cd0de12099af279646793062b52ccda41a9d52e

data/Gemfile

@@ -12,4 +12,6 @@ group :test do
 end
 gem 'puma', '~> 6'
 gem 'rake', '~> 12.0'
-gem 'rubocop', require: false
+gem 'rubocop'
+gem 'rubocop-graphql', '~> 1.0'
+gem 'rubocop-rails', '~> 2.18'

data/config/initializers/inflections.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym 'GraphQL'
+end

data/lib/groovestack/base/graphql/controllers/execute.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Groovestack
+  module Base
+    module GraphQL
+      module Controllers
+        module Execute
+          extend ActiveSupport::Concern
+
+          included do
+            skip_before_action :verify_authenticity_token
+
+            # If accessing from outside this domain, nullify the session
+            # This allows for outside API access while preventing CSRF attacks,
+            # but you'll have to authenticate your user separately
+            # protect_from_forgery with: :null_session
+
+            def groovestack_graphql_schema
+              raise 'groovestack_graphql_schema is not set' if groovestack_graphql_schema.blank?
+            end
+
+            def execute
+              result = groovestack_graphql_schema.execute(
+                query,
+                variables: variables,
+                context: execute_context,
+                operation_name: operation_name
+              )
+
+              process_result_errors(result['errors'])
+
+              render json: result
+            rescue StandardError => e
+              ::Groovestack::Base.notify_error(e.class.name, e.message)
+
+              raise e unless Rails.env.development?
+
+              handle_error_in_development(e)
+            end
+          end
+
+          private
+
+          def execute_context
+            return {} unless defined?(context)
+
+            context
+          end
+
+          def process_result_errors(errors)
+            # NOTE: This is a custom Bugsnag notify call for requests that
+            # have handled errors (validation, invariant, top-level, handled)
+            return if errors.blank?
+
+            errors.each do |error|
+              msg = error['message'] || error
+
+              ::Groovestack::Base.notify_error(error.class.name, msg)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groovestack/base/graphql/controllers/{graphql_controller.rb → helpers.rb}

@@ -4,7 +4,7 @@ module Groovestack
   module Base
     module GraphQL
       module Controllers
-        module GraphQLController
+        module Helpers
           extend ActiveSupport::Concern
 
           included do # rubocop:disable Metrics/BlockLength

data/lib/groovestack/base/graphql/providers/react_admin.rb

@@ -86,7 +86,7 @@ module Groovestack
               end
 
               def define_meta_resolver(entity, authorize, policy, base_scope)
-                define_method :"#{entity}_meta" do |_page: nil, _per_page: nil, **attrs|
+                define_method :"#{entity}_meta" do |page: nil, per_page: nil, **attrs| # rubocop:disable Lint/UnusedBlockArgument
                   scope = resolve_scope(authorize, policy, :IndexScope, base_scope)
                   { count: send("#{entity}_scope", **attrs, base_scope: scope).size }
                 end

data/lib/groovestack/base/graphql/schema_abstract.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Groovestack
+  module Base
+    module GraphQL
+      class SchemaAbstract < ::GraphQL::Schema
+        # NOTE: This is intended to be a base class for all GraphQL schemas in the Groovestack ecosystem.
+        # It is not intended to be used directly.
+        #
+        # To create a new GraphQL schema, subclass this class and specify:
+        # - query(::Types::QueryType) (required)
+        # - mutation(::Types::MutationType) (optional)
+        # - subscription(::Types::SubscriptionType) (optional)
+        #
+        # Example:
+        #
+        # class MySchema < Groovestack::Base::GraphQL::SchemaAbstract
+        #   query(::Types::QueryType)
+        #   mutation(::Types::MutationType)
+        #   subscription(::Types::SubscriptionType)
+
+        use ::GraphQL::Subscriptions::ActionCableSubscriptions
+
+        # For batch-loading (see https://graphql-ruby.org/dataloader/overview.html)
+        use ::GraphQL::Dataloader
+
+        # Stop validating when it encounters this many errors:
+        validate_max_errors(100)
+
+        # Error Handling https://graphql-ruby.org/errors/error_handling.html
+        rescue_from(
+          ::ActiveRecord::RecordInvalid,
+          ::ActiveRecord::RecordNotDestroyed
+          # AASM::InvalidTransition
+        ) do |err, _obj, args, _ctx, _field|
+          # Raise a graphql-friendly error with a custom message
+          raise ::GraphQL::ExecutionError.new(err.message, extensions: { args: })
+        end
+
+        rescue_from(::ActiveRecord::RecordNotFound) do |_err, _obj, args, _ctx, field|
+          # Raise a graphql-friendly error with a custom message
+          raise ::GraphQL::ExecutionError.new("#{field.type.unwrap.graphql_name} not found", extensions: { args: })
+        end
+
+        rescue_from(::ActiveRecord::RecordNotUnique) do |_err, _obj, args, _ctx, field|
+          # Raise a graphql-friendly error with a custom message
+          raise ::GraphQL::ExecutionError.new("#{field.type.unwrap.graphql_name} not unique", extensions: { args: })
+        end
+
+        # GraphQL-Ruby calls this when something goes wrong while running a query:
+
+        # Union and Interface Resolution
+        def self.resolve_type(_abstract_type, _obj, _ctx)
+          # to return the correct GraphQL object type for `obj`
+          raise(::GraphQL::RequiredImplementationMissingError)
+        end
+
+        # Relay-style Object Identification:
+
+        # Return a string UUID for `object`
+        def self.id_from_object(object, _type_definition, _query_ctx)
+          # For example, use Rails' GlobalID library (https://github.com/rails/globalid):
+          object.to_gid_param
+        end
+
+        # Given a string UUID, find the object
+        def self.object_from_id(global_id, _query_ctx)
+          # For example, use Rails' GlobalID library (https://github.com/rails/globalid):
+          ::GlobalID.find(global_id)
+        end
+      end
+    end
+  end
+end

data/lib/groovestack/base/railtie.rb

@@ -45,6 +45,14 @@ module Groovestack
           end
         end
 
+        def append_locales(app) # rubocop:disable Metrics/AbcSize
+          return if app.root.present? && root.present? && app.root.to_s.match?(root.to_s)
+
+          config.paths['config/locales'].expanded.each do |expanded_path|
+            app.config.paths['config/locales'] << expanded_path
+          end
+        end
+
         def core_base_dx_validate # rubocop:disable Metrics/AbcSize
           errors = []
           dx_validations.each do |v|

data/lib/groovestack/base/settings.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Groovestack
+  module Base
+    module Settings
+      extend ActiveSupport::Concern
+
+      included do
+        extend Dry::Configurable
+
+        setting :error_notifier, reader: true do
+          setting :handler, reader: true, default: ::Logger.new($stdout)
+          setting :notify_method, reader: true, default: :notify
+        end
+
+        setting :graphql do
+          setting :camelize, default: false
+        end
+
+        def self.notify_error(prefix, err)
+          msg = "#{[prefix, 'error'].compact.join(' ')}: #{err}"
+
+          error_notifier.handler.send(error_notifier.notify_method, msg)
+        end
+      end
+    end
+  end
+end

data/lib/groovestack/base/version.rb

@@ -2,6 +2,6 @@
 
 module Groovestack
   module Base
-    VERSION = '0.1.11'
+    VERSION = '0.1.12'
   end
 end

data/lib/groovestack/base.rb

@@ -8,16 +8,13 @@ require 'pg_lock'
 
 require 'groovestack/base/version'
 require 'groovestack/base/utilities/string'
+require 'groovestack/base/settings'
 
 module Groovestack
   module Base
-    module GraphQL
-      module Authorization
-        autoload :AuthorizedField, 'groovestack/base/graphql/authorization/authorized_field'
-        autoload :AuthorizedObject, 'groovestack/base/graphql/authorization/authorized_object'
-        autoload :VisibleField, 'groovestack/base/graphql/authorization/visible_field'
-      end
+    include ::Groovestack::Base::Settings
 
+    module GraphQL
       module Base
         autoload :Argument, 'groovestack/base/graphql/base/argument'
         autoload :Field, 'groovestack/base/graphql/base/field'
@@ -28,7 +25,8 @@ module Groovestack
       end
 
       module Controllers
-        autoload :GraphQLController, 'groovestack/base/graphql/controllers/graphql_controller'
+        autoload :Helpers, 'groovestack/base/graphql/controllers/helpers'
+        autoload :Execute, 'groovestack/base/graphql/controllers/execute'
       end
 
       module Documentation
@@ -50,6 +48,8 @@ module Groovestack
         end
       end
 
+      autoload :SchemaAbstract, 'groovestack/base/graphql/schema_abstract'
+
       module Subscriptions
         autoload :Trigger, 'groovestack/base/graphql/subscriptions/trigger'
       end
@@ -67,42 +67,12 @@ module Groovestack
       end
     end
 
-    autoload :ActiveRecord, 'groovestack/base/active_record'
     autoload :Listener, 'groovestack/base/listeners'
     autoload :Listeners, 'groovestack/base/listeners'
 
     autoload :PubSub, 'groovestack/base/pub_sub' if defined?(Wisper)
     autoload :CoreRailtie, 'groovestack/base/railtie' if defined?(Rails::Railtie)
 
-    extend Dry::Configurable
-
-    DEFAULT_ERROR_MONITOR =  ::Logger.new($stdout)
-
-    # ex:
-    #   /config/initializers/core_base.rb
-
-    #   Groovestack::Base.configure do |config|
-    #     config.error_notifier.handler = Bugsnag
-    #   end
-    setting :error_notifier, reader: true do
-      setting :handler, reader: true
-      setting :notify_method, reader: true, default: :notify
-    end
-
-    setting :graphql do
-      setting :camelize, default: false
-    end
-
-    def self.notify_error(prefix, err)
-      msg = "#{[prefix, 'error'].compact.join(' ')}: #{err}"
-
-      if error_notifier&.handler.present?
-        error_notifier.handler.send(error_notifier.notify_method, msg)
-      else
-        DEFAULT_ERROR_MONITOR.error(msg)
-      end
-    end
-
     class Error < StandardError; end
     class WrongSchemaFormat < Groovestack::Base::Error; end
   end
@@ -114,6 +84,8 @@ require 'groovestack/base/puma/plugin/core_cron' if defined?(Puma)
 # to reference Groovestack::Base
 module Core
   module Base
+    include ::Groovestack::Base::Settings
+
     module GraphQL
       module Subscriptions
         EventHandler = ::Groovestack::Base::GraphQL::Subscriptions::Trigger
@@ -123,9 +95,8 @@ module Core
         BaseArgument = ::Groovestack::Base::GraphQL::Base::Argument
         BaseField = ::Groovestack::Base::GraphQL::Base::Field
         BaseObject = ::Groovestack::Base::GraphQL::Base::Object
-        AuthorizedBaseField = ::Groovestack::Base::GraphQL::Authorization::AuthorizedField
-        AuthorizedBaseObject = ::Groovestack::Base::GraphQL::Authorization::AuthorizedObject
-        VisibleBaseField = ::Groovestack::Base::GraphQL::Authorization::VisibleField
+        Money = ::Groovestack::Base::GraphQL::Types::Money
+        SubscriptionPayload = ::Groovestack::Base::GraphQL::Types::SubscriptionPayload
       end
       BaseInputObject = ::Groovestack::Base::GraphQL::Base::InputObject
       BaseMutation = ::Groovestack::Base::GraphQL::Base::Mutation
@@ -144,7 +115,7 @@ module Core
           StatusEvents = ::Groovestack::Base::GraphQL::Mutations::AASMEventTrigger
           InstanceMethods = ::Groovestack::Base::GraphQL::Mutations::MethodTrigger
         end
-        Controller = ::Groovestack::Base::GraphQL::Controllers::GraphQLController
+        Controller = ::Groovestack::Base::GraphQL::Controllers::Helpers
       end
 
       module Providers
@@ -161,36 +132,12 @@ module Core
       end
     end
 
-    ActiveRecord = ::Groovestack::Base::ActiveRecord
     Listener = ::Groovestack::Base::Listener
     Listeners = ::Groovestack::Base::Listeners
 
     PubSub = ::Groovestack::Base::PubSub if defined?(Wisper)
     CoreRailtie = ::Groovestack::Base::CoreRailtie if defined?(Rails::Railtie)
 
-    extend Dry::Configurable
-
-    DEFAULT_ERROR_MONITOR =  ::Logger.new($stdout)
-
-    setting :error_notifier, reader: true do
-      setting :handler, reader: true
-      setting :notify_method, reader: true, default: :notify
-    end
-
-    setting :graphql do
-      setting :camelize, default: false
-    end
-
-    def self.notify_error(prefix, err)
-      msg = "#{[prefix, 'error'].compact.join(' ')}: #{err}"
-
-      if error_notifier&.handler.present?
-        error_notifier.handler.send(error_notifier.notify_method, msg)
-      else
-        DEFAULT_ERROR_MONITOR.error(msg)
-      end
-    end
-
     Error = ::Groovestack::Base::Error
     WrongSchemaFormat = ::Groovestack::Base::WrongSchemaFormat
   end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groovestack-base
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Darren Rush
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,24 +119,23 @@ files:
 - Gemfile
 - config.ru
 - config/initializers/graphql.rb
+- config/initializers/inflections.rb
 - groovestack-base.gemspec
 - lib/groovestack/base.rb
-- lib/groovestack/base/active_record.rb
-- lib/groovestack/base/graphql/authorization/authorized_field.rb
-- lib/groovestack/base/graphql/authorization/authorized_object.rb
-- lib/groovestack/base/graphql/authorization/visible_field.rb
 - lib/groovestack/base/graphql/base/argument.rb
 - lib/groovestack/base/graphql/base/field.rb
 - lib/groovestack/base/graphql/base/input_object.rb
 - lib/groovestack/base/graphql/base/mutation.rb
 - lib/groovestack/base/graphql/base/object.rb
 - lib/groovestack/base/graphql/base/subscription.rb
-- lib/groovestack/base/graphql/controllers/graphql_controller.rb
+- lib/groovestack/base/graphql/controllers/execute.rb
+- lib/groovestack/base/graphql/controllers/helpers.rb
 - lib/groovestack/base/graphql/documentation/arguments.rb
 - lib/groovestack/base/graphql/documentation/fields.rb
 - lib/groovestack/base/graphql/mutations/aasm_event_trigger.rb
 - lib/groovestack/base/graphql/mutations/method_trigger.rb
 - lib/groovestack/base/graphql/providers/react_admin.rb
+- lib/groovestack/base/graphql/schema_abstract.rb
 - lib/groovestack/base/graphql/subscriptions/trigger.rb
 - lib/groovestack/base/graphql/tracers.rb
 - lib/groovestack/base/graphql/types/aasm_event_attributes.rb
@@ -147,6 +147,7 @@ files:
 - lib/groovestack/base/pub_sub.rb
 - lib/groovestack/base/puma/plugin/core_cron.rb
 - lib/groovestack/base/railtie.rb
+- lib/groovestack/base/settings.rb
 - lib/groovestack/base/utilities/string.rb
 - lib/groovestack/base/version.rb
 homepage: https://talysto.com/tech/groovestack/
@@ -172,7 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Shared extensions for CORE modules
 test_files: []

data/lib/groovestack/base/active_record.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Groovestack
-  module Base
-    module ActiveRecord
-      module Authorization
-        module FieldsForSerialization
-          extend ActiveSupport::Concern
-
-          # required for memoization during graphql serialization
-          def authorized_fields_for_serialization(user)
-            @authorized_fields_for_serialization ||= Pundit.policy!(user, self).permitted_attributes_for_show
-            @authorized_fields_for_serialization
-          end
-        end
-      end
-    end
-  end
-end

data/lib/groovestack/base/graphql/authorization/authorized_field.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Groovestack
-  module Base
-    module GraphQL
-      module Authorization
-        class AuthorizedField < ::Groovestack::Base::GraphQL::Base::Field
-          def authorized?(obj, args, ctx)
-            authorized_fields = begin
-              obj.authorized_fields_for_serialization(ctx[:current_user])
-            rescue StandardError
-              []
-            end
-
-            super && authorized_fields.include?(name.to_sym)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/groovestack/base/graphql/authorization/authorized_object.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Groovestack
-  module Base
-    module GraphQL
-      module Authorization
-        class AuthorizedObject < ::Groovestack::Base::GraphQL::Base::Object
-          field_class ::Groovestack::Base::GraphQL::Authorization::AuthorizedField
-        end
-      end
-    end
-  end
-end

data/lib/groovestack/base/graphql/authorization/visible_field.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Groovestack
-  module Base
-    module GraphQL
-      module Authorization
-        class VisibleField < ::Groovestack::Base::GraphQL::Base::Field
-          def visible?(context)
-            return super unless @visibility_permission
-
-            # visibility profile are the visibility levels the
-            # current user is authorized for
-            visibility_profile = context.schema.visibility_profile_for_context(context).map(&:to_sym)
-
-            return super unless visibility_profile
-
-            super && visibility_profile.include?(@visibility_permission.to_sym)
-          end
-        end
-      end
-    end
-  end
-end