yarrow 0.7.1 → 0.7.3

data/lib/yarrow/schema/definitions.rb

@@ -0,0 +1,30 @@
+module Yarrow
+  module Schema
+    module Definitions
+      DEFINED_TYPES = {
+        string: Type::Raw[String],
+        integer: Type::Raw[Integer],
+        path: Type::Raw[Pathname],
+        any: Type::Any
+      }
+
+      def self.register(identifier, type_class)
+        if DEFINED_TYPES.key?(identifier)
+          raise "#{identifier} is already defined"
+        end
+
+        DEFINED_TYPES[identifier] = type_class
+      end
+
+      def resolve_type(identifier)
+        #return identifier unless identifier.is_a?(Symbol)
+
+        unless DEFINED_TYPES.key?(identifier)
+          raise "#{identifier} is not defined"
+        end
+
+        return DEFINED_TYPES[identifier]
+      end
+    end
+  end
+end

data/lib/yarrow/schema/dictionary.rb

@@ -0,0 +1,49 @@
+module Yarrow
+  module Schema
+    # Specifies types plugged into each attribute slot and runs any required
+    # validations and coercions.
+    #
+    # Current design throws on error rather than returns a boolean result.
+    class Dictionary
+      include Definitions
+
+      # @param attrs_spec [Hash] defines the slots in the schema to validate against
+      def initialize(attrs_spec={})
+        @attrs_spec = attrs_spec.reduce({}) do |spec, (name, type_identifier)|
+          spec[name] = resolve_type(type_identifier)
+          spec
+        end
+      end
+
+      def define_attribute(name, type_identifier)
+        @attrs_spec[name] = resolve_type(type_identifier)
+      end
+
+      def attr_names
+        @attrs_spec.keys
+      end
+
+      def check(input)
+        missing_attrs = @attrs_spec.keys.difference(input.keys)
+
+        if missing_attrs.any?
+          missing_attrs.each do |name|
+            raise "wrong number of attributes" unless @attrs_spec[name].eql?(Type::Any)
+          end
+        end
+
+        mismatching_attrs = input.keys.difference(@attrs_spec.keys)
+
+        raise "attribute does not exist" if mismatching_attrs.any?
+
+        input.each do |(name, value)|
+          unless value.is_a?(@attrs_spec[name]) || @attrs_spec[name].eql?(Type::Any)
+            raise "wrong data type"
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/yarrow/schema/entity.rb

@@ -0,0 +1,51 @@
+module Yarrow
+  module Schema
+    # 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)
+          dictionary.define_attribute(name, value_type)
+          attr_reader(name)
+        end
+
+        def dictionary
+          @dictionary ||= Dictionary.new({})
+        end
+      end
+
+      def initialize(config)
+        dictionary.check(config)
+        # dictionary.each_key do |name|
+        #   raise "missing declared attribute #{name}" unless config.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"
+          # end
+
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      def to_h
+        dictionary.attr_names.reduce({}) do |attr_dict, name|
+          attr_dict[name] = instance_variable_get("@#{name}")
+          attr_dict
+        end
+      end
+
+      private
+
+      def dictionary
+        self.class.dictionary
+      end
+    end
+  end
+end

data/lib/yarrow/schema/types.rb

@@ -0,0 +1,73 @@
+module Yarrow
+  module Schema
+    module Types
+      class CastError < TypeError
+        def self.instance_of(t, u)
+          new("#{t} is not an instance of #{u}")
+        end
+
+        def self.kind_of(t, u)
+          new("#{t} is not a subclass of #{u}")
+        end
+      end
+  
+      class TypeClass
+        attr_reader :unit
+  
+        def initialize(unit=nil)
+          @unit = unit
+        end
+  
+        def check_instance_of!(input)
+          unless input.instance_of?(unit)
+            raise CastError.instance_of(input.class, unit)
+          end
+        end
+
+        def check_kind_of!(input)
+          unless input.kind_of?(unit)
+            raise CastError.kind_of(input.class, unit)
+          end
+        end
+
+        def check_respond_to!(input)
+
+        end
+
+        def cast(input); end
+      end
+  
+      class Any < TypeClass
+        def cast(input)
+          input
+        end
+      end
+  
+      class Instance < TypeClass
+        def cast(input)
+          check_instance_of!(input)
+          input
+        end
+      end
+  
+      class Kind
+        def cast(input)
+          check_kind_of!(input)
+          input
+        end
+      end
+  
+      class Interface
+  
+      end
+  
+      class Optional
+  
+      end
+  
+      class Constrained
+  
+      end
+    end
+  end
+end

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.1'
+  VERSION = '0.7.3'
 end

data/lib/yarrow.rb

@@ -6,20 +6,29 @@ 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/generator'
 require 'yarrow/tools/front_matter'
 require 'yarrow/tools/content_utils'
 require 'yarrow/content/graph'
-require 'yarrow/content/content_type'
 require 'yarrow/content/source'
-require 'yarrow/content/source_collector'
-require 'yarrow/content/collection_expander'
+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'
+require 'yarrow/output/result'
 require 'yarrow/output/web/indexed_file'
 require 'yarrow/content_map'
 require 'yarrow/server'
@@ -31,6 +40,8 @@ require 'yarrow/process/expand_content'
 require 'yarrow/process/extract_source'
 require 'yarrow/process/project_manifest'
 
+require 'yarrow/generator'
+
 # Dir[File.dirname(__FILE__) + '/yarrow/generators/*.rb'].each do |generator|
 #   require generator
 # end

data/yarrow.gemspec

@@ -20,9 +20,9 @@ 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', '~> 2.2.9'
+  spec.add_runtime_dependency 'kramdown', '~> 2.4.0'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rspec', '~> 3.11'
   spec.add_development_dependency 'coveralls', '~> 0.8.23'
   spec.add_development_dependency 'rack-test', '~> 0.8'
   spec.homepage = 'http://rubygemspec.org/gems/yarrow'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-31 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: 2.2.9
-  type: :development
+        version: 2.4.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.9
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -203,11 +203,15 @@ files:
 - 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/expansion.rb
+- lib/yarrow/content/expansion_strategy.rb
 - lib/yarrow/content/graph.rb
+- lib/yarrow/content/manifest.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
 - lib/yarrow/extensions.rb
@@ -217,6 +221,7 @@ files:
 - lib/yarrow/output/context.rb
 - lib/yarrow/output/generator.rb
 - lib/yarrow/output/mapper.rb
+- lib/yarrow/output/result.rb
 - lib/yarrow/output/web/indexed_file.rb
 - lib/yarrow/process/expand_content.rb
 - lib/yarrow/process/extract_source.rb
@@ -224,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
@@ -258,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.