yarrow 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4a0ff53beff8749c36f82844efeefec5463ec6ea6ebc9126fc4e0928b4d4c0
-  data.tar.gz: 2d4c1e187e40f5e6f6e6316e5908c1630129c28fa419c4216f06c6566d27854b
+  metadata.gz: 7b1a14b73412ec27fad2ff75bd7944f1ef25f241779c532d3449339a436e4c32
+  data.tar.gz: 2cf2db75cc8c107b1d1bcbb6a79ad7fd92a6ba32e27413f2057158f7b8bb3c8a
 SHA512:
-  metadata.gz: 9624eb95caeb74e736c561d1bdfc18387d2e308427661073147b46377f35add1fd5aa7b03f758107e902fbbb741b6a7a070fd1cfc71a2371f3965774d1ddb128
-  data.tar.gz: 3ae340c7e995e51b6a09ef86bf1faa191565a73bd61660d8276f9f77c6722633717dd027e137b0de2eab3f8a320befc1903ed2ef3f5287a83e99ad6d0eda761b
+  metadata.gz: 436cec2447208c2641d4ac332cbb1910b7b016983a0630782282a28fe34e7a929b4661f424f0002d937854316d00f6d822ec05407f40185a7d5bbd642a2b88d2
+  data.tar.gz: bd798c5d999b7d2665209778d507bfe9b54da98473850dd66b62c60391a270f93aa00d913315a7b29e6c92e7cb436f64fb89b692ecb4ea2da8bad5387d43b0b6

data/README.md

@@ -2,15 +2,11 @@ Yarrow
 ======
 
 [![Gem Version](http://img.shields.io/gem/v/yarrow.svg)][gem]
-[![Build Status](http://img.shields.io/travis/maetl/yarrow.svg)][travis]
-[![Dependency Status](http://img.shields.io/gemnasium/maetl/yarrow.svg)][gemnasium]
-[![Code Climate](http://img.shields.io/codeclimate/github/maetl/yarrow.svg)][codeclimate]
+[![Build Status](http://img.shields.io/github/workflow/status/:user/maetl/yarrow/workflow)][github]
 [![Coverage Status](http://img.shields.io/coveralls/maetl/yarrow.svg)][coveralls]
 
 [gem]: https://rubygems.org/gems/yarrow
-[travis]: https://travis-ci.org/maetl/yarrow
-[gemnasium]: https://gemnasium.com/maetl/yarrow
-[codeclimate]: https://codeclimate.com/github/maetl/yarrow
+[github]: https://github.com/maetl/yarrow
 [coveralls]: https://coveralls.io/r/maetl/yarrow
 
 Yarrow is a tool for generating well structured documentation from a variety of input sources.

data/Rakefile

@@ -1,4 +1,18 @@
+$LOAD_PATH.unshift File.expand_path("./lib", __dir__)
+require "yarrow"
+
+task :version do
+  puts Yarrow::VERSION
+end
+
+task :build do
+  sh "gem build yarrow.gemspec"
+end
+
+task :publish do
+  sh "gem push yarrow-#{Yarrow::VERSION}.gem"
+end
 
 task :clean do
-  sh 'rm yarrow-*.gem'
+  sh "rm yarrow-*.gem"
 end

data/lib/yarrow/content/collection_expander.rb

@@ -1,5 +1,3 @@
-puts "CollectionExpander!!!"
-
 module Yarrow
   module Content
     class CollectionExpander

data/lib/yarrow/schema.rb

@@ -0,0 +1,109 @@
+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 slots [Array<Symbol>, <Hash>] defines the slots in the schema to validate against
+      def initialize(slots)
+        @keys = slots.reduce({}) do |keys, slot|
+          if slot.is_a?(Array)
+            keys[slot[0]] = slot[1]
+          else
+            keys[slot.to_sym] = Type::Any
+          end
+
+          keys
+        end
+      end
+
+      def check(fields)
+        raise "wrong number of args" unless fields.keys.length == @keys.keys.length
+
+        fields.keys.each do |key|
+          raise "key does not exist" unless @keys.key?(key)
+        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
+    # validation (and eventually type coercion if !yagni).
+    class Value
+      def self.new(*slots, &block)
+        factory(*slots, &block)
+      end
+
+      def self.factory(*slots, &block)
+        validator = Validator.new(slots)
+
+        struct = Struct.new(*slots, keyword_init: true, &block)
+
+        struct.define_method :initialize do |kwargs|
+          validator.check(kwargs)
+          # TODO: type coercion or mapping decision goes here
+          super(**kwargs)
+          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"
+          end
+
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+
+    def to_h
+      dictionary.keys.reduce({}) do |h, name|
+        h[name] = instance_variable_get("@#{name}")
+      end
+    end
+  end
+end

data/lib/yarrow/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 module Yarrow
-  APP_NAME = 'Yarrow'.freeze
-  VERSION = '0.5.1'.freeze
+  APP_NAME = 'Yarrow'
+  VERSION = '0.6.0'
 end

data/lib/yarrow/web/html_document.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class HTMLDocument
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/manifest.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Manifest
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/static_asset.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class StaticAsset
+      def initialize
+
+      end
+    end
+  end
+end

data/lib/yarrow/web/template.rb

@@ -0,0 +1,9 @@
+module Yarrow
+  module Web
+    class Template
+      def initialize
+
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Rickerby
@@ -236,12 +236,20 @@ files:
 - lib/yarrow/process/project_manifest.rb
 - lib/yarrow/process/step_processor.rb
 - lib/yarrow/process/workflow.rb
+- lib/yarrow/schema.rb
+- lib/yarrow/schema/validations/array.rb
+- lib/yarrow/schema/validations/object.rb
+- lib/yarrow/schema/validations/string.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
+- lib/yarrow/web/html_document.rb
+- lib/yarrow/web/manifest.rb
+- lib/yarrow/web/static_asset.rb
+- lib/yarrow/web/template.rb
 - yarrow.gemspec
 homepage: http://rubygemspec.org/gems/yarrow
 licenses: