yarrow 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b51706470a2ed364a5f75a8afd814d790377c37d
-  data.tar.gz: 429742706a961398946fec5082e0fcdec4bc0e43
+  metadata.gz: 1ac7d475a5d695a78ef24f94d64637deae4b2c70
+  data.tar.gz: 243ea4a6f7db3dd7b9f2e414b2d2b6bb9e20963f
 SHA512:
-  metadata.gz: 6b7fe451cbe5df3b2c2e5b38e99e3274a57118059099f7477ac2d577694edc5307bed004e8ab61d3e2580b803f318120b6001184df5a0a09a8168a25a5c97839
-  data.tar.gz: f80b00ea6ed50906e5d68b81c34564cea2e6a5664aeca76c95e0ef138133e50c035677c1948953f1151a88b5d608412eb6271508ea1f37b9b86db45edbfd111b
+  metadata.gz: 286765ed5b70e517868705c25cc545fa31ff109bcbcd3f727e323be6e858bae8e8c9175f6d536cf422ed523516f9c457e79faaca65414e3ea5155d8a0f992f8a
+  data.tar.gz: 2dc1154778db5e8ffc6656f0af62f1e7604ae0ba2ec0dde0d65fcb75af8ff8a7a796964e6493a21454dca9289d6222396c3a91510f7b4c01e6588fa1cbf2cff2

data/bin/yarrow-server

@@ -8,6 +8,6 @@ end
 $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'yarrow'
-require 'yarrow/server'
 
-Yarrow::Server.run
+server = Yarrow::Server.new
+server.run

data/lib/yarrow/assets/manifest.rb

@@ -46,7 +46,7 @@ module Yarrow
       # @param logical_path [String]
       # @return Boolean
       def exists?(logical_path)
-      	@manifest_index['assets'].key? logical_path
+        @manifest_index['assets'].key? logical_path
       end
 
       ##
@@ -55,7 +55,7 @@ module Yarrow
       # @param logical_path [String]
       # @return [String]
       def digest_path(logical_path)
-      	@manifest_index['assets'][logical_path]
+        @manifest_index['assets'][logical_path]
       end
 
       ##
@@ -64,7 +64,7 @@ module Yarrow
       # @param logical_path [String]
       # @return [Hash]
       def file(logical_path)
-      	@manifest_index['files'][digest_path(logical_path)]
+        @manifest_index['files'][digest_path(logical_path)]
       end
 
       ##
@@ -72,7 +72,7 @@ module Yarrow
       #
       # @return [Array<String>]
       def logical_paths
-      	@manifest_index['assets'].keys
+        @manifest_index['assets'].keys
       end
 
       ##
@@ -80,7 +80,7 @@ module Yarrow
       #
       # @return [Array<String>]
       def digest_paths
-      	@manifest_index['files'].keys
+        @manifest_index['files'].keys
       end
 
       ##
@@ -88,7 +88,7 @@ module Yarrow
       #
       # @return [Array<Hash>]
       def files
-      	@manifest_index['files'].values
+        @manifest_index['files'].values
       end
 
       ##

data/lib/yarrow/configuration.rb

@@ -35,7 +35,6 @@ module Yarrow
         @@configuration = self.new
       end
 
-
       ##
       # Merges the given configuration or hash-like object with the
       # registered global configuration.

data/lib/yarrow/console_runner.rb

@@ -1,22 +1,22 @@
 module Yarrow
-  
+
   class ConsoleRunner
-    
+
     SUCCESS = 0
     FAILURE = 1
-    
+
     ENABLED_OPTIONS = {
       :h => :help,
       :v => :version,
       :c => :config,
       :t => :theme,
     }
-    
+
     ALLOWED_CONFIG_FILES = [
       '.yarrowdoc',
       'Yarrowdoc'
     ]
-    
+
     def initialize(arguments, io=STDOUT)
       @out = io
       @arguments = arguments
@@ -24,11 +24,11 @@ module Yarrow
       @targets = []
       @config = Configuration.load(File.dirname(__FILE__) + "/defaults.yml")
     end
-    
+
     def config
       @config
     end
-    
+
     def run_application
       print_header
       
@@ -58,7 +58,7 @@ module Yarrow
         FAILURE
       end
     end
-    
+
     def process_arguments
       @arguments.each do |arg|
         if is_option?(arg)
@@ -68,7 +68,7 @@ module Yarrow
         end
       end
     end
-    
+
     # def load_configuration(path)
     #   ALLOWED_CONFIG_FILES.each do |filename|
     #     config_path = path + '/' + filename
@@ -78,9 +78,9 @@ module Yarrow
     #     end
     #   end
     # end
-    
+
     def process_configuration
-      #load_configuration(Dir.pwd)
+      # load_configuration(Dir.pwd)
       
       # @targets.each do |input_path|
       #   @config.deep_merge! load_configuration(input_path)
@@ -93,16 +93,17 @@ module Yarrow
       
       @config.options = @options.to_hash
 
-      #normalize_theme_path
+      # normalize_theme_path
       
-      #theme = @config.options.theme
-      #@config.append load_configuration(theme)
+      # theme = @config.options.theme
+      # @config.append load_configuration(theme)
     end
-    
+
     def normalize_theme_path
-      
+
+      # noop
     end
-    
+
     def register_option(raw_option)
       option = raw_option.gsub(":", "=")
       if option.include? "="
@@ -129,35 +130,35 @@ module Yarrow
       
       raise "Unrecognized option: #{raw_option}"
     end
-    
+
     def is_option?(argument)
       argument[0] == "-"
     end
-    
+
     def has_option?(option)
       @options.has_key? option
     end
-    
+
     def run_input_process
-      
+      # noop
     end
     
     def run_output_process
-      
+      # noop
     end
-    
+
     def print_header
       @out.puts Yarrow::APP_NAME + " " + Yarrow::VERSION
     end
-    
+
     def print_footer
       @out.puts "Content generated at {path}!"
     end
-    
+
     def print_error(e)
       @out.puts "Error! " + e.to_s
     end
-    
+
     def print_help
       help = <<HELP
   See http://yarrowdoc.org for more information.
@@ -197,4 +198,4 @@ HELP
 
   end
 
-end
+end

data/lib/yarrow/server.rb

@@ -2,16 +2,101 @@ require 'rack'
 
 module Yarrow
   ##
-  # Little server for viewing the generated output as a local website.
+  # Little web server for browsing local files.
   class Server
+    include Configurable
 
-    def self.run
-      local_server = Rack::Builder.new do
-        run Rack::Directory.new(Dir.pwd)
+    def initialize
+      if config.server.nil?
+        config.server = default_server_config
       end
+    end
+
+    ##
+    # Rack Middleware for detecting and serving an 'index.html' file
+    # instead of a directory index.
+    #
+    # TODO: Add configurable mapping and media types for README files as an alternative
+    class DirectoryIndex
+      def initialize(app, options={})
+        @app = app
+        @root = options[:root]
+        @index_file = options[:index]
+      end
+
+      def call(env)
+        index_path =  ::File.join(@root, Rack::Request.new(env).path.split('/'), @index_file)
+        if ::File.exists?(index_path)
+          return [200, {"Content-Type" => "text/html"}, [::File.read(index_path)]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+
+    ##
+    # Builds a Rack application to serve files in the output directory.
+    #
+    # If no output directory is specified, defaults to the current working
+    # directory.
+    #
+    # @return [Yarrow::Server::StaticFiles]
+    def app
+      root = docroot
+
+      Rack::Builder.new do
+        use Rack::ShowExceptions
+        use Rack::CommonLogger
+        use Rack::ContentLength
+        use DirectoryIndex, root: root, index: 'index.html'
+        run Rack::Directory.new(root)
+      end
+    end
+
+    ##
+    # Starts the server.
+    #
+    # Listens on `localhost:8888` unless `server.host` and `server.port` are
+    # provided in the config.
+    #
+    def run
+      server = Rack::Handler.get(rack_options[:server])
+      server.run(app, rack_options)
+    end
 
-      Rack::Handler.default.run(local_server, :port => 8080)
+    private
+
+    ##
+    # @return [String]
+    def docroot
+      config.output_dir || Dir.pwd
+    end
+
+    ##
+    # @return [Hash]
+    def default_server_config
+      {
+        port: 8888,
+        host: 'localhost',
+        handler: :thin
+      }
     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,
+        :daemonize => false,
+        :quiet => false,
+        :warn => true,
+        :debug => true,
+      }
+    end
   end
 end

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
-  APP_NAME = 'Yarrow'
-  VERSION = '0.3.0'
+  APP_NAME = 'Yarrow'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/yarrow.rb

@@ -16,6 +16,7 @@ require 'yarrow/content_map'
 require 'yarrow/assets'
 require 'yarrow/html'
 require 'yarrow/tools/front_matter'
+require 'yarrow/server'
 
 # Dir[File.dirname(__FILE__) + '/yarrow/generators/*.rb'].each do |generator|
 #   require generator

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Yarrow is a tool for generating well structured documentation from a
   variety of input sources.
 email: me@maetl.net
@@ -188,8 +202,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Documentation generator based on a fluent data model.
 test_files: []
+has_rdoc: