yarrow 0.4.3 → 0.6.2

data/lib/yarrow/server.rb

@@ -4,18 +4,21 @@ module Yarrow
   ##
   # Little web server for browsing local files.
   class Server
-    include Configurable
+    attr_reader :config
 
-    def initialize
-      if config.server.nil?
-        raise ConfigurationError.new('Missing server entry')
+    def initialize(instance_config)
+      if instance_config.server.nil?
+        raise ConfigurationError.new("Missing server entry")
       end
+
+      @config = instance_config
     end
 
     ##
     # Rack Middleware for detecting and serving an 'index.html' file
     # instead of a directory index.
     #
+    # TODO: Fix bug where a directory /index.html/ causes this to crash
     # TODO: Add configurable mapping and media types for README files as an alternative
     class DirectoryIndex
       def initialize(app, options={})
@@ -97,7 +100,7 @@ module Yarrow
     ##
     # @return [String]
     def docroot
-      config.output_dir || Dir.pwd
+      config.output_dir
     end
 
     ##

data/lib/yarrow/source/graph.rb

@@ -0,0 +1,6 @@
+module Yarrow
+  module Source
+    class Graph
+    end
+  end
+end

data/lib/yarrow/symbols.rb

@@ -0,0 +1,19 @@
+require "strings-inflection"
+require "strings-case"
+
+module Yarrow
+  module Symbols
+    # Converts an atomic content identifier to a live class constant.
+    def self.to_const(atom)
+      Object.const_get(Strings::Case.pascalcase(atom.to_s).to_sym)
+    end
+
+    def self.to_singular(atom)
+      Strings::Inflection.singularize(atom.to_s).to_sym
+    end
+
+    def self.to_plural(atom)
+      Strings::Inflection.pluralize(atom.to_s).to_sym
+    end
+  end
+end

data/lib/yarrow/tools/content_utils.rb

@@ -0,0 +1,66 @@
+module Yarrow
+  module Tools
+    # Synchronous utility functions for working with filesystem content tasks.
+    module ContentUtils
+      # Pass in a source path and get back a parsed representation of the
+      # content if it is in a known text format. Mostly used as a fallback if
+      # a custom parser or processing chain is not configured for a content
+      # type.
+      #
+      # Supported formats:
+      # - HTML template and document partials
+      # - Markdown documents
+      # - YAML documents
+      # - JSON (untested)
+      #
+      # Works around meta and content source in multiple files or a single
+      # file with front matter.
+      def read(name)
+        path = if name.is_a?(Pathname)
+          name
+        else
+          Pathname.new(name)
+        end
+
+        text = File.read(path, :encoding => 'utf-8')
+
+        case path.extname
+        when '.htm', '.md', '.txt', '.yfm'
+          extract_yfm(text, symbolize_keys: true)
+        # when '.md'
+        #   body, data = read_split_content(path.to_s, symbolize_keys: true)
+        #   [Kramdown::Document.new(body).to_html, data]
+        when '.yml'
+          [nil, YAML.load(File.read(path.to_s), symbolize_names: true)]
+        when '.json'
+          [nil, JSON.parse(File.read(path.to_s))]
+        end
+      end
+
+      def extract_yfm(text, options={})
+        pattern = /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        if text =~ pattern
+          content = text.sub(pattern, "")
+
+          begin
+            if options.key?(:symbolize_keys)
+              meta = YAML.load($1, symbolize_names: true)
+            else
+              meta = YAML.load($1)
+            end
+            return [content, meta]
+          rescue Psych::SyntaxError => error
+            if defined? ::Logger
+              # todo: application wide logger
+              #logger = ::Logger.new(STDOUT)
+              #logger.error "#{error.message}"
+            end
+            return [content, nil]
+          end
+        end
+
+        [text, nil]
+      end
+    end
+  end
+end

data/lib/yarrow/tools/front_matter.rb

@@ -1,5 +1,7 @@
 module Yarrow
   module Tools
+    # @deprecated
+    # Maintained here as it is still used in a number of places but needs to be removed soon
     module FrontMatter
 
       def read_split_content(path, options={})
@@ -21,8 +23,8 @@ module Yarrow
           rescue Psych::SyntaxError => error
             if defined? ::Logger
               # todo: application wide logger
-              logger = ::Logger.new(STDOUT)
-              logger.error "#{error.message}"
+              #logger = ::Logger.new(STDOUT)
+              #logger.error "#{error.message}"
             end
             return [content, nil]
           end

data/lib/yarrow/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Yarrow
-  APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.4.3'.freeze
+  APP_NAME = 'Yarrow'
+  VERSION = '0.6.2'
 end

data/lib/yarrow/web/html_document.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class HTMLDocument
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/manifest.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Manifest
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/static_asset.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class StaticAsset
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/template.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Template
+      def initialize
+
+      end
+    end
+  end
+end

data/yarrow.gemspec

@@ -0,0 +1,30 @@
+$:.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 'mementus', '~> 0.8'
+  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 'strings-inflection', '~> 0.1'
+  spec.add_runtime_dependency 'strings-case', '~> 0.3'
+  spec.add_development_dependency 'bundler', '~> 2.2.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8.23'
+  spec.add_development_dependency 'rack-test', '~> 0.8'
+  spec.homepage = 'http://rubygemspec.org/gems/yarrow'
+  spec.license = 'MIT'
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.2
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2021-03-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: mementus
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -109,75 +81,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: strings-inflection
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: strings-case
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.9
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: 0.8.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: 0.8.23
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -201,29 +187,58 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SERVER.md
 - bin/yarrow
 - bin/yarrow-server
 - lib/yarrow.rb
 - lib/yarrow/assets.rb
 - lib/yarrow/assets/manifest.rb
 - lib/yarrow/assets/pipeline.rb
+- lib/yarrow/config.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
+- lib/yarrow/content/collection_expander.rb
+- lib/yarrow/content/content_type.rb
+- lib/yarrow/content/graph.rb
+- lib/yarrow/content/source.rb
+- lib/yarrow/content/source_collector.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
+- lib/yarrow/extensions.rb
+- lib/yarrow/extensions/mementus.rb
 - lib/yarrow/generator.rb
-- lib/yarrow/html.rb
-- lib/yarrow/html/asset_tags.rb
-- lib/yarrow/html/content_tags.rb
 - lib/yarrow/logging.rb
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
+- lib/yarrow/output/web/indexed_file.rb
+- lib/yarrow/process/expand_content.rb
+- lib/yarrow/process/extract_source.rb
+- lib/yarrow/process/project_manifest.rb
+- lib/yarrow/process/step_processor.rb
+- lib/yarrow/process/workflow.rb
+- lib/yarrow/schema.rb
+- lib/yarrow/schema/validations/array.rb
+- lib/yarrow/schema/validations/object.rb
+- lib/yarrow/schema/validations/string.rb
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
+- lib/yarrow/source/graph.rb
+- lib/yarrow/symbols.rb
+- lib/yarrow/tools/content_utils.rb
 - lib/yarrow/tools/front_matter.rb
-- lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
+- lib/yarrow/web/html_document.rb
+- lib/yarrow/web/manifest.rb
+- lib/yarrow/web/static_asset.rb
+- lib/yarrow/web/template.rb
+- yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:
 - MIT
@@ -243,8 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Documentation generator based on a fluent data model.