ibrain-core 0.4.6 → 0.4.7

data/app/graphql/ibrain/util/query_combiner.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
-class Ibrain::Util::QueryCombiner
-  def self.combine(query_types)
-    Array(query_types).inject({}) do |acc, query_type|
-      acc.merge!(query_type.fields)
+module Ibrain
+  module Util
+    class QueryCombiner
+      def self.combine(query_types)
+        Array(query_types).inject({}) do |acc, query_type|
+          acc.merge!(query_type.fields)
+        end
+      end
     end
   end
 end

data/app/models/concerns/ibrain/soft_deletable.rb

@@ -2,13 +2,15 @@
 
 require 'discard'
 
-module Ibrain::SoftDeletable
-  extend ActiveSupport::Concern
+module Ibrain
+  module SoftDeletable
+    extend ActiveSupport::Concern
 
-  included do
-    include Discard::Model
-    self.discard_column = :deleted_at
+    included do
+      include Discard::Model
+      self.discard_column = :deleted_at
 
-    default_scope { kept }
+      default_scope { kept }
+    end
   end
 end

data/app/models/concerns/ibrain/user_api_authentication.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-module Ibrain::UserApiAuthentication
-  def generate_ibrain_api_key!
-    generate_ibrain_api_key
-    save!
-  end
+module Ibrain
+  module UserApiAuthentication
+    def generate_ibrain_api_key!
+      generate_ibrain_api_key
+      save!
+    end
 
-  def generate_ibrain_api_key
-    self.ibrain_api_key = SecureRandom.hex(24)
-  end
+    def generate_ibrain_api_key
+      self.ibrain_api_key = SecureRandom.hex(24)
+    end
 
-  def clear_ibrain_api_key!
-    clear_ibrain_api_key
-    save!
-  end
+    def clear_ibrain_api_key!
+      clear_ibrain_api_key
+      save!
+    end
 
-  def clear_ibrain_api_key
-    self.ibrain_api_key = nil
+    def clear_ibrain_api_key
+      self.ibrain_api_key = nil
+    end
   end
 end

data/app/models/concerns/ibrain/user_methods.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-module Ibrain::UserMethods
-  extend ActiveSupport::Concern
+module Ibrain
+  module UserMethods
+    extend ActiveSupport::Concern
 
-  include Ibrain::UserApiAuthentication
+    include Ibrain::UserApiAuthentication
 
-  included do
-    after_create :auto_generate_ibrain_api_key
+    included do
+      after_create :auto_generate_ibrain_api_key
 
-    include Ibrain::RansackableAttributes unless included_modules.include?(Ibrain::RansackableAttributes)
-  end
+      include Ibrain::RansackableAttributes unless included_modules.include?(Ibrain::RansackableAttributes)
+    end
 
-  def auto_generate_ibrain_api_key
-    return if !respond_to?(:ibrain_api_key) || ibrain_api_key.present?
+    def auto_generate_ibrain_api_key
+      return if !respond_to?(:ibrain_api_key) || ibrain_api_key.present?
 
-    if Ibrain::Config.generate_api_key_for_all_roles || (ibrain_roles.map(&:name) & Ibrain::Config.roles_for_auto_api_key).any?
-      generate_ibrain_api_key!
+      if Ibrain::Config.generate_api_key_for_all_roles || (ibrain_roles.map(&:name) & Ibrain::Config.roles_for_auto_api_key).any?
+        generate_ibrain_api_key!
+      end
     end
   end
 end

data/app/models/ibrain/ability.rb

@@ -5,46 +5,47 @@
 #
 # See http://github.com/ryanb/cancan for more details on cancan.
 require 'cancan'
+module Ibrain
+  class Ability
+    include CanCan::Ability
 
-class Ibrain::Ability
-  include CanCan::Ability
+    class_attribute :abilities
+    self.abilities = Set.new
 
-  class_attribute :abilities
-  self.abilities = Set.new
+    attr_reader :user
 
-  attr_reader :user
-
-  # Allows us to go beyond the standard cancan initialize method which makes it difficult for engines to
-  # modify the default +Ability+ of an application.  The +ability+ argument must be a class that includes
-  # the +CanCan::Ability+ module.  The registered ability should behave properly as a stand-alone class
-  # and therefore should be easy to test in isolation.
-  def self.register_ability(ability)
-    abilities.add(ability)
-  end
+    # Allows us to go beyond the standard cancan initialize method which makes it difficult for engines to
+    # modify the default +Ability+ of an application.  The +ability+ argument must be a class that includes
+    # the +CanCan::Ability+ module.  The registered ability should behave properly as a stand-alone class
+    # and therefore should be easy to test in isolation.
+    def self.register_ability(ability)
+      abilities.add(ability)
+    end
 
-  def self.remove_ability(ability)
-    abilities.delete(ability)
-  end
+    def self.remove_ability(ability)
+      abilities.delete(ability)
+    end
 
-  def initialize(current_user)
-    @user = current_user || Ibrain.user_class.new
+    def initialize(current_user)
+      @user = current_user || Ibrain.user_class.new
 
-    activate_permission_sets
-    register_extension_abilities
-  end
+      activate_permission_sets
+      register_extension_abilities
+    end
 
-  private
+    private
 
-  # Before, this was the only way to extend this ability. Permission sets have been added since.
-  # It is recommended to use them instead for extension purposes if possible.
-  def register_extension_abilities
-    Ability.abilities.each do |clazz|
-      ability = clazz.send(:new, user)
-      merge(ability)
+    # Before, this was the only way to extend this ability. Permission sets have been added since.
+    # It is recommended to use them instead for extension purposes if possible.
+    def register_extension_abilities
+      Ability.abilities.each do |clazz|
+        ability = clazz.send(:new, user)
+        merge(ability)
+      end
     end
-  end
 
-  def activate_permission_sets
-    Ibrain::Config.roles.activate_permissions! self, user
+    def activate_permission_sets
+      Ibrain::Config.roles.activate_permissions! self, user
+    end
   end
 end

data/app/models/ibrain/aggregate.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-class Ibrain::Aggregate
-  def initialize(count)
-    @count = count
-  end
+module Ibrain
+  class Aggregate
+    def initialize(count)
+      @count = count
+    end
 
-  attr_reader :count
+    attr_reader :count
+  end
 end

data/app/models/ibrain/application_record.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-class Ibrain::ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
+module Ibrain
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
 end

data/app/models/ibrain/legacy_user.rb

@@ -1,13 +1,19 @@
 # frozen_string_literal: true
 
-class Ibrain::LegacyUser < Ibrain::Base
-  include Ibrain::UserMethods
+module Ibrain
+  # Default implementation of User.
+  #
+  # @note This class is intended to be modified by extensions (ex.
+  #   ibrain-auth)
+  class LegacyUser < Ibrain::Base
+    include Ibrain::UserMethods
 
-  self.table_name = 'ibrain_users'
+    self.table_name = 'ibrain_users'
 
-  def self.model_name
-    ActiveModel::Name.new Ibrain::LegacyUser, Ibrain, 'user'
-  end
+    def self.model_name
+      ActiveModel::Name.new Ibrain::LegacyUser, Ibrain, 'user'
+    end
 
-  attr_accessor :password, :password_confirmation
+    attr_accessor :password, :password_confirmation
+  end
 end

data/app/models/ibrain/role.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-class Ibrain::Role < Ibrain::Base
-  has_many :role_users, class_name: "Ibrain::RoleUser", dependent: :destroy
-  has_many :users, through: :role_users
+module Ibrain
+  class Role < Ibrain::Base
+    has_many :role_users, class_name: "Ibrain::RoleUser", dependent: :destroy
+    has_many :users, through: :role_users
 
-  validates :name, uniqueness: { case_sensitive: true }
+    validates :name, uniqueness: { case_sensitive: true }
 
-  def admin?
-    name == "admin"
+    def admin?
+      name == "admin"
+    end
   end
 end

data/app/models/ibrain/role_user.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-class Ibrain::RoleUser < Ibrain::Base
-  belongs_to :role, class_name: "Ibrain::Role", optional: true
-  belongs_to :user, class_name: Ibrain::UserClassHandle.new, optional: true
+module Ibrain
+  class RoleUser < Ibrain::Base
+    belongs_to :role, class_name: "Ibrain::Role", optional: true
+    belongs_to :user, class_name: Ibrain::UserClassHandle.new, optional: true
 
-  after_create :auto_generate_ibrain_api_key
+    after_create :auto_generate_ibrain_api_key
 
-  validates :role_id, uniqueness: { scope: :user_id }
+    validates :role_id, uniqueness: { scope: :user_id }
 
-  private
+    private
 
-  def auto_generate_ibrain_api_key
-    user.try(:auto_generate_ibrain_api_key)
+    def auto_generate_ibrain_api_key
+      user.try(:auto_generate_ibrain_api_key)
+    end
   end
 end

data/app/repositories/ibrain/base_repository.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-class Ibrain::BaseRepository
-  def initialize(current_user, record)
-    @current_user = current_user
-    @record = record
-  end
+module Ibrain
+  class BaseRepository
+    def initialize(current_user, record)
+      @current_user = current_user
+      @record = record
+    end
 
-  attr_reader :current_user, :record
+    attr_reader :current_user, :record
 
-  protected
+    protected
 
-  def cryptor
-    Ibrain::Encryptor.new
+    def cryptor
+      Ibrain::Encryptor.new
+    end
   end
 end

data/lib/generators/ibrain/core/model_generator.rb

@@ -6,29 +6,33 @@ require 'rails/generators/base'
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
 
-class Ibrain::Core::ModelGenerator < Rails::Generators::Base
-  desc "Create a model by name"
-  source_root File.expand_path('templates', __dir__)
+module Ibrain
+  module Core
+    class ModelGenerator < Rails::Generators::Base
+      desc "Create a model by name"
+      source_root File.expand_path('templates', __dir__)
 
-  argument :name, type: :string
+      argument :name, type: :string
 
-  def initialize(args, *options) # :nodoc:
-    # Unfreeze name in case it's given as a frozen string
-    args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
-    super
+      def initialize(args, *options) # :nodoc:
+        # Unfreeze name in case it's given as a frozen string
+        args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
+        super
 
-    assign_names!(name)
-  end
+        assign_names!(name)
+      end
 
-  attr_reader :file_name
+      attr_reader :file_name
 
-  def create_model_file
-    template "model.erb", "app/models/#{file_name}.rb"
-  end
+      def create_model_file
+        template "model.erb", "app/models/#{file_name}.rb"
+      end
 
-  private
+      private
 
-  def assign_names!(name)
-    @file_name = name.underscore
+      def assign_names!(name)
+        @file_name = name.underscore
+      end
+    end
   end
 end

data/lib/generators/ibrain/graphql/core.rb

@@ -2,74 +2,78 @@
 
 require 'rails/generators/base'
 
-module Ibrain::Graphql::Core
-  def self.included(base)
-    base.send(
-      :class_option,
-      :directory,
-      type: :string,
-      default: "app/graphql",
-      desc: "Directory where generated files should be saved"
-    )
-  end
+module Ibrain
+  module Graphql
+    module Core
+      def self.included(base)
+        base.send(
+          :class_option,
+          :directory,
+          type: :string,
+          default: "app/graphql",
+          desc: "Directory where generated files should be saved"
+        )
+      end
 
-  def insert_root_type(type, name)
-    log :add_root_type, type
-    sentinel = /< GraphQL::Schema\s*\n/m
+      def insert_root_type(type, name)
+        log :add_root_type, type
+        sentinel = /< GraphQL::Schema\s*\n/m
 
-    in_root do
-      if File.exist?(schema_file_path)
-        inject_into_file schema_file_path, "  #{type}(Types::#{name})\n", after: sentinel, verbose: false, force: false
+        in_root do
+          if File.exist?(schema_file_path)
+            inject_into_file schema_file_path, "  #{type}(Types::#{name})\n", after: sentinel, verbose: false, force: false
+          end
+        end
       end
-    end
-  end
 
-  def create_mutation_root_type
-    create_dir("#{options[:directory]}/mutations")
-    insert_root_type('mutation', 'MutationType')
-  end
+      def create_mutation_root_type
+        create_dir("#{options[:directory]}/mutations")
+        insert_root_type('mutation', 'MutationType')
+      end
 
-  def create_resolver_root_type
-    create_dir("#{options[:directory]}/resolvers")
-    insert_root_type('query', 'QueryType')
-  end
+      def create_resolver_root_type
+        create_dir("#{options[:directory]}/resolvers")
+        insert_root_type('query', 'QueryType')
+      end
 
-  def create_repository_root_type
-    create_dir("app/repositories")
-  end
+      def create_repository_root_type
+        create_dir("app/repositories")
+      end
 
-  def schema_file_path
-    "#{options[:directory]}/#{schema_name.underscore}.rb"
-  end
+      def schema_file_path
+        "#{options[:directory]}/#{schema_name.underscore}.rb"
+      end
 
-  def create_dir(dir)
-    empty_directory(dir)
-    if !options[:skip_keeps]
-      create_file("#{dir}/.keep")
-    end
-  end
+      def create_dir(dir)
+        empty_directory(dir)
+        if !options[:skip_keeps]
+          create_file("#{dir}/.keep")
+        end
+      end
 
-  def module_namespacing_when_supported(&block)
-    if defined?(module_namespacing)
-      module_namespacing(&block)
-    else
-      yield
-    end
-  end
+      def module_namespacing_when_supported(&block)
+        if defined?(module_namespacing)
+          module_namespacing(&block)
+        else
+          yield
+        end
+      end
 
-  private
+      private
 
-  def schema_name
-    @schema_name ||= options[:schema] || "#{parent_name}Schema"
-  end
+      def schema_name
+        @schema_name ||= options[:schema] || "#{parent_name}Schema"
+      end
 
-  def parent_name
-    require File.expand_path("config/application", destination_root)
+      def parent_name
+        require File.expand_path("config/application", destination_root)
 
-    if Rails.application.class.respond_to?(:module_parent_name)
-      Rails.application.class.module_parent_name
-    else
-      Rails.application.class.parent_name
+        if Rails.application.class.respond_to?(:module_parent_name)
+          Rails.application.class.module_parent_name
+        else
+          Rails.application.class.parent_name
+        end
+      end
     end
   end
 end

data/lib/generators/ibrain/graphql/mutation_generator.rb

@@ -4,63 +4,71 @@ require 'rails/generators'
 require 'rails/generators/named_base'
 require_relative 'core'
 
-class Ibrain::Graphql::MutationGenerator < Rails::Generators::Base
-  include Core
-
-  desc "Create a Relay Classic mutation by name"
-  source_root File.expand_path('templates', __dir__)
-
-  argument :name, type: :string
-  class_option :model, type: :string, default: nil
-  class_option :prefix, type: :string, default: nil
-
-  def initialize(args, *options) # :nodoc:
-    # Unfreeze name in case it's given as a frozen string
-    args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
-    super
-
-    assign_names!(name)
-  end
-
-  attr_reader :file_name, :mutation_name, :field_name, :model_name
-
-  def create_mutation_file
-    if @behavior == :revoke
-      log :gsub, "#{options[:directory]}/types/mutation_type.rb"
-    else
-      create_mutation_root_type
+module Ibrain
+  module Graphql
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::RelayClassicMutation` by name
+    #     rails g graphql:mutation CreatePostMutation
+    class MutationGenerator < Rails::Generators::Base
+      include Core
+
+      desc "Create a Relay Classic mutation by name"
+      source_root File.expand_path('templates', __dir__)
+
+      argument :name, type: :string
+      class_option :model, type: :string, default: nil
+      class_option :prefix, type: :string, default: nil
+
+      def initialize(args, *options) # :nodoc:
+        # Unfreeze name in case it's given as a frozen string
+        args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
+        super
+
+        assign_names!(name)
+      end
+
+      attr_reader :file_name, :mutation_name, :field_name, :model_name
+
+      def create_mutation_file
+        if @behavior == :revoke
+          log :gsub, "#{options[:directory]}/types/mutation_type.rb"
+        else
+          create_mutation_root_type
+        end
+
+        if options[:model].present?
+          system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
+        end
+
+        template "mutation.erb", "#{options[:directory]}/mutations/#{file_name}.rb"
+        return unless ::Ibrain::Config.is_auto_append_mutation
+
+        in_root do
+          gsub_file "#{options[:directory]}/types/mutation_type.rb", /  \# TODO: Add Mutations as fields\s*\n/m, ""
+          inject_into_file "#{options[:directory]}/types/mutation_type.rb", "\n    field :#{field_name}, mutation: Mutations::#{mutation_name} \n  ", before: "end\nend", verbose: true, force: true
+        end
+      end
+
+      private
+
+      def assign_names!(name)
+        underscore_name = name&.camelize&.underscore
+        prefix = options[:prefix].try(:underscore)
+        @model_name = options[:model].blank? ? 'Post' : options[:model].try(:camelize, :upper)
+
+        if prefix.blank?
+          @mutation_name = name.camelize(:upper)
+          @file_name = underscore_name
+          @field_name = underscore_name
+
+          return
+        end
+
+        @mutation_name = "#{prefix.try(:camelize, :upper)}::#{name.camelize(:upper)}"
+        @file_name = "#{prefix}/#{underscore_name}"
+        @field_name = "#{prefix}_#{underscore_name}"
+      end
     end
-
-    if options[:model].present?
-      system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
-    end
-
-    template "mutation.erb", "#{options[:directory]}/mutations/#{file_name}.rb"
-    return unless ::Ibrain::Config.is_auto_append_mutation
-
-    in_root do
-      gsub_file "#{options[:directory]}/types/mutation_type.rb", /  \# TODO: Add Mutations as fields\s*\n/m, ""
-      inject_into_file "#{options[:directory]}/types/mutation_type.rb", "\n    field :#{field_name}, mutation: Mutations::#{mutation_name} \n  ", before: "end\nend", verbose: true, force: true
-    end
-  end
-
-  private
-
-  def assign_names!(name)
-    underscore_name = name&.camelize&.underscore
-    prefix = options[:prefix].try(:underscore)
-    @model_name = options[:model].blank? ? 'Post' : options[:model].try(:camelize, :upper)
-
-    if prefix.blank?
-      @mutation_name = name.camelize(:upper)
-      @file_name = underscore_name
-      @field_name = underscore_name
-
-      return
-    end
-
-    @mutation_name = "#{prefix.try(:camelize, :upper)}::#{name.camelize(:upper)}"
-    @file_name = "#{prefix}/#{underscore_name}"
-    @field_name = "#{prefix}_#{underscore_name}"
   end
-end
+end