buildonce 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba8c61308a01ef68287aafec385afd85e45c961321ebad2dacc4c1e2b063399
-  data.tar.gz: ee173570197c9b0f1c234e392e7164eefb9b9672f4d8877a708518698157f49d
+  metadata.gz: f1a0860cf2425eddaae411d83154c8379d38072c40309b634b6d998b28cb15a5
+  data.tar.gz: 39b47ad58bee6bfdc7abcac5e5365403c8c9de211d6b0510299ad95bad2b9007
 SHA512:
-  metadata.gz: 0c693558182fd5116497cb55b6055a7a3ca77aacd03141d2c1ac46c926cf307c07c40ef8cfba52f619e3dd7f561e425474a04eb4d8ac3c4ec3df0cc141c475a7
-  data.tar.gz: 86378ee698e58c1c49cc013da258134fbd3f22ffaccbb6f6df692214dcb9d5bde29df5af18db3f3fd41dca271cfcfc8c643be79637f6fe1325b2a900ed2124c0
+  metadata.gz: d5686e5a4f2f269966f20b20fa2fd71696b4ae9060603a3d9d1421a0bdb2f1bfd1d284f3af8d680a5e52fbf73eaff6dac22fcc10af4c2603bbbd6994088ef0ce
+  data.tar.gz: 1ae22f71085fc1d8b4d7c39b7753cf084085350cfe55d9a5fadf5fd920b5aaae6a0d98fb53001e50cb34ecae598bf6d2d275198e43cc5d4cd381e78fe07ca755

data/README.md

@@ -1,7 +1,7 @@
-# Once Ruby SDK
+# Once Ruby Software Development Kit
 
 `buildonce` exposes Once primitives to Ruby. It loads the same
-native Once library used by the other SDKs and does not expose script
+native Once library used by the other language libraries and does not expose script
 execution.
 
 ```ruby
@@ -16,3 +16,8 @@ raise unless bytes == "hello"
 
 The gem looks for a bundled native library under `prebuilds/`. Set
 `ONCE_LIBRARY_PATH` to load a custom `libonce` build.
+
+Use `Once::Cache.new(workspace_root:)` to share the effective provider
+configured for a repository, or `local_cache_root:` for isolation. Use
+`put_file` and `get_blob_to_file` for large payloads. `Once::ActionKey` builds
+a stable digest from ordered, labeled inputs.

data/lib/buildonce.rb

@@ -25,6 +25,17 @@ module Once
   CacheStats = Struct.new(:blob_count, :blob_bytes, :action_count, :action_bytes, keyword_init: true)
 
   class Cache
+    def initialize(local_cache_root: nil, workspace_root: nil)
+      if local_cache_root && workspace_root
+        raise ArgumentError, "local_cache_root and workspace_root cannot be used together"
+      end
+
+      @selection = {}
+      @selection[:local_cache_root] = local_cache_root.to_s if local_cache_root
+      @selection[:workspace_root] = workspace_root.to_s if workspace_root
+      @selection.freeze
+    end
+
     def version
       read_native_string(Native.once_version)
     end
@@ -37,37 +48,56 @@ module Once
 
     def put_blob(bytes)
       buffer = bytes.to_s.b
-      decode_request(:once_cache_put_blob_json, bytes: buffer.bytes)
+      decode_request(:once_cache_put_blob_json, selection(bytes: buffer.bytes))
+    end
+
+    def put_file(path)
+      decode_request(:once_cache_put_file_json, selection(path: path.to_s))
     end
 
     def get_blob(digest)
-      response = decode_request(:once_cache_get_blob_json, digest: digest)
+      response = decode_request(:once_cache_get_blob_json, selection(digest: digest))
       response.fetch("bytes").pack("C*")
     end
 
+    def get_blob_to_file(digest, path)
+      decode_request(
+        :once_cache_get_blob_to_file_json,
+        selection(digest: digest, path: path.to_s),
+      )
+    end
+
     def has_blob?(digest)
-      decode_request(:once_cache_has_blob_json, digest: digest)
+      decode_request(:once_cache_has_blob_json, selection(digest: digest))
     end
 
     def put_action_result(result, action_digest:)
       decode_request(
         :once_cache_put_action_result_json,
-        action_digest: action_digest,
-        result: normalize_action_result(result),
+        selection(
+          action_digest: action_digest,
+          result: normalize_action_result(result),
+        ),
       )
     end
 
     def get_action_result(action_digest)
-      response = decode_request(:once_cache_get_action_result_json, action_digest: action_digest)
+      response = decode_request(
+        :once_cache_get_action_result_json,
+        selection(action_digest: action_digest),
+      )
       response && action_result_from_native(response)
     end
 
     def forget_action(action_digest)
-      decode_request(:once_cache_forget_action_json, action_digest: action_digest)
+      decode_request(
+        :once_cache_forget_action_json,
+        selection(action_digest: action_digest),
+      )
     end
 
     def stats
-      response = decode_request(:once_cache_stats_json, {})
+      response = decode_request(:once_cache_stats_json, @selection)
       CacheStats.new(
         blob_count: response.fetch("blob_count"),
         blob_bytes: response.fetch("blob_bytes"),
@@ -78,6 +108,10 @@ module Once
 
     private
 
+    def selection(request)
+      @selection.merge(request)
+    end
+
     def decode_request(function, request)
       decode_response(Native.public_send(function, JSON.generate(request)))
     end
@@ -129,6 +163,49 @@ module Once
     end
   end
 
+  class ActionKey
+    def initialize(namespace)
+      raise ArgumentError, "namespace must be a String" unless namespace.is_a?(String)
+
+      @namespace = namespace
+      @inputs = []
+    end
+
+    def add_bytes(label, bytes)
+      validate_label(label)
+      @inputs << { kind: "bytes", label: label, bytes: bytes.to_s.b.bytes }
+      self
+    end
+
+    def add_digest(label, digest)
+      validate_label(label)
+      @inputs << { kind: "digest", label: label, digest: digest }
+      self
+    end
+
+    def digest
+      pointer = Native.once_action_key_json(
+        JSON.generate(namespace: @namespace, inputs: @inputs),
+      )
+      raise Error, "native Once function returned null" if pointer.null?
+
+      response = JSON.parse(pointer.read_string)
+      return response.fetch("value") if response.fetch("status") == "ok"
+
+      raise Error, response.fetch("message")
+    rescue JSON::ParserError, KeyError => e
+      raise Error, e.message
+    ensure
+      Native.once_string_free(pointer) if pointer && !pointer.null?
+    end
+
+    private
+
+    def validate_label(label)
+      raise ArgumentError, "input label must be a String" unless label.is_a?(String)
+    end
+  end
+
   def self.digest(bytes)
     Cache.new.digest(bytes)
   end

data/lib/once/native.rb

@@ -60,8 +60,11 @@ module Once
     attach_function :once_version, [], :pointer
     attach_function :once_string_free, [:pointer], :void
     attach_function :once_digest_bytes, %i[pointer size_t], :pointer
+    attach_function :once_action_key_json, [:string], :pointer
     attach_function :once_cache_put_blob_json, [:string], :pointer
+    attach_function :once_cache_put_file_json, [:string], :pointer
     attach_function :once_cache_get_blob_json, [:string], :pointer
+    attach_function :once_cache_get_blob_to_file_json, [:string], :pointer
     attach_function :once_cache_has_blob_json, [:string], :pointer
     attach_function :once_cache_put_action_result_json, [:string], :pointer
     attach_function :once_cache_get_action_result_json, [:string], :pointer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildonce
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Tuist GmbH
@@ -57,5 +57,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Ruby SDK for Once
+summary: Ruby software development kit for Once
 test_files: []