yarrow 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f774a7c3013a183129ba27e6929cb1d9cb65f784121f61d3df2c1ffba8a4fb
-  data.tar.gz: 7f94b3a971a5fb00d089b6bbad8c12cb724d35f3e00497091130c4731534b275
+  metadata.gz: 2a2ebdee5113cc218a9744d5da88b01cb0e7604b4ecfe0d133f776d48d2b4b97
+  data.tar.gz: 967ba36fec57253eea8069f903828b8529f43802578c8be009413e4a5373e1f1
 SHA512:
-  metadata.gz: de66835c7de07c4c84802a8adf75e57d637c4865f7a7e2f1f42f06ac0a22adbadfd067c812a6ba8a5be7e8fa03f116173f1a47777c550d38004e0683c6395685
-  data.tar.gz: a7aff55ba63ed7cc2b493b28dd27f415c985bd55730de71732411c2d3500ee0beb0dd21a599b7110599dfb80253bef6b4204a70276b4ed794cf0f2884d3149a1
+  metadata.gz: 982f7c783ed933419504e6722e9ffbacaf513468a16cdb07ca4ec7ffc859d5eaed1470948d8c1ca7ce5aa00f5e0fc05b9c29a38f0f0e2972aa6d2f348aec2c7b
+  data.tar.gz: 4debe486afb56d7f664a0dd730db05429b2d7256a5f2789f1987339b394f404ac0f59f67d9e2f25126ad946675a46b7f910a91881d447afed148cb56eb4b5317

data/.github/workflows/ruby.yml

@@ -10,10 +10,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.7, 3.1, 3.2]
+        ruby: [3.1, 3.2, "3.3.0-preview1"]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/yarrow/config.rb

@@ -53,13 +53,13 @@ module Yarrow
     #   Yarrow::Schema::Types::Map.of(Symbol)
     # )
 
-    class Content < Yarrow::Schema::Entity[:__config_content]
+    class Content < Yarrow::Schema::Entity
       attribute :module, :string
       #attribute :source_map, :__config_source_map
       attribute :source_map, :hash
     end
 
-    class Output < Yarrow::Schema::Entity[:__config_output]
+    class Output < Yarrow::Schema::Entity
       attribute :generator, :string
       attribute :template_dir, :path
       #attribute :scripts, :array
@@ -71,8 +71,8 @@ module Yarrow
       attribute :output_dir, :path
       attribute :meta, :any
       attribute :server, :any
-      attribute :content, :__config_content
-      attribute :output, :__config_output
+      attribute :content, :yarrow_config_content
+      attribute :output, :yarrow_config_output
     end
     #
     # `content_dir` and `output_dir` are placeholders and should be overriden

data/lib/yarrow/format/methods/front_matter.rb

@@ -60,7 +60,7 @@ module Yarrow
           end
 
           def parse_toml(raw)
-            TOML::Parser.new(raw).parsed
+            TomlRB.parse(raw, symbolize_keys: true)
           end
 
           def parse_json(raw)

data/lib/yarrow/schema/entity.rb

@@ -20,11 +20,16 @@ module Yarrow
         end
 
         def inherited(class_name)
+          class_type = Yarrow::Schema::Types::Instance.of(class_name).accept(Hash)
+          
           if @label
-            class_type = Yarrow::Schema::Types::Instance.of(class_name)
-            Yarrow::Schema::Definitions.register(@label, class_type)
+            label = @label
             @label = nil
+          else
+            label = Yarrow::Symbols.from_const(class_name)
           end
+
+          Yarrow::Schema::Definitions.register(label, class_type)
         end
       end
 
@@ -32,14 +37,7 @@ module Yarrow
         converted = dictionary.cast(config)
 
         converted.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"
-          # end
-
+          # TODO: should we represent this as an attribute set rather than instance vars?
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/yarrow/schema/value.rb

@@ -1,15 +1,20 @@
 module Yarrow
   module Schema
-    # class Structure < Struct
-    #   def self.inherited(subclass)
-    #     unless subclass.name
-    #       puts "CLASS"
-    #       p caller_locations[3]
-    #     else
-    #       p subclass.name.downcase.to_sym
-    #     end
-    #   end
-    # end
+    class ValueType < Struct
+      def self.register(label)
+        class_type = Yarrow::Schema::Types::Instance.of(self).accept(Hash)
+        Yarrow::Schema::Definitions.register(label, class_type)
+        self
+      end
+
+      # Automatically register when struct is defined as a class extension
+      # rather than anonymous struct class.
+      def self.inherited(subclass)
+        if subclass.name
+          self.register(subclass.name.downcase.to_sym)
+        end
+      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
@@ -33,12 +38,16 @@ module Yarrow
 
         validator = Dictionary.new(fields_spec)
 
-        struct = Struct.new(*slots_spec, keyword_init: true, &block)
+        struct = ValueType.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)]
+            if args.first.instance_of?(Hash) and args.count == 1
+              args.first
+            else
+              Hash[slots.zip(args)]
+            end
           else
             kwargs
           end

data/lib/yarrow/symbols.rb

@@ -19,6 +19,20 @@ module Yarrow
       Object.const_get(Strings::Case.pascalcase(atom.to_s).to_sym)
     end
 
+    # Converts a string name of class const to a symbol atom
+    #
+    # @param [Class, String, #to_s] const_obj
+    # @return [Symbol]
+    def self.from_const(const_obj)
+      const_lookup = if const_obj.respond_to?(:name)
+        const_obj.name
+      else
+        const_obj.to_s
+      end
+
+      Strings::Case.underscore(const_lookup).to_sym
+    end
+
     # @param [Symbol, String] atom
     # @return [Symbol]
     def self.to_singular(atom)

data/lib/yarrow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Yarrow
   APP_NAME = "Yarrow"
-  VERSION = "0.9.1"
+  VERSION = "0.9.3"
 end

data/lib/yarrow.rb

@@ -1,7 +1,7 @@
 require "pathname"
 require "yaml"
 require "kramdown"
-require "toml"
+require "toml-rb"
 require "mustache"
 require "parallel"
 

data/yarrow.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'parallel', '~> 1.22.1'
   spec.add_runtime_dependency 'strings-inflection', '~> 0.1'
   spec.add_runtime_dependency 'strings-case', '~> 0.3'
-  spec.add_runtime_dependency 'toml', '~> 0.3.0'
-  # https://github.com/joeldrapper/phlex
+  spec.add_runtime_dependency 'toml-rb', '~> 2.2.0'
+  spec.add_runtime_dependency 'shale', '~> 1.0.0'
+  spec.add_runtime_dependency 'phlex', '~> 1.8.1'
   spec.add_runtime_dependency 'kramdown', '~> 2.4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.11'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -165,19 +165,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: toml
+  name: toml-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: shale
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: phlex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -277,13 +305,9 @@ files:
 - lib/yarrow/console_runner.rb
 - lib/yarrow/content/expansion/aggregator.rb
 - lib/yarrow/content/expansion/basename_merge.rb
-- lib/yarrow/content/expansion/directory_map.rb
 - lib/yarrow/content/expansion/directory_merge.rb
-- lib/yarrow/content/expansion/file_list.rb
 - lib/yarrow/content/expansion/filename_map.rb
-- lib/yarrow/content/expansion/strategy.rb
 - lib/yarrow/content/expansion/traversal.rb
-- lib/yarrow/content/expansion/tree.rb
 - lib/yarrow/content/graph.rb
 - lib/yarrow/content/model.rb
 - lib/yarrow/content/policy.rb

data/lib/yarrow/content/expansion/directory_map.rb

@@ -1,21 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class DirectoryMap < Aggregator
-        def expand_source(container, policy)
-          puts "create_node label=:collection type=:#{policy.container} name='#{container.props[:basename]}'"
-          @current_collection = container.props[:basename]
-        end
-
-        def expand_directory(collection, policy)
-          puts "create_node label=:collection type=:#{policy.collection} name='#{collection.props[:basename]}' collection=#{@current_collection}"
-          @current_collection = collection.props[:basename]
-        end
-
-        def expand_file(entity, policy)
-          puts "create_node label=:entity type=:#{policy.entity} name='#{entity.props[:basename]}' collection='#{@current_collection}"
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/file_list.rb

@@ -1,15 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class FileList < Strategy
-        def expand(policy)
-          start_node = graph.n(:root).out(name: policy.container.to_s)
-
-          start_node.out(:files).each do |file_node|
-
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/strategy.rb

@@ -1,118 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class Strategy
-        include Yarrow::Tools::FrontMatter
-
-        attr_reader :graph
-
-        def initialize(graph)
-          @graph = graph
-          @subcollections = {}
-          @entity_links = []
-          @index_links = []
-          @index = nil
-        end
-
-        # Expand a directory to a collection node representing a collection of entities
-        def expand_directory(policy, node)
-          index = graph.create_node do |collection_node|
-
-            collection_attrs = {
-              name: node.props[:name],
-              title: node.props[:name].capitalize,
-              body: ""
-            }
-
-            populate_collection(collection_node, policy, collection_attrs)
-          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] == policy.collection.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
-
-        # 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 populate_collection(node, policy, meta_attrs)
-          node.label = :collection
-          node.props[:type] = policy.collection
-          node.props[:resource] = policy.collection_const.new(meta_attrs)
-        end
-
-        def populate_entity(node, policy, meta_attrs)
-          node.label = :item
-          node.props[:type] = policy.entity
-          node.props[:resource] = policy.entity_const.new(meta_attrs)
-        end
-
-        def merge_collection_index(node, policy, meta_attrs)
-          props = { resource: node.props[:resource].merge(meta_attrs) }
-          node.merge_props(props)
-        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
-          # TODO: Raise error if unsupported extname reaches here
-        end
-
-        def connect_expanded_entities
-          # Once all files and directories have been expanded, connect all the child
-          # edges between collections and entities
-          @entity_links.each do |entity_link|
-            graph.create_edge do |edge|
-              edge.label = :child
-              edge.from = entity_link[:parent_id].id
-              edge.to = entity_link[:child_id].id
-            end
-          end
-
-          # Merge index page body and metadata with their parent collections
-          @index_links.each do |index_link|
-            merge_collection_index(index_link[:parent_id], policy, index_link[:index_attrs])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/yarrow/content/expansion/tree.rb

@@ -1,93 +0,0 @@
-module Yarrow
-  module Content
-    module Expansion
-      class Tree < Strategy
-        def expand(policy)
-          # 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 policy.match_path == "."
-          start_node = if policy.match_path == "."
-            # TODO: match against source_dir
-            graph.n(:root).out(:directory)
-          else
-            graph.n(name: policy.match_path)
-          end
-
-          # Collect all nested collections in the subgraph for this content type
-          @subcollections = {}
-          @entity_links = []
-          @index_links = []
-          @index = nil
-
-          # Scan and collect all nested files from the root
-          start_node.depth_first.each do |node|
-            if node.label == :directory
-              expand_directory(policy, node)
-            elsif node.label == :file
-              expand_file_by_extension(policy, node)
-            end
-          end
-
-          # Once all files and directories have been expanded, connect all the child
-          # edges between collections and entities
-          @entity_links.each do |entity_link|
-            graph.create_edge do |edge|
-              edge.label = :child
-              edge.from = entity_link[:parent_id].id
-              edge.to = entity_link[:child_id].id
-            end
-          end
-
-          # Merge index page body and metadata with their parent collections
-          @index_links.each do |index_link|
-            merge_collection_index(index_link[:parent_id], policy, index_link[:index_attrs])
-          end
-        end
-
-        def expand_file_by_basename(policy, node)
-          body, meta = process_content(node.props[:entry])
-          meta = {} if !meta
-
-
-        end
-
-        def expand_file_by_extension(policy, node)
-          body, meta = process_content(node.props[:entry])
-          meta = {} if !meta
-
-          # TODO: document mapping convention for index pages and collection metadata
-          # TODO: underscore _index pattern?
-          bare_basename = node.props[:entry].basename(node.props[:entry].extname)
-          if bare_basename.to_s == "index"
-            @index_links << {
-              parent_id: @subcollections[node.props[:entry].parent.to_s],
-              index_attrs: meta.merge({ body: body})
-            }
-          else
-            # Create an entity node representing a file mapped to a unique content object
-            entity = graph.create_node do |entity_node|
-
-              entity_slug = node.props[:entry].basename(node.props[:entry].extname).to_s
-
-              entity_attrs = {
-                name: entity_slug,
-                title: entity_slug.gsub("-", " ").capitalize,
-                body: body
-              }
-
-              populate_entity(entity_node, policy, entity_attrs.merge(meta || {}))
-            end
-
-            # We may not have an expanded node for the parent collection if this is a
-            # preorder traversal so save it for later
-            @entity_links << {
-              parent_id: @subcollections[node.props[:entry].parent.to_s],
-              child_id: entity
-            }
-          end
-        end
-      end
-    end
-  end
-end