kwyktree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45c53da7e4aaef3c10161a6097dc952efb33313341b98e3d35c8e95a676bbc85
+  data.tar.gz: b5a5c985cf0e6346358e1da89b27c7dca8d8472baef50d27be750699acb0f20a
+SHA512:
+  metadata.gz: 5760d32bf2597389a48aed31ffd321d2d82fe9126a6313158d087560cc967cb081f3491d12bcb45b3cf1f1d2b4a59078130a8c6d101e291d02b9a1c91bac9af0
+  data.tar.gz: 227e6028d424b047c7efcbda67d71f8bc882fc9953e0c8859d488ef00620fe1acae811160ce8df1930921bb0270a935e18a2518db3a90f4d60be272defba02b5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+kwyktree.dot
+kwyktree.svg

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dave@dafyddcrosby.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-minitest"
+  gem "kwalify", "= 0.7.2"
+  gem "minitest", "~> 5.0"
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.7"
+end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    kwyktree (0.1.0)
+      ruby-graphviz (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    kwalify (0.7.2)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rubocop (1.28.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-graphviz (1.2.5)
+      rexml
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  guard
+  guard-minitest
+  kwalify (= 0.7.2)
+  kwyktree!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/Guardfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+directories %w[lib test] \
+  .select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") }
+
+guard :minitest do
+  watch(%r{^test/test_(.*)\.rb$}) { 'test' }
+  watch(%r{^lib/kwyktree/(.*)\.rb$}) { 'test' }
+  watch(%r{^lib/kwyktree\.rb$}) { 'test' }
+  watch(%r{^test/helper\.rb$}) { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,10 @@
+Copyright (c) 2022, David Crosby
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,3 @@
+# KwykTree
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dafyddcrosby/kwyktree

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "kwyktree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/kwyktree

@@ -0,0 +1,41 @@
+#!/bin/env ruby
+require "yaml"
+require "ruby-graphviz"
+require "pathname"
+require_relative "../lib/kwyktree"
+
+nodes = {}
+ARGV.each do |f|
+  if File.exist? f
+    y = YAML.load_file f
+    cluster = Pathname.new(f).basename.to_s.gsub('.yaml','')
+    nodes[cluster] = []
+    y['concepts'].each do |u|
+      nodes[cluster] << KwykTree::Concept.new(u)
+    end if y['concepts']
+    y['implementations'].each do |u|
+      nodes[cluster] << KwykTree::Implementation.new(u)
+    end if y['implementations']
+  end
+  pp nodes
+end
+pp nodes
+
+g = GraphViz.digraph("kwyktree")
+nodes.each do |k, nodelist|
+  nodelist.each do |n|
+    n.deps.each do |d|
+      g.add_edges d, n.graphviz_id
+    end
+  end
+end
+nodes.each do |k, nodelist|
+  nodelist.each do |n|
+    g.subgraph("cluster_#{k}", label: k) do |sg|
+      sg.add_nodes n.graphviz_id, n.graphviz_attributes
+    end
+  end
+end
+
+g.output dot: "kwyktree.dot"
+g.output svg: "kwyktree.svg"

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kwyktree.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/kwyktree/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kwyktree"
+  spec.version       = KwykTree::VERSION
+  spec.authors       = ["David Crosby"]
+  spec.email         = ["dave@dafyddcrosby.com"]
+
+  spec.summary       = "Know-What-You-Know Tree"
+  spec.description   = spec.summary
+  spec.homepage      = "https://daveops.net"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-graphviz", "~> 1.2"
+end

data/lib/kwyktree/unit.rb

@@ -0,0 +1,93 @@
+require "ruby-graphviz"
+
+module KwykTree
+  class Unit
+    attr_reader :deps, :url
+    def initialize(unit)
+      if unit['name']
+        @name = unit['name']
+      else
+        raise "unit needs a name"
+      end
+
+      @details = {}
+      @details["anki"] = unit['anki'] || false
+      @details["grok"] = unit['grok'] || false
+      @desc = unit['desc'] || ""
+      @url = unit['url'] if unit['url']
+      @deps = unit['deps'] || []
+      @deps.each do |l|
+        l.downcase!
+      end
+      @title = unit['title'] || pretty_name
+    end
+
+    def type
+      raise "unit needs to be subclassed!"
+    end
+
+    def graphviz_record_label
+      # TODO: add desc
+      "{#{@title}#{graphviz_details}}"
+    end
+
+    def graphviz_id
+      "#{type}.#{@name.downcase.tr(' ', '_')}"
+    end
+
+    def graphviz_attributes
+      hsh = {
+        tooltip: @title,
+        label: graphviz_record_label,
+        shape: graphviz_record_shape
+      }
+      hsh[:URL] = @url if @url
+      hsh
+    end
+
+    def graphviz_record_shape
+      raise "unit needs to be subclassed!"
+    end
+
+    private
+
+    def pretty_name
+      # Not perfect, but fine for now
+      @name.capitalize.tr("_", " ")
+    end
+
+    def graphviz_details
+      details_bar = ""
+      details = ""
+      if @details["grok"] != true
+        details_bar = "|"
+        details << 'grok: false\\n'
+      end
+      if @details["anki"] != true
+        details_bar = "|"
+        details << 'anki: false\\n'
+      end
+      "#{details_bar}#{details}"
+    end
+  end
+
+  class Concept < Unit
+    def type
+      "concept"
+    end
+
+    def graphviz_record_shape
+      "Mrecord"
+    end
+  end
+
+  class Implementation < Unit
+    def type
+      "implementation"
+    end
+
+    def graphviz_record_shape
+      "record"
+    end
+  end
+end

data/lib/kwyktree/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KwykTree
+  VERSION = "0.1.0"
+end

data/lib/kwyktree.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "kwyktree/version"
+require_relative "kwyktree/unit"
+
+module KwykTree
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/schema.yaml

@@ -0,0 +1,32 @@
+type: map
+mapping:
+  "concepts": &unit
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "name":
+            type: str
+            required: yes
+            unique: yes
+          "desc":
+            type: str
+          "url":
+            type: str
+          "details":
+            type: str
+          "acronym":
+            type: str
+          "grok":
+            type: bool
+          "anki":
+            type: bool
+          "aka":
+            type: seq
+            sequence:
+              - type: str
+          "deps":
+            type: seq
+            sequence:
+              - type: str
+  "implementations": *unit

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: kwyktree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Crosby
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Know-What-You-Know Tree
+email:
+- dave@dafyddcrosby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/kwyktree
+- bin/setup
+- kwyktree.gemspec
+- lib/kwyktree.rb
+- lib/kwyktree/unit.rb
+- lib/kwyktree/version.rb
+- schema.yaml
+homepage: https://daveops.net
+licenses: []
+metadata:
+  homepage_uri: https://daveops.net
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Know-What-You-Know Tree
+test_files: []