trick_bag 0.68.0 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59ec06de448c4ccb3f3cd3966fcdc855cb602ac5
-  data.tar.gz: 67da903f678ed62aae6d7e0ba4d84441fe6a837a
+SHA256:
+  metadata.gz: 8c964fe06a56296126af07267b11108fcb6e8722b73a7faece5a1e9dee83081e
+  data.tar.gz: abac32f4c508b3d8c1eb05ef53561f2d6e173d680310fc4adfbe5f6cf5a303dd
 SHA512:
-  metadata.gz: b8919fe6998b064c515dd6440474327691558c72c0755e93337d1e6c066fce99a6436610fe15651a71e6964ceb94b1daf785f225eaf3c2f38cb7dcb45f4c6906
-  data.tar.gz: a488a53c4369a98e6adf563e07b8f60d758726f7299aed2e6da47b6366caed364e4fbc57d7c059d9db499a09c36b4338aa71e8247852ac04fcc742116e364dcb
+  metadata.gz: 40d8c1188804504e01e339f13287b0803461ee425fce82e55221c74576e1ef4eadf08a5c0049f5924ea820ca11a1039c2adf98d3eed14968dbceb33904026683
+  data.tar.gz: d675e3eb74bb6f28e8ea329a47992c2803ff526ad54eab9ffbd0344d7b12c0b5d6d7ac88c1d1ec603f4c844db9cc984a8ff376e217b5581627a2798e3e750e8f

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v0.69.0
+
+In BufferedEnumerable, rename create_with_lambdas to create_with_callables. Create alias so old name still works.
+
+
 ## v0.68.0
 
 * Add Filesystem.running_as_script?

data/lib/trick_bag/enumerables/buffered_enumerable.rb

@@ -8,10 +8,10 @@ module Enumerables
 # fetches them in chunks.
 #
 # This class knows nothing about how to fetch anything; that behavior is provided
-# by either subclassing this class, or calling .create_with_lambdas and passing
-# a lambda that knows how to do that.
+# by either subclassing this class, or calling .create_with_callables and passing
+# a callable that knows how to do that.
 #
-# Also supported is an optional fetch notification, a method or lambda that will
+# Also supported is an optional fetch notification, a method or callable that will
 # be called whenever a fetch is done.  This can be useful to update counters,
 # provide user feedback (e.g. a progress bar), etc.
 #
@@ -19,8 +19,8 @@ module Enumerables
 # one immediately after another, and the responses can be collected as a group,
 # for improved performance.
 #
-# The fetch method and fetcher lambda modify the instance's data array directly,
-# to avoid the need to allow the lambda to modify the data array reference,
+# The fetch method and fetcher callable modify the instance's data array directly,
+# to avoid the need to allow the callable to modify the data array reference,
 # needlessly copying arrays,
 # and to eliminate the need for garbage collecting many array objects
 # (though the latter is rarely important).
@@ -37,20 +37,25 @@ class BufferedEnumerable
   attr_access :public,    :private,   :chunk_count, :fetch_count, :yield_count
 
 
-  # Creates an instance with lambdas for fetch and fetch notify behaviors.
+  # Creates an instance with callables for fetch and fetch notify behaviors.
+  # Callables are usually lambdas but can be any object responding to the method name `call`.
   # @param chunk_size the maximum number of objects to be buffered
-  # @param fetcher lambda to be called to fetch to fill the buffer
-  # @param fetch_notifier lambda to be called to when a fetch is done
-  def self.create_with_lambdas(chunk_size, fetcher, fetch_notifier = nil)
+  # @param fetcher callable to be called to fetch to fill the buffer
+  # @param fetch_notifier callable to be called to when a fetch is done
+  def self.create_with_callables(chunk_size, fetcher, fetch_notifier = nil)
     instance = self.new(chunk_size)
     instance.fetcher = fetcher
     instance.fetch_notifier = fetch_notifier
     instance
   end
+  class << self
+    alias_method :create_with_lambdas, :create_with_callables
+  end
+
 
-  # @param fetcher lambda to be called to fetch to fill the buffer
+  # @param fetcher callable to be called to fetch to fill the buffer
   # @param chunk_size the maximum number of objects to be buffered
-  # @param fetch_notifier lambda to be called to when a fetch is done
+  # @param fetch_notifier callable to be called to when a fetch is done
   #        in case the caller wants to receive notification, update counters, etc.
   #        It's passed the array of objects just fetched, whose size may be
   #        less than chunk size.
@@ -63,14 +68,14 @@ class BufferedEnumerable
   end
 
 
-  # Unless you use self.create_with_lambdas to create your instance,
+  # Unless you use self.create_with_callables to create your instance,
   # you'll need to override this method in your subclass.
   def fetch
     fetcher.(data, chunk_size) if fetcher
   end
 
 
-  # Unless you use self.create_with_lambdas to create your instance,
+  # Unless you use self.create_with_callables to create your instance,
   # you'll need to override this method in your subclass.
   def fetch_notify
     fetch_notifier.(data) if fetch_notifier

data/lib/trick_bag/filesystem/filesystem.rb

@@ -6,16 +6,14 @@ module Filesystem
   # @return true if the passed file is being run as a script, else false
   # @param __file__ - !!! __FILE__ must be passed as the __file__ argument for this to work correctly !!!
   #
+  # When the file's behavior needs to differ when running as a script and _not_ running as a script,
+  # this method can be called to report which of the two states it is.
+  #
   # Sometimes we want to see if a given file is being run as a script, as opposed to loaded
   # by other Ruby code. For example, the script at https://github.com/keithrbennett/macwifi/blob/master/bin/mac-wifi
   # is normally run as a script (either by running the file directly, or by running the executable's
   # binstub installed by the gem), but it can also be loaded so that the model can be used by custom code.
-  #
-  # When the file's behavior needs to differ when running as a script and _not_ running as a script,
-  # this method can be called to report which of the two states it is.
-  #
-  # An example of differing behavior is also in the case of `mac-wifi`. When run as a script,
-  # it parses the command line and executes a task, sending text to stdout.
+  # When run as a script, it parses the command line and executes a task, sending text to stdout.
   def running_as_script?(__file__)
 
     # Here is some sample state, when running a file as a gem executable:
@@ -36,7 +34,8 @@ module Filesystem
     basename = File.basename($0)
     gem_paths.any? do |path|
       ($0 == File.join(path, 'bin', basename)) \
-        && (path == File.expand_path(File.join(__file__, '..', '..', '..', '..')))
+          && \
+          (path == File.expand_path(File.join(__file__, '..', '..', '..', '..')))
     end
   end
 end

data/lib/trick_bag/io/temp_files.rb

@@ -4,28 +4,28 @@ module TrickBag
 module Io
 module TempFiles
 
-    module_function
+  module_function
 
-    # For the easy creation and deletion of a temp file populated with text,
-    # wrapped around the code block you provide.
-    #
-    # @param text the text to write to the temporary file
-    # @param file_prefix optional prefix for the temporary file's name
-    # @yield filespec of the temporary file
-    def file_containing(text, file_prefix = '')
-      raise "This method must be called with a code block." unless block_given?
+  # For the easy creation and deletion of a temp file populated with text,
+  # wrapped around the code block you provide.
+  #
+  # @param text the text to write to the temporary file
+  # @param file_prefix optional prefix for the temporary file's name
+  # @yield filespec of the temporary file
+  def file_containing(text, file_prefix = '')
+    raise "This method must be called with a code block." unless block_given?
 
-      filespec = nil
-      begin
-        Tempfile.open(file_prefix) do |file|
-          file << text
-          filespec = file.path
-        end
-        yield(filespec)
-      ensure
-        File.delete filespec if filespec && File.exist?(filespec)
+    filespec = nil
+    begin
+      Tempfile.open(file_prefix) do |file|
+        file << text
+        filespec = file.path
       end
+      yield(filespec)
+    ensure
+      File.delete(filespec) if filespec && File.exist?(filespec)
     end
   end
 end
 end
+end

data/lib/trick_bag/io/text_mode_status_updater.rb

@@ -1,8 +1,6 @@
 module TrickBag
 module Io
 
-# Provides an updatable and customizable status/information line in a terminal,
-# typically used to display progress.
 # Updates the terminal line with text, erasing the original content and displaying at the same place.
 # Uses ANSI escape sequences for cursor positioning and clearing
 # (see http://www.oldlinux.org/Linux.old/Ref-docs/ASCII/ANSI%20Escape%20Sequences.htm).

data/lib/trick_bag/networking/ssh_output_reader.rb

@@ -116,7 +116,9 @@ class SshOutputReader
 end
 
 
-
+# This is an eample of use of the class that will be run if the file is run explicitly
+# i.e.: ruby ssh_output_reader.rb
+# This should be moved somewhere else.
 if $0 == __FILE__
 
   Thread.abort_on_exception = true
@@ -147,6 +149,8 @@ echo 3
 sleep 1
 echo 4'
 
+  # TODO: Clean this up!
+
   # reader = SshOutputReader.new('localhost', command)
   # reader.run
   # puts "All reader stdout:\n" + reader.all_stdout

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = '0.68.0'
+  VERSION = '0.69.0'
 end

data/spec/trick_bag/enumerables/buffered_enumerable_spec.rb

@@ -6,7 +6,7 @@ module Enumerables
 
   describe BufferedEnumerable do
 
-    context 'when created with lambdas' do
+    context 'when created with callables' do
       # Returns an object that returns chunks of incrementing integers.
       let(:fetcher) do
         object = 0
@@ -27,15 +27,15 @@ module Enumerables
           object_count += fetched_objects.size
         end
 
-        e = BufferedEnumerable.create_with_lambdas(4, fetcher, fetch_notifier).to_enum
+        e = BufferedEnumerable.create_with_callables(4, fetcher, fetch_notifier).to_enum
         (1..10).each { |n| expect(e.next).to eq(n) }
         expect(chunk_fetch_calls).to eq(3)
         expect(object_count).to eq(12)
       end
 
-      specify 'create_with_lambdas can be called without specifying a fetch_notifier' do
+      specify 'create_with_callables can be called without specifying a fetch_notifier' do
         be = nil
-        f1 = -> { be = BufferedEnumerable.create_with_lambdas(4, fetcher).to_enum }
+        f1 = -> { be = BufferedEnumerable.create_with_callables(4, fetcher).to_enum }
         expect(f1).not_to raise_error
         f2 = -> { (1..10).each { be.next } }
         expect(f2).not_to raise_error
@@ -43,6 +43,12 @@ module Enumerables
     end
 
 
+    specify 'create with old method name create_with_lambdas still works' do
+      buffered_enumerable = BufferedEnumerable.create_with_lambdas(4, ->() {}, ->() {})
+      expect(buffered_enumerable.class).to eq(BufferedEnumerable)
+    end
+
+
     context "when instantiating a subclass" do
       specify 'the values and number of fetches are correct' do
         create_test_class = ->() do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.68.0
+  version: 0.69.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -224,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Miscellaneous general useful tools.