yarrow 0.2.8 → 0.2.9

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzRkODFhYjRmMDAyMTQ1OWJiOTdiYmJiNTZkMmJkOWM1NWEyODFmZQ==
-  data.tar.gz: !binary |-
-    MmZhNjI3NGRlMGI2ZGY5YTQ3ZmVhMTMyOWQ1YzZmNTg2NzEyYTQ5Yg==
+SHA1:
+  metadata.gz: 6a67be8972c7ab61211651896258120b27485152
+  data.tar.gz: 09c34931e14fdc5099565347d47b8876df831102
 SHA512:
-  metadata.gz: !binary |-
-    YTI2ZGMwNmMzOTg3N2Q0YTAxNmEyYzI3YWU4ZDE5YTAwMjM5YjJjYmQxZDMy
-    NzI2YjRhNjA4YTVkYTU1ZDkyMTU1M2YwNzJmMGZhZDYyOTc0ODg4YjliOWEy
-    MTNkYTYyZDE4YWI0MmU0NjdiNmU4Y2MwZGQ3MWE3ZmZjMGUzNWM=
-  data.tar.gz: !binary |-
-    ZjgyYjU1NWM4OWQ0YTdjYjUwYWY4ODFkYzA4MWJlMzMzMDM4YmJmMTUwMjYx
-    YmEyZjA0YjhhNjE4NDVmOGU3ZjE3YTBjOTM4MGYwZGViYmI0YzA2ZWI2ZDhm
-    MzYxMzg5MGVkMDUwNzkyNjYwMGU0ODdhY2ZmNDg5NTE0ZmZkYjI=
+  metadata.gz: 17007867d65925330adf3f5cf13ae1c15cd72d407c808cfa2908044ac348e3e1b430b71c9c1cb6d73078d22450d5bbad20d665f6547ec68b624a706017f49f69
+  data.tar.gz: 9a912fe2206f7d061f286e6dba240aaf45642b79af3d19d59d9e252c2be542f0a91ff2e0fa93cd3af23f1ca7cb57efa7f436967fcf1b704c6fcf15aea1ee0948

data/lib/yarrow/assets/manifest.rb

@@ -6,14 +6,17 @@ module Yarrow
 
     ##
     # Provides access to the bundle of compiled CSS and JS assets.
-    #
     class Manifest
 
+      ##
+      # @param config [Yarrow::Configuration]
       def initialize(config)
-        if config[:output_dir] && config[:manifest_path]
-          manifest_path = [config[:output_dir], config[:manifest_path]].join('/')
+        raise Yarrow::ConfigurationError if config.assets.nil?
+
+        if config.assets.output_dir
+          manifest_path = Pathname.new(config.assets.output_dir) + config.assets.manifest_file
         else
-          manifest_path = './manifest.json'
+          manifest_path = Pathname.new(config.output_dir) + config.assets.manifest_file
         end
 
         if File.exists?(manifest_path)

data/lib/yarrow/assets/pipeline.rb

@@ -4,6 +4,7 @@ require 'sprockets'
 
 module Yarrow
   module Assets
+    ##
     # A framework for processing and compressing static assets using Sprockets.
     class Pipeline
 
@@ -11,17 +12,24 @@ module Yarrow
 
       attr_reader :input_dir, :output_dir, :append_paths, :bundles, :assets
 
-      # @param options [Hash, Hashie::Mash, Yarrow::Configuration]
-      def initialize(options)
+      ##
+      # @param config [Yarrow::Configuration]
+      def initialize(config)
+        raise Yarrow::ConfigurationError if config.assets.nil?
 
-        @input_dir = options[:input_dir] || default_input_dir
-        @output_dir = options[:output_dir] || default_output_dir
+        @input_dir = config.assets.input_dir || default_input_dir
+
+        if config.assets.output_dir
+          @output_dir = config.assets.output_dir
+        else
+          @output_dir = config.output_dir || default_output_dir
+        end
 
         @append_paths = []
 
-        case options[:append_paths]
+        case config.assets.append_paths
         when Array
-          @append_paths = options[:append_paths]
+          @append_paths = config.assets.append_paths
         when '*'
           @append_paths = Dir[@input_dir + '/*'].select do |path|
             File.directory?(path)
@@ -29,7 +37,7 @@ module Yarrow
             File.basename(path)
           end
         when String
-          @append_paths << options[:append_paths]
+          @append_paths << config.assets.append_paths
         end
       end
 
@@ -37,7 +45,6 @@ module Yarrow
       # Also generates a manifest linking each output bundle to its given input name.
       # @param bundles [Array<String>]
       def compile(bundles = [])
-        manifest = Sprockets::Manifest.new(environment, manifest_file_path)
         bundles.each do |bundle|          
           if bundle.include? '*'
             Dir["#{@input_dir}/#{bundle}"].each do |asset|
@@ -59,7 +66,21 @@ module Yarrow
         end
       end
 
+      ##
+      # Purges redundant compiled assets from the output path.
+      #
+      # @example Purge all assets except those created in the last 10 minutes
+      #   pipeline.purge(0, )
+      #
+      # @param keep [Integer] Number of previous revisions to keep. Defaults to 2.
+      # @param age [Integer] Purge all assets older than this date. Defaults to 1 hour.
+      def purge(keep = 2, age = 3600)
+        # TODO: upgrade to Sprockets 3.0 to support the age arg
+        manifest.clean(keep)
+      end
+
       # Access instance of the Sprockets environment.
+      # TODO: make this private to avoid forcing a dependency on Sprockets
       def environment
         @environment ||= create_environment
       end
@@ -78,6 +99,10 @@ module Yarrow
         "#{@output_dir}/manifest.json"
       end
 
+      def manifest
+        Sprockets::Manifest.new(environment, manifest_file_path)
+      end
+
       def create_environment
         environment = Sprockets::Environment.new(@input_dir)
         

data/lib/yarrow/configuration.rb

@@ -58,7 +58,7 @@ module Yarrow
       end
 
     end
-    
+
   end
 
   ##
@@ -78,4 +78,9 @@ module Yarrow
 
   end
 
+  ##
+  # Raised when a required config section or property is missing.
+  class ConfigurationError < StandardError
+  end
+
 end

data/lib/yarrow/defaults.yml

@@ -1,8 +1,19 @@
 # Default configuration settings for Yarrow.
 # This is loaded when the configuration is initialized.
+input_dir: content
+output_dir: public
 meta:
   title: Default Project
-  author: Project Author
+  author: Default Name
 output:
+  target_dir: public
+  template_dir: templates
   object_map:
-    page: Yarrow::Model::Site.pages
+    page: Yarrow::Model::Site.pages
+assets:
+  input_dir: assets
+  output_dir: public/assets
+  append_paths:
+    - css
+    - js
+  manifest_file: manifest.json

data/lib/yarrow/html/asset_tags.rb

@@ -5,7 +5,20 @@ module Yarrow
 
       # TODO: make sprockets manifest optional/pluggable
       def manifest
-        Yarrow::Assets::Manifest.new(config || {})
+        Yarrow::Assets::Manifest.new(config)
+      end
+
+      ##
+      # 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?
+
+        # 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, '')
       end
 
       def script_tags
@@ -16,8 +29,7 @@ module Yarrow
       def script_tag(options)
         if options.has_key? :asset and manifest.exists? options[:asset]
           script_path = manifest.digest_path(options[:asset])
-          assets_path = config.assets_path || ''
-          src_path = [assets_path, script_path].join('/')
+          src_path = "#{base_url_path}/#{script_path}"
         else
           src_path = options[:src]
         end
@@ -29,8 +41,7 @@ module Yarrow
       def link_tag(options)
         if options.has_key? :asset and manifest.exists? options[:asset]
           stylesheet_path = manifest.digest_path(options[:asset])
-          assets_path = config.assets_path || ''
-          href_path = [assets_path, stylesheet_path].join('/')      
+          href_path = "#{base_url_path}/#{stylesheet_path}"      
         else
           href_path = options[:href]
         end

data/lib/yarrow/model/index.rb

@@ -5,7 +5,6 @@ module Yarrow
     class Index
       def self.register(klass)
         method_name = ActiveSupport::Inflector.pluralize(ActiveSupport::Inflector.underscore(klass.to_s)).to_sym
-        puts method_name
         define_singleton_method method_name, lambda { klass.all }
       end
     end

data/lib/yarrow/version.rb

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

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   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: sprockets
   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: mementus
   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: activesupport
   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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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
@@ -131,17 +131,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/yarrow
+- lib/yarrow.rb
+- lib/yarrow/assets.rb
 - lib/yarrow/assets/manifest.rb
 - lib/yarrow/assets/pipeline.rb
-- lib/yarrow/assets.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
 - lib/yarrow/generator.rb
+- lib/yarrow/html.rb
 - lib/yarrow/html/asset_tags.rb
 - lib/yarrow/html/content_tags.rb
-- lib/yarrow/html.rb
 - lib/yarrow/logging.rb
 - lib/yarrow/model/base.rb
 - lib/yarrow/model/index.rb
@@ -150,7 +151,6 @@ files:
 - lib/yarrow/output/mapper.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
-- lib/yarrow.rb
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:
 - MIT
@@ -161,17 +161,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.8
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Documentation generator based on a fluent data model.