yarrow 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7360a9c100d2a45cbf57a77fcec6a02f21156a6af46d22a6c438dd43ab07557f
-  data.tar.gz: c71c2e48c2b3118b1d3d734430925f9bee7981a89462df9a8e05bfc5d12fc3c7
+  metadata.gz: cf4a0ff53beff8749c36f82844efeefec5463ec6ea6ebc9126fc4e0928b4d4c0
+  data.tar.gz: 2d4c1e187e40f5e6f6e6316e5908c1630129c28fa419c4216f06c6566d27854b
 SHA512:
-  metadata.gz: 77ed4fe864b0ad9f7d4a73b9787619f166eb5aa2631c70377e57de4c1f781f8da2bca717dafd98a940aff2e637590335e0076894b99a2f4e7ebbf94151acaa56
-  data.tar.gz: 6732e24c0275884b3cfbab5a417ab755b900ca8d94ffa00d7a84a6c90a042325615221785085d1913f1a0b26b54399b500d90f5beb6b6cd1c7183236e12beade
+  metadata.gz: 9624eb95caeb74e736c561d1bdfc18387d2e308427661073147b46377f35add1fd5aa7b03f758107e902fbbb741b6a7a070fd1cfc71a2371f3965774d1ddb128
+  data.tar.gz: 3ae340c7e995e51b6a09ef86bf1faa191565a73bd61660d8276f9f77c6722633717dd027e137b0de2eab3f8a320befc1903ed2ef3f5287a83e99ad6d0eda761b

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.7, '3.0', jruby]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -4,4 +4,5 @@ fabfile.pyc
 pirum.xml
 Gemfile.lock
 yarrow-*.gem
-coverage
+coverage
+bin/scripts

data/lib/yarrow.rb

@@ -1,5 +1,6 @@
 require 'hashie'
 require 'yaml'
+require 'active_support/inflector'
 
 require 'yarrow/version'
 require 'yarrow/logging'
@@ -7,18 +8,27 @@ require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/generator'
 require 'yarrow/assets'
+require 'yarrow/tools/front_matter'
 require 'yarrow/content/graph'
-#require 'yarrow/content/resource_expander'
+require 'yarrow/content/content_type'
+require 'yarrow/content/source'
 require 'yarrow/content/source_collector'
+require 'yarrow/content/collection_expander'
 require 'yarrow/html/asset_tags'
 require 'yarrow/output/mapper'
 require 'yarrow/output/generator'
 require 'yarrow/output/context'
 require 'yarrow/content_map'
 require 'yarrow/html'
-require 'yarrow/tools/front_matter'
 require 'yarrow/server'
 require 'yarrow/server/livereload'
+require 'yarrow/schema'
+
+require 'yarrow/process/workflow'
+require 'yarrow/process/step_processor'
+require 'yarrow/process/expand_content'
+require 'yarrow/process/extract_source'
+require 'yarrow/process/project_manifest'
 
 # Dir[File.dirname(__FILE__) + '/yarrow/generators/*.rb'].each do |generator|
 #   require generator

data/lib/yarrow/content/collection_expander.rb

@@ -0,0 +1,219 @@
+puts "CollectionExpander!!!"
+
+module Yarrow
+  module Content
+    class CollectionExpander
+      include Yarrow::Tools::FrontMatter
+
+      def initialize(content_types=nil)
+        @content_types = content_types || [
+          Yarrow::Content::ContentType.from_name(:pages)
+        ]
+      end
+
+      def expand(graph)
+        @content_types.each do |content_type|
+          expand_nested(graph, content_type)
+        end
+      end
+
+      def expand_nested(graph, content_type)
+        type = content_type.collection
+        exts = content_type.extensions
+
+        # If match path represents entire content dir, then include the entire
+        # content dir instead of scanning from a subfolder matching the name of
+        # the collection.
+        start_node = if content_type.match_path == "."
+          graph.n(:root)
+        else
+          graph.n(:root).out(name: type.to_s)
+        end
+
+        # Extract metadata from given start node
+        data = extract_metadata(start_node, type)
+
+        # Collects all nested collections in the subgraph for this content type
+        subcollections = {}
+        index = nil
+
+        # Define alias for accessing metadata in the loop
+        metadata = data
+
+        # Scan and collect all nested directories under the top level source
+        start_node.depth_first.each do |node|
+          if node.label == :directory
+            # Check if this entry has metadata defined at the top level
+            if data[:collections]
+              item = data[:collections].find { |c| c[:slug] == node.props[:slug] }
+              metadata = item if item
+            end
+
+            # Create a collection node representing a collection of documents
+            index = graph.create_node do |collection_node|
+              collection_node.label = :collection
+              collection_node.props[:type] = type
+              collection_node.props[:name] = node.props[:name]
+              collection_node.props[:slug] = node.props[:slug]
+              collection_node.props[:title] = metadata[:title]
+
+              # Override default status so that mapped index collections always show
+              # up in the resulting document manifest, when they don’t have
+              # associated metadata. This is the opposite of how individual pieces
+              # of content behave (default to draft status if one isn’t supplied).
+              collection_node.props[:status] = if data[:status]
+                data[:status]
+              else
+                "published"
+              end
+
+              # TODO: URL generation might need to happen elsewhere
+              collection_node.props[:url] = if data[:url]
+                data[:url]
+              else
+                "#{node.props[:path].split('./content').last}/"
+              end
+            end
+
+            # Add this collection id to the lookup table for edge construction
+            subcollections[node.props[:path]] = index
+
+            # Join the collection to its parent
+            unless node.props[:slug] == type.to_s || !subcollections.key?(node.props[:entry].parent.to_s)
+              graph.create_edge do |edge|
+                edge.label = :child
+                edge.from = subcollections[node.props[:entry].parent.to_s].id
+                edge.to = index.id
+              end
+            end
+          end
+        end
+
+        subcollections.each do |path, index|
+          # Group files matching the same slug under a common key
+          objects = graph.n(path: path).out(:file).all.select do |file|
+            file.props[:name].end_with?(*exts)
+          end.group_by do |file|
+            file.props[:slug]
+          end
+
+          build_content_nodes(graph, objects, type, index)
+        end
+      end
+
+      # Extract collection level configuration/metadata from the root node for
+      # this content type.
+      def extract_metadata(node, type)
+        # TODO: support _index or _slug convention as well
+        meta_file = node.out(slug: type.to_s).first
+
+        if meta_file
+          # Process metadata and add it to the collection node
+          # TODO: pass in content converter object
+          # TODO: index/body content by default if extracted from frontmatter
+          body, data = process_content(meta_file.props[:entry])
+        else
+          # Otherwise, assume default collection behaviour
+          data = {}
+        end
+
+        # Generate a default title if not provided in metadata
+        unless data.key?(:title)
+          data[:title] = type.to_s.capitalize
+        end
+
+        data
+      end
+
+      def build_content_nodes(graph, objects, type, parent_index)
+        # TODO: this may need to use a strategy that can be overriden
+        content_type = ActiveSupport::Inflector.singularize(type).to_sym
+
+        # Process collected content objects and generate entity nodes
+        objects.each do |name, sources|
+          item_node = graph.create_node do |node|
+            # TODO: Rename this to :entry and support similar fields to Atom
+            node.label = :item
+            node.props[:name] = name
+            node.props[:type] = content_type
+
+            meta = {}
+            content = ""
+
+            sources.each do |source|
+              body, data = process_content(source.props[:entry])
+              meta.merge!(data) unless data.nil?
+              content << body unless body.nil?
+            end
+
+            if meta[:url]
+              # If a URL is explicitly proided in metadata then use it
+              node.props[:url] = meta[:url]
+            elsif meta[:permalink]
+              # Support for legacy permalink attribute
+              node.props[:url] = meta[:permalink]
+            else
+              # Default URL generation strategy when no explicit URL is provided
+              # TODO: collection nodes need URL generation too
+              # TODO: replace this with URL generation strategy
+              # TODO: slug vs name - why do some nodes have 2 and some 3 props?
+              node.props[:url] = if parent_index.props[:name].to_sym == parent_index.props[:type]
+                "/#{parent_index.props[:type]}/#{name}"
+              else
+                "/#{parent_index.props[:type]}/#{parent_index.props[:slug]}/#{name}"
+              end
+            end
+
+            # For now, we are storing title, url, etc on the top-level item.
+            node.props[:title] = meta[:title]
+
+            # TODO: What belongs on the entity and what belongs on the item?
+            entity_props = meta.merge(body: content, name: meta[:id], url: node.props[:url])
+
+
+            # TODO: consider whether to provide `body` on the item/document or at
+            # the custom content type level.
+            begin
+              content_struct = Object.const_get(ActiveSupport::Inflector.classify(content_type))
+            rescue
+              require "ostruct"
+              content_struct = OpenStruct
+            end
+
+            node.props[:entity] = content_struct.new(entity_props)
+          end
+
+          # Connect entity with source content
+          sources.each do |source|
+            graph.create_edge do |edge|
+              edge.label = :source
+              edge.from = item_node
+              edge.to = source.id
+            end
+          end
+
+          # Connect entity with parent collection
+          graph.create_edge do |edge|
+            edge.label = :child
+            edge.from = parent_index
+            edge.to = item_node
+          end
+        end
+      end
+
+      # Workaround for handling meta and content source in multiple files or a single
+      # file with front matter.
+      def process_content(path)
+        case path.extname
+        when '.htm', '.md'
+          read_split_content(path.to_s, 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)]
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/content/content_type.rb

@@ -0,0 +1,38 @@
+module Yarrow
+  module Content
+    class ContentType
+      DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
+
+      def self.from_name(name)
+        new(Yarrow::Configuration.new(collection: name.to_sym))
+      end
+
+      def initialize(properties)
+        unless properties.respond_to?(:collection) || properties.respond_to?(:entity)
+          raise "Must provide a collection name or entity name"
+        end
+
+        @properties = properties
+      end
+
+      def collection
+        return @properties.collection if @properties.respond_to?(:collection)
+        ActiveSupport::Inflector.pluralize(@properties.entity).to_sym
+      end
+
+      def entity
+        return @properties.entity if @properties.respond_to?(:entity)
+        ActiveSupport::Inflector.singularize(@properties.collection).to_sym
+      end
+
+      def extensions
+        return @properties.extensions if @properties.respond_to?(:extensions)
+        DEFAULT_EXTENSIONS
+      end
+
+      def match_path
+        "."
+      end
+    end
+  end
+end

data/lib/yarrow/content/graph.rb

@@ -8,6 +8,19 @@ module Mementus
       include Enumerable
     end
   end
+  module Structure
+    class IncidenceList
+      def inspect
+        "<Mementus::Structure::IncidenceList>"
+      end
+    end
+  end
+  class Graph
+    def inspect
+      "<Mementus::Graph @structure=#{@structure.inspect} " +
+        "nodes_count=#{nodes_count} edges_count=#{edges_count}>"
+    end
+  end
 end
 
 module Yarrow
@@ -16,7 +29,19 @@ module Yarrow
     class Graph
       # Construct a graph collected from source content files.
       def self.from_source(config)
-        new(SourceCollector.collect(config.input_dir))
+        new(SourceCollector.collect(config.input_dir), config)
+      end
+
+      attr_reader :graph, :config
+
+      def initialize(graph, config)
+        @graph = graph
+        @config = config
+      end
+
+      def expand_pages
+        expander = Yarrow::Content::CollectionExpander.new(config.content_types)
+        expander.expand(graph)
       end
 
       # List of source files.
@@ -28,14 +53,6 @@ module Yarrow
       def directories
         graph.nodes(:directory)
       end
-
-      private
-
-      def initialize(graph)
-        @graph = graph
-      end
-
-      attr_reader :graph
     end
   end
 end

data/lib/yarrow/content/source.rb

@@ -0,0 +1,11 @@
+module Yarrow
+  module Content
+    class Source
+      attr_reader :input_dir
+
+      def initialize(config)
+        @input_dir = config[:input_dir]
+      end
+    end
+  end
+end

data/lib/yarrow/process/expand_content.rb

@@ -0,0 +1,12 @@
+module Yarrow
+  module Process
+    class ExpandContent < StepProcessor
+      accepts String
+      provides String
+
+      def step(source)
+        "#{source} | ExpandContent::Result"
+      end
+    end
+  end
+end

data/lib/yarrow/process/extract_source.rb

@@ -0,0 +1,12 @@
+module Yarrow
+  module Process
+    class ExtractSource < StepProcessor
+      accepts String
+      provides String
+
+      def step(source)
+        "#{source} | ExtractSource::Result"
+      end
+    end
+  end
+end

data/lib/yarrow/process/project_manifest.rb

@@ -0,0 +1,20 @@
+module Yarrow
+  module Process
+    class ProjectManifest < StepProcessor
+      accepts String
+      provides String
+
+      def before_step(content)
+
+      end
+
+      def step(content)
+        "#{content} | ProjectManifest::Result"
+      end
+
+      def after_step(content)
+
+      end
+    end
+  end
+end

data/lib/yarrow/process/step_processor.rb

@@ -0,0 +1,43 @@
+module Yarrow
+  module Process
+    class StepProcessor
+      attr_reader :source
+
+      class << self
+        attr_reader :accepted_input, :provided_output
+
+        def accepts(input_const)
+          @accepted_input = input_const.to_s
+        end
+
+        def provides(output_const)
+          @provided_output = output_const.to_s
+        end
+      end
+
+      def initialize
+        @source = nil
+      end
+
+      def accepts
+        self.class.accepted_input
+      end
+
+      def provides
+        self.class.provided_output
+      end
+
+      def can_accept?(provided)
+        accepts == provided
+      end
+
+      def process(source)
+        # begin
+        result = step(source)
+        # log.info("<Result source=#{result}>")
+        # rescue
+        result
+      end
+    end
+  end
+end

data/lib/yarrow/process/workflow.rb

@@ -0,0 +1,36 @@
+module Yarrow
+  module Process
+    class Workflow
+      def initialize(input)
+        @input = input
+        @processors = []
+      end
+
+      def connect(processor)
+        provided_input = if @processors.any?
+          @processors.last.provides
+        else
+          @input.class.to_s
+        end
+
+        if processor.can_accept?(provided_input)
+          @processors << processor
+        else
+          raise ArgumentError.new(
+            "`#{processor.class}` accepts `#{processor.accepts}` but was connected to `#{provided_input}`"
+          )
+        end
+      end
+
+      def process(&block)
+        result = @input
+
+        @processors.each do |processor|
+          result = processor.process(result)
+        end
+
+        block.call(result)
+      end
+    end
+  end
+end

data/lib/yarrow/server.rb

@@ -16,6 +16,7 @@ module Yarrow
     # 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={})

data/lib/yarrow/source/graph.rb

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

data/lib/yarrow/version.rb

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

data/yarrow.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   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 '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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -128,56 +128,56 @@ dependencies:
     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,8 +201,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -216,7 +216,10 @@ files:
 - lib/yarrow/assets/pipeline.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
@@ -228,8 +231,14 @@ files:
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.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/server.rb
 - lib/yarrow/server/livereload.rb
+- lib/yarrow/source/graph.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/tools/output_file.rb
 - lib/yarrow/version.rb
@@ -253,8 +262,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.

data/.travis.yml

@@ -1,16 +0,0 @@
-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