yarrow 0.7.2 → 0.7.3

data/lib/yarrow/schema/value.rb

@@ -0,0 +1,46 @@
+module Yarrow
+  module Schema
+    # Value object (with comparison by value equality). This just chucks back a
+    # Ruby struct but wraps the constructor with method advice that handles
+    # type checking and conversion.
+    class Value
+      def self.new(*slots, **fields, &block)
+        factory(*slots, **fields, &block)
+      end
+
+      def self.factory(*slots, **fields, &block)
+        if slots.empty? && fields.empty?
+          raise ArgumentError.new("missing attribute definition")
+        end
+
+        slots_spec, fields_spec = if fields.any?
+          raise ArgumentError.new("cannot use slots when field map is supplied") if slots.any?
+          [fields.keys, fields]
+        else
+          [slots, Hash[slots.map { |s| [s, :any]}]]
+        end
+
+        validator = Dictionary.new(fields_spec)
+
+        struct = Struct.new(*slots_spec, keyword_init: true, &block)
+
+        struct.define_method :initialize do |*args, **kwargs|
+          attr_values = if args.any?
+            raise ArgumentError.new("cannot mix slots and kwargs") if kwargs.any?
+            Hash[slots.zip(args)]
+          else
+            kwargs
+          end
+
+          validator.check(attr_values)
+          # TODO: type coercion or mapping decision goes here
+          super(**attr_values)
+
+          freeze
+        end
+
+        struct
+      end
+    end
+  end
+end

data/lib/yarrow/schema.rb

@@ -1,132 +1,41 @@
+require "delegate"
+
 module Yarrow
   module Schema
     module Type
-      class Any
-      end
-    end
-
-    ##
-    # Checks values plugged into each slot and runs any required validations
-    # (validations not yet implemented).
-    #
-    # Current design throws on error rather than returns a boolean result.
-    class Validator
-      # @param fields_spec [Hash] defines the slots in the schema to validate against
-      def initialize(fields_spec)
-        @spec = fields_spec
-      end
-
-      def check(fields)
-        missing_fields = @spec.keys.difference(fields.keys)
-
-        if missing_fields.any?
-          missing_fields.each do |field|
-            raise "wrong number of args" unless @spec[field].eql?(Type::Any)
-          end
-        end
-
-        mismatching_fields = fields.keys.difference(@spec.keys)
-
-        raise "key does not exist" if mismatching_fields.any?
-
-        fields.each do |(field, value)|
-          raise "wrong data type" unless value.is_a?(@spec[field]) || @spec[field].eql?(Type::Any)
-        end
-
-        true
-      end
-    end
-
-    ##
-    # Value object (with comparison by value equality). This just chucks back a
-    # Ruby struct but wraps the constructor with method advice that handles
-    # validation (and eventually type coercion if !yagni).
-    class Value
-      def self.new(*slots, **fields, &block)
-        factory(*slots, **fields, &block)
-      end
-
-      def self.factory(*slots, **fields, &block)
-        if slots.empty? && fields.empty?
-          raise ArgumentError.new("missing attribute definition")
-        end
-
-        slots_spec, fields_spec = if fields.any?
-          raise ArgumentError.new("cannot use slots when field map is supplied") if slots.any?
-          [fields.keys, fields]
-        else
-          [slots, Hash[slots.map { |s| [s, Type::Any]}]]
-        end
-
-        validator = Validator.new(fields_spec)
-
-        struct = Struct.new(*slots_spec, keyword_init: true, &block)
-
-        struct.define_method :initialize do |*args, **kwargs|
-          attr_values = if args.any?
-            raise ArgumentError.new("cannot mix slots and kwargs") if kwargs.any?
-            Hash[slots.zip(args)]
-          else
-            kwargs
+      class Raw
+        class << self
+          def [](primitive)
+            @primitive = primitive
           end
 
-          validator.check(attr_values)
-          # TODO: type coercion or mapping decision goes here
-          super(**attr_values)
-
-          freeze
-        end
-
-        struct
-      end
-    end
-
-    ##
-    # Entity with comparison by reference equality. Generates attribute helpers
-    # for a declared set of props. Used to replace Hashie::Mash without dragging
-    # in a whole new library.
-    class Entity
-      class << self
-        def attribute(name, value_type)
-          # define_method("map_#{name}".to_sym) do |input|
-          #   value_type.coerce(input)
-          # end
-          dictionary[name] = value_type
-          attr_reader(name)
-        end
-
-        def dictionary
-          @dictionary ||= Hash.new
-        end
-      end
-
-      def dictionary
-        self.class.dictionary
-      end
-
-      def initialize(config)
-        dictionary.each_key do |name|
-          raise "missing declared attribute #{name}" unless dictionary.key?(name)
-        end
-
-        config.each_pair do |key, value|
-          raise "#{key} not a declared attribute" unless dictionary.key?(key)
-
-          defined_type = dictionary[key]
-
-          unless value.is_a?(defined_type)
-            raise "#{key} accepts #{defined_type} but #{value.class} given"
+          def new(input)
+            input
           end
-
-          instance_variable_set("@#{key}", value)
         end
       end
-    end
 
-    def to_h
-      dictionary.keys.reduce({}) do |h, name|
-        h[name] = instance_variable_get("@#{name}")
+      class Any
       end
+      # class Attribute
+      #   class << self
+      #     def accepts(attr_type)
+      #       @accepts = attr_type
+      #     end
+      #   end
+      #
+      #   attr_accessor :value
+      #   alias_method :__getobj__, :value
+      #
+      #   def initialize(value)
+      #     raise "Invalid type" unless @accepts.is_a?(value.class)
+      #     @value = value
+      #   end
+      # end
+      #
+      # class Text < Attribute
+      #   accepts String
+      # end
     end
   end
 end

data/lib/yarrow/symbols.rb

@@ -3,15 +3,30 @@ require "strings-case"
 
 module Yarrow
   module Symbols
+    # @param [Array<String>, Array<Symbol>] parts
+    # @return [Object]
+    def self.to_module_const(parts)
+      Object.const_get(parts.map { |atom|
+        Strings::Case.pascalcase(atom.to_s)
+      }.join("::"))
+    end
+
     # Converts an atomic content identifier to a live class constant.
+    #
+    # @param [Symbol, String] atom
+    # @return [Object]
     def self.to_const(atom)
       Object.const_get(Strings::Case.pascalcase(atom.to_s).to_sym)
     end
 
+    # @param [Symbol, String] atom
+    # @return [Symbol]
     def self.to_singular(atom)
       Strings::Inflection.singularize(atom.to_s).to_sym
     end
 
+    # @param [Symbol, String] atom
+    # @return [Symbol]
     def self.to_plural(atom)
       Strings::Inflection.pluralize(atom.to_s).to_sym
     end

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
   APP_NAME = 'Yarrow'
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 end

data/lib/yarrow.rb

@@ -6,18 +6,25 @@ require 'yarrow/extensions'
 require 'yarrow/symbols'
 require 'yarrow/logging'
 require 'yarrow/schema'
+require 'yarrow/schema/types'
+require 'yarrow/schema/definitions'
+require 'yarrow/schema/dictionary'
+require 'yarrow/schema/entity'
+require 'yarrow/schema/value'
 require 'yarrow/config'
 require 'yarrow/configuration'
 require 'yarrow/console_runner'
 require 'yarrow/tools/front_matter'
 require 'yarrow/tools/content_utils'
 require 'yarrow/content/graph'
-require 'yarrow/content/object_type'
-require 'yarrow/content/source_collector'
-require 'yarrow/content/collection_expander'
+require 'yarrow/content/source'
 require 'yarrow/content/expansion'
+require 'yarrow/content/expansion_strategy'
 require 'yarrow/content/tree_expansion'
 require 'yarrow/content/manifest'
+require 'yarrow/content/resource'
+require 'yarrow/content/model'
+require 'yarrow/content/policy'
 require 'yarrow/output/mapper'
 require 'yarrow/output/generator'
 require 'yarrow/output/context'

data/yarrow.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_runtime_dependency 'kramdown', '~> 2.4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.11'
   spec.add_development_dependency 'coveralls', '~> 0.8.23'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mementus
@@ -109,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.4.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -203,13 +203,14 @@ files:
 - lib/yarrow/config.rb
 - lib/yarrow/configuration.rb
 - lib/yarrow/console_runner.rb
-- lib/yarrow/content/collection_expander.rb
 - lib/yarrow/content/expansion.rb
+- lib/yarrow/content/expansion_strategy.rb
 - lib/yarrow/content/graph.rb
 - lib/yarrow/content/manifest.rb
-- lib/yarrow/content/object_type.rb
+- lib/yarrow/content/model.rb
+- lib/yarrow/content/policy.rb
+- lib/yarrow/content/resource.rb
 - lib/yarrow/content/source.rb
-- lib/yarrow/content/source_collector.rb
 - lib/yarrow/content/tree_expansion.rb
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
@@ -228,9 +229,14 @@ files:
 - lib/yarrow/process/step_processor.rb
 - lib/yarrow/process/workflow.rb
 - lib/yarrow/schema.rb
+- lib/yarrow/schema/definitions.rb
+- lib/yarrow/schema/dictionary.rb
+- lib/yarrow/schema/entity.rb
+- lib/yarrow/schema/types.rb
 - lib/yarrow/schema/validations/array.rb
 - lib/yarrow/schema/validations/object.rb
 - lib/yarrow/schema/validations/string.rb
+- lib/yarrow/schema/value.rb
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
 - lib/yarrow/source/graph.rb
@@ -262,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Documentation generator based on a fluent data model.

data/lib/yarrow/content/collection_expander.rb

@@ -1,241 +0,0 @@
-module Yarrow
-  module Content
-    class CollectionExpander
-      include Yarrow::Tools::FrontMatter
-
-      # If a list of object types is not provided, a default `pages` type is
-      # created.
-      def initialize(object_types=nil)
-        @object_types = object_types || [
-          Yarrow::Content::ObjectType.from_name(:pages)
-        ]
-      end
-
-      def expand(graph)
-        @object_types.each do |object_type|
-          expand_nested(graph, object_type)
-        end
-      end
-
-      def expand_nested(graph, content_type)
-        strategy = TreeExpansion.new(graph)
-        strategy.expand(content_type)
-      end
-
-      def expand_nested_legacy(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
-
-        # If there are no subcollections then we need to look at the start node
-        # TODO: test to verify if this could be used in all cases, not just
-        # the situation where there are subfolders to be mapped.
-        if subcollections.empty?
-          # Collect files that match the content type extension and group them
-          # under a common key for each slug (this is so we can merge multiple
-          # files with the same name together into a single content type, a
-          # specific pattern found in some legacy content folders).
-          #
-          # Ideally, this code should be deleted once we have a clean workflow
-          # and can experiment with decoupling different strategies for
-          # expansion/enrichment of content objects.
-          objects = start_node.out(:file).all.select do |file|
-            file.props[:name].end_with?(*exts)
-          end.group_by do |file|
-            file.props[:slug]
-          end
-
-          # This is a massive hack to deal with situations where we don’t
-          # recurse down the list of directories. The best way to clean it up
-          # will be to document the different supported mapping formats and
-          # URL generation strategies and break these up into separate
-          # traversal objects for each particular style of content organisation.
-          if index.nil?
-            index = graph.create_node do |collection_node|
-              collection_node.label = :collection
-              collection_node.props[:type] = type
-              collection_node.props[:name] = type
-              collection_node.props[:slug] = type.to_s
-              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
-                "/#{type}/"
-              end
-            end
-          end
-
-          build_content_nodes(graph, objects, type, index)
-        end
-
-        # Go through each subcollection and expand content nodes step by step.
-        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
-
-      def build_content_nodes(graph, objects, type, parent_index)
-        # TODO: this may need to use a strategy that can be overriden
-        content_type = Yarrow::Symbols.to_singular(type)
-
-        # 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 = Yarrow::Symbols.to_const(content_type)
-            rescue
-              # No immutable struct found: fall back to slower dynamically typed open struct
-              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
-    end
-  end
-end

data/lib/yarrow/content/object_type.rb

@@ -1,42 +0,0 @@
-gem "strings-inflection"
-
-module Yarrow
-  module Content
-    class ObjectType
-      Value = Yarrow::Schema::Value.new(:collection, :entity, :extensions)
-
-      DEFAULT_EXTENSIONS = [".md", ".yml", ".htm"]
-
-      def self.from_name(name)
-        new(Value.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.collection
-        Yarrow::Symbols.to_plural(@properties.entity)
-      end
-
-      def entity
-        return @properties.entity if @properties.entity
-        Yarrow::Symbols.to_singular(@properties.collection)
-      end
-
-      def extensions
-        return @properties.extensions if @properties.extensions
-        DEFAULT_EXTENSIONS
-      end
-
-      def match_path
-        "."
-      end
-    end
-  end
-end