yarrow 0.9.2 → 0.9.4

data/lib/yarrow/schema/types.rb

@@ -53,14 +53,37 @@ module Yarrow
           accepts.key?(input.class)
         end
 
-        def coerce(input)
+        # Coerce input into the defined format based on configured
+        # accept rules.
+        #
+        # Will use the unit type’s constructor by default unless
+        # an alternative factory method and constructor arguments are
+        # provided in the accept rule or passed in via context.
+        #
+        # Most object coercions use the defaults, but the context
+        # and options enable specific customisations, such as passing
+        # in an assigned attribute name or the hash key that the input
+        # is a value of.
+        # 
+        # @param [Object] input
+        # @param [nil, Hash] context
+        #
+        # @return [Object] instance of unit type represented by this wrapper
+        def coerce(input, context=nil)
           constructor, options = accepts[input.class]
 
-          # TODO: should we clone all input so copy is stored rather than ref?
-          if options.nil?
+          context_args = if context.nil?
+            options.clone
+          elsif options.nil?
+            context.clone
+          else
+            options.merge(context)
+          end
+
+          if context_args.nil?
             unit.send(constructor, input)
           else
-            unit.send(constructor, input, options.clone)
+            unit.send(constructor, input, context_args)
           end
         end
 
@@ -88,14 +111,14 @@ module Yarrow
           end
         end
 
-        def cast(input)
-          return coerce(input) if should_coerce?(input)
+        def cast(input, context=nil)
+          return coerce(input, context) if should_coerce?(input)
           check(input)
         end
       end
 
       class Any < TypeClass
-        def cast(input)
+        def cast(input, context=nil)
           input
         end
       end
@@ -141,39 +164,40 @@ module Yarrow
         end
       end
 
-      module CompoundType
-        def instance(unit_type)
-          @unit = Instance.of(unit_type)
-          self
+      class List < TypeClass
+        def self.any
+          # Constraint: must be array instance
+          new(Instance.of(Array), Any.new)
         end
 
-        def kind(unit_type)
-          @unit = Kind.of(unit_type)
-          self
+        def self.of(wrapped_type)
+          new(Instance.of(Array), Instance.of(wrapped_type))
         end
 
-        def interface(*args)
-          @unit = Interface.of(args)
-          self
-        end
-      end
+        attr_reader :element_type
+        alias container_type unit
 
-      class List < TypeClass
-        include CompoundType
+        def initialize(unit_type, element_type)
+          @element_type = element_type
+          super(unit_type)
+        end
 
-        def self.of(unit_type)
-          new(Instance.of(unit_type))
+        def accept_elements(accept_type)
+          element_type.accept(accept_type)
+          self
         end
 
-        def cast(input)
-          input.map do |item|
-            unit.cast(item)
+        def check(input)
+          converted = container_type.cast(input)
+
+          converted.map do |item|
+            element_type.cast(item)
           end
         end
       end
 
       class Map < TypeClass
-        include CompoundType
+        #include CompoundType
 
         def self.of(map_spec)
           if map_spec.is_a?(Hash)
@@ -198,15 +222,21 @@ module Yarrow
           super(value_type)
         end
 
+        def accept_elements(accept_type, constructor=:new, options=nil)
+          value_type.accept(accept_type, constructor, options)
+          self
+        end
+
         def check(input)
-          keys = input.keys.map do |key|
-            key_type.cast(key)
-          end
-          values = input.values.map do |value|
-            value_type.cast(value)
+          result = {}
+
+          input.each_pair do |key, value|
+            checked_key = key_type.cast(key)
+            checked_value = value_type.cast(value, { key: checked_key })
+            result[checked_key] = checked_value
           end
 
-          [keys, values].transpose.to_h
+          result
         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.2"
+  VERSION = "0.9.4"
 end

data/lib/yarrow/web/document.rb

@@ -1,5 +1,26 @@
-  module Yarrow
+module Yarrow
   module Web
+    class Document
+      attr_reader :content_node
+
+      def initialize(node, manifest)
+        @content_node = node
+        #manifest.add_document(self)
+        @manifest = manifest
+      end
+
+      def resource
+        content_node.props[:resource]
+      end
+
+      def url
+        @url ||= URL.generate(resource)
+      end
+    end
+  end
+
+  # Deprecated
+  module LegacyWeb
     class BaseDocument
       def resource
         @resource

data/lib/yarrow/web/manifest.rb

@@ -1,5 +1,27 @@
 module Yarrow
   module Web
+    class NewManifest
+      def initialize
+        @documents_index = {}
+        @documents = []
+      end
+
+      attr_reader :documents
+
+      def add_resource(resource)
+        add_document(Document.new(resource, self))
+      end
+
+      def add_document(document)
+        if @documents_index.key?(document.url)
+          raise "#{document.url} already exists in manifest" 
+        end
+
+        @documents << document
+        @documents_index[document.url] = @documents.count - 1
+      end
+    end
+
     class Manifest
       def self.build(graph)
         manifest = new

data/lib/yarrow/web/url.rb

@@ -0,0 +1,29 @@
+module Yarrow
+  module Web
+    module URI
+    end
+
+    class URL
+      def self.generate(resource)
+        path = if resource.respond_to?(:url)
+          resource.url
+        elsif resource.respond_to?(:permalink)
+          resource.permalink
+        else
+          # TODO: URL generation strategy
+          "/one/two/three"
+        end
+
+        new(path)
+      end
+
+      def initialize(path)
+        @path = path
+      end
+
+      def to_s
+        @path
+      end
+    end
+  end
+end

data/lib/yarrow.rb

@@ -4,6 +4,7 @@ require "kramdown"
 require "toml-rb"
 require "mustache"
 require "parallel"
+require "addressable/template"
 
 require "extensions/mementus"
 
@@ -28,11 +29,11 @@ require "yarrow/content/expansion/directory_merge"
 require "yarrow/content/expansion/traversal"
 require "yarrow/content/resource"
 require "yarrow/web/manifest"
+require "yarrow/web/url"
 require "yarrow/web/document"
 require "yarrow/web/generator"
 require "yarrow/web/template"
-require "yarrow/output/context"
-require "yarrow/output/web/indexed_file"
+require "yarrow/output/build"
 require "yarrow/content_map"
 require "yarrow/server"
 require "yarrow/server/livereload"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -297,12 +297,10 @@ files:
 - bin/yarrow-server
 - lib/extensions/mementus.rb
 - 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.rb
 - lib/yarrow/content/expansion/aggregator.rb
 - lib/yarrow/content/expansion/basename_merge.rb
 - lib/yarrow/content/expansion/directory_merge.rb
@@ -330,8 +328,7 @@ files:
 - lib/yarrow/generator.rb
 - lib/yarrow/help.txt
 - lib/yarrow/logging.rb
-- lib/yarrow/output/context.rb
-- lib/yarrow/output/web/indexed_file.rb
+- lib/yarrow/output/build.rb
 - lib/yarrow/process/expand_content.rb
 - lib/yarrow/process/extract_source.rb
 - lib/yarrow/process/project_manifest.rb
@@ -348,15 +345,14 @@ files:
 - lib/yarrow/schema/value.rb
 - lib/yarrow/server.rb
 - lib/yarrow/server/livereload.rb
-- lib/yarrow/source/graph.rb
 - lib/yarrow/symbols.rb
-- lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
 - lib/yarrow/web/document.rb
 - lib/yarrow/web/generator.rb
 - lib/yarrow/web/manifest.rb
 - lib/yarrow/web/static_asset.rb
 - lib/yarrow/web/template.rb
+- lib/yarrow/web/url.rb
 - yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses:

data/lib/yarrow/assets/manifest.rb

@@ -1,118 +0,0 @@
-# TODO: where else is this used?
-require 'json'
-
-module Yarrow
-  module Assets
-    ##
-    # Provides access to the bundle of compiled CSS and JS assets.
-    #
-    # This is currently based on the output structure of the JSON manifest file
-    # generated by Sprockets, but this class isn't coupled to the Sprockets API
-    # so could be used as a generic manifest reader.
-    #
-    # - `logical_path` represents the core named path to an asset sans version, eg: `main.css`
-    # - `digest_path` represents the versioned instance of an asset with associated digest,
-    #    eg: `main-4362eea15558e73d3663de653cdeb81e.css`
-    class Manifest
-      ##
-      # Initializes the manifest from a Sprockets-style JSON file.
-      #
-      # If no assets directory is given, looks for a manifest in the main output directory.
-      #
-      # @param config [Yarrow::Configuration]
-      def initialize(config)
-        raise Yarrow::ConfigurationError if config.assets.nil?
-
-        if config.assets.output_dir
-          manifest_path = Pathname.new(config.assets.output_dir) + config.assets.manifest_file
-        else
-          manifest_path = Pathname.new(config.output_dir) + config.assets.manifest_file
-        end
-
-        if File.exists?(manifest_path)
-          manifest_data = JSON.parse(File.read(manifest_path))
-
-          @manifest_index = if manifest_data.key?('assets')
-            manifest_data['assets']
-          else
-            manifest_data
-          end
-        else
-          @manifest_index = {}
-        end
-      end
-
-      ##
-      # True if the named asset exists.
-      #
-      # @param logical_path [String]
-      # @return [Boolean]
-      def exists?(logical_path)
-        @manifest_index.key? logical_path
-      end
-
-      ##
-      # Returns the generated digest path to a named asset.
-      #
-      # @param logical_path [String]
-      # @return [String]
-      def digest_path(logical_path)
-        @manifest_index[logical_path]
-      end
-
-      ##
-      # Returns the list of named assets in the manifest.
-      #
-      # @return [Array<String>]
-      def logical_paths
-        @manifest_index.keys
-      end
-
-      ##
-      # Returns the list of generated digest paths in the manifest.
-      #
-      # @return [Array<String>]
-      def digest_paths
-        @manifest_index.values
-      end
-
-      ##
-      # Returns the list of named CSS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def css_logical_paths
-        select_by_extension(logical_paths, '.css')
-      end
-
-      ##
-      # Returns the list of named JS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def js_logical_paths
-        select_by_extension(logical_paths, '.js')
-      end
-
-      ##
-      # Returns the list of generated CSS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def css_digest_paths
-        select_by_extension(digest_paths, '.css')
-      end
-
-      ##
-      # Returns the list of generated JS assets in the manifest.
-      #
-      # @return [Array<String>]
-      def js_digest_paths
-        select_by_extension(digest_paths, '.js')
-      end
-
-      private
-
-      def select_by_extension(collection, ext)
-        collection.select { |asset| asset.end_with?(ext) }
-      end
-    end
-  end
-end

data/lib/yarrow/assets/pipeline.rb

@@ -1,126 +0,0 @@
-require 'pathname'
-require 'fileutils'
-require 'sprockets'
-
-module Yarrow
-  module Assets
-    ##
-    # Processes static assets using Sprockets.
-    class Pipeline
-
-      include Loggable
-
-      attr_reader :input_dir, :output_dir, :append_paths, :bundles, :assets
-
-      ##
-      # @param config [Yarrow::Configuration]
-      def initialize(config)
-        raise Yarrow::ConfigurationError if config.assets.nil?
-
-        @input_dir = config.assets.input_dir || default_input_dir
-
-        if config.assets.output_dir
-          @output_dir = config.assets.output_dir
-        else
-          @output_dir = config.output_dir || default_output_dir
-        end
-
-        @append_paths = []
-
-        case config.assets.append_paths
-        when Array
-          @append_paths = config.assets.append_paths
-        when '*'
-          @append_paths = Dir[@input_dir + '/*'].select do |path|
-            File.directory?(path)
-          end.map do |path|
-            File.basename(path)
-          end
-        when String
-          @append_paths << config.assets.append_paths
-        end
-      end
-
-      ##
-      # Compiles an asset manifest and processed output files from the given input bundles.
-      # Also generates a manifest linking each output bundle to its given input name.
-      #
-      # @param bundles [Array<String>]
-      def compile(bundles = [])
-        bundles.each do |bundle|          
-          if bundle.include? '*'
-            Dir["#{@input_dir}/#{bundle}"].each do |asset|
-              logger.info "Compiling: #{asset}"
-              manifest.compile(File.basename(asset))
-            end
-          else
-            logger.info "Compiling: #{bundle}"
-            manifest.compile(bundle)
-          end
-        end
-      end
-
-      ##
-      # Copy the given files to the output path without processing or renaming.
-      #
-      # @param bundle [Array<String>]
-      def copy(bundles = [])
-        bundles.each do |bundle|
-          FileUtils.cp_r "#{@input_dir}/#{bundle}", "#{@output_dir}/#{bundle}"
-        end
-      end
-
-      ##
-      # Purges redundant compiled assets from the output path.
-      #
-      # @example Purge all assets except those created in the last 10 minutes
-      #   pipeline.purge(0, )
-      #
-      # @param keep [Integer] Number of previous revisions to keep. Defaults to 2.
-      # @param age [Integer] Purge all assets older than this date. Defaults to 1 hour.
-      def purge(keep = 2, age = 3600)
-        # TODO: upgrade to Sprockets 3.0 to support the age arg
-        manifest.clean(keep)
-      end
-
-      ##
-      # Access instance of the Sprockets environment.
-      #
-      # @return [Sprockets::Environment]
-      def environment
-        # TODO: decouple dependency on Sprockets
-        @environment ||= create_environment
-      end
-
-      private
-
-      def default_input_dir
-        "#{Dir.pwd}/assets"
-      end
-
-      def default_output_dir
-        "#{Dir.pwd}/public/assets"
-      end
-
-      def manifest_file_path
-        "#{@output_dir}/manifest.json"
-      end
-
-      def manifest
-        Sprockets::Manifest.new(environment, manifest_file_path)
-      end
-
-      def create_environment
-        environment = Sprockets::Environment.new(@input_dir)
-        
-        @append_paths.each do |path|
-          environment.append_path path
-        end
-
-        environment
-      end
-
-    end
-
-  end
-end

data/lib/yarrow/assets.rb

@@ -1,2 +0,0 @@
-require_relative 'assets/pipeline'
-require_relative 'assets/manifest'

data/lib/yarrow/output/context.rb

@@ -1,16 +0,0 @@
-module Yarrow
-  module Output
-    # Provides a data context for rendering a template.
-    #
-    # Methods provided by this class become available as named variables in
-    # Mustache templates.
-    class Context
-      def initialize(attributes)
-        metaclass = class << self; self; end
-        attributes.each do |name, value|
-          metaclass.send :define_method, name, lambda { value }
-        end
-      end
-    end
-  end
-end