praxis 2.0.pre.17 → 2.0.pre.21

data/lib/praxis/api_general_info.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Praxis
   class ApiGeneralInfo
-
     attr_reader :version
 
-    def initialize(global_info=nil, version: nil)
-      @data = Hash.new
+    def initialize(global_info = nil, version: nil)
+      @data = {}
       @global_info = global_info
       @version = version
 
-      if @global_info.nil? # this *is* the global info
-        version_with [:header, :params]
-        consumes 'json', 'x-www-form-urlencoded'
-        produces 'json'
-      end
+      return unless @global_info.nil?
+
+      # this *is* the global info
+      version_with %i[header params]
+      consumes 'json', 'x-www-form-urlencoded'
+      produces 'json'
     end
 
     # Allow any custom method to get/set any value
-    def method_missing(name, val=nil)
+    def method_missing(name, val = nil)
       if val.nil?
         get(name)
       else
@@ -28,17 +30,18 @@ module Praxis
       true
     end
 
-    def get(k)
-      return @data[k] if @data.key?(k)
-      return @global_info.get(k) if @global_info
+    def get(key)
+      return @data[key] if @data.key?(key)
+      return @global_info.get(key) if @global_info
+
       nil
     end
 
-    def set(k, v)
-      @data[k] = v
+    def set(key, val)
+      @data[key] = val
     end
 
-    def name(val=nil)
+    def name(val = nil)
       if val.nil?
         get(:name)
       else
@@ -46,7 +49,7 @@ module Praxis
       end
     end
 
-    def title(val=nil)
+    def title(val = nil)
       if val.nil?
         get(:title)
       else
@@ -54,7 +57,7 @@ module Praxis
       end
     end
 
-    def logo_url(val=nil)
+    def logo_url(val = nil)
       if val.nil?
         get(:logo_url)
       else
@@ -62,7 +65,7 @@ module Praxis
       end
     end
 
-    def description(val=nil)
+    def description(val = nil)
       if val.nil?
         get(:description)
       else
@@ -70,106 +73,92 @@ module Praxis
       end
     end
 
-    def version_with(val=nil)
+    def version_with(val = nil)
       if val.nil?
         get(:version_with)
+      elsif @global_info.nil?
+        Application.instance.versioning_scheme = val
+        set(:version_with, val) # this *is* the global info
       else
-        if @global_info.nil? # this *is* the global info
-          Application.instance.versioning_scheme = val
-          set(:version_with, val)
-        else
-          raise "Use of version_with is only allowed in the global part of " \
-            "the API definition (but you are attempting to use it in the API " \
-            "definition of version #{self.version}"
-        end
+        raise 'Use of version_with is only allowed in the global part of ' \
+          'the API definition (but you are attempting to use it in the API ' \
+          "definition of version #{version}"
       end
     end
 
-    def endpoint(val=nil)
+    def endpoint(val = nil)
       if val.nil?
         get(:endpoint)
+      elsif @global_info.nil?
+        set(:endpoint, val) # this *is* the global info
       else
-        if @global_info.nil? # this *is* the global info
-          set(:endpoint, val)
-        else
-          raise "Use of endpoint is only allowed in the global part of " \
-            "the API definition (but you are attempting to use it in the API " \
-            "definition of version #{self.version}"
-        end
+        raise 'Use of endpoint is only allowed in the global part of ' \
+          'the API definition (but you are attempting to use it in the API ' \
+          "definition of version #{version}"
       end
     end
 
-    def documentation_url(val=nil)
+    def documentation_url(val = nil)
       if val.nil?
         get(:documentation_url)
+      elsif @global_info.nil?
+        set(:documentation_url, val) # this *is* the global info
       else
-        if @global_info.nil? # this *is* the global info
-          set(:documentation_url, val)
-        else
-          raise "Use of documentation_url is only allowed in the global part of " \
-            "the API definition (but you are attempting to use it in the API " \
-            "definition of version #{self.version}"
-        end
+        raise 'Use of documentation_url is only allowed in the global part of ' \
+          'the API definition (but you are attempting to use it in the API ' \
+          "definition of version #{version}"
       end
     end
 
-    def base_path(val=nil)
-      if val
-        return set(:base_path, val)
-      end
+    def base_path(val = nil)
+      return set(:base_path, val) if val
 
       if @global_info # this is for a specific version
         global_path = @global_info.base_path
         if version_with == :path
           global_pattern = Mustermann.new(global_path)
-          global_path = global_pattern.expand(Request::API_VERSION_PARAM_NAME => self.version.to_s)
+          global_path = global_pattern.expand(Request::API_VERSION_PARAM_NAME => version.to_s)
         end
 
-        version_path = @data.fetch(:base_path,'')
+        version_path = @data.fetch(:base_path, '')
         "#{global_path}#{version_path}"
       else
-        @data.fetch(:base_path,'')
+        @data.fetch(:base_path, '')
       end
     end
 
     def consumes(*vals)
       if vals.empty?
-        return get(:consumes)
+        get(:consumes)
       else
-        return set(:consumes, vals)
+        set(:consumes, vals)
       end
     end
 
-
     def produces(*vals)
       if vals.empty?
-        return get(:produces)
+        get(:produces)
       else
-        return set(:produces, vals)
+        set(:produces, vals)
       end
     end
 
-
-    def base_params(type=Attributor::Struct, **opts, &block)
+    def base_params(type = Attributor::Struct, **opts, &block)
       if !block && type == Attributor::Struct
         get(:base_params)
       else
-        set(:base_params, Attributor::Attribute.new(type, opts, &block) )
+        set(:base_params, Attributor::Attribute.new(type, opts, &block))
       end
     end
 
     def describe
-      hash = { schema_version: "1.0".freeze }
-      [:name, :title, :description, :base_path, :version_with, :endpoint, :consumes, :produces].each do |attr|
-        val = self.__send__(attr)
+      hash = { schema_version: '1.0' }
+      %i[name title description base_path version_with endpoint consumes produces].each do |attr|
+        val = __send__(attr)
         hash[attr] = val unless val.nil?
       end
-      if base_params
-        hash[:base_params] = base_params.describe[:type][:attributes]
-      end
+      hash[:base_params] = base_params.describe[:type][:attributes] if base_params
       hash
     end
-
   end
-
 end

data/lib/praxis/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'mustermann'
 require 'logger'
@@ -6,28 +8,12 @@ module Praxis
   class Application
     include Singleton
 
-    attr_reader :router
-    attr_reader :controllers
-    attr_reader :endpoint_definitions
-    attr_reader :app
-    attr_reader :builder
-
-    attr_accessor :bootloader
-    attr_accessor :file_layout
-    attr_accessor :loaded_files
-    attr_accessor :logger
-    attr_accessor :plugins
-    attr_accessor :doc_browser_plugin_paths
-    attr_accessor :handlers
-    attr_accessor :root
-    attr_accessor :error_handler
-    attr_accessor :validation_handler
-
-    attr_accessor :versioning_scheme
+    attr_reader :router, :controllers, :endpoint_definitions, :app, :builder
 
+    attr_accessor :bootloader, :file_layout, :loaded_files, :logger, :plugins, :doc_browser_plugin_paths, :handlers, :root, :error_handler, :validation_handler, :versioning_scheme
 
     def self.configure
-      yield(self.instance)
+      yield(instance)
     end
 
     def initialize
@@ -44,16 +30,15 @@ module Praxis
 
       @bootloader = Bootloader.new(self)
       @file_layout = nil
-      @plugins = Hash.new
+      @plugins = {}
       @doc_browser_plugin_paths = []
-      @handlers = Hash.new
+      @handlers = {}
       @loaded_files = Set.new
       @config = Config.new
       @root = nil
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
     end
 
-
     def setup(root: '.')
       return self unless @app.nil?
 
@@ -92,9 +77,7 @@ module Praxis
       handler = handler.new
 
       # Make sure it quacks like a handler.
-      unless handler.respond_to?(:generate) && handler.respond_to?(:parse)
-        raise ArgumentError, "Media type handlers must respond to #generate and #parse"
-      end
+      raise ArgumentError, 'Media type handlers must respond to #generate and #parse' unless handler.respond_to?(:generate) && handler.respond_to?(:parse)
 
       # Register that thing!
       @handlers[name.to_s] = handler
@@ -102,17 +85,17 @@ module Praxis
 
     def call(env)
       response = []
-      Notifications.instrument 'rack.request.all'.freeze, response: response do
+      Notifications.instrument 'rack.request.all', response: response do
         response.push(*@app.call(env))
       end
     end
 
     def layout(&block)
-      self.file_layout = FileGroup.new(self.root, &block)
+      self.file_layout = FileGroup.new(root, &block)
     end
 
-    def config(key=nil, type=Attributor::Struct, **opts, &block)
-      if block_given? || (type==Attributor::Struct && !opts.empty? )
+    def config(key = nil, type = Attributor::Struct, **opts, &block)
+      if block_given? || (type == Attributor::Struct && !opts.empty?)
         @config.define(key, type, **opts, &block)
       else
         @config.get
@@ -123,9 +106,9 @@ module Praxis
       @config.set(config)
     end
 
-    # [DEPRECATED] - Warn of the change of method name for the transition 
+    # [DEPRECATED] - Warn of the change of method name for the transition
     def resource_definitions
-      raise "Praxis::Application.instance does not use `resource_definitions` any longer. Use `endpoint_definitions` instead."
+      raise 'Praxis::Application.instance does not use `resource_definitions` any longer. Use `endpoint_definitions` instead.'
     end
   end
 end