yarrow 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb890c962e1b152e81d7a896a716b1bc95d71cf3d338bd21eae5e5ffdc42d99c
-  data.tar.gz: 5e8e94e90d2e89d7e39d88fa7261061c6b819a93fa50abf0404b9c505badf79c
+  metadata.gz: 7360a9c100d2a45cbf57a77fcec6a02f21156a6af46d22a6c438dd43ab07557f
+  data.tar.gz: c71c2e48c2b3118b1d3d734430925f9bee7981a89462df9a8e05bfc5d12fc3c7
 SHA512:
-  metadata.gz: 6d4b8dfecfa7740c5a6cef0d2441fdb0d7b7b0b28e0e92506a20f3f32ad826460b5c11142f6f62ea6da3ca5db61b5791cffa334feb8d397fa287e74134683f0a
-  data.tar.gz: f70d14e7b308a606194f1f79ea20d35241cc27d46d98bd2aa02ae8f5f754c6315c2fa25c310671a787114ac32c3dfd438c79484f62abb33d94baafc0eb387c2e
+  metadata.gz: 77ed4fe864b0ad9f7d4a73b9787619f166eb5aa2631c70377e57de4c1f781f8da2bca717dafd98a940aff2e637590335e0076894b99a2f4e7ebbf94151acaa56
+  data.tar.gz: 6732e24c0275884b3cfbab5a417ab755b900ca8d94ffa00d7a84a6c90a042325615221785085d1913f1a0b26b54399b500d90f5beb6b6cd1c7183236e12beade

data/.gitignore

@@ -0,0 +1,7 @@
+*.tgz
+fabfile.py
+fabfile.pyc
+pirum.xml
+Gemfile.lock
+yarrow-*.gem
+coverage

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - ruby-head
+  - jruby
+  - rbx-3
+
+script: bundle exec rspec
+
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2010-2014 by Mark Rickerby <http://maetl.net>.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+Yarrow
+======
+
+[![Gem Version](http://img.shields.io/gem/v/yarrow.svg)][gem]
+[![Build Status](http://img.shields.io/travis/maetl/yarrow.svg)][travis]
+[![Dependency Status](http://img.shields.io/gemnasium/maetl/yarrow.svg)][gemnasium]
+[![Code Climate](http://img.shields.io/codeclimate/github/maetl/yarrow.svg)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/maetl/yarrow.svg)][coveralls]
+
+[gem]: https://rubygems.org/gems/yarrow
+[travis]: https://travis-ci.org/maetl/yarrow
+[gemnasium]: https://gemnasium.com/maetl/yarrow
+[codeclimate]: https://codeclimate.com/github/maetl/yarrow
+[coveralls]: https://coveralls.io/r/maetl/yarrow
+
+Yarrow is a tool for generating well structured documentation from a variety of input sources.
+
+Unlike most static site generators and code documentation tools, Yarrow is written with design and content-strategy in mind. It does not impose its own structure on your content. This makes it appropriate for building static sites and blogs as well as style guides and API docs.
+
+Installation
+------------
+
+Install the library and command line tool via RubyGems:
+
+```
+gem install yarrow
+```
+
+Or embed it in an existing Ruby project by adding the following line to the `Gemfile` and running `bundle`:
+
+```
+gem 'yarrow'
+```
+
+Status
+------
+
+Yarrow is an extraction from several existing private documentation projects. This repo is in alpha state, which means that many of the useful features are not yet folded into this codebase.
+
+Yarrow is being slowly developed as a part-time project to scratch a few itches. New features and bugfixes are pushed straight to master, and releases of the Gem are kept more or less in sync with the planned roadmap.
+
+Roadmap
+-------
+
+A rough sketch of the project direction.
+
+| Version | Features |
+|---------|----------|
+| `0.3`   | **[Local dev server and asset pipeline](https://github.com/maetl/yarrow/issues/48)** |
+| `0.4`   | Default media type mapping, collector, markup converters |
+| `0.5`   | Content model/object mapping, template/site context |
+| `0.6`   | HTML tag helpers, default layout templates |
+| `0.7`   | Rake integration, task library |
+| `0.8`   | Generic command line runner |
+| `0.9`   | Refactoring, performance fixes, lock down API |
+
+License
+-------
+
+MIT. See the `LICENSE` file in the source distribution.
+
+Contact
+-------
+
+Author: Mark Rickerby <me@maetl.net>

data/Rakefile

@@ -0,0 +1,4 @@
+
+task :clean do
+  sh 'rm yarrow-*.gem'
+end

data/SERVER.md

@@ -0,0 +1,41 @@
+# Local Dev Server
+
+Yarrow provides a local dev server for quick previews and incremental development of documentation.
+
+## Getting Started
+
+To start the server in the current working directory, run `yarrow-server`:
+
+```
+$ yarrow-server
+```
+
+## Directory Indexes
+
+There are several options that control the behavior of directory indexes:
+
+- `default_index` sets the name of the file used as a default directory index (usually `index.html`).
+- `auto_index` generates a listing of files in the directory when no default index is provided.
+
+## Default Content Type
+
+To set a default content type for files without an automatically detected MIME type or extension, use `default_type`:
+
+```
+default_type: 'text/html'
+```
+
+## Rack Configuration
+
+The following options are available under the `server` entry in the main configuration:
+
+|Option|Type|Description|Default|
+|-|-|-|-|
+|**port**|Integer|Local port for the server to listen on|`8888`|
+|**host**|String|Local host for the server to listen on|`localhost`|
+|**handler**|Symbol (one of `:thin`, `:webrick`, etc)|Specifies the webserver implementation that handles requests|`:thin`|
+|**middleware**|Array|List of Rack middleware to be injected as plugins|
+
+Additional configuration options that are relevant:
+
+`config.output_dir`: If specified, determines the docroot. Otherwise the server defaults to the current working directory.

data/lib/yarrow.rb

@@ -7,6 +7,9 @@ require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/generator'
 require 'yarrow/assets'
+require 'yarrow/content/graph'
+#require 'yarrow/content/resource_expander'
+require 'yarrow/content/source_collector'
 require 'yarrow/html/asset_tags'
 require 'yarrow/output/mapper'
 require 'yarrow/output/generator'

data/lib/yarrow/content/graph.rb

@@ -0,0 +1,41 @@
+require "mementus"
+
+module Mementus
+  module Pipeline
+    class Step
+      # Monkeypatch extension to ensure each pipeline step supports enumerable
+      # methods. Mostly used for #map. API needs to be fixed in the gem itself.
+      include Enumerable
+    end
+  end
+end
+
+module Yarrow
+  module Content
+    # A directed graph of every element of content in the project.
+    class Graph
+      # Construct a graph collected from source content files.
+      def self.from_source(config)
+        new(SourceCollector.collect(config.input_dir))
+      end
+
+      # List of source files.
+      def files
+        graph.nodes(:file)
+      end
+
+      # List of source directories.
+      def directories
+        graph.nodes(:directory)
+      end
+
+      private
+
+      def initialize(graph)
+        @graph = graph
+      end
+
+      attr_reader :graph
+    end
+  end
+end

data/lib/yarrow/content/source_collector.rb

@@ -0,0 +1,55 @@
+module Yarrow
+  module Content
+    # Collects a digraph of all directories and files underneath the given input
+    # directory.
+    class SourceCollector
+      def self.collect(input_dir)
+        Mementus::Graph.new(is_mutable: true) do
+          root = create_node do |root|
+            root.label = :root
+          end
+
+          directories = {
+            Pathname.new(input_dir).to_s => root.id
+          }
+
+          Pathname.glob("#{input_dir}/**/**").each do |entry|
+            if entry.directory?
+              #puts "Reading directory: #{entry}"
+
+              content_node = create_node do |dir|
+                dir.label = :directory
+                dir.props[:name] = entry.basename.to_s
+                dir.props[:slug] = entry.basename.to_s
+                dir.props[:path] = entry.to_s
+                dir.props[:entry] = entry
+              end
+
+              directories[entry.to_s] = content_node.id
+            else
+              #puts "Reading file: #{entry} (#{entry.basename.sub_ext('')})"
+
+              content_node = create_node do |file|
+                file.label = :file
+                file.props[:name] = entry.basename.to_s
+                file.props[:slug] = entry.basename.sub_ext('').to_s
+                file.props[:path] = entry.to_s
+                file.props[:entry] = entry
+              end
+            end
+
+            if directories.key?(entry.dirname.to_s)
+              #puts "Create parent edge: #{directories[entry.dirname.to_s]}"
+
+              create_edge do |edge|
+                edge.label = :child
+                edge.from = directories[entry.dirname.to_s]
+                edge.to = content_node
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/output/context.rb

@@ -6,7 +6,6 @@ module Yarrow
     # Mustache templates.
     #
     # Includes the library of helpers for dynamically generating HTML tags.
-    #
     class Context
       include Yarrow::HTML::AssetTags
 
@@ -17,6 +16,5 @@ module Yarrow
         end
       end
     end
-
   end
 end

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
   APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.4.3'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/yarrow.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'yarrow/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'yarrow'
+  spec.version     = Yarrow::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.summary     = 'Documentation generator based on a fluent data model.'
+  spec.description = 'Yarrow is a tool for generating well structured documentation from a variety of input sources.'
+  spec.authors     = ['Mark Rickerby']
+  spec.email       = 'me@maetl.net'
+  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables << 'yarrow'
+  spec.executables << 'yarrow-server'
+  spec.add_runtime_dependency 'hashie', '~> 3.5'
+  spec.add_runtime_dependency 'mementus', '~> 0.8'
+  spec.add_runtime_dependency 'activesupport', '~> 5.1'
+  spec.add_runtime_dependency 'rack', '~> 2.0'
+  spec.add_runtime_dependency 'rack-livereload', '~> 0.3'
+  spec.add_runtime_dependency 'eventmachine', '~> 1.2'
+  spec.add_runtime_dependency 'em-websocket', '~> 0.5.1'
+  spec.add_runtime_dependency 'sprockets', '~> 3.7'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency 'rack-test', '~> 0.8'
+  spec.homepage = 'http://rubygemspec.org/gems/yarrow'
+  spec.license = 'MIT'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -201,6 +201,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SERVER.md
 - bin/yarrow
 - bin/yarrow-server
 - lib/yarrow.rb
@@ -209,6 +216,8 @@ files:
 - lib/yarrow/assets/pipeline.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
+- lib/yarrow/content/graph.rb
+- lib/yarrow/content/source_collector.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
 - lib/yarrow/generator.rb
@@ -224,6 +233,7 @@ files:
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
+- yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:
 - MIT