augmented 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8cd8a8566eb16186e26909a2c32597cb2cf8d0e12e2f6785a55fa2cc43992ab
-  data.tar.gz: b19a9fd510664c6dc52e99b98ebf0faa5bc70c8c061143b7c4e57addb84f261f
+  metadata.gz: '0681d93502d452cf0eea808e3bfbe7db964263697d45aa13b6a8b68056a7afaa'
+  data.tar.gz: 4111ebc7818e495cf1f194131baa467f97f68ad1ed48594b0eb8bf9fb000f3e0
 SHA512:
-  metadata.gz: de5a4fde6a7325acd6d90008bd4f7895da85a87b71691d4c7cc5cbb81b798576f46b34621cbd9f0857c6ae087ab7e684855d839b97885ad7f127118a00e92f88
-  data.tar.gz: f6185c773e2af7676f35e07d0732305bfc7c5882109a0248db835c77ebd41c361ee8946cc66dcdced3b3087fcfc14b8c6953299eea677e8b08019f70983323cd
+  metadata.gz: a0ed6ba9498d327dd0bde6fec29c529d6e8053972d17eafb7847967a8da2188ab4d62aa0d47b989b8511e88b50f3f8d9131216d68b1a2d14a613a947ea453036
+  data.tar.gz: e6baa7157e3a59441828c5fbb5a181ddb20a38ea61a15b0dcfd1b543546a47e9c47344ac8fcf452061dad2b5e70e3d9c7302021ee0050fc63b0397e7aebd54a8

data/README.md

@@ -35,6 +35,7 @@ using Augmented::Hashes
 using Augmented::Modules
 using Augmented::Objects
 using Augmented::Procs
+using Augmented::Strings
 using Augmented::Symbols
 # etc.
 ```
@@ -60,7 +61,7 @@ Weaves an object between the elements of an array. Like `join` but without flatt
 ```ruby
 using Augmented::Arrays::Tieable
 
-[1, 2, 3].tie :hello
+[1, 2, 3].tie(:hello)
 # [1, :hello, 2, :hello, 3]
 
 [1, 5, 12].tie{ |a, b| a + b }
@@ -72,13 +73,13 @@ using Augmented::Arrays::Tieable
 
 ##### `Enumerator#index_by`
 
-Builds an index of all elements of an enumerator according to the given criterion.
+Builds an index of all elements of an enumerator according to the given criterion. Last element wins.
 
 ```ruby
 using Augmented::Enumerators::Indexing
 
-['a', 'bb', 'ccccc'].to_enum.index_by(&:length)
-# {1=>"a", 2=>"bb", 5=>"ccccc"}
+['a', 'bb', 'c', 'ddddd'].to_enum.index_by(&:length)
+# {1=>"c", 2=>"bb", 5=>"ddddd"}
 ```
 
 
@@ -149,21 +150,16 @@ tree.transform({ lorem: :upcase, dolor: { sit: triple } })
 Makes it less verbose to create small refinements.
 
 ```ruby
-using Augmented::Hashes::Transformable
+using Augmented::Modules::Refined
 
 class TextPage
   using refined String,
-    as_phrase: -> { self.strip.capitalize.gsub /\.?\z/, '.' },
-    fill:      -> filler { (filler * self.length)[0..length] }
+    to_phrase: -> { self.strip.capitalize.gsub(/\.?\z/, '.') }
 
   # ...
 
   def text
-    @strings.map(&:as_phrase).join ' '
-  end
-
-  def obscured_text
-    text.fill '?'
+    @lines.map(&:to_phrase).join(' ')
   end
 end
 ```
@@ -178,11 +174,11 @@ Allows you to conditionally return an object, allowing you to be more concise in
 ```ruby
 using Augmented::Objects::Iffy
 
-Person.new.eat toast.if(toast.buttered?).else(muffin)
-Person.new.eat toast.if(&:buttered?).else(muffin)
+Person.new.eat(toast.if(toast.buttered?).else(muffin))
+Person.new.eat(toast.if(&:buttered?).else(muffin))
 
-Person.new.eat toast.unless(toast.soggy?).else(muffin)
-Person.new.eat toast.unless(&:soggy?).else(muffin)
+Person.new.eat(toast.unless(toast.soggy?).else(muffin))
+Person.new.eat(toast.unless(&:soggy?).else(muffin))
 ```
 
 ##### `Object#pick`
@@ -193,13 +189,13 @@ Calls a bunch of methods on an object and collects the results.
 using Augmented::Objects::Pickable
 
 class MyThing
-  def lorem; 'hello'; end
-  def ipsum; 'cruel'; end
-  def dolor; 'world'; end
+  def foo; 'lorem'; end
+  def bar; 'ipsum'; end
+  def baz; 'dolor'; end
 end
 
-MyThing.new.pick :lorem, :dolor
-# {:lorem=>"hello", :dolor=>"world"}
+MyThing.new.pick(:foo, :baz)
+# {:foo=>"lorem", :baz=>"dolor"}
 ```
 
 ##### `Object#tack`
@@ -209,8 +205,8 @@ Appends a bunch of singleton methods to an object.
 ```ruby
 using Augmented::Objects::Tackable
 
-Object.new.tack(id: 11, greet: -> { puts "hello I'm #{id}" }).greet
-# hello I'm 11
+Object.new.tack(name: 'Alice', greet: -> { puts "hello I'm #{name}" }).greet
+# hello I'm Alice
 ```
 
 ##### `Object#tap_if`, `Object#tap_unless`
@@ -269,13 +265,45 @@ Wraps a `Proc` to rescue it from certain exceptions while returning a given valu
 ```ruby
 using Augmented::Procs::Rescuable
 
-integerify = proc{ |x| Integer(x) }.rescues ArgumentError, 42
+integerify = proc{ |x| Integer(x) }.rescues(ArgumentError, 42)
 
-['1', '2', 'abc', '4'].map &integerify
+['1', '2', 'oops!', '4'].map(&integerify)
 # [1, 2, 42, 4]
 ```
 
 
+#### `Augmented::Strings`
+
+##### `String#blank?`
+
+Tests if a string is empty or made of whitespace.
+
+```ruby
+using Augmented::Strings::Blank
+
+''.blank?
+# true
+' '.blank?
+# true
+' hello '.blank?
+# false
+```
+
+
+##### `String#truncate`, `String#truncate!`
+
+Returns a prefix of a string up to a given number of characters.
+
+```ruby
+using Augmented::Strings::Truncatable
+
+'hello world'.truncate(5)
+# "hello"
+[(string = 'hello world'), string.truncate!(5)]
+# ["hello", "hello"]
+```
+
+
 #### `Augmented::Symbols`
 
 ##### `Symbol#with`
@@ -311,8 +339,8 @@ end
 
 users = [ User.new('Marianne'), User.new('Jeremy') ]
 
-users.find &(:name.eq 'Marianne')
-# <User:0x... name='Marianne'>
+users.find(&:name.eq('Marianne'))
+# <User:0x... @name='Marianne'>
 ```
 
 

data/augmented.gemspec

@@ -6,18 +6,26 @@ require 'augmented/version'
 Gem::Specification.new do |spec|
   spec.name          = "augmented"
   spec.version       = Augmented::VERSION
-  spec.authors       = ["bruno"]
-  spec.email         = ["bruno@brunze.com"]
+  spec.authors       = ["brunze"]
   spec.summary       = %q{Useful extra methods for some Ruby core types.}
   spec.description   = %q{Adds a few useful extra methods to some of Ruby's core types, available as refinements.}
   spec.homepage      = "https://github.com/brunze/augmented"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.add_development_dependency "bundler", "~> 2.1"
-  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri']   = spec.homepage + '/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", ">= 13.0.3"
 end

data/lib/augmented.rb

@@ -6,6 +6,7 @@ require 'augmented/hashes'
 require 'augmented/modules'
 require 'augmented/objects'
 require 'augmented/procs'
+require 'augmented/strings'
 require 'augmented/symbols'
 
 module Augmented
@@ -15,5 +16,6 @@ module Augmented
   include Modules
   include Objects
   include Procs
+  include Strings
   include Symbols
 end

data/lib/augmented/enumerators/indexing.rb

@@ -4,7 +4,9 @@ module Augmented
       refine Enumerator do
 
         def index_by &criterion
-          Hash[ self.map(&criterion).zip(self) ]
+          self.each_with_object({}) do |element, index|
+            index[criterion.(element)] = element
+          end
         end
 
       end

data/lib/augmented/strings.rb

@@ -0,0 +1,9 @@
+require 'augmented/strings/blank'
+require 'augmented/strings/truncatable'
+
+module Augmented
+  module Strings
+    include Blank
+    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/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.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: augmented
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
-- bruno
-autorequire: 
+- brunze
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,32 +16,31 @@ 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
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,30 +71,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/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: {}
-post_install_message: 
+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:
 - lib
@@ -103,30 +93,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.18
+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