yarrow 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a67be8972c7ab61211651896258120b27485152
-  data.tar.gz: 09c34931e14fdc5099565347d47b8876df831102
+  metadata.gz: b51706470a2ed364a5f75a8afd814d790377c37d
+  data.tar.gz: 429742706a961398946fec5082e0fcdec4bc0e43
 SHA512:
-  metadata.gz: 17007867d65925330adf3f5cf13ae1c15cd72d407c808cfa2908044ac348e3e1b430b71c9c1cb6d73078d22450d5bbad20d665f6547ec68b624a706017f49f69
-  data.tar.gz: 9a912fe2206f7d061f286e6dba240aaf45642b79af3d19d59d9e252c2be542f0a91ff2e0fa93cd3af23f1ca7cb57efa7f436967fcf1b704c6fcf15aea1ee0948
+  metadata.gz: 6b7fe451cbe5df3b2c2e5b38e99e3274a57118059099f7477ac2d577694edc5307bed004e8ab61d3e2580b803f318120b6001184df5a0a09a8168a25a5c97839
+  data.tar.gz: f80b00ea6ed50906e5d68b81c34564cea2e6a5664aeca76c95e0ef138133e50c035677c1948953f1151a88b5d608412eb6271508ea1f37b9b86db45edbfd111b

data/bin/yarrow

@@ -5,9 +5,9 @@ path = __FILE__
 while File.symlink?(path)
   path = File.expand_path(File.readlink(path), File.dirname(path))
 end
-$:.unshift(File.join(File.dirname(File.expand_path(path)), "..", "lib"))
+$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
-require "yarrow"
+require 'yarrow'
 
 app = Yarrow::ConsoleRunner.new ARGV
 app.run_application

data/bin/yarrow-server

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# load path annoyance
+path = __FILE__
+while File.symlink?(path)
+  path = File.expand_path(File.readlink(path), File.dirname(path))
+end
+$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+
+require 'yarrow'
+require 'yarrow/server'
+
+Yarrow::Server.run

data/lib/yarrow/assets/manifest.rb

@@ -3,12 +3,23 @@ require 'json'
 
 module Yarrow
   module Assets
-
     ##
     # Provides access to the bundle of compiled CSS and JS assets.
+    #
+    # This is currently based on the output structure of the JSON manifest file
+    # generated by Sprockets, but this class isn't coupled to the Sprockets API
+    # so could be used as a generic manifest reader.
+    #
+    # - `logical_path` represents the core named path to an asset sans version, eg: `main.css`
+    # - `digest_path` represents the versioned instance of an asset with associated digest,
+    #    eg: `main-4362eea15558e73d3663de653cdeb81e.css`
     class Manifest
 
       ##
+      # Initializes the manifest from a Sprockets-style JSON file.
+      #
+      # If no assets directory is given, looks for a manifest in the main output directory.
+      #
       # @param config [Yarrow::Configuration]
       def initialize(config)
         raise Yarrow::ConfigurationError if config.assets.nil?
@@ -29,42 +40,85 @@ module Yarrow
         end
       end
 
+      ##
+      # True if the named asset exists.
+      #
+      # @param logical_path [String]
+      # @return Boolean
       def exists?(logical_path)
       	@manifest_index['assets'].key? logical_path
       end
 
+      ##
+      # Returns the generated digest path to a named asset.
+      #
+      # @param logical_path [String]
+      # @return [String]
       def digest_path(logical_path)
       	@manifest_index['assets'][logical_path]
       end
 
+      ##
+      # Returns a hash of file information for a generated asset.
+      #
+      # @param logical_path [String]
+      # @return [Hash]
       def file(logical_path)
       	@manifest_index['files'][digest_path(logical_path)]
       end
 
+      ##
+      # Returns the list of named assets in the manifest.
+      #
+      # @return [Array<String>]
       def logical_paths
       	@manifest_index['assets'].keys
       end
 
+      ##
+      # Returns the list of generated digest paths in the manifest.
+      #
+      # @return [Array<String>]
       def digest_paths
       	@manifest_index['files'].keys
       end
 
+      ##
+      # Returns the list of generated files in the manifest.
+      #
+      # @return [Array<Hash>]
       def files
       	@manifest_index['files'].values
       end
 
+      ##
+      # Returns the list of named CSS assets in the manifest.
+      #
+      # @return [Array<String>]
       def css_logical_paths
         select_by_extension(logical_paths, '.css')
       end
 
+      ##
+      # Returns the list of named JS assets in the manifest.
+      #
+      # @return [Array<String>]
       def js_logical_paths
         select_by_extension(logical_paths, '.js')
       end
 
+      ##
+      # Returns the list of generated CSS assets in the manifest.
+      #
+      # @return [Array<String>]
       def css_digest_paths
         select_by_extension(digest_paths, '.css')
       end
 
+      ##
+      # Returns the list of generated JS assets in the manifest.
+      #
+      # @return [Array<String>]
       def js_digest_paths
         select_by_extension(digest_paths, '.js')
       end

data/lib/yarrow/assets/pipeline.rb

@@ -5,7 +5,7 @@ require 'sprockets'
 module Yarrow
   module Assets
     ##
-    # A framework for processing and compressing static assets using Sprockets.
+    # Processes static assets using Sprockets.
     class Pipeline
 
       include Loggable
@@ -41,8 +41,10 @@ module Yarrow
         end
       end
 
+      ##
       # Compiles an asset manifest and processed output files from the given input bundles.
       # Also generates a manifest linking each output bundle to its given input name.
+      #
       # @param bundles [Array<String>]
       def compile(bundles = [])
         bundles.each do |bundle|          
@@ -58,7 +60,9 @@ module Yarrow
         end
       end
 
+      ##
       # Copy the given files to the output path without processing or renaming.
+      #
       # @param bundle [Array<String>]
       def copy(bundles = [])
         bundles.each do |bundle|
@@ -79,9 +83,12 @@ module Yarrow
         manifest.clean(keep)
       end
 
+      ##
       # Access instance of the Sprockets environment.
-      # TODO: make this private to avoid forcing a dependency on Sprockets
+      #
+      # @return [Sprockets::Environment]
       def environment
+        # TODO: decouple dependency on Sprockets
         @environment ||= create_environment
       end
 

data/lib/yarrow/server.rb

@@ -0,0 +1,17 @@
+require 'rack'
+
+module Yarrow
+  ##
+  # Little server for viewing the generated output as a local website.
+  class Server
+
+    def self.run
+      local_server = Rack::Builder.new do
+        run Rack::Directory.new(Dir.pwd)
+      end
+
+      Rack::Handler.default.run(local_server, :port => 8080)
+    end
+
+  end
+end

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
-  APP_NAME = "Yarrow"
-  VERSION = "0.2.9"
+  APP_NAME = 'Yarrow'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Rickerby
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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
@@ -127,10 +141,12 @@ description: Yarrow is a tool for generating well structured documentation from
 email: me@maetl.net
 executables:
 - yarrow
+- yarrow-server
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/yarrow
+- bin/yarrow-server
 - lib/yarrow.rb
 - lib/yarrow/assets.rb
 - lib/yarrow/assets/manifest.rb
@@ -149,6 +165,7 @@ files:
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
+- lib/yarrow/server.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
 homepage: http://rubygemspec.org/gems/yarrow