praxis 0.22.pre.2 → 2.0.pre.1

data/lib/praxis/action_definition.rb

@@ -12,7 +12,6 @@ module Praxis
 
     attr_reader :name
     attr_reader :resource_definition
-    attr_reader :api_definition
     attr_reader :routes
     attr_reader :primary_route
     attr_reader :named_routes
@@ -40,7 +39,6 @@ module Praxis
       @metadata = Hash.new
       @routes = []
       @traits = []
-      @api_definition = resource_definition.application.api_definition
 
       if (media_type = resource_definition.media_type)
         if media_type.kind_of?(Class) && media_type < Praxis::Types::MediaTypeCommon
@@ -49,7 +47,7 @@ module Praxis
       end
 
       version = resource_definition.version
-      api_info = api_definition.info(resource_definition.version)
+      api_info = ApiDefinition.instance.info(resource_definition.version)
 
       route_base = "#{api_info.base_path}#{resource_definition.version_prefix}"
       prefix = Array(resource_definition.routing_prefix)
@@ -66,11 +64,11 @@ module Praxis
     end
 
     def trait(trait_name)
-      unless api_definition.traits.has_key? trait_name
+      unless ApiDefinition.instance.traits.has_key? trait_name
         raise Exceptions::InvalidTrait.new("Trait #{trait_name} not found in the system")
       end
 
-      trait = api_definition.traits.fetch(trait_name)
+      trait = ApiDefinition.instance.traits.fetch(trait_name)
       trait.apply!(self)
       traits << trait_name
     end
@@ -92,7 +90,7 @@ module Praxis
         args[:media_type] = type
       end
 
-      template = api_definition.response(name)
+      template = ApiDefinition.instance.response(name)
       @responses[name] = template.compile(self, **args)
     end
 
@@ -305,7 +303,7 @@ module Praxis
 
         # and return that one if it already corresponds to a registered handler
         # otherwise, add the encoding
-        if resource_definition.application.handlers.include?(pick.handler_name)
+        if Praxis::Application.instance.handlers.include?(pick.handler_name)
           return pick
         else
           return pick + handler_name
@@ -322,13 +320,13 @@ module Praxis
 
       hash[:examples] = {}
 
-      default_handlers = api_definition.info.consumes
+      default_handlers = ApiDefinition.instance.info.consumes
 
       default_handlers.each do |default_handler|
         dumped_payload = payload.dump(example, default_format: default_handler)
 
         content_type = derive_content_type(example, default_handler)
-        handler = resource_definition.application.handlers[content_type.handler_name]
+        handler = Praxis::Application.instance.handlers[content_type.handler_name]
 
         # in case handler is nil, use dumped_payload as-is.
         generated_payload = if handler.nil?

data/lib/praxis/api_definition.rb

@@ -1,57 +1,41 @@
+require 'singleton'
 require 'forwardable'
 
 module Praxis
 
   class ApiDefinition
+    include Singleton
     extend Forwardable
 
     attr_reader :traits
     attr_reader :responses
     attr_reader :infos
     attr_reader :global_info
-    attr_reader :application    
 
     attr_accessor :versioning_scheme
 
-    def self.instance
-      i = Thread.current[:praxis_instance] || $praxis_initializing_instance
-      raise "Trying to use Praxis::ApiDefinition outside the context of a Praxis::Application" unless i
-      i.api_definition
-    end
-    
     def self.define(&block)
-      
-      definition = Praxis::Application.current_instance.api_definition
-      if block.arity == 0
-        definition.instance_eval(&block)
-      else
-        yield(definition)
-      end
-    end
-    
-    def define(&block)
       if block.arity == 0
-        self.instance_eval(&block)
+        self.instance.instance_eval(&block)
       else
-        yield(self)
+        yield(self.instance)
       end
     end
 
-    def initialize(application)
-      @application = application
+    def initialize
       @responses = Hash.new
       @traits = Hash.new
       @base_path = ''
 
-      @global_info = ApiGeneralInfo.new(application: application)
+      @global_info = ApiGeneralInfo.new
 
       @infos = Hash.new do |hash, version|
-        hash[version] = ApiGeneralInfo.new(@global_info, application: application, version: version)
+        hash[version] = ApiGeneralInfo.new(@global_info, version: version)
       end
     end
 
     def response_template(name, &block)
-      @responses[name] = Praxis::ResponseTemplate.new(name, application, &block)
+      @responses[name] = Praxis::ResponseTemplate.new(name, &block)
     end
 
     def response(name)
@@ -107,26 +91,25 @@ module Praxis
       data
     end
 
-    # CANNOT DEFINE IT AT FILE LOADING TIME: THE INSTANCE FOR THE API_DEFINITION IS NOT READY YET.
-    # define do |api|
-    #   api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
-    #     status 200
-    #     description( description || 'Standard response for successful HTTP requests.' )
-    #
-    #     media_type media_type
-    #     location location
-    #     headers headers if headers
-    #   end
-    #
-    #   api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
-    #     status 201
-    #     description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
-    #
-    #     media_type media_type if media_type
-    #     location location
-    #     headers headers if headers
-    #   end
-    # end
+    define do |api|
+      api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
+        status 200
+        description( description || 'Standard response for successful HTTP requests.' )
+
+        media_type media_type
+        location location
+        headers headers if headers
+      end
+
+      api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
+        status 201
+        description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
+
+        media_type media_type if media_type
+        location location
+        headers headers if headers
+      end
+    end
 
   end
 

data/lib/praxis/api_general_info.rb

@@ -3,11 +3,10 @@ module Praxis
 
     attr_reader :version
 
-    def initialize(global_info=nil, application:, version: nil)
+    def initialize(global_info=nil, version: nil)
       @data = Hash.new
       @global_info = global_info
       @version = version
-      @application = application
 
       if @global_info.nil? # this *is* the global info
         version_with [:header, :params]
@@ -55,7 +54,7 @@ module Praxis
         get(:version_with)
       else
         if @global_info.nil? # this *is* the global info
-          @application.versioning_scheme = val
+          Application.instance.versioning_scheme = val
           set(:version_with, val)
         else
           raise "Use of version_with is only allowed in the global part of " \

data/lib/praxis/application.rb

@@ -1,15 +1,16 @@
+require 'singleton'
 require 'mustermann'
 require 'logger'
 
 module Praxis
   class Application
+    include Singleton
 
     attr_reader :router
     attr_reader :controllers
     attr_reader :resource_definitions
     attr_reader :app
     attr_reader :builder
-    attr_reader :api_definition
 
     attr_accessor :bootloader
     attr_accessor :file_layout
@@ -24,30 +25,12 @@ module Praxis
 
     attr_accessor :versioning_scheme
 
-    @@registered_apps = {}
 
-    def self.registered_apps
-      @@registered_apps
-    end
-        
-    def self.instance
-      i = current_instance
-      return i if i
-      $praxis_initializing_instance = self.new
-    end
-    
-    def self.current_instance
-      Thread.current[:praxis_instance] || $praxis_initializing_instance
-    end
-    
     def self.configure
-       # Should fail (i.e., be nil) if it's not in initialization/setup or a runtime call
-      yield(current_instance)
+      yield(self.instance)
     end
 
-    def initialize(name: 'default', skip_registration: false)
-      old = $praxis_initializing_instance
-      $praxis_initializing_instance = self # ApiDefinition.new needs to get the instance...
+    def initialize
       @controllers = Set.new
       @resource_definitions = Set.new
 
@@ -68,135 +51,29 @@ module Praxis
       @config = Config.new
       @root = nil
       @logger = Logger.new(STDOUT)
-      @api_definition = ApiDefinition.new(self)
-      
-      @api_definition.define do |api|
-        api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
-          status 200
-          description( description || 'Standard response for successful HTTP requests.' )
-
-          media_type media_type
-          location location
-          headers headers if headers
-        end
-
-        api.response_template :created do |media_type: nil, location: nil, headers: nil, description: nil|
-          status 201
-          description( description || 'The request has been fulfilled and resulted in a new resource being created.' )
-
-          media_type media_type if media_type
-          location location
-          headers headers if headers
-        end
-      end
-      
-      require 'praxis/responses/http'
-      self.api_definition.define do |api|
-        [
-          [ :accepted, 202, "The request has been accepted for processing, but the processing has not been completed." ],
-          [ :no_content, 204,"The server successfully processed the request, but is not returning any content."],
-          [ :multiple_choices, 300,"Indicates multiple options for the resource that the client may follow."],
-          [ :moved_permanently, 301,"This and all future requests should be directed to the given URI."],
-          [ :found, 302,"The requested resource resides temporarily under a different URI."],
-          [ :see_other, 303,"The response to the request can be found under another URI using a GET method"],
-          [ :not_modified, 304,"Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-Match."],
-          [ :temporary_redirect, 307,"In this case, the request should be repeated with another URI; however, future requests should still use the original URI."],
-          [ :bad_request, 400,"The request cannot be fulfilled due to bad syntax."],
-          [ :unauthorized, 401,"Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided."],
-          [ :forbidden, 403,"The request was a valid request, but the server is refusing to respond to it."],
-          [ :not_found, 404,"The requested resource could not be found but may be available again in the future."],
-          [ :method_not_allowed, 405,"A request was made of a resource using a request method not supported by that resource."],
-          [ :not_acceptable, 406,"The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request."],
-          [ :request_timeout, 408,"The server timed out waiting for the request."],
-          [ :conflict, 409, "Indicates that the request could not be processed because of conflict in the request, such as an edit conflict in the case of multiple updates."],
-          [ :precondition_failed, 412,"The server does not meet one of the preconditions that the requester put on the request."],
-          [ :unprocessable_entity, 422,"The request was well-formed but was unable to be followed due to semantic errors."],
-        ].each do |name, code, base_description|
-          api.response_template name do |media_type: nil, location: nil, headers: nil, description: nil|
-            status code
-            description( description || base_description ) # description can "potentially" be overriden in an individual action.
-
-            media_type media_type if media_type
-            location location if location
-            headers headers if headers
-          end
-        end
+    end
+
+
+    def setup(root: '.')
+      return self unless @app.nil?
+
+      @root = Pathname.new(root).expand_path
 
-      end
-      
-      require 'praxis/responses/internal_server_error'
-      self.api_definition.define do |api|
-        api.response_template :internal_server_error do
-          description "A generic error message, given when an unexpected condition was encountered and no more specific message is suitable."
-          status 500
-          media_type "application/json"
-        end
-      end
-      
-      require 'praxis/responses/validation_error'
-      self.api_definition.define do |api|
-        api.response_template :validation_error do
-          description "An error message indicating that one or more elements of the request did not match the API specification for the action"
-          status 400
-          media_type "application/json"
-        end
-      end
-      
-      
-      require 'praxis/responses/multipart_ok'
-      self.api_definition.define do |api|
-        api.response_template :multipart_ok do |media_type: Praxis::Types::MultipartArray|
-          status 200
-          media_type media_type
-        end
-      end
-      
       builtin_handlers = {
         'plain' => Praxis::Handlers::Plain,
         'json' => Praxis::Handlers::JSON,
         'x-www-form-urlencoded' => Praxis::Handlers::WWWForm
       }
-      
       # Register built-in handlers unless the app already provided its own
       builtin_handlers.each_pair do |name, handler|
         self.handler(name, handler) unless handlers.key?(name)
       end
-      
-      setup_initial_config!
-      
-      unless skip_registration
-        if self.class.registered_apps[name]
-          raise "A Praxis instance named #{name} has already been registered, please use the :name parameter to initialize them"
-        end
-        self.class.registered_apps[name] = self
-      end
-      $praxis_initializing_instance = old
-    end
-
-    def setup_initial_config!
-      self.config do
-        attribute :praxis do
-          attribute :validate_responses, Attributor::Boolean, default: false
-          attribute :validate_response_bodies, Attributor::Boolean, default: false
-
-          attribute :show_exceptions, Attributor::Boolean, default: false
-          attribute :x_cascade, Attributor::Boolean, default: true
-        end
-      end
-    end
-
 
-    def setup(root: '.')
-      return self unless @app.nil?
-      saved_value = $praxis_initializing_instance
-      $praxis_initializing_instance = self
-      @root = Pathname.new(root).expand_path
+      @bootloader.setup!
 
-      bootloader.setup!
-      builder.run(@router)
-      @app = builder.to_app
+      @builder.run(@router)
+      @app = @builder.to_app
 
-      $praxis_initializing_instance = saved_value
       self
     end
 
@@ -226,13 +103,9 @@ module Praxis
 
     def call(env)
       response = []
-      old = Thread.current[:praxis_instance]
-      Thread.current[:praxis_instance] = self
       Notifications.instrument 'rack.request.all'.freeze, response: response do
         response.push(*@app.call(env))
       end
-    ensure
-      Thread.current[:praxis_instance] = old      
     end
 
     def layout(&block)

data/lib/praxis/bootloader.rb

@@ -47,9 +47,8 @@ module Praxis
       stages << BootloaderStages::WarnUnloadedFiles.new(:warn_unloaded_files, application)
 
       after(:app) do
-        Praxis::Mapper.finalize!
         Praxis::Blueprint.finalize!
-        Praxis::ResourceDefinition.finalize!(application: self.application)
+        Praxis::ResourceDefinition.finalize!
       end
 
     end

data/lib/praxis/bootloader_stages/environment.rb

@@ -8,6 +8,7 @@ module Praxis
       # 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
@@ -36,6 +37,18 @@ module Praxis
         end
       end
 
+      # TODO: not really sure I like this here... but where else is better?
+      def setup_initial_config!
+        application.config do
+          attribute :praxis do
+            attribute :validate_responses, Attributor::Boolean, default: false
+            attribute :validate_response_bodies, Attributor::Boolean, default: false
+
+            attribute :show_exceptions, Attributor::Boolean, default: false
+            attribute :x_cascade, Attributor::Boolean, default: true
+          end
+        end
+      end
 
     end
 

data/lib/praxis/controller.rb

@@ -20,8 +20,6 @@ module Praxis
         end
 
         definition.controller = self
-        # `implements` should only be processed while the application initializes/setup
-        # So we will use the `.instance` function to get the "current" application instance
         Application.instance.controllers << self
       end
 

data/lib/praxis/dispatcher.rb

@@ -28,13 +28,11 @@ module Praxis
       @deferred_callbacks[:after] << [conditions, block]
     end
 
-    # Typically, this is only called from the router, and the app will always be known.
-    # But we'll leave the application param as optional if we know there is a dispatcher in the thread
-    def self.current(thread: Thread.current, application: nil)
+    def self.current(thread: Thread.current, application: Application.instance)
       thread[:praxis_dispatcher] ||= self.new(application: application)
     end
 
-    def initialize(application:)
+    def initialize(application: Application.instance)
       @stages = []
       @application = application
       setup_stages!
@@ -106,9 +104,9 @@ module Praxis
           response_stage.run
 
           payload[:response] = controller.response
-          controller.response.finish(application: application)
+          controller.response.finish
         rescue => e
-          @application.error_handler.handle!(request, e, app: application)
+          @application.error_handler.handle!(request, e)
         end
       end
     end

data/lib/praxis/docs/generator.rb

@@ -5,8 +5,7 @@ module Praxis
       require 'active_support/core_ext/enumerable' # For index_by
 
       API_DOCS_DIRNAME = 'docs/api'
-      
-      attr_reader :app_instance
+
       attr_reader :resources_by_version, :types_by_id, :infos_by_version
       attr_reader :doc_root_dir
 
@@ -25,21 +24,13 @@ module Praxis
         Attributor::URI,
       ]).freeze
 
-      def self.generate(root, name:, skip_sub_directory: false)
-        instance = Praxis::Application.registered_apps[name]
-        Thread.current[:praxis_instance] = instance
-        self.new(root, instance: instance, name: name, skip_sub_directory: skip_sub_directory).save!
-        Thread.current[:praxis_instance] = nil
-      end
-      
-      def initialize(root, instance:, name:, skip_sub_directory:)
+
+      def initialize(root)
         require 'yaml'
         @resources_by_version =  Hash.new do |h,k|
           h[k] = Set.new
         end
-        @app_instance = instance
-        subdir = skip_sub_directory ? nil : name
-        initialize_directories(root, subdir: subdir )
+        initialize_directories(root)
 
         Attributor::AttributeResolver.current = Attributor::AttributeResolver.new
         collect_infos
@@ -57,10 +48,9 @@ module Praxis
 
       private
 
-      def initialize_directories(root, subdir: nil )
+      def initialize_directories(root)
         @doc_root_dir = File.join(root, API_DOCS_DIRNAME)
-        @doc_root_dir = File.join(@doc_root_dir, subdir) if subdir
-        
+
         # remove previous data (and reset the directory)
         FileUtils.rm_rf @doc_root_dir if File.exists?(@doc_root_dir)
         FileUtils.mkdir_p @doc_root_dir unless File.exists? @doc_root_dir
@@ -68,7 +58,7 @@ module Praxis
 
       def collect_resources
         # load all resource definitions registered with Praxis
-        app_instance.resource_definitions.map do |resource|
+        Praxis::Application.instance.resource_definitions.map do |resource|
           # skip resources with doc_visibility of :none
           next if resource.metadata[:doc_visibility] == :none
           version = resource.version
@@ -86,7 +76,7 @@ module Praxis
 
       def collect_infos
         # All infos. Including keys for `:global`, "n/a", and any string version
-        @infos_by_version = app_instance.api_definition.describe
+        @infos_by_version = ApiDefinition.instance.describe
       end
 
 

data/lib/praxis/docs/link_builder.rb

@@ -20,7 +20,7 @@ module Praxis
 
       def endpoint
         @endpoint ||= begin
-          endpoint = Application.current_instance.api_definition.global_info.documentation_url
+          endpoint = ApiDefinition.instance.global_info.documentation_url
           endpoint.gsub(/\/index\.html$/i, '/') if endpoint
         end
       end

data/lib/praxis/error_handler.rb

@@ -1,15 +1,15 @@
 module Praxis
   class ErrorHandler
-    
-    def handle!(request, error, app:)
-      app.logger.error error.inspect
+
+    def handle!(request, error)
+      Application.instance.logger.error error.inspect
       error.backtrace.each do |line|
-        app.logger.error line
+        Application.instance.logger.error line
       end
 
       response = Responses::InternalServerError.new(error: error)
       response.request = request
-      response.finish(application: app)
+      response.finish
     end
 
   end

data/lib/praxis/extensions/attribute_filtering/active_record_filter_query_builder.rb

@@ -23,7 +23,7 @@ module Praxis
       end
 
       # Base query to build upon
-      def initialize(query: , model: )
+      def initialize(query: , model:)
         @query = query
         @table = model.table_name
         @last_join_alias = model.table_name