didgood 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30468ec76fd6ef7bcf9811dd6b789a0dcf5a01b97d7cbadddaacda4e9efee011
-  data.tar.gz: e7dd28d517d84ffaaf3dc0c7b34bf945efd59ea84f57a66f30184c5c1759c8b7
+  metadata.gz: 52b48699d65d87fddc805c6f80857546c5fb09fc9b6707140b28dd71b70d637f
+  data.tar.gz: 570e8f325a14587968a1fda5dd660fe9e4781b2326f614c12697fd696c37cf59
 SHA512:
-  metadata.gz: 34f947738281d597651c2dd87037dabfcb91ca3e8422335b6a4b8710b64850d62fd59504b0973ff816a4177ff22336b1f8758d0aa8830f4e4ed3671a80a54eb8
-  data.tar.gz: da573cf10011fc0e6a15c8d9d822d4acc47603953ffd85b9330dfb36fe524352f4f3f0ba68adf208f34553d1fb9f75f8577b0d40adaa5375311094d480cbf6ea
+  metadata.gz: 554dce72220b582911f37c948e0f93429e75872a73b11366d7975237e13de56b6a3e6d04e97eab9ff23e0724464308fe5f69af1b04f64a7789227c9b262ae6ee
+  data.tar.gz: e7ab49d442c7a929ad9983a5f1a277887d2527234f96b0f861593621ce0066429669d1ec9520a77b9a18382976f8cd16d3921e0f661763ccdac78bc035ae2a45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    didgood (0.1.0)
+    didgood (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -22,22 +22,64 @@ If you have a DGD application that uses didgood, run `didgood install` to downlo
 
 ## 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.
-
-
+Your app will need a dgd.didgood file, which is a lot like NPM's package.json file.
+
+Here's an example:
+
+```
+{
+    "name": "eOS",
+    "version": "1.0.0",
+    "description": "A game platform from the folks at ChatTheatre",
+    "app": "app",
+    "goods": [
+        "https://raw.githubusercontent.com/noahgibbs/DidGood/main/goods/skotos_httpd.goods"
+    ],
+    "unbundled_goods": [
+        {
+            "name": "kernellib",
+            "git": {
+                "url": "https://github.com/dworkin/cloud-server.git",
+                "branch": "master"
+            },
+            "paths": {
+                "src/doc/kernel": "doc/kernel",
+                "src/include/kernel": "include/kernel",
+                "src/kernel": "kernel"
+            }
+        }
+    ]
+}
+```
+
+DidGood needs a .goods file for each of your dependencies - or it needs the equivalent of that .goods file, in the form of unbundled_goods. That one line in "goods" is basically the same information in unbundled_goods, just stored at a URL that DidGood can download for you.
+
+A DidGood-enabled DGD codebase can provide Goods files directly and you can use them by their URLs. A non-DidGood codebase may require you to create your own .goods files, or use them directly and unbundled in the dgd.didgood file for your app.
 
 ## Creating the Goods
 
 To create a new DidGood-usable library, you'll want to create a Goods file for it.
 
+Here's what those look like:
+
+```
+{
+    "name": "SkotOS HTTPD",
+    "git": {
+        "url": "https://github.com/ChatTheatre/SkotOS.git"
+    },
+    "paths": {
+        "skoot/usr/HTTP": "usr/HTTP"
+    }
+}
+```
+
 ## 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.

data/lib/didgood.rb

@@ -173,9 +173,7 @@ CONTENTS
             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) }
+            read_didgood_file(contents)
 
             paths = @specs.flat_map { |s| s.paths }
             unless paths == paths.uniq
@@ -201,30 +199,30 @@ CONTENTS
             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 == "" }
+        def read_didgood_file(contents)
+            raise "Expected a top-level JSON object in dgd.didgood!" unless contents.is_a?(Hash)
+
+            @specs = []
 
-            if item["unbundled_goods"]
-                raise "Unbundled_goods must have only one key!" unless item.size == 1
+            if contents["unbundled_goods"]
+                raise "Unbundled_goods must be an array!" unless contents["unbundled_goods"].is_a?(Array)
 
-                return [unbundled_json_to_spec(item["unbundled_goods"])]
+                @specs += contents["unbundled_goods"].map { |item| unbundled_json_to_spec(item) }
             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|
+            if contents["goods"]
+                raise "Goods must be an array!" unless contents["goods"].is_a?(Array)
+
+                @specs += contents["goods"].map do |goods_url|
                     begin
-                        contents = JSON.parse(URI.open(goods_url).read)
+                        json_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)
+                    unbundled_json_to_spec(json_contents)
                 end
             end
-
-            raise "Didn't recognize JSON objects as Goods specs in dgd.didgood!"
         end
 
         def unbundled_json_to_spec(fields)

data/lib/didgood/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didgood
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Noah Gibbs