ruby-dagger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d74463b8145c28c660a15879bd8e3ce3ff2059aa7bd9fbf6ec58ed0d2412d7b2
-  data.tar.gz: ea0364d683460c925dddc028dbbb041e06774cba69c3725d738c9a850bffa5c5
+  metadata.gz: 4f9f8d4432457feb3dc6ba9ec83c29f75f2acf0844fd7c9b6ab123d3555f6d91
+  data.tar.gz: 2bffbf05b225e888c28f36d3cb25c4277b616d35d6bcdec7bc40c5f7e266fd2e
 SHA512:
-  metadata.gz: 9e0e6bde47b0aeed349122b293fcd4322febe07c9a6d85c1e469e479661d4152aa01ed62340dc26d4a901acba5951a0cd4ca53f012da6f06ff30e9d8fddf94a2
-  data.tar.gz: 20e4b90104dc47c3abe92b9fed52f3a7b4f3fdb101154f62b2bd2cd9a46fb7dc8c6cabb922dc4e0aa0df997c85524c8ea37979a75f1ba9abc74cd92311a0787c
+  metadata.gz: b1ec64aeaddec996a0235df76ebc797ab2ec0c04cef3aa1cc4482054a5d7248a4100d8e4420aeecbff6a3a589bf6664d96e75c3e974bc4cd7e14632f9cad49f8
+  data.tar.gz: c30423f432e38dd25dbb525c2458b6508b746f4b53057b6ef27b8eca8fe4ca6ee996c2131e3cf1d8f8faa1633fb7f410c71d1366a27a1d13f795fefaf81090dc

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 /vendor
 /Gemfile.lock
+coverage

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/*_spec.rb'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 
@@ -11,4 +13,4 @@ desc 'Run RSpec'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: %i[rubocop spec]
+task default: %i[spec rubocop]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'dagger'

data/lib/dagger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'yaml'
 require 'dagger/graph'
@@ -5,8 +7,8 @@ require 'dagger/graph'
 # Manage a DAG, stored in a posix file structure
 #
 module Dagger
-  def self.load(dir)
-    Graph.load(dir)
+  def self.load(dir, **kwargs)
+    Graph.load(dir, **kwargs)
   end
 end
 

data/lib/dagger/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 module Dagger

data/lib/dagger/default.rb

@@ -1,20 +1,33 @@
+# frozen_string_literal: true
+
 require 'set'
+require 'key_tree/refinements'
 require_relative 'context'
 require_relative 'generator'
 
 module Dagger
   # Default value generator for a dictionary
   class Default
-    # Initialize a default value generator for a +dictionary+
+    using KeyTree::Refinements
+
+    def self.proc(*args)
+      new(*args).default_proc
+    end
+
+    # Initialize a default value generator for a +vertex+
     #
     # :call-seq:
-    #   new(dictionary) => Dagger::Default
+    #   new(graph, vertex) => Dagger::Default
     #   new(*, cached: false)
     #   new(*, rule_prefix: '_default')
-    def initialize(dictionary, cached: false, rule_prefix: '_default')
-      @dictionary = dictionary
+    def initialize(vertex,
+                   cached: false,
+                   fallback: nil,
+                   rule_prefix: '_default')
+      @vertex = vertex
       @cached = cached
-      @rule_prefix = KeyTree::Path[rule_prefix]
+      @fallback = fallback
+      @rule_prefix = rule_prefix.to_key_path
       @default_proc = ->(tree, key) { generate(tree, key) }
       @locks = Set[]
     end
@@ -32,21 +45,41 @@ module Dagger
 
     # Generate a default value for a +key+, possibly caching the
     # result in the +tree+.
-    # Raises a +KeyError+ f the default value cannot be generated.
     #
     # :call-seq:
     #   generate(tree, key) => value || KeyError
+    #
+    # Raises a +KeyError+ if the default value cannot be generated.
+    # Raises a +RuntimeError+ in case of a deadlock for +key+.
     def generate(tree, key)
-      key = KeyTree::Path[key] unless key.is_a? KeyTree::Path
-      raise %(deadlock detected: "#{key}") unless @locks.add?(key)
+      key = key.to_key_path
+      with_locked_key(key) { |locked_key| cached_value(tree, locked_key) }
+    end
 
-      return result = process(key) unless cached?
-      tree[key] = result unless result.nil?
+    private
+
+    # Process a +block+ with mutex for +key+
+    #
+    # :call-seq:
+    #   with_locked_key(key &->(locked_key)) => result
+    def with_locked_key(key)
+      raise %(deadlock detected: "#{key}") unless @locks.add?(key)
+      yield(key)
     ensure
       @locks.delete(key)
     end
 
-    private
+    # Return the default value for +key+, caching it in +tree+ if enabled.
+    #
+    # :call-seq:
+    #   cached_value(tree, key) => value || KeyError
+    def cached_value(tree, key)
+      result = process(key)
+      return result unless result.nil?
+      result = @fallback&.[](key)
+    ensure
+      tree[key] = result if cached? && !result.nil?
+    end
 
     # Process value generation rules for +context+, raising a +KeyError+
     # if a value could not be generated. Catches :result thows from rule
@@ -56,21 +89,23 @@ module Dagger
     #   yield => value || KeyError
     def process(key)
       catch do |ball|
-        default_rules(key).each do |rule|
-          context = Context.new(result: ball, dictionary: @dictionary)
-
+        default_rules(key)&.each do |rule|
+          context = Context.new(dictionary: @vertex,
+                                result: ball,
+                                vertex: @vertex)
           process_rule_chain(rule, context)
         end
-        raise KeyError, %(no rule succeeded for "#{key}")
+        nil
       end
     end
 
     # Return the default value generation rules for a +key+.
     #
     # :call-seq:
-    #   default_rules(key) => Array of Hash || KeyError
+    #   default_rules(key) => Array of Hash
     def default_rules(key)
-      @dictionary.fetch(@rule_prefix + key)
+      result = @vertex.fetch(@rule_prefix + key, nil)
+      result
     end
 
     # Process the methods in a rule chain
@@ -78,12 +113,13 @@ module Dagger
     # :call-seq:
     #   process_rule_chain(rule_chain, context)
     def process_rule_chain(rule_chain, context)
-      rule_chain.each do |key, arg|
-        klass = Dagger::Generate.const_get(camelize(key))
-        klass[context, arg, &->(value) { throw context.result, value }]
+      catch do |ball|
+        context.stop = ball
+        rule_chain.each do |key, arg|
+          klass = Dagger::Generate.const_get(camelize(key))
+          klass[context, arg, &->(value) { throw context.result, value }]
+        end
       end
-    rescue StopIteration
-      nil
     end
 
     # Convert snake_case to CamelCase

data/lib/dagger/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Dagger
@@ -40,16 +42,14 @@ module Dagger
 
     private
 
-    delegate %i[dictionary] => :@context
+    delegate %i[dictionary vertex] => :@context
 
     # Stop processing the current rule chain
     #
     # :call-seq:
     #   stop
-    #
-    # Raises +StopIteration+
     def stop
-      raise StopIteration
+      throw @context.stop
     end
 
     # Update context attributes with new values
@@ -67,6 +67,20 @@ module Dagger
     def enumerable(value)
       value.respond_to?(:each) ? value : [value]
     end
+
+    # Format a +string+ with values from a +dictionary+
+    #
+    # :call-seq:
+    #   format(string)
+    def format_string(string)
+      hash = Hash.new do |_, key|
+        result = @context.dictionary[key]
+        next result unless result.nil?
+        return nil
+      end
+
+      format(string, hash)
+    end
   end
 end
 

data/lib/dagger/generator/regexp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../generator'
 
 module Dagger

data/lib/dagger/generator/require.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../generator'
 
 module Dagger

data/lib/dagger/generator/require_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../generator'
 
 module Dagger
@@ -9,9 +11,8 @@ module Dagger
     #   - ...
     class RequireName < Dagger::Generator
       def process(regexps)
-        string = dictionary['_meta.name']
         stop unless enumerable(regexps).any? do |regexp|
-          ::Regexp.new(regexp).match?(string)
+          ::Regexp.new(regexp).match?(vertex.name)
         end
       end
     end

data/lib/dagger/generator/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../generator'
 
 module Dagger
@@ -12,22 +14,10 @@ module Dagger
     class String < Dagger::Generator
       def process(strings)
         enumerable(strings).each do |fmtstr|
-          result = format_string(fmtstr, dictionary)
+          result = format_string(fmtstr)
           yield result unless result.nil?
         end
       end
-
-      private
-
-      # Format a +string+ with values from a +dictionary+
-      #
-      # :call-seq:
-      #   format_string(string, dictionary)
-      def format_string(string, dictionary)
-        Kernel.format(string, Hash.new { |_, key| dictionary[key] })
-      rescue KeyError
-        nil
-      end
     end
   end
 end

data/lib/dagger/graph.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tangle'
 require 'tangle/mixin/directory'
 require_relative 'vertex'
@@ -5,17 +7,16 @@ require_relative 'vertex'
 module Dagger
   # Specialization of Tangle::DAG
   class Graph < Tangle::DAG
-    DEFAULT_MIXINS = [Tangle::Mixin::Directory].freeze
-
-    def self.load(dir)
+    def self.load(dir, cached: false)
+      @cached = cached
       dir_options = {
         root: File.realpath(dir),
         loaders: %i[symlink_loader directory_loader keytree_loader]
       }
-      new(directory: dir_options)
+      new(directory: dir_options, currify: true)
     end
 
-    def initialize(*)
+    def initialize(mixins: [Tangle::Mixin::Directory], **)
       @deferred_edges = []
       super
       @deferred_edges.each do |args|
@@ -28,6 +29,10 @@ module Dagger
       vertices.select { |vertex| yield(self, vertex) }
     end
 
+    def cached?
+      !(!@cached)
+    end
+
     protected
 
     def symlink_loader(path:, parent:, lstat:, **)
@@ -42,7 +47,7 @@ module Dagger
       return unless lstat.directory?
 
       path = local_path(path)
-      vertex = Vertex.new(path)
+      vertex = Vertex.new(path, cached: cached?)
       add_vertex(vertex)
       return true if parent.nil?
       parent = local_path(parent)

data/lib/dagger/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Dagger # rubocop:disable Style/Documentation
+  begin
+    require 'git-version-bump'
+    VERSION = GVB.version.freeze
+  rescue LoadError
+    VERSION = '0.0.0.UNDEF'
+  end
+end

data/lib/dagger/vertex.rb

@@ -1,59 +1,119 @@
+# frozen_string_literal: true
+
 require 'key_tree'
+require 'key_tree/refinements'
 require_relative 'default'
 
 module Dagger
   # Vertex class for Dagger, representing a filesystem directory
+  #
+  #   dir/
+  #     file.yaml         => keytree
+  #     prefix@file.yaml  => prefix.keytree
+  #
+  #   +forest+ = [ +meta+       = {},
+  #                +local+        [ { file_keys }, ... ],
+  #                               [ { Default } ],
+  #                +inherited+  = [ [ parent ], ... ]
+  #              ]
+  #
   class Vertex
-    def initialize(name)
-      initialize_forest
+    using KeyTree::Refinements
 
-      meta['_meta.name'] = name
-      meta['_meta.basename'] = File.basename(name)
-      meta['_meta.dirname'] = File.dirname(name)
+    def initialize(name, cached: false)
+      @forest = initialize_forest(cached)
+      @meta['_meta.name'] = name
+      @meta['_meta.basename'] = File.basename(name)
+      @meta['_meta.dirname'] = File.dirname(name)
     end
 
-    attr_reader :inherited, :keys, :local, :meta
+    def to_key_forest
+      @forest
+    end
+    alias to_key_wood to_key_forest
 
     def name
-      meta['_meta.name']
+      @forest['_meta.name']
     end
+    alias to_s name
 
     def [](key)
-      key = KeyTree::Path[key] unless key.is_a? KeyTree::Path
-      return inherited[key[1..-1]] if key.prefix?(KeyTree::Path['^'])
-      keys[key]
+      key = key.to_key_path
+      @inherited[key.drop(1)] if key.prefix?('^')
+      @forest[key]
     end
 
-    def fetch(key)
-      keys.fetch(key)
+    def fetch(key, *default, &block)
+      key = key.to_key_path
+      @inherited.fetch(key.drop(1), *default, &block) if key.prefix?('^')
+      @forest.fetch(key, *default, &block)
     end
 
     def <<(keytree)
-      local << keytree
+      @local << keytree
     end
 
     def edge_added(edge)
       return unless edge.head?(self)
-      inherited << edge.tail.keys
+      @inherited << edge.tail.to_key_wood
     end
 
     def edge_removed(edge)
       return unless edge.head?(self)
-      inherited.reject! { |tree| tree.equal?(edge.tail.keys) }
+      @inherited.reject! { |tree| tree.equal?(edge.tail.to_key_wood) }
     end
 
-    alias to_s name
+    def added_to_graph(graph)
+      raise %(belongs another graph) if @graph&.!= graph
+      @graph = graph
+    end
+
+    def removed_from_graph(graph)
+      raise %(not part of graph) if @graph&.!= graph
+      @graph = nil
+    end
+
+    def flatten(cleanup: true)
+      forest = initialize_forest(true)
+
+      forest.key_paths.select { |key| key.prefix?('_default') }.each do |key|
+        forest[key.drop(1)]
+      end
+
+      flattened = forest.flatten
+      return flattened unless cleanup
+      flattened.to_h.delete_if { |key| key.to_s.start_with?('_') }
+      flattened
+    end
+
+    def to_h
+      flatten(cleanup: true).to_h
+    end
+
+    def to_yaml
+      flatten(cleanup: true).to_yaml
+    end
+
+    def to_json
+      flatten(cleanup: true).to_json
+    end
 
     private
 
-    def initialize_forest
-      @keys = KeyTree::Forest.new
-      @keys << @meta = KeyTree::Tree.new
-      @keys << @local = KeyTree::Forest.new
-      @keys << @default = KeyTree::Forest.new
-      @keys << @inherited = KeyTree::Forest.new
-      default_proc = Default.new(self).default_proc
-      @default << KeyTree::Tree.new(&default_proc)
+    def initialize_forest(cached)
+      forest = KeyTree::Forest.new
+      forest << @meta ||= KeyTree::Tree.new
+      forest << @local ||= KeyTree::Forest.new
+      forest << default = KeyTree::Forest.new
+      forest << @inherited ||= KeyTree::Forest.new
+      default << initialize_default_tree(cached)
+      forest
+    end
+
+    def initialize_default_tree(cached)
+      default_args = cached ? { cached: true, fallback: @inherited } : {}
+      default_proc = Default.proc(self, default_args)
+      KeyTree::Tree.new(&default_proc)
     end
   end
 end

data/ruby-dagger.gemspec

@@ -1,17 +1,13 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-begin
-  require 'git-version-bump'
-  GIT_VERSION = GVB.version.freeze
-rescue LoadError
-  GIT_VERSION = '0.0.0.UNDEF'.freeze
-end
+require 'dagger/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ruby-dagger'
-  spec.version       = GIT_VERSION
+  spec.version       = Dagger::VERSION
   spec.authors       = ['Calle Englund']
   spec.email         = ['calle@discord.bofh.se']
 
@@ -27,14 +23,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = '~> 2.3'
 
-  spec.add_dependency 'key_tree', '~> 0.5'
-  spec.add_dependency 'tangle', '~> 0.9'
+  spec.add_dependency 'key_tree', '~> 0.6'
+  spec.add_dependency 'tangle', '~> 0.10'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'git-version-bump', '~> 0.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'ruby-prof', '~> 0.17'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dagger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 2018-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: key_tree
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: tangle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: 
 email:
 - calle@discord.bofh.se
@@ -135,6 +163,7 @@ files:
 - lib/dagger/generator/require_name.rb
 - lib/dagger/generator/string.rb
 - lib/dagger/graph.rb
+- lib/dagger/version.rb
 - lib/dagger/vertex.rb
 - ruby-dagger.gemspec
 homepage: https://github.com/notcalle/ruby-dagger
@@ -149,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="