augmented 0.2.2 → 0.2.7

data/lib/augmented/objects.rb

@@ -1,4 +1,5 @@
 require 'augmented/objects/iffy'
+require 'augmented/objects/in'
 require 'augmented/objects/pickable'
 require 'augmented/objects/tackable'
 require 'augmented/objects/tappable'
@@ -7,6 +8,7 @@ require 'augmented/objects/thru'
 module Augmented
   module Objects
     include Iffy
+    include In
     include Pickable
     include Tackable
     include Tappable

data/lib/augmented/objects/in.rb

@@ -0,0 +1,13 @@
+module Augmented
+  module Objects
+    module In
+      refine Object do
+
+        def in? collection
+          collection.include?(self)
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/strings.rb

@@ -0,0 +1,11 @@
+require 'augmented/strings/blank'
+require 'augmented/strings/squish'
+require 'augmented/strings/truncatable'
+
+module Augmented
+  module Strings
+    include Blank
+    include Squish
+    include Truncatable
+  end
+end

data/lib/augmented/strings/blank.rb

@@ -0,0 +1,15 @@
+module Augmented
+  module Strings
+    module Blank
+      REGEXP = /\A[[:space:]]*\z/
+
+      refine String do
+
+        def blank?
+          empty? || !!REGEXP.match(self)
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/strings/squish.rb

@@ -0,0 +1,40 @@
+module Augmented
+  module Strings
+    module Squish
+      refine String do
+
+        def squish pattern = /\s+/, replacement = ' '
+          dup.squish!(pattern, replacement)
+        end
+
+        def squish! pattern = /\s+/, replacement = ' '
+          cursor = 0
+
+          while match = pattern.match(self, cursor)
+            slice_start  = match.begin(0)
+            slice_end    = match.end(0)
+            slice_length = slice_end - slice_start
+
+            slice!(slice_start, slice_length)
+
+            if slice_start == 0
+              # we're at the start of the string
+              # don't insert the replacement
+              # don't change the cursor
+            elsif slice_end >= self.size
+              # we're at the end of the string
+              # don't insert the replacement
+              break
+            else
+              insert(slice_start, replacement)
+              cursor = slice_start + replacement.size
+            end
+          end
+
+          self
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/strings/truncatable.rb

@@ -0,0 +1,20 @@
+module Augmented
+  module Strings
+    module Truncatable
+      refine String do
+
+        def truncate length
+          raise ArgumentError, 'length must be a non-negative integer' unless length && length.to_int >= 0
+
+          slice(0, length)
+        end
+
+        def truncate! length
+          replace(truncate(length))
+          self
+        end
+
+      end
+    end
+  end
+end

data/lib/augmented/version.rb

@@ -1,3 +1,3 @@
 module Augmented
-  VERSION = "0.2.2"
+  VERSION = "0.2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augmented
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.7
 platform: ruby
 authors:
-- bruno
+- brunze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,37 +16,37 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.3
 description: Adds a few useful extra methods to some of Ruby's core types, available
   as refinements.
-email:
-- bruno@brunze.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,6 +57,10 @@ files:
 - lib/augmented/arrays/tieable.rb
 - lib/augmented/enumerators.rb
 - lib/augmented/enumerators/indexing.rb
+- lib/augmented/exceptions.rb
+- lib/augmented/exceptions/chain.rb
+- lib/augmented/exceptions/detailed.rb
+- lib/augmented/exceptions/serializable.rb
 - lib/augmented/hashes.rb
 - lib/augmented/hashes/mappable.rb
 - lib/augmented/hashes/polymorphable.rb
@@ -65,6 +69,7 @@ files:
 - lib/augmented/modules/refined.rb
 - lib/augmented/objects.rb
 - lib/augmented/objects/iffy.rb
+- lib/augmented/objects/in.rb
 - lib/augmented/objects/pickable.rb
 - lib/augmented/objects/tackable.rb
 - lib/augmented/objects/tappable.rb
@@ -72,29 +77,21 @@ files:
 - lib/augmented/procs.rb
 - lib/augmented/procs/chainable.rb
 - lib/augmented/procs/rescuable.rb
+- lib/augmented/strings.rb
+- lib/augmented/strings/blank.rb
+- lib/augmented/strings/squish.rb
+- lib/augmented/strings/truncatable.rb
 - lib/augmented/symbols.rb
 - lib/augmented/symbols/arguable.rb
 - lib/augmented/symbols/comparing.rb
 - lib/augmented/version.rb
-- test/augmented/arrays/tieable_test.rb
-- test/augmented/enumerators/indexing_test.rb
-- test/augmented/hashes/mappable_test.rb
-- test/augmented/hashes/polymorphable_test.rb
-- test/augmented/hashes/transformable_test.rb
-- test/augmented/modules/refined_test.rb
-- test/augmented/objects/iffy_test.rb
-- test/augmented/objects/pickable_test.rb
-- test/augmented/objects/tackable_test.rb
-- test/augmented/objects/tappable_test.rb
-- test/augmented/objects/thru_test.rb
-- test/augmented/procs/chainable_test.rb
-- test/augmented/procs/rescuable_test.rb
-- test/augmented/symbols/arguable_test.rb
-- test/augmented/symbols/comparing_test.rb
 homepage: https://github.com/brunze/augmented
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/brunze/augmented
+  source_code_uri: https://github.com/brunze/augmented
+  changelog_uri: https://github.com/brunze/augmented/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -110,23 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.21
 signing_key: 
 specification_version: 4
 summary: Useful extra methods for some Ruby core types.
-test_files:
-- test/augmented/arrays/tieable_test.rb
-- test/augmented/enumerators/indexing_test.rb
-- test/augmented/hashes/mappable_test.rb
-- test/augmented/hashes/polymorphable_test.rb
-- test/augmented/hashes/transformable_test.rb
-- test/augmented/modules/refined_test.rb
-- test/augmented/objects/iffy_test.rb
-- test/augmented/objects/pickable_test.rb
-- test/augmented/objects/tackable_test.rb
-- test/augmented/objects/tappable_test.rb
-- test/augmented/objects/thru_test.rb
-- test/augmented/procs/chainable_test.rb
-- test/augmented/procs/rescuable_test.rb
-- test/augmented/symbols/arguable_test.rb
-- test/augmented/symbols/comparing_test.rb
+test_files: []

data/test/augmented/arrays/tieable_test.rb

@@ -1,66 +0,0 @@
-require 'minitest/autorun'
-require 'augmented/arrays/tieable'
-
-describe Augmented::Arrays::Tieable do
-  using Augmented::Arrays::Tieable
-
-  describe '#tie' do
-
-    describe 'when supplied with an object' do
-
-      it 'returns an array interweaved with the specified object' do
-        object = Object.new
-        weaved = %w(a b c).tie object
-
-        assert_equal weaved, ['a', object, 'b', object, 'c']
-      end
-
-      it 'returns an empty array if the original array is empty' do
-        assert_equal [].tie(1), []
-      end
-
-      it 'returns the original array if it has only one element' do
-        assert_equal [42].tie(1), [42]
-      end
-
-    end
-
-    describe 'when supplied with a block' do
-
-      it 'returns an array interweaved with the result of invoking the block' do
-        values = [10 ,20].each
-        weaved = %w(a b c).tie{ values.next }
-
-        assert_equal weaved, ['a', 10, 'b', 20, 'c']
-      end
-
-      it 'passes both neighbour values as arguments to the supplied block' do
-        weaved = [1, 5, 12].tie{ |a, b| a + b }
-
-        assert_equal weaved, [1, 6, 5, 17, 12]
-      end
-
-      it 'will weave nils if the block does not return anything else' do
-        weaved = [1, 2, 3].tie{}
-
-        assert_equal weaved, [1, nil, 2, nil, 3]
-      end
-
-      it 'returns an empty array if the original arrays is empty' do
-        assert_equal [].tie{ 1 }, []
-      end
-
-      it 'returns the original array if it has only one element' do
-        assert_equal [42].tie{ 1 }, [42]
-      end
-
-    end
-
-    it 'raises an ArgumentError if not passed a non-nil object or block' do
-      assert_raises(ArgumentError){ [].tie }
-      assert_raises(ArgumentError){ [].tie nil }
-    end
-
-  end
-
-end

data/test/augmented/enumerators/indexing_test.rb

@@ -1,15 +0,0 @@
-require 'minitest/autorun'
-require 'augmented/enumerators/indexing'
-
-describe Augmented::Enumerators::Indexing do
-  using Augmented::Enumerators::Indexing
-
-  describe '#index_by' do
-
-    it 'returns a hash keyed by the results of invoking the criterion on every collection element and the values are the last element matching the criterion' do
-      assert_equal ['a', 'bbb', 'c', 'dd'].to_enum.index_by(&:length), ({ 1 => 'c', 2 => 'dd', 3 => 'bbb' })
-    end
-
-  end
-
-end

data/test/augmented/hashes/mappable_test.rb

@@ -1,37 +0,0 @@
-require 'minitest/autorun'
-require 'augmented/hashes/mappable'
-
-describe Augmented::Hashes::Mappable do
-  using Augmented::Hashes::Mappable
-
-  describe '#map_values' do
-
-    it 'returns a new hash with the same keys but transformed values' do
-      assert_equal ({ aa: 11, bb: 22 }.map_values{ |i| i * 3 }), ({ aa: 33, bb: 66 })
-    end
-
-    it 'also provides the key and hash to the tranformer function as additional arguments' do
-      hash = { aa: 11, bb: 22 }
-      result = hash.map_values{ |i, key, h| [key, h.object_id] }
-
-      assert_equal result.values, [[:aa, hash.object_id], [:bb, hash.object_id]]
-    end
-
-  end
-
-  describe '#map_keys' do
-
-    it 'returns a new hash with the same values but transformed keys' do
-      assert_equal ({ aa: 11, bb: 22 }.map_keys{ |k| k.to_s[0] }), ({ 'a' => 11, 'b' => 22 })
-    end
-
-    it 'also provides the value and hash to the tranformer function as additional arguments' do
-      hash = { aa: 11, bb: 22 }
-      result = hash.map_keys{ |k, value, h| [value, h.object_id] }
-
-      assert_equal result.keys, [[11, hash.object_id], [22, hash.object_id]]
-    end
-
-  end
-
-end

data/test/augmented/hashes/polymorphable_test.rb

@@ -1,45 +0,0 @@
-require 'minitest/autorun'
-require 'augmented/hashes/polymorphable'
-require 'ostruct'
-
-describe Augmented::Hashes::Polymorphable do
-  using Augmented::Hashes::Polymorphable
-
-  describe '#polymorph' do
-
-    it 'returns an object of the class specified by the `:type` attribute, initialized with the hash itself' do
-      object = { type: 'OpenStruct', speak: 'meeehh' }.polymorph
-
-      assert_instance_of OpenStruct, object
-      assert_equal object.speak, 'meeehh'
-    end
-
-    describe 'type attribute' do
-
-      it 'can also be a string key in the hash' do
-        assert_instance_of OpenStruct, { 'type' => 'OpenStruct' }.polymorph
-      end
-
-      it 'can be an arbitrary attribute in the hash' do
-        assert_instance_of OpenStruct, { lorem_ipsum: 'OpenStruct' }.polymorph(:lorem_ipsum)
-        assert_instance_of OpenStruct, { 'lorem_ipsum' => 'OpenStruct' }.polymorph(:lorem_ipsum)
-      end
-
-      it 'can be a class' do
-        assert_instance_of OpenStruct, { type: OpenStruct }.polymorph()
-      end
-
-      it 'can be a class passed directly to the method, ignoring the type attribute in the hash' do
-        assert_instance_of OpenStruct, { type: 'TotallyIgnoredClass' }.polymorph(OpenStruct)
-      end
-
-    end
-
-    it 'raises an error if it cannot find a type class' do
-      assert_raises(ArgumentError){ {}.polymorph }
-      assert_raises(ArgumentError){ { type: nil }.polymorph }
-    end
-
-  end
-
-end

data/test/augmented/hashes/transformable_test.rb

@@ -1,87 +0,0 @@
-require 'minitest/autorun'
-require 'augmented/hashes/transformable'
-require 'ostruct'
-
-describe Augmented::Hashes::Transformable do
-  using Augmented::Hashes::Transformable
-
-  describe '#transform(!)' do
-
-    it 'mutates the values of the given keys by applying their respective procables' do
-      hash = { thing1: 100, thing2: OpenStruct.new(random_method_name: 900) }.freeze
-
-      new_hash = hash.transform thing1: -> i { i * 3 }, thing2: :random_method_name
-
-      assert_equal new_hash[:thing1], 300
-      assert_equal new_hash[:thing2], 900
-
-
-      # mutable version test:
-      hash = { thing1: 100, thing2: OpenStruct.new(random_method_name: 900) }
-
-      hash.transform! thing1: -> i { i * 3 }, thing2: :random_method_name
-
-      assert_equal hash[:thing1], 300
-      assert_equal hash[:thing2], 900
-    end
-
-    it 'applies procables recursively when given a hash' do
-      hash = { a: { b: { c: 100 } } }.freeze
-
-      new_hash = hash.transform({ a: { b: { c: -> i { i * 3 } } } })
-
-      assert_equal new_hash[:a][:b][:c], 300
-
-
-      # mutable version test:
-      hash = { a: { b: { c: 100 } } }
-
-      hash.transform!({ a: { b: { c: -> i { i * 3 } } } })
-
-      assert_equal hash[:a][:b][:c], 300
-    end
-
-    it 'applies procables to all elements of a collection if a value is iterable (iterable MUST be a collection of hashes)' do
-      hash = { a: [ { my_value: 10 }, { my_value: 20 } ] }.freeze
-
-      new_hash = hash.transform(a: { my_value: -> i { i * 3 } })
-
-      assert_equal new_hash[:a], [ { my_value: 30 }, { my_value: 60 } ]
-
-
-      # mutable version test:
-      hash = { a: [ { my_value: 10 }, { my_value: 20 } ] }
-
-      hash.transform!(a: { my_value: -> i { i * 3 } })
-
-      assert_equal hash[:a], [ { my_value: 30 }, { my_value: 60 } ]
-    end
-
-    it 'can apply several procables to a value, supplied in an array, executed from left to right' do
-      add_ten = -> i { i + 10 }
-      double = -> i { i * 2 }
-
-      hash = { a: 2.5 }.freeze
-
-      new_hash = hash.transform a: [ :to_i, add_ten, double ]
-
-      assert_equal new_hash[:a], 24
-
-
-      # mutable version test:
-      hash = { a: 2.5 }
-
-      hash.transform! a: [ :to_i, add_ten, double ]
-
-      assert_equal hash[:a], 24
-    end
-
-    it 'returns itself (mutable version only)' do
-      hash = {}
-      same_hash = hash.transform! Hash.new
-
-      assert_equal same_hash.object_id, hash.object_id
-    end
-
-  end
-end