praxis 2.0.pre.18 → 2.0.pre.19

data/lib/praxis/bootloader.rb

@@ -1,13 +1,12 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   class Bootloader
-
-    attr_reader :application
-    attr_reader :stages
+    attr_reader :application, :stages
 
     def initialize(application)
       @application = application
-      @stages = Array.new
+      @stages = []
 
       setup_stages!
     end
@@ -26,7 +25,7 @@ module Praxis
 
       # then setup plugins
       stages << BootloaderStages::PluginLoader.new(:plugins, application)
-      
+
       # then the initializers. as it is their job to ensure monkey patches and other
       # config is in place first.
       stages << BootloaderStages::FileLoader.new(:initializers, application)
@@ -50,24 +49,18 @@ module Praxis
         Praxis::Blueprint.finalize!
         Praxis::EndpointDefinition.finalize!
       end
-
     end
 
     def delete_stage(stage_name)
-      if (stage = stages.find { |stage| stage.name == stage_name })
-        stages.delete(stage)
-      else
-        raise Exceptions::StageNotFound.new(
-          "Cannot remove stage with name #{stage_name}, stage does not exist."
-        )
-      end
-    end
+      raise Exceptions::StageNotFound, "Cannot remove stage with name #{stage_name}, stage does not exist." unless (stage = stages.find { |s| s.name == stage_name })
 
+      stages.delete(stage)
+    end
 
     def before(*stage_path, &block)
       stage_name = stage_path.shift
       the_stage = stages.find { |stage| stage.name == stage_name }
-      raise Exceptions::StageNotFound.new("Error running a before block for stage #{stage_name}") unless the_stage
+      raise Exceptions::StageNotFound, "Error running a before block for stage #{stage_name}" unless the_stage
 
       the_stage.before(*stage_path, &block)
     end
@@ -75,36 +68,37 @@ module Praxis
     def after(*stage_path, &block)
       stage_name = stage_path.shift
       the_stage = stages.find { |stage| stage.name == stage_name }
-      raise Exceptions::StageNotFound.new("Error running an after block for stage #{stage_name}") unless the_stage
+      raise Exceptions::StageNotFound, "Error running an after block for stage #{stage_name}" unless the_stage
 
       the_stage.after(*stage_path, &block)
     end
 
-    def use(plugin,**options, &block)
+    def use(plugin, **options, &block)
       if plugin.ancestors.include?(PluginConcern)
         plugin.setup!
         plugin = plugin::Plugin
       end
 
       instance = if plugin.ancestors.include?(Singleton)
-        plugin.instance
-      elsif plugin.kind_of?(Class)
-        plugin.new
-      else
-        plugin
-      end
+                   plugin.instance
+                 elsif plugin.is_a?(Class)
+                   plugin.new
+                 else
+                   plugin
+                 end
 
       instance.application = application
       instance.options.merge!(options)
       instance.block = block if block_given?
 
       config_key = if instance.config_key.nil?
-        raise "Cannot use plugin: #{plugin}. It does not have a config_key defined, and its class does not have a name" unless instance.class.name
-        # Default the config key based on the full class name transformed to snake case (and joining modules with '_')
-        instance.class.name.to_s.split('::').collect{|n| n.underscore }.join('_').to_sym
-      else
-        instance.config_key
-      end
+                     raise "Cannot use plugin: #{plugin}. It does not have a config_key defined, and its class does not have a name" unless instance.class.name
+
+                     # Default the config key based on the full class name transformed to snake case (and joining modules with '_')
+                     instance.class.name.to_s.split('::').collect(&:underscore).join('_').to_sym
+                   else
+                     instance.config_key
+                   end
 
       if application.plugins.key?(instance.config_key)
         used_in = application.plugins[config_key].class
@@ -128,8 +122,5 @@ module Praxis
         stage.run
       end
     end
-
   end
-
-
 end

data/lib/praxis/bootloader_stages/environment.rb

@@ -1,21 +1,18 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class Environment < Stage
-
       # require environment files. we will require 2 files:
       # 1) the environment.rb file    - generic stuff for all environments
       # 2) "Deployer.environment".rb  - environment specific stuff
       def execute
         setup_initial_config!
 
-        env_file = application.root + "config/environment.rb"
-        require env_file if File.exists? env_file
+        env_file = application.root / 'config/environment.rb'
+        require env_file if File.exist? env_file
 
-        unless application.file_layout
-          setup_default_layout!
-        end
+        setup_default_layout! unless application.file_layout
       end
 
       def setup_default_layout!
@@ -52,8 +49,6 @@ module Praxis
           end
         end
       end
-
     end
-
   end
 end

data/lib/praxis/bootloader_stages/file_loader.rb

@@ -1,10 +1,8 @@
-module Praxis
-
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class FileLoader < Stage
-
       attr_reader :path
 
       def initialize(name, application, path: nil)
@@ -16,6 +14,7 @@ module Praxis
         application.file_layout[*path].each do |file|
           next if application.loaded_files.include?(file)
           next unless file.extname == '.rb'
+
           require file
           application.loaded_files << file
         end
@@ -24,8 +23,6 @@ module Praxis
       def callback_args
         application.file_layout[*path]
       end
-
     end
   end
-
 end

data/lib/praxis/bootloader_stages/plugin_config_load.rb

@@ -1,21 +1,19 @@
+# frozen_string_literal: true
+
 module Praxis
   module BootloaderStages
     class PluginConfigLoad < Stage
-
       def execute
         application.plugins.each do |config_key, plugin|
           context = [plugin.class.name]
           value = plugin.load_config!
           object = plugin.config_attribute.load(value, context)
 
-          if object
-            application.config.send("#{config_key}=", object)
-          end
+          application.config.send("#{config_key}=", object) if object
 
-          plugin.config = application.config.send("#{config_key}")
+          plugin.config = application.config.send(config_key.to_s)
         end
       end
-
     end
   end
 end

data/lib/praxis/bootloader_stages/plugin_config_prepare.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Praxis
   module BootloaderStages
     class PluginConfigPrepare < Stage
-
       def execute
         application.plugins.each do |config_key, plugin|
           attribute = Attributor::Attribute.new(Attributor::Struct) {}
@@ -12,7 +13,6 @@ module Praxis
           application.config.class.attributes[config_key] = plugin.config_attribute
         end
       end
-
     end
   end
 end

data/lib/praxis/bootloader_stages/plugin_loader.rb

@@ -1,19 +1,15 @@
-module Praxis
-
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class PluginLoader < Stage
-
-      def initialize(name, context,**opts)
+      def initialize(name, context, **opts)
         super
 
         stages << PluginConfigPrepare.new(:prepare, context, parent: self)
         stages << PluginConfigLoad.new(:load, context, parent: self)
         stages << PluginSetup.new(:setup, context, parent: self)
       end
-
     end
-
   end
 end

data/lib/praxis/bootloader_stages/plugin_setup.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module Praxis
   module BootloaderStages
     class PluginSetup < Stage
-
       def execute
-        application.plugins.each do |config_key, plugin|
+        application.plugins.each do |_config_key, plugin|
           plugin.setup!
         end
       end
-
     end
   end
 end

data/lib/praxis/bootloader_stages/routing.rb

@@ -1,17 +1,17 @@
-module Praxis
-
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class Routing < Stage
       class Target
         attr_reader :action
+
         def initialize(application, controller, action)
           @application = application
           @controller = controller
           @action = action
         end
-        
+
         def call(request)
           request.action = @action
           dispatcher = Dispatcher.current(application: @application)
@@ -19,7 +19,7 @@ module Praxis
           dispatcher.dispatch(@controller, @action, request)
         end
       end
-      
+
       def execute
         application.controllers.each do |controller|
           controller.definition.actions.each do |action_name, action|
@@ -29,14 +29,11 @@ module Praxis
         end
       end
 
-
       def target_factory(controller, action_name)
         action = controller.definition.actions.fetch(action_name)
 
         Target.new(application, controller, action)
       end
-
     end
-
   end
 end

data/lib/praxis/bootloader_stages/subgroup_loader.rb

@@ -1,17 +1,10 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class SubgroupLoader < Stage
-
       attr_writer :order
 
-      def initialize(name, application)
-        super
-        # always finalize Taylor after loading app code.
-
-      end
-
       def order
         @order ||= application.file_layout[name] == [] ? [] : application.file_layout[name].groups.keys
       end
@@ -23,6 +16,5 @@ module Praxis
         setup_deferred_callbacks!
       end
     end
-
   end
 end

data/lib/praxis/bootloader_stages/warn_unloaded_files.rb

@@ -1,28 +1,26 @@
-module Praxis
-
+# frozen_string_literal: true
 
+module Praxis
   module BootloaderStages
-
     class WarnUnloadedFiles < Stage
       @enabled = true
 
-      def self.enabled=(enabled)
-        @enabled = enabled
+      class << self
+        attr_writer :enabled
       end
 
-      def self.enabled
-        @enabled
+      class << self
+        attr_reader :enabled
       end
 
       def execute
         return unless self.class.enabled
 
-        if application.file_layout[:app] == []
-          return
-        end
+        return if application.file_layout[:app] == []
 
         base = application.file_layout[:app].base
         return unless base.exist?
+
         file_enum = base.find.to_a
         files = file_enum.select do |file|
           path = file.relative_path_from(base)
@@ -30,17 +28,15 @@ module Praxis
         end
 
         missing = Set.new(files) - application.loaded_files
-        if missing.any?
-          msg = "The following application files under #{base} were not loaded:\n"
-          missing.each do |file|
-            path = file.relative_path_from(base)
-            msg << " * #{path}\n"
-          end
-          warn msg
+        return unless missing.any?
+
+        msg = "The following application files under #{base} were not loaded:\n"
+        missing.each do |file|
+          path = file.relative_path_from(base)
+          msg << " * #{path}\n"
         end
+        warn msg
       end
-
-
     end
   end
 end

data/lib/praxis/callbacks.rb

@@ -1,33 +1,34 @@
+# frozen_string_literal: true
+
 module Praxis
   module Callbacks
     extend ::ActiveSupport::Concern
 
     included do
       class_attribute :before_callbacks, :after_callbacks, :around_callbacks
-      self.before_callbacks = Hash.new
-      self.after_callbacks = Hash.new
-      self.around_callbacks = Hash.new
+      self.before_callbacks = ({})
+      self.after_callbacks = ({})
+      self.around_callbacks = ({})
     end
-    
+
     module ClassMethods
- 
       def before(*stage_path, **conditions, &block)
         stage_path = [:action] if stage_path.empty?
-        before_callbacks[stage_path] ||= Array.new
+        before_callbacks[stage_path] ||= []
         before_callbacks[stage_path] << [conditions, block]
       end
-      
+
       def after(*stage_path, **conditions, &block)
         stage_path = [:action] if stage_path.empty?
-        after_callbacks[stage_path] ||= Array.new
+        after_callbacks[stage_path] ||= []
         after_callbacks[stage_path] << [conditions, block]
       end
-      
+
       def around(*stage_path, **conditions, &block)
         stage_path = [:action] if stage_path.empty?
-        around_callbacks[stage_path] ||= Array.new
+        around_callbacks[stage_path] ||= []
         around_callbacks[stage_path] << [conditions, block]
       end
     end
   end
-end
+end

data/lib/praxis/collection.rb

@@ -1,28 +1,25 @@
+# frozen_string_literal: true
+
 module Praxis
   class Collection < Attributor::Collection
     include Types::MediaTypeCommon
 
     def self.of(type)
-      if defined?(type::Collection)
-        return type::Collection
-      end
+      return type::Collection if defined?(type::Collection)
 
       klass = super
       klass.anonymous_type
 
-      if type < Praxis::Types::MediaTypeCommon
-        klass.member_type type
-        type.const_set :Collection, klass
-      else
-        raise "Praxis::Collection.of() for non-MediaTypes is unsupported. Use Attributor::Collection.of() instead."
-      end
+      raise 'Praxis::Collection.of() for non-MediaTypes is unsupported. Use Attributor::Collection.of() instead.' unless type < Praxis::Types::MediaTypeCommon
 
+      klass.member_type type
+      type.const_set :Collection, klass
     end
 
-    def self.member_type(type=nil)
+    def self.member_type(type = nil)
       unless type.nil?
         @member_type = type
-        self.identifier(type.identifier + ';type=collection') unless type.identifier.nil?
+        identifier("#{type.identifier};type=collection") unless type.identifier.nil?
       end
 
       @member_type
@@ -36,8 +33,8 @@ module Praxis
       :array
     end
 
-    def self.as_json_schema(**args)
-      the_type = @attribute && @attribute.type || member_type
+    def self.as_json_schema(**_args)
+      the_type = @attribute&.type || member_type
       {
         type: json_schema_type,
         items: { '$ref': "#/components/schemas/#{the_type.id}" }

data/lib/praxis/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Praxis
   class Config
     include Attributor::Type
@@ -10,7 +12,7 @@ module Praxis
     end
 
     # You can define the configuration in different ways
-    # 
+    #
     # Add a key to the top struct
     # define do
     #   attribute :added_to_top, String
@@ -28,46 +30,36 @@ module Praxis
     #     attribute :two String
     #   end
     # end
-    
+
     # ...or using this way too (equivalent)
     # define(:app) do
     #   attribute :two, String
     # end
     # You can also define a key to be a non-Struct type
     # define :app, Attributor::Hash
-        
-    def define(key=nil, type=Attributor::Struct, **opts, &block)
-      if key.nil? && type != Attributor::Struct
-        raise Exceptions::InvalidConfiguration.new(
-          "You cannot define the top level configuration with a non-Struct type. Got: #{type.inspect}"
-        )
-      end
-      
+
+    def define(key = nil, type = Attributor::Struct, **opts, &block)
+      raise Exceptions::InvalidConfiguration, "You cannot define the top level configuration with a non-Struct type. Got: #{type.inspect}" if key.nil? && type != Attributor::Struct
+
       case key
       when String, Symbol, NilClass
 
         top = key.nil? ? @attribute : @attribute.attributes[key]
-        if top #key defined...redefine
-          unless  type == Attributor::Struct && top.type < Attributor::Struct
-            raise Exceptions::InvalidConfiguration.new(
-              "Incompatible type received for extending configuration key [#{key}]. Got type #{type.name}"
-            )
-          end
+        if top # key defined...redefine
+          raise Exceptions::InvalidConfiguration, "Incompatible type received for extending configuration key [#{key}]. Got type #{type.name}" unless type == Attributor::Struct && top.type < Attributor::Struct
+
           top.options.merge!(opts)
           top.type.attributes(**opts, &block)
         else
           @attribute.attributes[key] = Attributor::Attribute.new(type, opts, &block)
         end
       else
-        raise Exceptions::InvalidConfiguration.new(
-          "Defining a configuration key requires a String or a Symbol key. Got: #{key.inspect}"
-        )
+        raise Exceptions::InvalidConfiguration, "Defining a configuration key requires a String or a Symbol key. Got: #{key.inspect}"
       end
-            
     end
 
     def set(config)
-      context = ['Application', 'config']
+      context = %w[Application config]
 
       begin
         @value = @attribute.load(config, context, recurse: true)
@@ -77,17 +69,14 @@ module Praxis
 
       errors = @attribute.validate(@value, context)
 
-      unless errors.empty?
-        raise Exceptions::ConfigValidation.new(errors: errors)
-      end
+      raise Exceptions::ConfigValidation.new(errors: errors) unless errors.empty?
     end
 
     def get
-      @value ||= begin
-        context = ['Application','config'].freeze
-        @attribute.load({},context, recurse: true)
+      @value ||= begin # rubocop:disable Naming/MemoizedInstanceVariableName
+        context = %w[Application config].freeze
+        @attribute.load({}, context, recurse: true)
       end
     end
-
   end
 end

data/lib/praxis/config_hash.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # TODO: move to Praxis proper...it's not used here
 module Praxis
   class ConfigHash < BasicObject
@@ -22,7 +23,7 @@ module Praxis
       true
     end
 
-    def method_missing(name, value, *rest, &block) # rubocop:disable Style/MethodMissing
+    def method_missing(name, value, *rest, &block)
       if (existing = @hash[name])
         if block
           existing << [value, block]

data/lib/praxis/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 require 'active_support/all'
 
@@ -24,11 +26,11 @@ module Praxis
       end
 
       def id
-        self.name.gsub('::'.freeze,'-'.freeze)
+        name.gsub('::', '-')
       end
     end
 
-    def initialize(request, response=Responses::Ok.new)
+    def initialize(request, response = Responses::Ok.new)
       @request = request
       @response = response
     end
@@ -38,12 +40,11 @@ module Praxis
     end
 
     def media_type
-      if (response_definition = self.request.action.responses[self.response.name])
-        return response_definition.media_type
+      if (response_definition = request.action.responses[response.name])
+        response_definition.media_type
       else
-        self.definition.media_type
+        definition.media_type
       end
     end
-
   end
 end