ibrain-core 0.4.6 → 0.4.7

data/lib/generators/ibrain/install/templates/rubocop.yml.tt

@@ -6,12 +6,7 @@ require:
   - rubocop-graphql
 
 AllCops:
-  Exclude:
-    - db/migrate/*.rb
-    - bin/*
-    - config/application.rb
-    - "**/vendor/**/*"
-    - vendor/eco-api-ruby
+  TargetRubyVersion: 2.5
 
 # We use class vars and will have to continue doing so for compatability
 Style/ClassVars:
@@ -32,6 +27,9 @@ Naming/AccessorMethodName:
 Style/MutableConstant:
   Enabled: false
 
+Style/ClassAndModuleChildren:
+  Enabled: false
+
 Style/EmptyElse:
   Enabled: false
 
@@ -51,7 +49,7 @@ Style/ConditionalAssignment:
   Enabled: false
 
 Performance/Count:
-  Enabled: true
+  Enabled: false
 
 Style/RaiseArgs:
   Enabled: false
@@ -68,44 +66,44 @@ Style/AsciiComments:
   Enabled: false
 
 Layout/EndAlignment:
-  Enabled: true
+  Enabled: false
 
 Layout/ElseAlignment:
-  Enabled: true
+  Enabled: false
 
 Layout/IndentationWidth:
-  Enabled: true
+  Enabled: false
 
 Layout/ParameterAlignment:
-  Enabled: true
+  Enabled: false
 
 Layout/ClosingParenthesisIndentation:
-  Enabled: true
+  Enabled: false
 
 Layout/MultilineMethodCallIndentation:
-  Enabled: true
+  Enabled: false
 
 Layout/FirstArrayElementIndentation:
-  Enabled: true
+  Enabled: false
 
 Layout/FirstHashElementIndentation:
-  Enabled: true
+  Enabled: false
 
 Layout/HashAlignment:
-  Enabled: true
+  Enabled: false
 
 Style/TrailingCommaInArguments:
-  Enabled: true
+  Enabled: false
 
 Style/TrailingCommaInArrayLiteral:
-  Enabled: true
+  Enabled: false
 
 Style/TrailingCommaInHashLiteral:
-  Enabled: true
+  Enabled: false
 
 # Symbol Arrays are ok and the %i syntax widely unknown
 Style/SymbolArray:
-  Enabled: true
+  Enabled: false
 
 Rails/DynamicFindBy:
   Whitelist:
@@ -116,7 +114,7 @@ Rails/DynamicFindBy:
 Rails/SkipsModelValidations:
   Exclude:
     - db/seeds/**/*.rb
-    - "*/spec/**/*"
+    - '*/spec/**/*'
 
 # We use a lot of
 #
@@ -127,13 +125,13 @@ Rails/SkipsModelValidations:
 # syntax in the specs files.
 Lint/AmbiguousBlockAssociation:
   Exclude:
-    - "*/spec/**/*"
-    - "spec/**/*" # For the benefit of apps that inherit from this config
+    - '*/spec/**/*'
+    - 'spec/**/*' # For the benefit of apps that inherit from this config
 
 Security/Eval:
   Exclude:
-    - "Gemfile"
-    - "*/Gemfile"
+    - 'Gemfile'
+    - '*/Gemfile'
 
 Naming/VariableNumber:
   Enabled: false
@@ -237,7 +235,7 @@ Layout/SpaceInsideParens:
   StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
 
 Style/SpecialGlobalVars:
-  Enabled: true
+  Enabled: false
   StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
 
 Style/StringLiterals:
@@ -302,9 +300,6 @@ Style/FrozenStringLiteralComment:
   Enabled: true
   EnforcedStyle: always
 
-Style/FetchEnvVar:
-  Enabled: true
-
 # json.() is idiomatic in jbuilder files
 Style/LambdaCall:
   Enabled: false
@@ -320,7 +315,7 @@ Style/IdenticalConditionalBranches:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
-  Enabled: true
+  Enabled: false
 
 Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: false
@@ -604,7 +599,10 @@ GraphQL/FieldDescription:
   Enabled: false
 
 GraphQL/ObjectDescription:
-  Enabled: false
+  Enabled: true
+  Exclude:
+    - app/graphql/policies/*.rb
+    - app/graphql/*.rb
 
 GraphQL/ExtractType:
   Enabled: false
@@ -614,55 +612,4 @@ Rails/UnknownEnv:
     - production
     - development
     - test
-    - staging
-
-Style/MixinUsage:
-  Enabled: true
-  Exclude:
-    - db/seeds/*.rb
-
-GraphQL/ExtractInputType:
-  Enabled: false
-GraphQL/ArgumentDescription:
-  Enabled: false
-
-Style/AccessorGrouping:
-  Enabled: true
-
-Layout/AccessModifierIndentation:
-  Enabled: true
-  EnforcedStyle: indent
-
-Layout/ArrayAlignment:
-  Enabled: true
-
-Layout/ArgumentAlignment:
-  Enabled: true
-
-Layout/ClassStructure:
-  Categories:
-    association:
-      - has_many
-      - has_one
-    attribute_macros:
-      - attr_accessor
-      - attr_reader
-      - attr_writer
-    macros:
-      - validates
-      - validate
-    module_inclusion:
-      - include
-      - prepend
-      - extend
-Layout/IndentationConsistency:
-  EnforcedStyle: indented_internal_methods
-
-Layout/InitialIndentation:
-  Enabled: true
-
-Layout/IndentationStyle:
-  EnforcedStyle: spaces
-
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
+    - staging

data/lib/ibrain/app_configuration.rb

@@ -20,54 +20,56 @@
 require 'ibrain/preferences/configuration'
 require 'ibrain/core/environment'
 
-class Ibrain::AppConfiguration < Ibrain::Preferences::Configuration
-  # Preferences (alphabetized to more easily lookup particular preferences)
+module Ibrain
+  class AppConfiguration < Preferences::Configuration
+    # Preferences (alphabetized to more easily lookup particular preferences)
 
-  # @!attribute [rw] guest_token_cookie_options
-  #   @return [Hash] Add additional guest_token cookie options here (ie. domain or path)
-  preference :guest_token_cookie_options, :hash, default: {}
+    # @!attribute [rw] guest_token_cookie_options
+    #   @return [Hash] Add additional guest_token cookie options here (ie. domain or path)
+    preference :guest_token_cookie_options, :hash, default: {}
 
-  # @!attribute [rw] generate_api_key_for_all_roles
-  #   @return [Boolean] Allow generating api key automatically for user
-  #   at role_user creation for all roles. (default: +false+)
-  preference :generate_api_key_for_all_roles, :boolean, default: false
+    # @!attribute [rw] generate_api_key_for_all_roles
+    #   @return [Boolean] Allow generating api key automatically for user
+    #   at role_user creation for all roles. (default: +false+)
+    preference :generate_api_key_for_all_roles, :boolean, default: false
 
-  # @!attribute [rw] mails_from
-  #   @return [String] Email address used as +From:+ field in transactional emails.
-  preference :mails_from, :string, default: 'ibrain@example.com'
+    # @!attribute [rw] mails_from
+    #   @return [String] Email address used as +From:+ field in transactional emails.
+    preference :mails_from, :string, default: 'ibrain@example.com'
 
-  preference :graphql_policy, :string, default: 'Ibrain::Policies::GraphqlPolicy'
+    preference :graphql_policy, :string, default: 'Ibrain::Policies::GraphqlPolicy'
 
-  # Api version for route config
-  preference :api_version, :string, default: 'v1'
+    # Api version for route config
+    preference :api_version, :string, default: 'v1'
 
-  # Graphql Schema name
-  preference :graphql_schema, :string, default: 'Ibrain::BaseSchema'
+    # Graphql Schema name
+    preference :graphql_schema, :string, default: 'Ibrain::BaseSchema'
 
-  # Graphql Encryptor key
-  preference :ibrain_encryptor_key, :string, default: nil
+    # Graphql Encryptor key
+    preference :ibrain_encryptor_key, :string, default: nil
 
-  # Parent controller
-  preference :parent_controller, :string, default: 'ActionController::API'
+    # Parent controller
+    preference :parent_controller, :string, default: 'ActionController::API'
 
-  preference :master_database, :string, default: 'primary'
+    preference :master_database, :string, default: 'primary'
 
-  preference :graphql_max_depth, :integer, default: 3
+    preference :graphql_max_depth, :integer, default: 3
 
-  preference :is_auto_append_mutation, :boolean, default: true
+    preference :is_auto_append_mutation, :boolean, default: true
 
-  def static_model_preferences
-    @static_model_preferences ||= Ibrain::Preferences::StaticModelPreferences.new
-  end
+    def static_model_preferences
+      @static_model_preferences ||= Ibrain::Preferences::StaticModelPreferences.new
+    end
 
-  def roles
-    @roles ||= Ibrain::RoleConfiguration.new.tap do |roles|
-      roles.assign_permissions :default, ['Ibrain::PermissionSets::DefaultCustomer']
-      roles.assign_permissions :admin, ['Ibrain::PermissionSets::SuperUser']
+    def roles
+      @roles ||= Ibrain::RoleConfiguration.new.tap do |roles|
+        roles.assign_permissions :default, ['Ibrain::PermissionSets::DefaultCustomer']
+        roles.assign_permissions :admin, ['Ibrain::PermissionSets::SuperUser']
+      end
     end
-  end
 
-  def environment
-    @environment ||= Ibrain::Core::Environment.new(self)
+    def environment
+      @environment ||= Ibrain::Core::Environment.new(self)
+    end
   end
 end

data/lib/ibrain/core/class_constantizer.rb

@@ -2,37 +2,40 @@
 
 require 'active_support/core_ext/module'
 
-module Ibrain::Core::ClassConstantizer
-  class Set
-    include Enumerable
-
-    def initialize
-      @collection = ::Set.new
-    end
-
-    def <<(klass)
-      @collection << klass.to_s
-    end
-
-    def concat(klasses)
-      klasses.each do |klass|
-        self << klass
-      end
-
-      self
-    end
-
-    delegate :clear, :empty?, to: :@collection
-
-    def delete(object)
-      @collection.delete(object.to_s)
-    end
-
-    def each
-      @collection.each do |klass|
-        yield klass.constantize
+module Ibrain
+  module Core
+    module ClassConstantizer
+      class Set
+        include Enumerable
+
+        def initialize
+          @collection = ::Set.new
+        end
+
+        def <<(klass)
+          @collection << klass.to_s
+        end
+
+        def concat(klasses)
+          klasses.each do |klass|
+            self << klass
+          end
+
+          self
+        end
+
+        delegate :clear, :empty?, to: :@collection
+
+        def delete(object)
+          @collection.delete(object.to_s)
+        end
+
+        def each
+          @collection.each do |klass|
+            yield klass.constantize
+          end
+        end
       end
     end
   end
 end
-

data/lib/ibrain/core/controller_helpers/auth.rb

@@ -1,62 +1,68 @@
 # frozen_string_literal: true
 
-module Ibrain::Core::ControllerHelpers::Auth
-  extend ActiveSupport::Concern
-  include Response
-
-  # @!attribute [rw] fallback_on_unauthorized
-  #   @!scope class
-  #   Extension point for overriding behaviour of access denied errors.
-  #   Default behaviour is to redirect back or to "/unauthorized" with a flash
-  #   message.
-  #   @return [Proc] action to take when access denied error is raised.
-
-  included do
-    before_action :set_guest_token
-    helper_method :try_ibrain_current_user
-
-    class_attribute :fallback_on_unauthorized
-    self.fallback_on_unauthorized = -> do
-      error = ::Struct.new(
-        message: I18n.t('ibrain.authorization_failure')
-                                )
-
-      render_json_error(error, :unauthorized)
-    end
+module Ibrain
+  module Core
+    module ControllerHelpers
+      module Auth
+        extend ActiveSupport::Concern
+        include Response
 
-    rescue_from CanCan::AccessDenied do
-      instance_exec(&fallback_on_unauthorized)
-    end
-  end
+        # @!attribute [rw] fallback_on_unauthorized
+        #   @!scope class
+        #   Extension point for overriding behaviour of access denied errors.
+        #   Default behaviour is to redirect back or to "/unauthorized" with a flash
+        #   message.
+        #   @return [Proc] action to take when access denied error is raised.
 
-  # Needs to be overriden so that we use Brain's Ability rather than anyone else's.
-  def current_ability
-    @current_ability ||= Ibrain::Ability.new(try_ibrain_current_user)
-  end
+        included do
+          before_action :set_guest_token
+          helper_method :try_ibrain_current_user
 
-  def set_guest_token
-    # if cookies.signed[:guest_token].blank?
-    #   cookies.permanent.signed[:guest_token] = Ibrain::Config[:guest_token_cookie_options].merge(
-    #     value: SecureRandom.urlsafe_base64(nil, false),
-    #     httponly: true
-    #   )
-    # end
-  end
+          class_attribute :fallback_on_unauthorized
+          self.fallback_on_unauthorized = -> do
+            error = ::Struct.new(
+              message: I18n.t('ibrain.authorization_failure')
+                                     )
 
-  # proxy method to *possible* ibrain_current_user method
-  # Authentication extensions (such as ibrain-auth) are meant to provide ibrain_current_user
-  def try_ibrain_current_user
-    # This one will be defined by apps looking to hook into Ibrain
-    # As per authentication_helpers.rb
-    if respond_to?(:ibrain_current_user, true)
-      try(:ibrain_current_user)
-    # This one will be defined by Devise
-    elsif respond_to?(:current_ibrain_user, true)
-      try(:current_ibrain_user)
-    end
-  rescue StandardError => e
-    Ibrain::Logger.warn e.message.to_s
+            render_json_error(error, :unauthorized)
+          end
 
-    nil
+          rescue_from CanCan::AccessDenied do
+            instance_exec(&fallback_on_unauthorized)
+          end
+        end
+
+        # Needs to be overriden so that we use Brain's Ability rather than anyone else's.
+        def current_ability
+          @current_ability ||= Ibrain::Ability.new(try_ibrain_current_user)
+        end
+
+        def set_guest_token
+          # if cookies.signed[:guest_token].blank?
+          #   cookies.permanent.signed[:guest_token] = Ibrain::Config[:guest_token_cookie_options].merge(
+          #     value: SecureRandom.urlsafe_base64(nil, false),
+          #     httponly: true
+          #   )
+          # end
+        end
+
+        # proxy method to *possible* ibrain_current_user method
+        # Authentication extensions (such as ibrain-auth) are meant to provide ibrain_current_user
+        def try_ibrain_current_user
+          # This one will be defined by apps looking to hook into Ibrain
+          # As per authentication_helpers.rb
+          if respond_to?(:ibrain_current_user, true)
+            try(:ibrain_current_user)
+          # This one will be defined by Devise
+          elsif respond_to?(:current_ibrain_user, true)
+            try(:current_ibrain_user)
+          end
+        rescue StandardError => e
+          Ibrain::Logger.warn e.message.to_s
+
+          nil
+        end
+      end
+    end
   end
 end

data/lib/ibrain/core/controller_helpers/current_host.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
-module Ibrain::Core::ControllerHelpers::CurrentHost
-  extend ActiveSupport::Concern
+module Ibrain
+  module Core
+    module ControllerHelpers
+      module CurrentHost
+        extend ActiveSupport::Concern
 
-  included do
-    before_action do
-      ActiveStorage::Current.host = request.base_url
+        included do
+          before_action do
+            ActiveStorage::Current.host = request.base_url
+          end
+        end
+      end
     end
   end
 end

data/lib/ibrain/core/controller_helpers/response.rb

@@ -1,47 +1,53 @@
 # frozen_string_literal: true
 
-module Ibrain::Core::ControllerHelpers::Response
-  extend ActiveSupport::Concern
-
-  included do
-    helper_method :render_json_error
-    helper_method :render_json_ok
-  end
-
-  protected
-
-  def render_json_error(error, status)
-    e_message = error.try(:record).try(:errors).try(:full_messages).try(:first)
-    e_message = error.try(:message) if e_message.blank?
-    e_message = error.try(:details) if e_message.blank?
-
-    backtrace = error.try(:backtrace).try(:join, "\n")
-
-    Ibrain::Logger.error e_message
-    Ibrain::Logger.error backtrace
-
-    render json: {
-      errors: [{
-        message: e_message,
-        extensions: {
-          code: status,
-          exception: {
-            stacktrace: [
-              backtrace
-            ]
-          }
-        }
-      }],
-      message: e_message,
-      data: nil
-    }, status: status
-  end
-
-  def render_json_ok(data, message, errors = [])
-    render json: {
-      errors: errors,
-      message: message || I18n.t('ibrain.system.message.ok'),
-      data: data.as_json
-    }, status: :ok
+module Ibrain
+  module Core
+    module ControllerHelpers
+      module Response
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :render_json_error
+          helper_method :render_json_ok
+        end
+
+        protected
+
+        def render_json_error(error, status)
+          e_message = error.try(:record).try(:errors).try(:full_messages).try(:first)
+          e_message = error.try(:message) if e_message.blank?
+          e_message = error.try(:details) if e_message.blank?
+
+          backtrace = error.try(:backtrace).try(:join, "\n")
+
+          Ibrain::Logger.error e_message
+          Ibrain::Logger.error backtrace
+
+          render json: {
+            errors: [{
+              message: e_message,
+              extensions: {
+                code: status,
+                exception: {
+                  stacktrace: [
+                    backtrace
+                  ]
+                }
+              }
+            }],
+            message: e_message,
+            data: nil
+          }, status: status
+        end
+
+        def render_json_ok(data, message, errors = [])
+          render json: {
+            errors: errors,
+            message: message || I18n.t('ibrain.system.message.ok'),
+            data: data.as_json
+          }, status: :ok
+        end
+      end
+    end
   end
 end

data/lib/ibrain/core/controller_helpers/strong_parameters.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 
-module Ibrain::Core::ControllerHelpers::StrongParameters
-  def permitted_attributes
-    Ibrain::PermittedAttributes
-  end
+module Ibrain
+  module Core
+    module ControllerHelpers
+      module StrongParameters
+        def permitted_attributes
+          Ibrain::PermittedAttributes
+        end
 
-  delegate(*Ibrain::PermittedAttributes::ATTRIBUTES,
-            to: :permitted_attributes,
-            prefix: :permitted)
+        delegate(*Ibrain::PermittedAttributes::ATTRIBUTES,
+                 to: :permitted_attributes,
+                 prefix: :permitted)
 
-  def permitted_user_attributes
-    permitted_attributes.user_attributes
+        def permitted_user_attributes
+          permitted_attributes.user_attributes
+        end
+      end
+    end
   end
 end

data/lib/ibrain/core/engine.rb

@@ -2,11 +2,15 @@
 
 require 'ibrain/config'
 
-class Ibrain::Core::Engine < ::Rails::Engine
-  isolate_namespace Ibrain::Core
-  config.generators.api_only = true
+module Ibrain
+  module Core
+    class Engine < ::Rails::Engine
+      isolate_namespace Ibrain::Core
+      config.generators.api_only = true
 
-  initializer "ibrain.environment", before: :load_config_initializers do |app|
-    app.config.ibrain = Ibrain::Config.environment
+      initializer "ibrain.environment", before: :load_config_initializers do |app|
+        app.config.ibrain = Ibrain::Config.environment
+      end
+    end
   end
 end