yarrow 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71cc6bb31451de567a4dc5f5ef84df45855d3a21
-  data.tar.gz: 7ad6ffae5eeaec2084b50a295a10b07610f2fb5f
+  metadata.gz: 648a0f70b24617f5498150579e5c18775c1b4c8c
+  data.tar.gz: 25f8f7a1f34525764329e798169c0c430362f31a
 SHA512:
-  metadata.gz: 8b5e08f3edca9b08b59e7ed777e50b0e5b7e738a7e7c1f5a14440919e9d93c84ab4b5b5b55b46061d520deaebd7cee84c43dc7c6beff160c23a4b2c4643ff850
-  data.tar.gz: 378379ec11cb8944230afc693ca8b1df083e192e6ad53ddebc70d083bd26b2e63fc58b9c4690f7d848aa741edb86071c0f8f404cb34aa7c9264cfd29a18226c5
+  metadata.gz: 887acaa6c3d7fe08fe3c8ef0ede960c825a312e47510a10b456f3170c052dfacfe041609fdf5d7d599d98efd6b49ba71d74b7fdb4aa84369911f42e5f4e6449a
+  data.tar.gz: fc1cfe571626692b46cf1946f54294e74c87dee9c81df8545e9585245756baf2caa84472021563331f21c68a15b1e239a025d3b30e9b2884148f450d97052b37

data/bin/yarrow-server

@@ -9,5 +9,7 @@ $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'yarrow'
 
+Yarrow::Configuration.register_defaults
+
 server = Yarrow::Server.new
 server.run

data/lib/yarrow/configuration.rb

@@ -1,13 +1,10 @@
 module Yarrow
-
   ##
   # Hash-like object containing runtime configuration values. Can be accessed indifferently
   # via object style lookups or symbol keys.
   #
   class Configuration < Hashie::Mash
-   
     class << self
-
       ##
       # Provides access to the registered global configuration.
       #
@@ -20,12 +17,24 @@ module Yarrow
       end
 
       ##
-      # Loads and registers a global configuration object.
+      # Loads and registers a global configuration instance.
+      #
+      # This will reset any previously initialized configuration.
       #
       # @param [String] path to YAML file
       #
       def register(file)
-        @@configuration = self.load(file)
+        @@configuration = load(file)
+      end
+
+      ##
+      # Loads and registers a global configuration instance with
+      # library-provided defaults.
+      #
+      # This will reset any previously initialized configuration.
+      #
+      def register_defaults
+        @@configuration = load_defaults
       end
 
       ##
@@ -56,15 +65,22 @@ module Yarrow
         self.new(YAML.load_file(file))
       end
 
+      ##
+      # Yarrow is distributed with a `defaults.yml` which provides minimum
+      # boostrap configuration and default settings for various internal
+      # classes. Use this method to automatically load these defaults.
+      #
+      # @return [Yarrow::Configuration]
+      def load_defaults
+        load(File.join(File.dirname(__FILE__), 'defaults.yml'))
+      end
     end
-
   end
 
   ##
   # Embeds global configuration access in a client object.
   #
   module Configurable
-
     ##
     # Provides access to the registered global configuration. This can
     # be overriden by subclasses to customize behaviour (eg: in test cases).
@@ -74,12 +90,10 @@ module Yarrow
     def config
       Configuration.instance
     end
-
   end
 
   ##
   # Raised when a required config section or property is missing.
   class ConfigurationError < StandardError
   end
-
 end

data/lib/yarrow/console_runner.rb

@@ -22,7 +22,7 @@ module Yarrow
       @arguments = arguments
       @options = {}
       @targets = []
-      @config = Configuration.load(File.dirname(__FILE__) + "/defaults.yml")
+      @config = Configuration.load_defaults
     end
 
     def config

data/lib/yarrow/defaults.yml

@@ -1,7 +1,7 @@
 # Default configuration settings for Yarrow.
 # This is loaded when the configuration is initialized.
 input_dir: content
-output_dir: public
+output_dir: .
 meta:
   title: Default Project
   author: Default Name
@@ -21,4 +21,8 @@ server:
   port: 8888
   host: localhost
   handler: thin
+  middleware:
+    - Rack::ShowExceptions
+    - Rack::CommonLogger
+    - Rack::ContentLength
 

data/lib/yarrow/server.rb

@@ -44,11 +44,13 @@ module Yarrow
     def app
       root = docroot
       index = @index_file || 'index.html'
+      plugins = middleware || []
 
       Rack::Builder.new do
-        use Rack::ShowExceptions
-        use Rack::CommonLogger
-        use Rack::ContentLength
+        plugins.each do |plugin|
+          puts plugin
+          use plugin
+        end
         use DirectoryIndex, root: root, index: index
         run Rack::Directory.new(root)
       end
@@ -73,13 +75,20 @@ module Yarrow
       config.output_dir || Dir.pwd
     end
 
+    ##
+    # @return [Array<Class>]
+    def middleware
+      plugins = config.server.middleware || []
+      plugins.map { |plugin| Kernel.const_get(plugin) }
+    end
+
     ##
     # Stub to fill in default Rack options that will eventually be
     # provided by config.
     #
     # TODO: remove this and use config.merge to build a single access point
     def rack_options
-      rack_options = {
+      {
         :Port => config.server.port,
         :Host => config.server.port,
         :server => config.server.handler.to_sym,

data/lib/yarrow/tools/output_file.rb

@@ -0,0 +1,40 @@
+module Yarrow
+  module Tools
+    # TODO: consider renaming this to OutputDocument.
+    class OutputFile
+      include ::Configurable
+
+      WRITE_MODE = 'w+:UTF-8'.freeze
+
+      # @return [String] Basename reflecting the server convention (usually: index.html)
+      def index_name
+        @index_name ||= config.index_name || 'index.html'
+      end
+
+      # @return [String] Docroot of the output target
+      def docroot
+        @docroot ||= config.output_dir
+      end
+
+      # Write an output file to the specified path under the docroot.
+      #
+      # @param path [String]
+      # @param content [String]
+      def write(path, content)
+        # If the target path is a directory,
+        # generate a default index filename.
+        if path[path.length-1] == '/'
+          path = "#{path}#{index_name}"
+        end
+
+        target_path = Pathname.new("docroot#{path}")
+
+        FileUtils.mkdir_p(target_path.dirname)
+
+        File.open(target_path.to_s, WRITE_MODE) do |file|
+          file.puts(content)
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
   APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.3.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -181,6 +181,7 @@ files:
 - lib/yarrow/output/mapper.rb
 - lib/yarrow/server.rb
 - lib/yarrow/tools/front_matter.rb
+- lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
 homepage: http://rubygemspec.org/gems/yarrow
 licenses: