tins 1.32.1 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ddaf2f0c1167a939e82f81678dcad1415c446295b71be5b9f103ed7d3119c9
-  data.tar.gz: 6e0609afd1eaee465c64a5ea65911f7f09b15b166cb5bfa8e85cf1a7f71446b9
+  metadata.gz: '049e3bf81de447eec53664f5555656602906bbd44a5f98b2e0e953318aadff77'
+  data.tar.gz: 14debef966e248366ec1ef72b39b8ccc094a91049ed6cd44e9ee2550c607ae02
 SHA512:
-  metadata.gz: 3edf583d1f22b556058cad481d9bb78710394b3869fbb118321a31213124534449d1ea507f8a00d264ea7e029226673e062bc07544d445ccd044bb8643cbdbf3
-  data.tar.gz: bd04720c57cbec746b212354767d166ae38eb22824635be747a9a0708af71b82078a1b832552c0f7425827234c49178357e914ac36365a8f6ece1cd91ab88700
+  metadata.gz: c93d9b5b23c3305f422f0efd81e0828591682331532b51f4de1a84e305f77bb3f9374abcf8b725cd665a74ef352cabb525f49b4dfa68fc78f5568e87a5e78012
+  data.tar.gz: 4b8d5d1da5bffb1b26449f96aa0f292a28582e5409d734ba5cdc18c428a2e6b57f577662773b776abcbb5464d505ae6726b60bba54f2142ddf5a32faae5fd9e9

data/CHANGES.md

@@ -0,0 +1,105 @@
+# Changes
+
+## 2024-10-19 v1.37.0
+
+* Add support for module prepended blocks in **Tins::Concern**:
+  * Added `prepend_features` method to Tins concern
+  * Updated ConcernTest to test prepend feature
+  * Raise StandardError for duplicate block definitions for included and 
+    prepended blocks
+* Added `class_methods` method to Tins concern:
+  * Added `class_methods` method to lib/tins/concern.rb
+    - Creates or retrieves ClassMethods module for defining class-level methods
+  * Updated tests in `tests/concern_test.rb`
+    - Added test for new `baz1` and `baz2` methods
+      + Tested availability of `bar`, `baz1`, and `baz2` methods on A
+
+## 2024-10-11 v1.36.1
+
+* Fixed a typo in the code
+
+## 2024-10-11 v1.36.0
+
+### Significant Changes
+
+* Refactor bfs method in `hash_bfs.rb`:
+  + Rename `include_nodes` variable to `visit_internal`
+  + Update test cases in `hash_bfs_test.rb` to use new method signature
+  + Update method signature and docstring to reflect new behavior
+* Update hash conversion logic:
+  + Rename method parameter from `v` to `object`
+  + Use `object` instead of `v` consistently throughout the method
+  + Add documentation for new method name and behavior
+
+## 2024-10-10 v1.35.0
+
+### New Features
+* Implemented breadth-first search in hashes using the `Tins::HashBFS` module.
+  + Added tests for the `Tins::HashBFS` module.
+
+### Refactoring and Cleanup
+* Reformatted code.
+* Removed TODO note from the `TODO` file.
+* Cleaned up test requirements:
+  - Added `require 'tins'` to `tests/test_helper.rb`.
+  - Removed unnecessary `require 'tins'` lines from test files.
+* Refactored BASE16 constants and alphabet:
+  + Added `BASE16_LOWERCASE_ALPHABET` constant.
+  + Added `BASE16_UPPERCASE_ALPHABET` constant.
+
+### Tool Updates
+* Updated bundler command to use full index:
+  - Added `--full-index` flag to `bundle install`.
+  - Replaced `bundle update` with `bundle install --full-index`.
+
+## 2024-09-30 v1.34.0
+
+* **Secure write functionality updated**
+  + Added support for `Pathname` objects in `secure_write`
+  + Updated `File.new` call to use `to_s` method on filename
+  + New test case added for `secure_write` with `Pathname` object
+* **Refactor version comparisons in various modules**
+  + Added `Tins::StringVersion.compare` method to compare Ruby versions with operators.
+  + Replaced direct version comparisons with `compare` method in multiple modules.
+* **Deprecate deep_const_get and const_defined_in? methods**
+  + Add deprecation notice for `const_defined_in?` for ruby >= 1.8
+  + Add deprecation notice for `deep_const_get` method with a new method name `const_get` for ruby >= 2.0
+* **Refactor deprecation logic and tests**
+  + Update `Tins::Deprecate#deprecate` method to allow for optional `new_method` parameter.
+  + Modify `tests/deprecate_test.rb` to test deprecated methods with and without messages.
+* **Prepare count_by method for deprecation**
+  + Suggest using `count` with block instead in newer Rubies
+* **Prepare uniq_by / uniq_by! method for deprecation**
+  + Suggest using `uniq` / `uniq!` with block instead in newer Rubies
+
+## 2024-04-17 v1.33.0
+
+* **Changes for Ruby 3.3 and 3.4**
+  + Added support for Ruby **3.3**
+  + Added dependency on `bigdecimal` for upcoming Ruby **3.4**
+* **Other Changes**
+  + Halting once is enough
+  + Added ruby **3.2**, removed some older ones
+  + Added test process convenience method
+
+## 2022-11-21 v1.32.1
+
+* Removed mutex for finalizer, allowing Ruby to handle cleanup instead.
+* Significant changes:
+  + Removed `mutex` variable
+  + Updated code to rely on Ruby's built-in finalization mechanism
+
+## 2022-11-17 v1.32.0
+
+* **attempt** method now supports passing of previously caught exception into
+  the called block to let the handling behaviour depend on it.
+* Some smaller changes to make debugging on multiple Ruby releases, easier via
+  all_images.
+* Enable fast failing mode
+* Add convenience method to create `Tins::StringVersion` objects.
+* Pass previous exception to attempt block ...
+  ... to allow reacting to it, logging it etc.
+* Remove additional groups
+* Use debug instead of byebug for development
+* Ignore more hidden files in the package
+* Update Ruby version to **3.1**

data/Rakefile

@@ -14,18 +14,17 @@ GemHadar do
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.rvmrc', 'coverage', '.rbx',
     '.AppleDouble', '.DS_Store', 'tags', '.bundle', '.byebug_history'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
-     '.utilsrc', '.rspec', 'TODO',
-     *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
+    '.utilsrc', 'TODO', *Dir.glob('.github/**/*', File::FNM_DOTMATCH)
 
   readme      'README.md'
   licenses << 'MIT'
 
   required_ruby_version  '>= 2.0'
-  development_dependency 'utils'
   development_dependency 'all_images'
   development_dependency 'debug'
   development_dependency 'term-ansicolor'
   development_dependency 'test-unit', '~>3.1'
   development_dependency 'simplecov'
   dependency 'sync'
+  dependency 'bigdecimal'
 end

data/examples/ones_difference.stm

@@ -22,4 +22,3 @@
 18. right goto: 19
 19. cond  if: '1', then: 18, else: 21
 20. halt
-21. halt

data/lib/tins/concern.rb

@@ -19,12 +19,48 @@ module Tins
       end
     end
 
+    def prepend_features(base)
+      if base.instance_variable_defined?("@_dependencies")
+        base.instance_variable_get("@_dependencies") << self
+        false
+      else
+        return false if base < self
+        @_dependencies.each { |dep| base.send(:include, dep) }
+        super
+        base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
+        base.class_eval(&@_prepended_block) if instance_variable_defined?("@_prepended_block")
+        Thread.current[:tin_concern_args] = nil
+        true
+      end
+    end
+
     def included(base = nil, &block)
       if base.nil?
+        instance_variable_defined?(:@_included_block) and
+          raise StandardError, "included block already defined"
         @_included_block = block
       else
         super
       end
     end
+
+    def prepended(base = nil, &block)
+      if base.nil?
+        instance_variable_defined?(:@_prepended_block) and
+          raise StandardError, "prepended block already defined"
+        @_prepended_block = block
+      else
+        super
+      end
+    end
+
+    def class_methods(&block)
+      modul = const_get(:ClassMethods) if const_defined?(:ClassMethods, false)
+      unless modul
+        modul = Module.new
+        const_set(:ClassMethods, modul)
+      end
+      modul.module_eval(&block)
+    end
   end
 end

data/lib/tins/count_by.rb

@@ -1,8 +1,21 @@
+require 'tins/string_version'
+
 module Tins
   module CountBy
-    def count_by(&b)
-      b ||= lambda { |x| true }
-      inject(0) { |s, e| s += 1 if b[e]; s }
+    if Tins::StringVersion.compare(RUBY_VERSION, :<=, "1.8")
+      def count_by(&block)
+        block ||= lambda { |x| true }
+        inject(0) { |s, e| s += 1 if block.call(e); s }
+      end
+    else
+      require 'tins/deprecate'
+      extend Tins::Deprecate
+
+      deprecate method:
+        def count_by(&block)
+          count(&block)
+        end,
+        new_method: :count
     end
   end
 end

data/lib/tins/deep_const_get.rb

@@ -1,45 +1,59 @@
+require 'tins/string_version'
+
 module Tins
   module DeepConstGet
-    if ::Object.method(:const_defined?).arity == 1
-      # :nocov:
-      # We do not create coverage on 1.8
-      def self.const_defined_in?(modul, constant)
-        modul.const_defined?(constant)
-      end
-      # :nocov:
-    else
-      def self.const_defined_in?(modul, constant)
-        modul.const_defined?(constant, false)
+    class << self
+      if ::Object.method(:const_defined?).arity == 1
+        # :nocov:
+        # We do not create coverage on 1.8
+        def const_defined_in?(modul, constant)
+          modul.const_defined?(constant)
+        end
+        # :nocov:
+      else
+        require 'tins/deprecate'
+        extend Tins::Deprecate
+
+        deprecate method:
+          def const_defined_in?(modul, constant)
+            modul.const_defined?(constant, false)
+          end,
+          new_method: :const_defined?
       end
-    end
 
-    if Tins::StringVersion(RUBY_VERSION) < Tins::StringVersion('2.0')
-      def self.deep_const_get(path, start_module = Object)
-        path.to_s.split('::').inject(start_module) do |p, c|
-          case
-          when c.empty?
-            if start_module == Object
-              Object
+      if Tins::StringVersion.compare(RUBY_VERSION, :<, '2.0')
+        def deep_const_get(path, start_module = Object)
+          path.to_s.split('::').inject(start_module) do |p, c|
+            case
+            when c.empty?
+              if start_module == Object
+                Object
+              else
+                raise ArgumentError, "top level constants cannot be reached from"\
+                  " start module #{start_module.inspect}"
+              end
+            when const_defined_in?(p, c)
+              p.const_get(c)
             else
-              raise ArgumentError, "top level constants cannot be reached from"\
-                " start module #{start_module.inspect}"
-            end
-          when const_defined_in?(p, c)
-            p.const_get(c)
-          else
-            begin
-              p.const_missing(c)
-            rescue NameError => e
-              raise ArgumentError, "can't get const #{path}: #{e}"
+              begin
+                p.const_missing(c)
+              rescue NameError => e
+                raise ArgumentError, "can't get const #{path}: #{e}"
+              end
             end
           end
         end
-      end
-    else
-      def self.deep_const_get(path, start_module = Object)
-        start_module.const_get(path)
-      rescue NameError => e
-        raise ArgumentError, "can't get const #{path}: #{e}"
+      else
+        require 'tins/deprecate'
+        extend Tins::Deprecate
+
+        deprecate method:
+          def deep_const_get(path, start_module = Object)
+            start_module.const_get(path)
+          rescue NameError => e
+            raise ArgumentError, "can't get const #{path}: #{e}"
+          end,
+          new_method: :const_get
       end
     end
 

data/lib/tins/deprecate.rb

@@ -0,0 +1,15 @@
+module Tins
+  module Deprecate
+    def deprecate(method:, new_method: nil, message: nil)
+      message ||= '[DEPRECATION] `%{method}` is deprecated. Please use `%{new_method}` instead.'
+      message = message % { method: method, new_method: new_method }
+      m = Module.new do
+        define_method(method) do |*a, **kw, &b|
+          warn message
+          super(*a, **kw, &b)
+        end
+      end
+      prepend m
+    end
+  end
+end

data/lib/tins/duration.rb

@@ -2,6 +2,48 @@ module Tins
   class Duration
     include Comparable
 
+    # Returns the number of seconds represented by the given duration string
+    # according to the provided template format.
+    #
+    # @param [String] string The duration string to parse.
+    # @param [String] template for the duration format, see {#format}.
+    #
+    # @return [Integer, Float] The number of (fractional) seconds of the duration.
+    #
+    # @example
+    #   Tins::Duration.parse('6+05:04:03', template: '%S%d+%h:%m:%s') # => 536643
+    #   Tins::Duration.parse('6+05:04:03.21', template: '%S%d+%h:%m:%s.%f') # => 536643.21
+    def self.parse(string, template: '%S%d+%h:%m:%s.%f')
+      s, t = string.to_s.dup, template.dup
+      d, sd = 0, 1
+      loop do
+        t.sub!(/\A(%[Sdhmsf%]|.)/) { |directive|
+          case directive
+          when '%S' then s.sub!(/\A-?/)   { sd *= -1 if _1 == ?-; '' }
+          when '%d' then s.sub!(/\A\d+/)  { d += 86_400 * _1.to_i; '' }
+          when '%h' then s.sub!(/\A\d+/)  { d += 3_600 * _1.to_i; '' }
+          when '%m' then s.sub!(/\A\d+/)  { d += 60 * _1.to_i; '' }
+          when '%s' then s.sub!(/\A\d+/)  { d += _1.to_i; '' }
+          when '%f' then s.sub!(/\A\d+/)  { d += Float(?. + _1); '' }
+          when '%%' then
+            if s[0] == ?%
+              s[0] = ''
+            else
+              raise "expected %s, got #{s.inspect}"
+            end
+          else
+            if directive == s[0]
+              s[0] = ''
+            else
+              raise ArgumentError, "expected #{t.inspect}, got #{s.inspect}"
+            end
+          end
+          ''
+        } or break
+      end
+      sd * d
+    end
+
     def initialize(seconds)
       @negative = seconds < 0
       seconds = seconds.abs

data/lib/tins/hash_bfs.rb

@@ -0,0 +1,67 @@
+require 'tins/thread_local'
+
+module Tins
+  module HashBFS
+    extend Tins::ThreadLocal
+
+    thread_local :seen
+
+    # The bfs method performs a breadth-first search on the object's structure,
+    # visiting all elements and yielding their indices and values to the block.
+    #
+    # @param visit_internal [ true, false ] whether to visit internal hashes or arrays
+    # @yield [ index, value ] yields each element's index and value to the block
+    #
+    # @raise [ ArgumentError ] if no &block argument was provided
+    #
+    # @example bfs { |index, value| … } # performs a breadth-first search on the object's structure
+    #
+    # @return [ self ] returns the receiver
+    def bfs(visit_internal: false, &block)
+      block or raise ArgumentError, 'require &block argument'
+      self.seen = {}
+      queue     = []
+      queue.push([ nil, self ])
+      while (index, object = queue.shift)
+        case
+        when seen[object.__id__]
+          next
+        when Hash === object
+          seen[object.__id__] = true
+          object.each do |k, v|
+            queue.push([ k, convert_to_hash_or_ary(v) ])
+          end
+          visit_internal or next
+        when Array === object
+          seen[object.__id__] = true
+          object.each_with_index do |v, i|
+            queue.push([ i, convert_to_hash_or_ary(v) ])
+          end
+          visit_internal or next
+        end
+        block.(index, object)
+      end
+      self
+    ensure
+      self.seen = nil
+    end
+
+    # Converts the given object into a hash or array if possible
+    #
+    # @param object [Object] The object to convert
+    #
+    # @return [Hash, Array, Object] The converted object or itself if not convertible
+    def convert_to_hash_or_ary(object)
+      case
+      when object.respond_to?(:to_hash)
+        object.to_hash
+      when object.respond_to?(:to_ary)
+        object.to_ary
+      else
+        object
+      end
+    end
+  end
+end
+
+require 'tins/alias'

data/lib/tins/secure_write.rb

@@ -2,7 +2,7 @@ module Tins
   module SecureWrite
     # Write to a file atomically
     def secure_write(filename, content = nil, mode = 'w')
-      temp = File.new(filename + ".tmp.#$$.#{Time.now.to_f}", mode)
+      temp = File.new(filename.to_s + ".tmp.#$$.#{Time.now.to_f}", mode)
       if content.nil? and block_given?
         yield temp
       elsif !content.nil?

data/lib/tins/sexy_singleton.rb

@@ -1,3 +1,4 @@
+require 'tins/string_version'
 require 'singleton'
 
 module Tins
@@ -12,7 +13,7 @@ module Tins
   class << SexySingleton
     alias __old_singleton_included__ included
 
-    if RUBY_VERSION < "2.7"
+    if Tins::StringVersion.compare(RUBY_VERSION, :<, "2.7")
       def included(klass)
         __old_singleton_included__(klass)
         (class << klass; self; end).class_eval do

data/lib/tins/string_version.rb

@@ -98,6 +98,10 @@ module Tins
     def version
       Version.new(self)
     end
+
+    def self.compare(version1, operator, version2)
+      Version.new(version1).send(operator, Version.new(version2))
+    end
   end
 
   def self.StringVersion(string)

data/lib/tins/terminal.rb

@@ -10,9 +10,9 @@ module Tins
 
     def winsize
       if IO.respond_to?(:console)
-        console = IO.console
-        if console.respond_to?(:winsize)
-          console.winsize
+        c = IO.console
+        if c.respond_to?(:winsize)
+          c.winsize
         else
           []
         end

data/lib/tins/time_dummy.rb

@@ -1,3 +1,4 @@
+require 'tins/string_version'
 require 'time'
 
 module Tins
@@ -35,7 +36,7 @@ module Tins
           end
         end
 
-        if RUBY_VERSION >= "3.0"
+        if Tins::StringVersion.compare(RUBY_VERSION, :>=, "3.0")
           def new(*a, **kw)
             if dummy
               dummy.dup

data/lib/tins/timed_cache.rb

@@ -15,7 +15,7 @@ class TimedCache
     @jitter = jitter
     block or raise ArgumentError, 'block is required'
     @block = block
-    @redis = Redis.new # RedisPool::Pool.connection(:timed_cache, configuration: :redis)
+    @redis = Redis.new
   end
 
   def namespaced(key)

data/lib/tins/token.rb

@@ -15,7 +15,11 @@ module Tins
 
     BASE32_EXTENDED_HEX_ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUV".freeze
 
-    BASE16_ALPHABET = "0123456789ABCDEF".freeze
+    BASE16_UPPERCASE_ALPHABET = "0123456789ABCDEF".freeze
+
+    BASE16_LOWERCASE_ALPHABET = "0123456789abcdef".freeze
+
+    BASE16_ALPHABET = BASE16_UPPERCASE_ALPHABET
 
     def initialize(bits: 128, length: nil, alphabet: DEFAULT_ALPHABET, random: SecureRandom)
       alphabet.size > 1 or raise ArgumentError, 'need at least 2 symbols in alphabet'

data/lib/tins/uniq_by.rb

@@ -1,8 +1,21 @@
+require 'tins/string_version'
+
 module Tins
   module UniqBy
-    def uniq_by(&b)
-      b ||= lambda { |x| x }
-      inject({}) { |h, e| h[b[e]] ||= e; h }.values
+    if Tins::StringVersion.compare(RUBY_VERSION, :<=, "1.8")
+      def uniq_by(&block)
+        block ||= lambda { |x| x }
+        inject({}) { |h, e| h[ block.call(e) ] ||= e; h }.values
+      end
+    else
+      require 'tins/deprecate'
+      extend Tins::Deprecate
+
+      deprecate method:
+        def uniq_by(&block)
+          uniq(&block)
+        end,
+        new_method: :uniq
     end
   end
 end

data/lib/tins/version.rb

@@ -1,6 +1,6 @@
 module Tins
   # Tins version
-  VERSION         = '1.32.1'
+  VERSION         = '1.37.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/tins/xt/count_by.rb

@@ -4,8 +4,4 @@ module Tins
   module ::Enumerable
     include CountBy
   end
-
-  class ::Array
-    include CountBy
-  end
 end

data/lib/tins/xt/deprecate.rb

@@ -0,0 +1,5 @@
+require 'tins/deprecate'
+
+class Module
+  include Tins::Deprecate
+end

data/lib/tins/xt/hash_bfs.rb

@@ -0,0 +1,7 @@
+require 'tins/hash_bfs'
+
+module Tins
+  class ::Hash
+    include HashBFS
+  end
+end

data/lib/tins/xt/uniq_by.rb

@@ -1,3 +1,4 @@
+require 'tins/string_version'
 require 'tins/uniq_by'
 
 module Tins
@@ -6,10 +7,19 @@ module Tins
   end
 
   class ::Array
-    include UniqBy
+    if Tins::StringVersion.compare(RUBY_VERSION, :<=, "1.8")
+      include UniqBy
+
+      def uniq_by!(&b)
+        replace uniq_by(&b)
+      end
+    else
+      require 'tins/deprecate'
+      extend Tins::Deprecate
 
-    def uniq_by!(&b)
-      replace uniq_by(&b)
+      deprecate method:
+        alias_method(:uniq_by!, :uniq!),
+        new_method: :uniq!
     end
   end
 end

data/lib/tins/xt.rb

@@ -42,4 +42,6 @@ module Tins
   require 'tins/xt/complete'
   require 'tins/xt/expose'
   require 'tins/xt/temp_io'
+  require 'tins/xt/deprecate'
+  require 'tins/xt/hash_bfs'
 end

data/lib/tins.rb

@@ -58,5 +58,7 @@ module Tins
   require 'tins/temp_io'
   require 'tins/temp_io_enum'
   require 'tins/lru_cache'
+  require 'tins/deprecate'
+  require 'tins/hash_bfs'
 end
 require 'tins/alias'

data/tests/annotate_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'tins'
 
 module Tins
   class AnnotateTest < Test::Unit::TestCase

data/tests/bijection_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'tins'
 
 module Tins
   class BijectionTest < Test::Unit::TestCase