ibrain-core 0.4.5 → 0.4.6

data/lib/ibrain/core/environment.rb

@@ -2,16 +2,12 @@
 
 require 'ibrain/core/environment_extension'
 
-module Ibrain
-  module Core
-    class Environment
-      include EnvironmentExtension
+class Ibrain::Core::Environment
+  include Ibrain::Core::EnvironmentExtension
 
-      attr_accessor :preferences
+  attr_accessor :preferences
 
-      def initialize(ibrain_config)
-        @preferences = ibrain_config
-      end
-    end
+  def initialize(ibrain_config)
+    @preferences = ibrain_config
   end
 end

data/lib/ibrain/core/environment_extension.rb

@@ -2,25 +2,21 @@
 
 require 'ibrain/core/class_constantizer'
 
-module Ibrain
-  module Core
-    module EnvironmentExtension
-      extend ActiveSupport::Concern
+module Ibrain::Core::EnvironmentExtension
+  extend ActiveSupport::Concern
 
-      class_methods do
-        def add_class_set(name)
-          define_method(name) do
-            set = instance_variable_get("@#{name}")
-            set ||= send("#{name}=", [])
-            set
-          end
+  class_methods do
+    def add_class_set(name)
+      define_method(name) do
+        set = instance_variable_get("@#{name}")
+        set ||= send("#{name}=", [])
+        set
+      end
 
-          define_method("#{name}=") do |klasses|
-            set = ClassConstantizer::Set.new
-            set.concat(klasses)
-            instance_variable_set("@#{name}", set)
-          end
-        end
+      define_method("#{name}=") do |klasses|
+        set = ClassConstantizer::Set.new
+        set.concat(klasses)
+        instance_variable_set("@#{name}", set)
       end
     end
   end

data/lib/ibrain/core/role_configuration.rb

@@ -3,70 +3,68 @@
 require 'singleton'
 require 'ibrain/core/class_constantizer'
 
-module Ibrain
-  # A class responsible for associating {Ibrain::Role} with a list of permission sets.
-  #
-  # @see Ibrain::PermissionSets
-  #
-  # @example Adding order, data, and user display to customer service users.
-  #   Ibrain::RoleConfiguration.configure do |config|
-  #     config.assign_permissions :customer_service, [
-  #       Ibrain::PermissionSets::UserDisplay,
-  #     ]
-  #   end
-  class RoleConfiguration
-    # An internal structure for the association between a role and a
-    # set of permissions.
-    class Role
-      attr_reader :name, :permission_sets
+# A class responsible for associating {Ibrain::Role} with a list of permission sets.
+#
+# @see Ibrain::PermissionSets
+#
+# @example Adding order, data, and user display to customer service users.
+#   Ibrain::RoleConfiguration.configure do |config|
+#     config.assign_permissions :customer_service, [
+#       Ibrain::PermissionSets::UserDisplay,
+#     ]
+#   end
+class Ibrain::RoleConfiguration
+  # An internal structure for the association between a role and a
+  # set of permissions.
+  class Role
+    attr_reader :name, :permission_sets
 
-      def initialize(name, permission_sets)
-        @name = name
-        @permission_sets = Ibrain::Core::ClassConstantizer::Set.new
-        @permission_sets.concat permission_sets
-      end
+    def initialize(name, permission_sets)
+      @name = name
+      @permission_sets = Ibrain::Core::ClassConstantizer::Set.new
+      @permission_sets.concat permission_sets
     end
+  end
 
-    attr_accessor :roles
+  attr_accessor :roles
 
-    # Given a CanCan::Ability, and a user, determine what permissions sets can
-    # be activated on the ability, then activate them.
-    #
-    # This performs can/cannot declarations on the ability, and can modify its
-    # internal permissions.
-    #
-    # @param ability [CanCan::Ability] the ability to invoke declarations on
-    # @param user [#roles] the user that holds the roles association.
-    def activate_permissions!(ability, user)
-      ibrain_roles = ['default'] | user.roles.map(&:name)
-      applicable_permissions = Set.new
+  # Given a CanCan::Ability, and a user, determine what permissions sets can
+  # be activated on the ability, then activate them.
+  #
+  # This performs can/cannot declarations on the ability, and can modify its
+  # internal permissions.
+  #
+  # @param ability [CanCan::Ability] the ability to invoke declarations on
+  # @param user [#roles] the user that holds the roles association.
+  def activate_permissions!(ability, user)
+    ibrain_roles = ['default'] | user.roles.map(&:name)
+    applicable_permissions = Set.new
 
-      ibrain_roles.each do |role_name|
-        applicable_permissions |= roles[role_name].permission_sets
-      end
+    ibrain_roles.each do |role_name|
+      applicable_permissions |= roles[role_name].permission_sets
+    end
 
-      applicable_permissions.each do |permission_set|
-        permission_set.new(ability).activate!
-      end
+    applicable_permissions.each do |permission_set|
+      permission_set.new(ability).activate!
     end
+  end
 
-    # Not public due to the fact this class is a Singleton
-    # @!visibility private
-    def initialize
-      @roles = Hash.new do |hash, name|
-        hash[name] = Role.new(name, Set.new)
-      end
+  # Not public due to the fact this class is a Singleton
+  # @!visibility private
+  def initialize
+    @roles = Hash.new do |hash, name|
+      hash[name] = Role.new(name, Set.new)
     end
+  end
 
-    # Assign permission sets for a {Ibrain::Role} that has the name of role_name
-    # @param role_name [Symbol, String] The name of the role to associate permissions with
-    # @param permission_sets [Array<Ibrain::PermissionSets::Base>, Set<Ibrain::PermissionSets::Base>]
-    #   A list of permission sets to activate if the user has the role indicated by role_name
-    def assign_permissions(role_name, permission_sets)
-      name = role_name.to_s
+  # Assign permission sets for a {Ibrain::Role} that has the name of role_name
+  # @param role_name [Symbol, String] The name of the role to associate permissions with
+  # @param permission_sets [Array<Ibrain::PermissionSets::Base>, Set<Ibrain::PermissionSets::Base>]
+  #   A list of permission sets to activate if the user has the role indicated by role_name
+  def assign_permissions(role_name, permission_sets)
+    name = role_name.to_s
 
-      roles[name].permission_sets.concat permission_sets
-      roles[name]
-    end
+    roles[name].permission_sets.concat permission_sets
+    roles[name]
   end
 end

data/lib/ibrain/core/validators/email.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
 
-module Ibrain
-  # == An ActiveModel Email Validator
-  #
-  # === Usage
-  #
-  #     require 'ibrain/core/validators/email'
-  #
-  #     class Person < ApplicationRecord
-  #       validates :email_address, 'ibrain/email' => true
-  #     end
-  #
-  class EmailValidator < ActiveModel::EachValidator
-    EMAIL_REGEXP = URI::MailTo::EMAIL_REGEXP
+# == An ActiveModel Email Validator
+#
+# === Usage
+#
+#     require 'ibrain/core/validators/email'
+#
+#     class Person < ApplicationRecord
+#       validates :email_address, 'ibrain/email' => true
+#     end
+#
+class Ibrain::EmailValidator < ActiveModel::EachValidator
+  EMAIL_REGEXP = URI::MailTo::EMAIL_REGEXP
 
-    def validate_each(record, attribute, value)
-      unless EMAIL_REGEXP.match? value
-        record.errors.add(attribute, :invalid, **{ value: value }.merge!(options))
-      end
+  def validate_each(record, attribute, value)
+    unless EMAIL_REGEXP.match? value
+      record.errors.add(attribute, :invalid, **{ value: value }.merge!(options))
     end
   end
 end

data/lib/ibrain/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Ibrain
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 
   def self.ibrain_version
     VERSION
   end
 
   def self.previous_ibrain_minor_version
-    '0.4.4'
+    '0.4.5'
   end
 
   def self.ibrain_gem_version

data/lib/ibrain/core/versioned_value.rb

@@ -1,73 +1,69 @@
 # frozen_string_literal: true
 
-module Ibrain
-  module Core
-    # Wrapper for a value that can be different depending on the Ibrain version
-    #
-    # Some configuration defaults can be added or changed when a new Ibrain
-    # version is released. This class encapsulates getting the correct value for a
-    # given Ibrain version.
-    #
-    # The way it works is you provide an initial value in time, plus the version
-    # boundary where it got changed. Then you can fetch the value providing the
-    # desired Ibrain version:
-    #
-    # @example
-    #   value = VersionedValue.new(true, "3.0.0" => false)
-    #   value.call("2.7.0") # => true
-    #   value.call("3.0.0") # => false
-    #   value.call("3.1.0") # => false
-    #
-    # Remember that you must provide the exact boundary when a value got changed,
-    # which could easily be during a pre-release:
-    #
-    # @example
-    #   value = VersionedValue.new(true, "3.0.0" => false)
-    #   value.call("3.0.0.alpha") # => true
-    #
-    #   value = VersionedValue.new(true, "3.0.0.alpha" => false)
-    #   value.call("3.0.0.alpha") # => false
-    #
-    # Multiple boundaries can also be provided:
-    #
-    # @example
-    #   value = VersionedValue.new(0, "2.0.0" => 1, "3.0.0" => 2)
-    #   value.call("1.0.0") # => 0
-    #   value.call("2.1.0") # => 1
-    #   value.call("3.0.0") # => 2
-    class VersionedValue
-      attr_reader :boundaries
+# Wrapper for a value that can be different depending on the Ibrain version
+#
+# Some configuration defaults can be added or changed when a new Ibrain
+# version is released. This class encapsulates getting the correct value for a
+# given Ibrain version.
+#
+# The way it works is you provide an initial value in time, plus the version
+# boundary where it got changed. Then you can fetch the value providing the
+# desired Ibrain version:
+#
+# @example
+#   value = VersionedValue.new(true, "3.0.0" => false)
+#   value.call("2.7.0") # => true
+#   value.call("3.0.0") # => false
+#   value.call("3.1.0") # => false
+#
+# Remember that you must provide the exact boundary when a value got changed,
+# which could easily be during a pre-release:
+#
+# @example
+#   value = VersionedValue.new(true, "3.0.0" => false)
+#   value.call("3.0.0.alpha") # => true
+#
+#   value = VersionedValue.new(true, "3.0.0.alpha" => false)
+#   value.call("3.0.0.alpha") # => false
+#
+# Multiple boundaries can also be provided:
+#
+# @example
+#   value = VersionedValue.new(0, "2.0.0" => 1, "3.0.0" => 2)
+#   value.call("1.0.0") # => 0
+#   value.call("2.1.0") # => 1
+#   value.call("3.0.0") # => 2
+class Ibrain::Core::VersionedValue
+  attr_reader :boundaries
 
-      # @param initial_value [Any]
-      # @param boundary [Hash<String, Any>] Map from version number to new value
-      def initialize(initial_value, boundaries = {})
-        @boundaries = { '0' => initial_value }
-                        .merge(boundaries)
-                        .transform_keys { |version| to_gem_version(version) }
-                        .sort.to_h
-      end
+  # @param initial_value [Any]
+  # @param boundary [Hash<String, Any>] Map from version number to new value
+  def initialize(initial_value, boundaries = {})
+    @boundaries = { '0' => initial_value }
+                    .merge(boundaries)
+                    .transform_keys { |version| to_gem_version(version) }
+                    .sort.to_h
+  end
 
-      # @param ibrain_version [String]
-      def call(ibrain_version = Ibrain.ibrain_version)
-        ibrain_version = to_gem_version(ibrain_version)
-        boundaries.fetch(
-          boundaries
-            .keys
-            .reduce do |target, following|
-              if target <= ibrain_version && ibrain_version < following
-                target
-              else
-                following
-              end
-            end
-        )
-      end
+  # @param ibrain_version [String]
+  def call(ibrain_version = Ibrain.ibrain_version)
+    ibrain_version = to_gem_version(ibrain_version)
+    boundaries.fetch(
+      boundaries
+        .keys
+        .reduce do |target, following|
+          if target <= ibrain_version && ibrain_version < following
+            target
+          else
+            following
+          end
+        end
+    )
+  end
 
-      private
+  private
 
-      def to_gem_version(string)
-        Gem::Version.new(string)
-      end
-    end
+  def to_gem_version(string)
+    Gem::Version.new(string)
   end
 end

data/lib/ibrain/encryptor.rb

@@ -1,27 +1,25 @@
 # frozen_string_literal: true
 
-module Ibrain
-  # Ibrain::Encryptor is a thin wrapper around ActiveSupport::MessageEncryptor.
-  class Encryptor
-    # @param key [String] the 256 bits signature key
-    def initialize(key = Ibrain::Config.ibrain_encryptor_key)
-      key = Rails.application.secrets.secret_key_base.byteslice(0..31) if key.blank?
+# Ibrain::Encryptor is a thin wrapper around ActiveSupport::MessageEncryptor.
+class Ibrain::Encryptor
+  # @param key [String] the 256 bits signature key
+  def initialize(key = Ibrain::Config.ibrain_encryptor_key)
+    key = Rails.application.secrets.secret_key_base.byteslice(0..31) if key.blank?
 
-      @crypt = ActiveSupport::MessageEncryptor.new(key)
-    end
+    @crypt = ActiveSupport::MessageEncryptor.new(key)
+  end
 
-    # Encrypt a value
-    # @param value [String] the value to encrypt
-    # @return [String] the encrypted value
-    def encrypt(value)
-      @crypt.encrypt_and_sign(value)
-    end
+  # Encrypt a value
+  # @param value [String] the value to encrypt
+  # @return [String] the encrypted value
+  def encrypt(value)
+    @crypt.encrypt_and_sign(value)
+  end
 
-    # Decrypt an encrypted value
-    # @param encrypted_value [String] the value to decrypt
-    # @return [String] the decrypted value
-    def decrypt(encrypted_value)
-      @crypt.decrypt_and_verify(encrypted_value)
-    end
+  # Decrypt an encrypted value
+  # @param encrypted_value [String] the value to decrypt
+  # @return [String] the decrypted value
+  def decrypt(encrypted_value)
+    @crypt.decrypt_and_verify(encrypted_value)
   end
 end

data/lib/ibrain/logger.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
 
-module Ibrain
-  class Logger
-    class << self
-      def info(message)
-        Rails.logger.info("[Ibrain] #{message}")
-      end
+class Ibrain::Logger
+  class << self
+    def info(message)
+      Rails.logger.info("[Ibrain] #{message}")
+    end
 
-      def warn(message)
-        Rails.logger.warn("[Ibrain] #{message}")
-      end
+    def warn(message)
+      Rails.logger.warn("[Ibrain] #{message}")
+    end
 
-      def debug(message)
-        Rails.logger.debug { "[Ibrain] #{message}" }
-      end
+    def debug(message)
+      Rails.logger.debug { "[Ibrain] #{message}" }
+    end
 
-      def error(message)
-        Rails.logger.error("[Ibrain] #{message}")
-      end
+    def error(message)
+      Rails.logger.error("[Ibrain] #{message}")
     end
   end
 end

data/lib/ibrain/permission_sets/base.rb

@@ -1,33 +1,29 @@
 # frozen_string_literal: true
 
-module Ibrain
-  module PermissionSets
-    # This is the base class used for crafting permission sets.
-    #
-    # This is used by {Ibrain::RoleConfiguration} when adding custom behavior to {Ibrain::Ability}.
-    # See one of the subclasses for example structure such as {Ibrain::PermissionSets::UserDisplay}
-    #
-    # @see Ibrain::RoleConfiguration
-    # @see Ibrain::PermissionSets
-    class Base
-      # @param ability [CanCan::Ability]
-      #   The ability that will be extended with the current permission set.
-      #   The ability passed in must respond to #user
-      def initialize(ability)
-        @ability = ability
-      end
+# This is the base class used for crafting permission sets.
+#
+# This is used by {Ibrain::RoleConfiguration} when adding custom behavior to {Ibrain::Ability}.
+# See one of the subclasses for example structure such as {Ibrain::PermissionSets::UserDisplay}
+#
+# @see Ibrain::RoleConfiguration
+# @see Ibrain::PermissionSets
+class Ibrain::PermissionSets::Base
+  # @param ability [CanCan::Ability]
+  #   The ability that will be extended with the current permission set.
+  #   The ability passed in must respond to #user
+  def initialize(ability)
+    @ability = ability
+  end
 
-      # Activate permissions on the ability. Put your can and cannot statements here.
-      # Must be overriden by subclasses
-      def activate!
-        raise NotImplementedError.new
-      end
+  # Activate permissions on the ability. Put your can and cannot statements here.
+  # Must be overriden by subclasses
+  def activate!
+    raise NotImplementedError.new
+  end
 
-      private
+  private
 
-      attr_reader :ability
+  attr_reader :ability
 
-      delegate :can, :cannot, :user, to: :ability
-    end
-  end
+  delegate :can, :cannot, :user, to: :ability
 end

data/lib/ibrain/permission_sets/super_user.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-module Ibrain
-  module PermissionSets
-    class SuperUser < PermissionSets::Base
-      def activate!
-        can :manage, :all
-      end
-    end
+class Ibrain::PermissionSets::SuperUser < PermissionSets::Base
+  def activate!
+    can :manage, :all
   end
 end

data/lib/ibrain/permitted_attributes.rb

@@ -1,26 +1,24 @@
 # frozen_string_literal: true
 
-module Ibrain
-  # Ibrain::PermittedAttributes contains the attributes permitted through strong
-  # params in various controllers in the frontend. Extensions and stores that
-  # need additional params to be accepted can mutate these arrays to add them.
-  module PermittedAttributes
-    ATTRIBUTES = [
-      :address_attributes,
-      :user_attributes
-    ]
+# Ibrain::PermittedAttributes contains the attributes permitted through strong
+# params in various controllers in the frontend. Extensions and stores that
+# need additional params to be accepted can mutate these arrays to add them.
+module Ibrain::PermittedAttributes
+  ATTRIBUTES = [
+    :address_attributes,
+    :user_attributes
+  ]
 
-    mattr_reader(*ATTRIBUTES)
+  mattr_reader(*ATTRIBUTES)
 
-    @@address_attributes = [
-      :id, :name, :address1, :address2, :city, :country_id, :state_id,
-      :zipcode, :phone, :state_name, :province_id, :ward_id, :district_id
-    ]
+  @@address_attributes = [
+    :id, :name, :address1, :address2, :city, :country_id, :state_id,
+    :zipcode, :phone, :state_name, :province_id, :ward_id, :district_id
+  ]
 
-    # Intentionally leaving off email here to prevent privilege escalation
-    # by changing a user with higher priveleges' email to one a lower-priveleged
-    # admin owns. Creating a user with an email is handled separate at the
-    # controller level.
-    @@user_attributes = [:name, :email, :provider, :uid, :first_name, :last_name, :password, :password_confirmation]
-  end
+  # Intentionally leaving off email here to prevent privilege escalation
+  # by changing a user with higher priveleges' email to one a lower-priveleged
+  # admin owns. Creating a user with an email is handled separate at the
+  # controller level.
+  @@user_attributes = [:name, :email, :provider, :uid, :first_name, :last_name, :password, :password_confirmation]
 end