deas 0.10.0 → 0.11.0

data/lib/deas.rb

@@ -2,6 +2,7 @@ require 'ns-options'
 require 'pathname'
 
 require 'deas/version'
+require 'deas/exceptions'
 require 'deas/server'
 require 'deas/view_handler'
 

data/lib/deas/exceptions.rb

@@ -0,0 +1,11 @@
+module Deas
+
+  Error = Class.new(RuntimeError)
+  ServerError = Class.new(Error)
+  ServerRootError = Class.new(ServerError) do
+    def message
+      "server `root` not set but required"
+    end
+  end
+
+end

data/lib/deas/server.rb

@@ -1,7 +1,10 @@
 require 'ns-options'
 require 'ns-options/boolean'
 require 'pathname'
+require 'set'
+require 'deas/exceptions'
 require 'deas/template'
+require 'deas/logging'
 require 'deas/redirect_handler'
 require 'deas/route'
 require 'deas/sinatra_app'
@@ -15,7 +18,7 @@ module Deas::Server
     # Sinatra based options
     option :env,  String,   :default => 'development'
 
-    option :root,          Pathname
+    option :root,          Pathname, :required => true
     option :public_folder, Pathname
     option :views_folder,  Pathname
 
@@ -31,23 +34,57 @@ module Deas::Server
     option :init_procs,      Array, :default => []
     option :logger,                 :default => proc{ Deas::NullLogger.new }
     option :middlewares,     Array, :default => []
-    option :settings,        Array, :default => []
+    option :settings,        Hash,  :default => {}
     option :verbose_logging,        :default => true
     option :routes,          Array, :default => []
     option :view_handler_ns, String
 
     attr_reader :template_helpers
 
-    def initialize
+    def initialize(values=nil)
       # these are defaulted here because we want to use the Configuration
       # instance `root`. If we define a proc above, we will be using the
       # Configuration class `root`, which will not update these options as
       # expected.
-      super({
+      super((values || {}).merge({
         :public_folder => proc{ self.root.join('public') },
         :views_folder  => proc{ self.root.join('views') }
-      })
+      }))
       @template_helpers = []
+      @valid = nil
+    end
+
+    def valid?
+      !!@valid
+    end
+
+    # for the config to be considered "valid", a few things need to happen.  The
+    # key here is that this only needs to be done _once_ for each config.
+
+    def validate!
+      return @valid if !@valid.nil?  # only need to run this once per config
+
+      # ensure all user and plugin configs/settings are applied
+      self.init_procs.each{ |p| p.call }
+      raise Deas::ServerRootError if self.root.nil?
+
+      # constantize the routes to ensure they are available
+      self.routes.each(&:constantize!)
+
+      # set the :erb :outvar setting if it hasn't been set.  this is used
+      # by template helpers and plugins and needs to be queryable.  the actual
+      # value doesn't matter - it just needs to be set
+      self.settings[:erb] ||= {}
+      self.settings[:erb][:outvar] ||= '@_out_buf'
+
+      # add the logging middleware args last.  This ensures that the logging
+      # happens just before the app gets the request and just after the app
+      # sends a response.
+      [*Deas::Logging.middleware(self.verbose_logging)].tap do |mw_args|
+        self.middlewares << mw_args
+      end
+
+      @valid = true  # if it made it this far, its valid!
     end
 
     def template_scope
@@ -141,8 +178,8 @@ module Deas::Server
       self.configuration.middlewares << args
     end
 
-    def set(*args)
-      self.configuration.settings << args
+    def set(name, value)
+      self.configuration.settings[name.to_sym] = value
     end
 
     def view_handler_ns(*args)

data/lib/deas/sinatra_app.rb

@@ -1,17 +1,11 @@
 require 'sinatra/base'
 require 'deas/error_handler'
-require 'deas/logging'
 
 module Deas
-
   module SinatraApp
 
     def self.new(server_config)
-      # the reason this is done here is b/c the below sinatra configuration is
-      # not considered valid until the init procs have been run and the routes
-      # have been constantized.
-      server_config.init_procs.each{ |p| p.call }
-      server_config.routes.each(&:constantize!)
+      server_config.validate!
 
       Sinatra.new do
 
@@ -38,8 +32,6 @@ module Deas
         server_config.settings.each{ |set_args| set *set_args }
         server_config.middlewares.each{ |use_args| use *use_args }
 
-        use Deas::Logging.middleware(server_config.verbose_logging)
-
         # routes
         server_config.routes.each do |route|
           send(route.method, route.path){ route.run(self) }
@@ -58,5 +50,4 @@ module Deas
     end
 
   end
-
 end

data/lib/deas/version.rb

@@ -1,3 +1,3 @@
 module Deas
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/test/unit/exceptions_tests.rb

@@ -0,0 +1,29 @@
+require 'assert'
+require 'deas/exceptions'
+
+module Deas
+
+  class ErrorTests < Assert::Context
+    desc "Deas"
+
+    should "provide an error exception that subclasses `RuntimeError" do
+      assert Deas::Error
+      assert_kind_of RuntimeError, Deas::Error.new
+    end
+
+    should "provide a server exception that subclasses `Error`" do
+      assert Deas::ServerError
+      assert_kind_of Deas::Error, Deas::ServerError.new
+    end
+
+    should "provide a server root exception that subclasses `ServerError`" do
+      assert Deas::ServerRootError
+
+      e = Deas::ServerRootError.new
+      assert_kind_of Deas::ServerError, e
+      assert_equal "server `root` not set but required", e.message
+    end
+
+  end
+
+end

data/test/unit/server_configuration_tests.rb

@@ -0,0 +1,146 @@
+require 'assert'
+require 'set'
+require 'test/support/view_handlers'
+require 'deas/exceptions'
+require 'deas/template'
+require 'deas/server'
+
+class Deas::Server::Configuration
+
+  class BaseTests < Assert::Context
+    desc "Deas::Server::Configuration"
+    setup do
+      @configuration = Deas::Server::Configuration.new
+      @configuration.root = TEST_SUPPORT_ROOT
+    end
+    subject{ @configuration }
+
+    # sinatra related options
+    should have_imeths :env, :root, :public_folder, :views_folder
+    should have_imeths :dump_errors, :method_override, :sessions, :show_exceptions
+    should have_imeths :static_files, :reload_templates
+
+    # server handling options
+    should have_imeths :error_procs, :init_procs, :logger, :middlewares, :settings
+    should have_imeths :verbose_logging, :routes, :view_handler_ns
+
+    should have_reader :template_helpers
+    should have_imeths :valid?, :validate!
+
+    should "default the env to 'development'" do
+      assert_equal 'development', subject.env
+    end
+
+    should "default the public and views folders based off the root" do
+      assert_equal subject.root.join('public'), subject.public_folder
+      assert_equal subject.root.join('views'), subject.views_folder
+    end
+
+    should "default the Sinatra flags" do
+      assert_equal false, subject.dump_errors
+      assert_equal true,  subject.method_override
+      assert_equal false, subject.sessions
+      assert_equal false, subject.show_exceptions
+      assert_equal true,  subject.static_files
+      assert_equal false, subject.reload_templates
+    end
+
+    should "default the handling options" do
+      assert_empty subject.error_procs
+      assert_empty subject.init_procs
+      assert_instance_of Deas::NullLogger, subject.logger
+      assert_empty subject.middlewares
+      assert_empty subject.settings
+      assert_equal true, subject.verbose_logging
+      assert_empty subject.routes
+      assert_nil   subject.view_handler_ns
+      assert_empty subject.template_helpers
+    end
+
+    should "build a template scope including its template helpers" do
+      config = Deas::Server::Configuration.new
+      config.template_helpers << (helper_module = Module.new)
+
+      assert_includes Deas::Template::Scope, config.template_scope.ancestors
+      assert_includes helper_module, config.template_scope.included_modules
+    end
+
+    should "not be valid until validate! has been run" do
+      assert_not subject.valid?
+
+      subject.validate!
+      assert subject.valid?
+    end
+
+    should "complain if validating and `root` isn't set" do
+      config = Deas::Server::Configuration.new
+      assert_raises(Deas::ServerRootError){ config.validate! }
+      assert_nothing_raised{ config.root '/path/to/root'; config.validate! }
+    end
+
+  end
+
+  class ValidationTests < BaseTests
+    desc "when successfully validated"
+    setup do
+      @initialized = false
+      @other_initialized = false
+      @route = Deas::Route.new(:get, '/something', 'TestViewHandler')
+
+      @configuration = Deas::Server::Configuration.new.tap do |c|
+        c.env              = 'staging'
+        c.root             = 'path/to/somewhere'
+        c.dump_errors      = true
+        c.method_override  = false
+        c.sessions         = false
+        c.show_exceptions  = true
+        c.static           = true
+        c.reload_templates = true
+        c.routes           = [ @route ]
+        c.middlewares      = [ ['MyMiddleware'] ]
+      end
+      @configuration.init_procs << proc{ @initialized = true }
+      @configuration.init_procs << proc{ @other_initialized = true }
+    end
+
+    should "call init procs" do
+      assert_equal false, @initialized
+      assert_equal false, @other_initialized
+
+      subject.validate!
+
+      assert_equal true, @initialized
+      assert_equal true, @other_initialized
+    end
+
+    should "call constantize! on all routes" do
+      assert_nil @route.handler_class
+
+      subject.validate!
+
+      assert_equal TestViewHandler, @route.handler_class
+    end
+
+    should "default the :erb :outvar setting in the SinatraApp it creates" do
+      assert_nil subject.settings[:erb]
+
+      subject.validate!
+
+      assert_kind_of ::Hash, subject.settings[:erb]
+      assert_equal '@_out_buf', subject.settings[:erb][:outvar]
+    end
+
+    should "add the Deas::Logging middleware to the end of the middlewares" do
+      assert subject.verbose_logging
+      assert_equal 1, subject.middlewares.size
+      assert_not_equal [Deas::VerboseLogging], subject.middlewares.last
+
+      subject.validate!
+
+      assert_equal 2, subject.middlewares.size
+      assert_equal [Deas::VerboseLogging], subject.middlewares.last
+    end
+
+  end
+
+end

data/test/unit/server_tests.rb

@@ -1,8 +1,8 @@
 require 'assert'
-require 'deas/template'
+require 'set'
+require 'logger'
 require 'deas/route'
 require 'deas/server'
-require 'logger'
 
 module Deas::Server
 
@@ -62,7 +62,7 @@ module Deas::Server
       assert_equal [ ['MyMiddleware'] ], config.middlewares
 
       subject.set :testing_set_meth, 'it works!'
-      assert_equal [ [:testing_set_meth, 'it works!'] ], config.settings
+      assert_equal({ :testing_set_meth => 'it works!'}, config.settings)
 
       stdout_logger = Logger.new(STDOUT)
       subject.logger stdout_logger
@@ -162,71 +162,11 @@ module Deas::Server
       assert_equal '::NoNsTest', route.handler_class_name
     end
 
-    should "add and query helper modules using #template_helpers and #template_helper?" do
+    should "add and query helper modules" do
       subject.template_helpers(helper_module = Module.new)
       assert subject.template_helper?(helper_module)
     end
 
   end
 
-  class ConfigurationTests < BaseTests
-    desc "Configuration"
-    setup do
-      @configuration = Deas::Server::Configuration.new
-    end
-    subject{ @configuration }
-
-    # sinatra related options
-    should have_imeths :env, :root, :public_folder, :views_folder
-    should have_imeths :dump_errors, :method_override, :sessions, :show_exceptions
-    should have_imeths :static_files, :reload_templates
-
-    # server handling options
-    should have_imeths :error_procs, :init_procs, :logger, :middlewares, :settings
-    should have_imeths :verbose_logging, :routes, :view_handler_ns
-
-    should have_reader :template_helpers
-
-    should "default the env to 'development'" do
-      assert_equal 'development', subject.env
-    end
-
-    should "default the public and views folders based off the root" do
-      subject.root = TEST_SUPPORT_ROOT
-
-      assert_equal subject.root.join('public'), subject.public_folder
-      assert_equal subject.root.join('views'), subject.views_folder
-    end
-
-    should "default the Sinatra flags" do
-      assert_equal false, subject.dump_errors
-      assert_equal true,  subject.method_override
-      assert_equal false, subject.sessions
-      assert_equal false, subject.show_exceptions
-      assert_equal true,  subject.static_files
-      assert_equal false, subject.reload_templates
-    end
-
-    should "default the handling options" do
-      assert_empty subject.error_procs
-      assert_empty subject.init_procs
-      assert_instance_of Deas::NullLogger, subject.logger
-      assert_empty subject.middlewares
-      assert_empty subject.settings
-      assert_equal true, subject.verbose_logging
-      assert_empty subject.routes
-      assert_nil   subject.view_handler_ns
-      assert_empty subject.template_helpers
-    end
-
-    should "build a template scope including its template helpers" do
-      config = Deas::Server::Configuration.new
-      config.template_helpers << (helper_module = Module.new)
-
-      assert_includes Deas::Template::Scope, config.template_scope.ancestors
-      assert_includes helper_module, config.template_scope.included_modules
-    end
-
-  end
-
 end

data/test/unit/sinatra_app_tests.rb

@@ -26,23 +26,12 @@ module Deas::SinatraApp
     end
     subject{ @sinatra_app }
 
-    should "be a kind of Sinatra::Base" do
-      assert_equal Sinatra::Base, subject.superclass
-    end
-
-    should "call init procs when initialized" do
-      initialized = false
-      other_initialized = false
-      @configuration.init_procs << proc{ initialized = true }
-      @configuration.init_procs << proc{ other_initialized = true }
-      @sinatra_app = Deas::SinatraApp.new(@configuration)
-
-      assert_equal true, initialized
-      assert_equal true, other_initialized
+    should "ensure its config is valid" do
+      assert @configuration.valid?
     end
 
-    should "call constantize! on all routes" do
-      assert_equal TestViewHandler, @route.handler_class
+    should "be a kind of Sinatra::Base" do
+      assert_equal Sinatra::Base, subject.superclass
     end
 
     should "have it's configuration set based on the server configuration" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deas
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 51
   prerelease: 
   segments: 
   - 0
-  - 10
+  - 11
   - 0
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,11 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-14 00:00:00 Z
+date: 2013-05-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: ns-options
   prerelease: false
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -38,12 +39,12 @@ dependencies:
         - 1
         - 4
         version: 1.1.4
-  requirement: *id001
-  name: ns-options
   type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: rack
   prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -53,12 +54,12 @@ dependencies:
         - 1
         - 5
         version: "1.5"
-  requirement: *id002
-  name: rack
   type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: sinatra
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -68,12 +69,12 @@ dependencies:
         - 1
         - 4
         version: "1.4"
-  requirement: *id003
-  name: sinatra
   type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: assert
   prerelease: false
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -82,12 +83,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-  name: assert
   type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: assert-mocha
   prerelease: false
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -96,12 +97,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
-  name: assert-mocha
   type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: assert-rack-test
   prerelease: false
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -110,9 +111,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
-  name: assert-rack-test
   type: :development
+  version_requirements: *id006
 description: Handler-based web framework powered by Sinatra
 email: 
 - kelly@kellyredding.com
@@ -132,6 +132,7 @@ files:
 - deas.gemspec
 - lib/deas.rb
 - lib/deas/error_handler.rb
+- lib/deas/exceptions.rb
 - lib/deas/logging.rb
 - lib/deas/rack_request_fix.rb
 - lib/deas/redirect_handler.rb
@@ -158,10 +159,12 @@ files:
 - test/support/views/with_layout.erb
 - test/system/rack_tests.rb
 - test/unit/error_handler_tests.rb
+- test/unit/exceptions_tests.rb
 - test/unit/logging_tests.rb
 - test/unit/redirect_handler_tests.rb
 - test/unit/route_tests.rb
 - test/unit/runner_tests.rb
+- test/unit/server_configuration_tests.rb
 - test/unit/server_tests.rb
 - test/unit/sinatra_app_tests.rb
 - test/unit/sinatra_runner_tests.rb
@@ -197,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Handler-based web framework powered by Sinatra
@@ -214,10 +217,12 @@ test_files:
 - test/support/views/with_layout.erb
 - test/system/rack_tests.rb
 - test/unit/error_handler_tests.rb
+- test/unit/exceptions_tests.rb
 - test/unit/logging_tests.rb
 - test/unit/redirect_handler_tests.rb
 - test/unit/route_tests.rb
 - test/unit/runner_tests.rb
+- test/unit/server_configuration_tests.rb
 - test/unit/server_tests.rb
 - test/unit/sinatra_app_tests.rb
 - test/unit/sinatra_runner_tests.rb