didgood 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30468ec76fd6ef7bcf9811dd6b789a0dcf5a01b97d7cbadddaacda4e9efee011
+  data.tar.gz: e7dd28d517d84ffaaf3dc0c7b34bf945efd59ea84f57a66f30184c5c1759c8b7
+SHA512:
+  metadata.gz: 34f947738281d597651c2dd87037dabfcb91ca3e8422335b6a4b8710b64850d62fd59504b0973ff816a4177ff22336b1f8758d0aa8830f4e4ed3671a80a54eb8
+  data.tar.gz: da573cf10011fc0e6a15c8d9d822d4acc47603953ffd85b9330dfb36fe524352f4f3f0ba68adf208f34553d1fb9f75f8577b0d40adaa5375311094d480cbf6ea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in DidGood.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    didgood (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  didgood!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Noah Gibbs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# DidGood
+
+DidGood is an experimental library system for [DGD](https://github.com/dworkin/LPC). DGD is an interpreter for a dialect of LPC, the C-like language of LPMuds. I don't actually know of a second attempt to set up a library system for it. DidGood is inspired loosely by RubyGems and the Ruby [Bundler](https://bundler.io).
+
+DidGood refers to its libraries as Goods. The file dgd.didgood, if it's present in your application's directory, specifies where and how to find its various libraries. By running "didgood install", you can install those various files into a complete application.
+
+DidGood is a simple initial library system. I'm sure I'll figure more out as I go along, and I'm sure it'll need changes. But you have to start somewhere!
+
+This work has grown out of [SkotOS and ChatTheatre](https://github.com/ChatTheatre) tasks.
+
+DidGood requires Ruby. It comes preinstalled on recent Mac computers, or you can install it yourself on Linux. On Windows, if you're not using WSL or similar, you're going to have a less-than-optimal experience.
+
+## Installation
+
+You would normally install DidGood directly: `gem install didgood`.
+
+It's possible to add it to a Ruby's application's Gemfile. Ordinarily you wouldn't.
+
+## Usage
+
+If you have a DGD application that uses didgood, run `didgood install` to download its dependencies and create a fully-assembled DGD directory for it.
+
+## Using DidGood with your DGD Application
+
+DidGood needs a .goods file for each library you intend to use, or it needs the information that would normally have been in that .goods file. DidGood keeps its various settings in JSON.
+
+
+
+## Creating the Goods
+
+To create a new DidGood-usable library, you'll want to create a Goods file for it.
+
+## Design Notes on Libraries
+
+The Kernel Library allows changing some config settings, including the name of the "/usr" dir. Consider some other name? Should definitely decide which direction to set "persistent" and stick with it.
+
+Having admin users exist as library-ettes next to libraries seems highly dubious. But to avoid it, there would need to be a whole other permissions system sitting on top of the Kernel Library (like SkotOS, but more so.)
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noahgibbs/DidGood.
+
+## License
+
+The gem is available as open source under the terms of the AGPL.

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "DidGood"
+
+# 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/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/didgood.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/DidGood/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "didgood"
+  spec.version       = DidGood::VERSION
+  spec.authors       = ["Noah Gibbs"]
+  spec.email         = ["the.codefolio.guy@gmail.com"]
+
+  spec.summary       = %q{DidGood is an experimental library and packaging system for the DGD language.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/noahgibbs/didgood"
+  spec.license       = "AGPL"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/exe/didgood

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "didgood"
+
+if ARGV.size == 0
+    ARGV.push "install"
+end
+
+case ARGV[0]
+when "test"
+    unless File.exist?("dgd.didgood")
+        raise "I don't see a dgd.didgood file in this directory!"
+    end
+    puts "Running didgood installer..."
+    repo = DidGood::Repo.new
+    repo.didgood_file("dgd.didgood")
+    puts "Verified Goods packages: this looks likely correct."
+when "install"
+    unless File.exist?("dgd.didgood")
+        raise "I don't see a dgd.didgood file in this directory!"
+    end
+    puts "Running didgood installer..."
+    repo = DidGood::Repo.new
+    repo.didgood_file("dgd.didgood")
+    repo.assemble_app(".")
+when "work"
+    puts "Starting DGD server... (not yet)"
+else
+    raise "Unrecognised didgood command: #{ARGV[0].inspect}!"
+end

data/goods/skotos_httpd.goods

@@ -0,0 +1,10 @@
+{
+    "name": "SkotOS HTTPD",
+    "git": {
+        "url": "https://github.com/ChatTheatre/SkotOS.git",
+        "branch": "master"
+    },
+    "paths": {
+        "skoot/usr/HTTP": "usr/HTTP"
+    }
+}

data/lib/didgood.rb

@@ -0,0 +1,265 @@
+require "DidGood/version"
+
+require "json"
+require "open-uri"
+require "fileutils"
+
+module DidGood
+    class Error < StandardError; end
+
+    DGD_BUILD_COMMAND = %(make DEFINES='-DUINDEX_TYPE="unsigned int" -DUINDEX_MAX=UINT_MAX -DEINDEX_TYPE="unsigned short" -DEINDEX_MAX=USHRT_MAX -DSSIZET_TYPE="unsigned int" -DSSIZET_MAX=1048576' install
+)
+    KERNEL_PATHS = ["/include/kernel", "/kernel"]
+    DEFAULT_KERNELLIB_URL = "https://github.com/ChatTheatre/kernellib"
+
+    GENERATED_ROOT = ".root"
+
+    def self.system_call(cmd)
+        puts "Running command: #{cmd.inspect}..."
+        system(cmd, out: $stdout, err: :out)
+        unless $?.success?
+            raise "Error running command: #{cmd.inspect}!"
+        end
+    end
+
+    # This is a repo of everything DidGood saves between runs.
+    # It includes downloaded Git repos, Goods files and more.
+    class Repo
+        attr_reader :didgood_dir
+
+        def initialize
+            @home = ENV["HOME"]
+            @didgood_dir = "#{@home}/.didgood"
+            Dir.mkdir(@didgood_dir) unless File.directory?(@didgood_dir)
+            ["git", "goods"].each do |subdir|
+                full_subdir = "#{@didgood_dir}/#{subdir}"
+                Dir.mkdir(full_subdir) unless File.directory?(full_subdir)
+            end
+
+            unless File.exist?("#{@didgood_dir}/dgd/bin/dgd")
+                dgd_dir = "#{@didgood_dir}/dgd"
+                if File.directory?(dgd_dir)
+                    # Not clear to me what to do here...
+                else
+                    DidGood.system_call("git clone https://github.com/ChatTheatre/dgd.git #{dgd_dir}")
+                    Dir.chdir("#{@didgood_dir}/dgd/src") do
+                        DidGood.system_call(DGD_BUILD_COMMAND)
+                    end
+                end
+            end
+        end
+
+        def git_repo(git_url)
+            @git_repos ||= {}
+            @git_repos[git_url] ||= GitRepo.new(self, git_url)
+        end
+
+        def didgood_file(path)
+            raise "Already have a dgd.didgood file!" if @didgood_file
+
+            @didgood_file ||= AppFile.new(self, path)
+        end
+
+        def assemble_app(location)
+            dgd_root = "#{File.expand_path(location)}/#{GENERATED_ROOT}"
+            FileUtils.rm_rf(dgd_root)
+            Dir.mkdir(dgd_root)
+
+            write_config_file("#{location}/dgd.config")
+            specs = @didgood_file.specs
+
+
+            specs.each do |spec|
+                git_repo = spec.source
+                git_repo.use_details(spec.source_details)
+
+                spec.paths.each do |from, to|
+                    from_path = "#{git_repo.local_dir}/#{from}"
+                    to_path = "#{dgd_root}/#{to}"
+                    FileUtils.mkdir_p to_path
+                    FileUtils.cp_r(from_path, to_path)
+                end
+            end
+        end
+
+        def write_config_file(path)
+            File.open(path, "wb") do |f|
+                f.write <<CONTENTS
+/* These are SkotOS limits. They are enormous. They should
+   be configurable but they are not yet. */
+telnet_port = ([
+    "*":50100  /* telnet port number */
+]);
+binary_port = ([
+    "*":50110, /* Failsafe */
+]);   /* binary ports */
+directory = "./#{GENERATED_ROOT}";
+
+users       = 100;           /* max # of users */
+editors     = 40;           /* max # of editor sessions */
+ed_tmpfile  = "../state/ed";        /* proto editor tmpfile */
+swap_file   = "../state/swap";  /* swap file */
+swap_size   = 1048576;         /* # sectors in swap file */
+sector_size = 512;          /* swap sector size */
+swap_fragment   = 4096;           /* fragment to swap out */
+static_chunk    = 64512;        /* static memory chunk */
+dynamic_chunk   = 261120;       /* dynamic memory chunk */
+dump_file   = "../state/dump";  /* dump file */
+dump_interval   = 3600;             /* dump interval */
+
+typechecking    = 2;            /* highest level of typechecking */
+include_file    = "/include/std.h";     /* standard include file */
+include_dirs    = ({ "/include", "~/include" }); /* directories to search */
+auto_object     = "/kernel/lib/auto";   /* auto inherited object */
+driver_object   = "/kernel/sys/driver"; /* driver object */
+create      = "_F_create";      /* name of create function */
+
+array_size  = 16384;         /* max array size */
+objects     = 262144;          /* max # of objects */
+call_outs   = 16384;          /* max # of call_outs */
+CONTENTS
+            end
+        end
+    end
+
+    # This is a DidGood-downloaded Git repo.
+    # It can be a source for a GoodsSpec
+    class GitRepo
+        attr_reader :local_dir
+        attr_reader :git_url
+
+        def initialize(repo, git_url)
+            @git_url = git_url
+            @repo = repo
+            local_path = git_url.tr("/\\", "_")
+            @local_dir = "#{@repo.didgood_dir}/git/#{local_path}"
+
+            if File.directory?(@local_dir)
+                Dir.chdir(@local_dir) do
+                    DidGood.system_call("git checkout #{default_branch} && git pull")
+                end
+            else
+                DidGood.system_call("git clone #{@git_url} #{@local_dir}")
+            end
+        end
+
+        def default_branch
+            return @default_branch if @default_branch
+            output = `git rev-parse --abbrev-ref origin/HEAD`.chomp
+            @default_branch = output.gsub(/^origin\//, "")
+        end
+
+        def use_details(details)
+            if details["branch"]
+                Dir.chdir(@local_dir) do
+                    DidGood.system_call("git checkout #{details["branch"]}")
+                end
+            else
+                Dir.chdir(@local_dir) do
+                    DidGood.system_call("git checkout #{default_branch}")
+                end
+            end
+        end
+    end
+
+    class AppFile
+        attr_reader :path
+        attr_reader :repo
+        attr_reader :specs
+
+        def initialize(repo, path)
+            @path = path
+            @repo = repo
+            raise("No such dgd.didgood file as #{path.inspect}!") unless File.exist?(path)
+            contents = JSON.load(File.read(path))
+
+            raise "Expected a top-level JSON array in dgd.didgood!" unless contents.is_a?(Array)
+
+            @specs = contents.flat_map { |item| json_to_specs(item) }
+
+            paths = @specs.flat_map { |s| s.paths }
+            unless paths == paths.uniq
+                repeated_paths = paths.select { |p| paths.count(p) > 1 }
+                raise "Repeated (conflicting?) paths in dgd.didgood! #{repeated_paths.inspect}"
+            end
+
+            # Make sure the dgd.didgood file overrides either no kernel paths or both/all
+            if KERNEL_PATHS.any? { |kp| paths.include?(kp) }
+                unless KERNEL_PATHS.all? { |kp| paths.include?(kp) }
+                    raise "dgd.didgood file #{path.inspect} includes some Kernel Library paths but not all! All needed: #{KERNEL_PATHS}!"
+                end
+                puts "This dgd.didgood file overrides the Kernel Library with its own."
+            else
+                # This app has specified no kernellib paths -- add them
+                git_repo = @repo.git_repo(DEFAULT_KERNELLIB_URL)
+                kl_paths = { "src/kernel" => "/kernel", "src/include/kernel" => "/include/kernel", "src/doc/kernel" => "/doc/kernel" }
+                klib_spec = GoodsSpec.new @repo, name: "default Kernel Library",
+                    source: git_repo, paths: kl_paths
+                specs.push klib_spec
+            end
+
+            nil
+        end
+
+        def json_to_specs(item)
+            raise "Expected every spec to be a JSON object, not #{item.inspect}!" unless item.is_a?(Hash)
+            return [] if item.size == 0 || item.all? { |k, v| k == "" }
+
+            if item["unbundled_goods"]
+                raise "Unbundled_goods must have only one key!" unless item.size == 1
+
+                return [unbundled_json_to_spec(item["unbundled_goods"])]
+            end
+
+            # A string-to-string mapping means a list of names and Goods URLs
+            if item.is_a?(Hash) && item.all? { |k, v| k.is_a?(String) && v.is_a?(String) }
+                return item.map do |name, goods_url|
+                    begin
+                        contents = JSON.parse(URI.open(goods_url).read)
+                    rescue
+                        STDERR.puts "Error reading or parsing by URL: #{goods_url.inspect}"
+                        raise
+                    end
+                    unbundled_json_to_spec(contents)
+                end
+            end
+
+            raise "Didn't recognize JSON objects as Goods specs in dgd.didgood!"
+        end
+
+        def unbundled_json_to_spec(fields)
+            source = nil
+            source_details = nil
+            if fields["git"]
+                raise "A git source requires a git url: #{fields.inspect}!" unless fields["git"]["url"]
+                source = @repo.git_repo(fields["git"]["url"])
+                source_details = fields["git"]  # May contain branch info, etc.
+            else
+                raise "Didgood currently requires a Git-based source!"
+            end
+
+            unless fields["paths"].all? { |k, v| k.is_a?(String) && v.is_a?(String) }
+                raise "Paths in Goods files must map strings to strings! #{fields["paths"].inspect}"
+            end
+
+            spec = GoodsSpec.new(@repo, name: fields["name"], source: source, source_details: source_details, paths: fields["paths"])
+            return spec
+        end
+    end
+
+    class GoodsSpec
+        attr_reader :repo
+        attr_reader :name
+        attr_reader :source
+        attr_reader :source_details
+        attr_reader :paths
+
+        def initialize(repo, name:, source:, source_details: {}, paths:)
+            @repo = repo
+            @name = name
+            @source = source
+            @source_details = source_details
+            @paths = paths
+        end
+    end
+end

data/lib/didgood/version.rb

@@ -0,0 +1,3 @@
+module DidGood
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: didgood
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noah Gibbs
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies: []
+description: DidGood is an experimental library and packaging system for the DGD language.
+email:
+- the.codefolio.guy@gmail.com
+executables:
+- didgood
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- didgood.gemspec
+- exe/didgood
+- goods/skotos_httpd.goods
+- lib/didgood.rb
+- lib/didgood/version.rb
+homepage: https://github.com/noahgibbs/didgood
+licenses:
+- AGPL
+metadata:
+  homepage_uri: https://github.com/noahgibbs/didgood
+  source_code_uri: https://github.com/noahgibbs/didgood
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: DidGood is an experimental library and packaging system for the DGD language.
+test_files: []