wash 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564995e2e64780be1da143efd49c1814123eae654acd381e245b6e59738104d4
-  data.tar.gz: 870a5691d24dfcf51dadd3b5b67e2fa963c58a45c8e362bd3a9d01ba57358467
+  metadata.gz: 29c5e73c61e19273eeeb661fe0632dd71d98c6b5155b3928a71165b4dbcb255d
+  data.tar.gz: 96435335cf622b25ef9fd412ba4a66db4f4ad2d20c12eea766ffad0afdab1d9b
 SHA512:
-  metadata.gz: 02245abc3f32840842da57d9238768a477b981af2ba1a485a9ca23d6baa1b5d22de1d856bb9b3d5daeba79e2ff6aad979f9d9242c05781858c84e8894d1691c5
-  data.tar.gz: 4dd768b920b3121d5652770111448bf1bf701366aa6745a3b9bcc42ea2248099107be84f2c4b0007840edaccc0049809dc5db12dea8e40a025fe2e13d7ef260d
+  metadata.gz: 69b74fb0465cd0b9706e597e4226eaf5304aa1888b824e516d8606dc62a998f807b72ae3445068d28afb801fc1252af63ee5876978f23d00ea3ababba7320c65
+  data.tar.gz: 1fc0e79f46a566a26ead6b30d82c84d62918b37abe7efd2fb45eb02abe0160df014281b2c2f174932c4b98fcfc9c8102f037d38c2930ce0c25e2b3bbc1b736cb

data/lib/wash.rb

@@ -92,7 +92,7 @@ module Wash
 
   def self.next_arg(argv)
     if argv.size < 1
-      raise "Invalid plugin-script invocation. See https://puppetlabs.github.io/wash/docs/external_plugins/ for details on what this should look like"
+      raise "Invalid plugin-script invocation. See https://puppetlabs.github.io/wash/docs/external-plugins for details on what this should look like"
     end
     return argv[0], argv[1..-1]
   end

data/lib/wash/entry.rb

@@ -12,12 +12,12 @@ module Wash
       #
       # @example
       #   class Foo
-      #     # Instances of Foo will be able to set the @mtime and @meta fields
-      #     attributes :mtime, :meta
+      #     # Instances of Foo will be able to set the @mtime and @size fields
+      #     attributes :mtime, :size
       #
-      #     def initialize(mtime, meta)
+      #     def initialize(mtime, size)
       #       @mtime = mtime
-      #       @meta = meta
+      #       @size = size
       #     end
       #   end
       #
@@ -120,12 +120,12 @@ module Wash
         add_signal_schema(name, regex, description)
       end
 
-      # meta_attribute_schema sets the meta attribute's schema to schema. It is a helper
+      # partial_metadata_schema sets the partial metadata's schema to schema. It is a helper
       # for Entry schemas.
       #
-      # @param schema A hash containing the meta attribute's JSON schema
-      def meta_attribute_schema(schema)
-        @meta_attribute_schema = schema
+      # @param schema A hash containing the partial metadata's JSON schema
+      def partial_metadata_schema(schema)
+        @partial_metadata_schema = schema
       end
 
       # metadata_schema sets the metadata schema to schema. It is a helper for Entry schemas.
@@ -179,7 +179,7 @@ module Wash
           singleton: @singleton,
           description: @description,
           signals: @signals,
-          meta_attribute_schema: @meta_attribute_schema,
+          partial_metadata_schema: @partial_metadata_schema,
           metadata_schema: @metadata_schema,
         }
         unless @child_klasses
@@ -241,6 +241,9 @@ module Wash
     # included in the entry's state hash.
     attr_accessor :name
 
+    # Contains the entry's partial metadata.
+    attr_accessor :partial_metadata
+
     def to_json(*)
       unless @name && @name.size > 0
         unless singleton
@@ -258,6 +261,13 @@ module Wash
       hash[:methods] = self.class.send(:methods).map do |method|
         if prefetched_methods.include?(method)
           [method, self.send(method)]
+        elsif method == :read
+          # Check if this entry is block-readable
+          #
+          # TODO: Generalize this to lib/wash/method.rb if Wash starts
+          # supporting more overloaded methods
+          block_readable = self.method(:read).arity > 0
+          [:read, block_readable]
         else
           method
         end
@@ -269,6 +279,9 @@ module Wash
       if attributes.size > 0 && (attributes_hash = to_hash(attributes))
         hash[:attributes] = attributes_hash
       end
+      if @partial_metadata
+        hash[:partial_metadata] = @partial_metadata
+      end
       if cache_ttls.size > 0
         hash[:cache_ttls] = cache_ttls
       end

data/lib/wash/method.rb

@@ -36,8 +36,17 @@ module Wash
     method(:delete)
     method(:signal)
 
-    method(:read) do |entry, _|
-      STDOUT.print(entry.read)
+    method(:read) do |entry, *args|
+      if args.length > 0
+        # We're invoking read on a block-readable entry so munge
+        # the size and offset
+        args = args.map(&:to_i)
+      end
+      STDOUT.print(entry.read(*args))
+    end
+
+    method(:write) do |entry, _|
+      entry.write(STDIN)
     end
 
     method(:exec) do |entry, *args|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2020-01-14 00:00:00.000000000 Z
 dependencies: []
 description: A library for building Wash external plugins
 email:
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.10
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A library for building Wash external plugins