yarrow 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc35279dd3d2e8d12c883c813391011aeb64656f
-  data.tar.gz: eb12a310c3fb88687d69e4602a4dbac50d6010d6
+  metadata.gz: e033523f4e9cd963daf57a6550813742b5639c99
+  data.tar.gz: fce06e453eb7ade5d7cceb0d1aef81412c5d12d4
 SHA512:
-  metadata.gz: b6d3cc965dcc26c80d564f776f2eeefc8e66e9db8c9bda124c15c2d1dbef2927c523656c6a93092ceaeb5fdc175b9fa3b9796ad7f84eee4444862998bbd8b5b6
-  data.tar.gz: 1b6f155d6b036f0ab25cb002fc83f2c0e82c647aa9520ef7f8c0d70c7b4b02e666d1ec0afa548fbc88d725fa7adf265d5644b978feedea6070a211e5ba50a82e
+  metadata.gz: 91c941f27267787bdf6e0959262e966d2be36c2dde5261b89cc80dec853dd24409b8a48c4e17372509cbfd3938ea89b029e182d6ddf95965bc0f0cb81e51c724
+  data.tar.gz: 675e0ffd43413591ccc5eeaee2a88977254a62e57eb58c53a0157ce3ad66716ff3be5a24c1801840230464415b64e332e70653b40a63eabe88236c6aa71cc227

data/bin/yarrow-server

@@ -11,5 +11,7 @@ require 'yarrow'
 
 Yarrow::Configuration.register_defaults
 
+Yarrow.logger = Logger.new(STDOUT)
+
 server = Yarrow::Server.new
 server.run

data/lib/yarrow/defaults.yml

@@ -18,12 +18,13 @@ assets:
     - js
   manifest_file: manifest.json
 server:
+  live_reload: true
   auto_index: true
   default_index: index.html
   default_type: text/plain
-  port: 8888
+  port: 4000
   host: localhost
-  handler: thin
+  handler: webrick
   middleware:
     - Rack::ShowExceptions
     - Rack::CommonLogger

data/lib/yarrow/html/asset_tags.rb

@@ -1,6 +1,6 @@
 module Yarrow
   module HTML
-    module AssetTags     
+    module AssetTags
       include Yarrow::Configurable
 
       # TODO: make sprockets manifest optional/pluggable
@@ -11,44 +11,49 @@ module Yarrow
       ##
       # Computes the base URL path to assets in the public web directory.
       def base_url_path
-        raise Yarrow::ConfigurationError if config.assets.nil?
-        raise Yarrow::ConfigurationError if config.output_dir.nil?
+        if config.assets.nil? || config.output_dir.nil?
+          raise Yarrow::ConfigurationError
+        end
 
         # TODO: prepend configurable CDN URL for host path
         # TODO: dev/production mode switch
 
-        assets_path = config.assets.output_dir
-        assets_path.gsub(config.output_dir, '')
+        config.assets.output_dir.gsub(config.output_dir, '')
       end
 
       def script_tags
-        manifest.js_logical_paths.map { |asset_path| script_tag(asset: asset_path) }.join("\n")
+        manifest.js_logical_paths.map { |path| script_tag(asset: path) }.join("\n")
       end
 
-      # TODO: support asset path option?
       def script_tag(options)
-        if options.has_key? :asset and manifest.exists? options[:asset]
-          script_path = manifest.digest_path(options[:asset])
-          src_path = "#{base_url_path}/#{script_path}"
+        src_path = if asset_in_manifest?(options)
+          digest_path(options[:asset])
         else
-          src_path = options[:src]
+          options[:src]
         end
 
         "<script src=\"#{src_path}\"></script>"
       end
 
-      # TODO: support asset path option?
       def link_tag(options)
-        if options.has_key? :asset and manifest.exists? options[:asset]
-          stylesheet_path = manifest.digest_path(options[:asset])
-          href_path = "#{base_url_path}/#{stylesheet_path}"      
+        href_path = if asset_in_manifest?(options)
+           digest_path(options[:asset])
         else
-          href_path = options[:href]
+          options[:href]
         end
 
         "<link href=\"#{href_path}\" rel=\"stylesheet\" type=\"text/css\">"
       end
 
+      private
+
+      def asset_in_manifest?(options)
+        options.has_key?(:asset) and manifest.exists?(options[:asset])
+      end
+
+      def digest_path(path)
+        "#{base_url_path}/#{manifest.digest_path(path)}"
+      end
     end
   end
 end

data/lib/yarrow/server/livereload.rb

@@ -0,0 +1,74 @@
+require 'eventmachine'
+require 'em-websocket'
+require 'json'
+
+module Yarrow
+  class Server
+    module Livereload
+      class Reactor
+        include Yarrow::Loggable
+
+        def initialize
+          @sockets = []
+          @running = false
+        end
+
+        def running?
+          @running
+        end
+
+        def start
+          @thread = Thread.new do
+            run_loop
+          end
+          @running = true
+        end
+
+        def stop
+          logger.info 'Shutting down Livereload'
+          @thread.kill
+          @running = false
+        end
+
+        def refresh_payload(path)
+          data = JSON.dump(['refresh', {
+            :path           => path,
+            :apply_js_live  => false,
+            :apply_css_live => false
+          }])
+        end
+
+        def send_refresh
+          @updated_paths.each do |path|
+            @sockets.each do |ws|
+              ws.send(refresh_payload(path))
+            end
+          end
+        end
+
+        def run_loop
+          EventMachine.run do
+            logger.info 'Starting Livereload reactor on port: 35729'
+
+            EventMachine::WebSocket.start(:host => 'localhost', :port => 35729) do |socket|
+              socket.onopen do
+                socket.send "!!ver:1.6"
+                @sockets << socket
+                logger.info 'Livereload connected'
+              end
+
+              socket.onmessage do |message|
+                logger.info "Receiving message: #{message}"
+              end
+
+              socket.onclose do
+                @sockets.delete(socket)
+                logger.info 'Livereload disconnected'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/server.rb

@@ -26,7 +26,7 @@ module Yarrow
 
       def call(env)
         index_path = File.join(@root, Rack::Request.new(env).path.split('/'), @index_file)
-        if File.exists?(index_path)
+        if File.exist?(index_path)
           return [200, {"Content-Type" => "text/html"}, [File.read(index_path)]]
         else
           @app.call(env)
@@ -40,41 +40,56 @@ module Yarrow
     # If no output directory is specified, defaults to the current working
     # directory.
     #
+    # `auto_index` and `live_reload` middleware needs to run in the specific order
+    # which is hardcoded here.
+    #
     # @return [Yarrow::Server::StaticFiles]
     def app
-      root = docroot
-      index = default_index
-      middleware_stack = middleware_map
-      auto_index = auto_index?
-      mime_type = default_type
-
-      Rack::Builder.new do
-        middleware_stack.each do |middleware|
-          use middleware
-        end
+      app = Rack::Builder.new
 
-        use DirectoryIndex, root: root, index: index
+      middleware_stack.each do |middleware|
+        app.use(middleware)
+      end
 
-        app_args = [root, {}].tap { |args| args.push(mime_type) if mime_type }
-        static_app = Rack::File.new(*app_args)
+      app.use(DirectoryIndex, root: docroot, index: default_index)
 
-        if auto_index
-          run Rack::Directory.new(root, static_app)
-        else
-          run static_app
-        end
+      app_args = [docroot, {}].tap { |args| args.push(default_type) if default_type }
+      static_app = Rack::File.new(*app_args)
+
+      if live_reload?
+        require 'rack-livereload'
+        app.use(Rack::LiveReload, no_swf: true)
+      end
+
+      if auto_index?
+        app.run(Rack::Directory.new(docroot, static_app))
+      else
+        app.run(static_app)
       end
+
+      app
     end
 
     ##
     # Starts the server.
     #
-    # Listens on `localhost:8888` unless `server.host` and `server.port` are
+    # Listens on `localhost:4000` unless `server.host` and `server.port` are
     # provided in the config.
     #
     def run
-      server = Rack::Handler.get(run_options[:server])
-      server.run(app, run_options)
+      if live_reload?
+        reactor = Livereload::Reactor.new
+        reactor.start
+      end
+
+      handler = Rack::Handler.get(run_options[:server])
+
+      trap(:INT) do
+        handler.shutdown if handler.respond_to?(:shutdown)
+        reactor.stop
+      end
+
+      handler.run(app, run_options)
     end
 
     private
@@ -98,6 +113,12 @@ module Yarrow
       config.server.auto_index
     end
 
+    ##
+    # @return [TrueClass, FalseClass]
+    def live_reload?
+      if config.server.live_reload then true else false; end
+    end
+
     ##
     # @return [String]
     def default_type
@@ -106,7 +127,7 @@ module Yarrow
 
     ##
     # @return [Array<Class>]
-    def middleware_map
+    def middleware_stack
       middleware = config.server.middleware || []
       middleware.map { |class_name| Kernel.const_get(class_name) }
     end
@@ -118,12 +139,12 @@ module Yarrow
     def run_options
       {
         :Port => config.server.port,
-        :Host => config.server.port,
+        :Host => config.server.host,
         :server => config.server.handler.to_sym,
         :daemonize => false,
         :quiet => false,
         :warn => true,
-        :debug => true,
+        :debug => false,
       }
     end
   end

data/lib/yarrow/tools/front_matter.rb

@@ -2,17 +2,21 @@ module Yarrow
   module Tools
     module FrontMatter
 
-      def read_split_content(path)
-        extract_split_content(File.read(path, :encoding => 'utf-8'))
+      def read_split_content(path, options={})
+        extract_split_content(File.read(path, :encoding => 'utf-8'), options)
       end
 
-      def extract_split_content(text)
+      def extract_split_content(text, options={})
         pattern = /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
         if text =~ pattern
           content = text.sub(pattern, "")
 
           begin
-            meta = YAML.load($1)
+            if options.key?(:symbolize_keys)
+              meta = symbolize_keys(YAML.load($1))
+            else
+              meta = YAML.load($1)
+            end
             return [content, meta]
           rescue Psych::SyntaxError => error
             if defined? ::Logger
@@ -22,12 +26,26 @@ module Yarrow
             end
             return [content, nil]
           end
-
         end
 
         [text, nil]
       end
 
+      def symbolize_keys(hash)
+        hash.inject({}) do |result, (key, value)|
+          new_key = case key
+                    when String then key.to_sym
+                    else key
+                    end
+          new_value = case value
+                      when Hash then symbolize_keys(value)
+                      when Array then value.map { |entry| symbolize_keys(entry) }
+                      else value
+                      end
+          result[new_key] = new_value
+          result
+        end
+      end
     end
   end
 end

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
   APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.3.4'.freeze
+  VERSION = '0.3.5'.freeze
 end

data/lib/yarrow.rb

@@ -6,8 +6,6 @@ require 'yarrow/logging'
 require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/generator'
-require 'yarrow/model/index'
-require 'yarrow/model/base'
 require 'yarrow/html/asset_tags'
 require 'yarrow/output/mapper'
 require 'yarrow/output/generator'
@@ -17,6 +15,7 @@ require 'yarrow/assets'
 require 'yarrow/html'
 require 'yarrow/tools/front_matter'
 require 'yarrow/server'
+require 'yarrow/server/livereload'
 
 # 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.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -80,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-livereload
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,12 +216,11 @@ files:
 - lib/yarrow/html/asset_tags.rb
 - lib/yarrow/html/content_tags.rb
 - lib/yarrow/logging.rb
-- lib/yarrow/model/base.rb
-- lib/yarrow/model/index.rb
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
 - lib/yarrow/server.rb
+- lib/yarrow/server/livereload.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
@@ -203,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Documentation generator based on a fluent data model.

data/lib/yarrow/model/base.rb

@@ -1,13 +0,0 @@
-require "mementus"
-require "active_support/inflector"
-
-module Yarrow
-  module Model
-    class Base < Mementus::Model
-      def self.inherited(klass)
-        self.superclass.inherited(klass)
-        Index.register(klass)
-      end
-    end
-  end
-end

data/lib/yarrow/model/index.rb

@@ -1,12 +0,0 @@
-require "active_support/inflector"
-
-module Yarrow
-  module Model
-    class Index
-      def self.register(klass)
-        method_name = ActiveSupport::Inflector.pluralize(ActiveSupport::Inflector.underscore(klass.to_s)).to_sym
-        define_singleton_method method_name, lambda { klass.all }
-      end
-    end
-  end
-end