refinements 6.2.2 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ba775099d5db3e1c9d5cc47aa06412cc0adeddfbfc52f6cf8862f13af7441a
-  data.tar.gz: 3ee7c50aa7c658d0eab3dba89079bfe34c1b8c36935a5747248956fc27444e5e
+  metadata.gz: b1ea3f558caa4371babea8a3cf9653d95a785575456cc6be4b043f5811984c49
+  data.tar.gz: cf99c530f40b36cc5f14143e75cb781d75bd7d3c8e79387e5ea76c89c95bb48d
 SHA512:
-  metadata.gz: 24d00666e8499824b2434a49b145811f9b227c7990c1dd83dcacb369869636b445564d14027893a7ed8b4c661619101bfa285985a2916757ffbfa6115b0f9b74
-  data.tar.gz: 3ef9f9fc3b89754eca711a5152bbef5ac2bc5cbc5ad320d147f6585f699df6ff097e718f7de5ca498b0e269b2b686b1bc18f8f7a94c162504cff0ba8252cbe4d
+  metadata.gz: 3074e9fbfeb98ca10cbed67f38bb7daf103898e570884f49eee277337799b165058dfff0210bcb87d5472193f4b02cd39d0dc10211ab492c94b5d7ac3d73d966
+  data.tar.gz: 70aec9d111a40cd8d0d965de5f6b43f7482210b1101b678785b14635145ebc587ed4789dad04053092a9bd134ea2834873b4da8f5ec9cc52db46687549f5a691

data/README.md

@@ -24,7 +24,9 @@ Provides additional enhancements (refinements) to core Ruby objects.
     - [Examples](#examples)
       - [Array](#array)
       - [Big Decimal](#big-decimal)
+      - [File](#file)
       - [Hash](#hash)
+      - [Pathname](#pathname)
       - [String](#string)
   - [Tests](#tests)
   - [Versioning](#versioning)
@@ -43,6 +45,9 @@ Provides additional enhancements (refinements) to core Ruby objects.
   - `#compress!` - Removes `nil` and empty values while modifying itself.
 - Provides BigDecimal refinements:
   - `#inspect` - Allows one to inspect a big decimal with numeric representation.
+- Provides File refinements:
+  - `.rewrite` - When given a file path and a block, it provides the contents of the recently read
+    file for manipulation and immediate writing back to the same file.
 - Provides Hash refinements:
   - `#except` - Answers new hash with given keys removed without modifying calling hash.
   - `#except!` - Answers new hash with given keys removed while modifying calling hash.
@@ -52,6 +57,9 @@ Provides additional enhancements (refinements) to core Ruby objects.
   - `#deep_merge!` - Merges deeply nested hashes together while modifying itself.
   - `#reverse_merge` - Merges calling hash into passed in hash without modifying calling hash.
   - `#reverse_merge!` - Merges calling hash into passed in hash while modifying calling hash.
+- Provides Pathname refinements:
+  - `#rewrite` - When given a block, it provides the contents of the recently read file for
+    manipulation and immediate writing back to the same file.
 - Provides String refinements:
   - `#first` - Answers first character of a string or first set of characters if given a number.
   - `#last` - Answers last character of a string or last set of characters if given a number.
@@ -92,8 +100,9 @@ If all refinements are not desired, add the following to your `Gemfile` instead:
 
     require "refinements/arrays"
     require "refinements/big_decimals"
+    require "refinements/files"
     require "refinements/hashes"
-    require "refinements/objects"
+    require "refinements/pathnames"
     require "refinements/strings"
 
 ### Using
@@ -103,8 +112,9 @@ Much like including/extending a module, you'll need modify your object(s) to use
     class Example
       using Refinements::Arrays
       using Refinements::BigDecimals
+      using Refinements::Files
       using Refinements::Hashes
-      using Refinements::Objects
+      using Refinements::Pathnames
       using Refinements::Strings
     end
 
@@ -124,8 +134,11 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 #### Big Decimal
 
-    big = BigDecimal.new "5.0E-10"
-    big.inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
+    BigDecimal.new("5.0E-10").inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
+
+#### File
+
+    File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
 
 #### Hash
 
@@ -172,6 +185,10 @@ The following sections demonstrate how each refinement enriches your objects wit
     example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
     example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
 
+#### Pathname
+
+    Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
+
 #### String
 
     "example".first # => "e"

data/lib/refinements/files.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Files
+    refine File.singleton_class do
+      def rewrite path
+        read(path).then { |content| write path, yield(content) }
+      end
+    end
+  end
+end

data/lib/refinements/identity.rb

@@ -12,7 +12,7 @@ module Refinements
     end
 
     def self.version
-      "6.2.2"
+      "6.3.0"
     end
 
     def self.version_label

data/lib/refinements/pathnames.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Refinements
+  module Pathnames
+    refine Pathname do
+      def rewrite
+        read.then { |content| write yield(content) }
+      end
+    end
+  end
+end

data/lib/refinements.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "refinements/identity"
 require "refinements/arrays"
 require "refinements/big_decimals"
+require "refinements/files"
 require "refinements/hashes"
-require "refinements/identity"
+require "refinements/pathnames"
 require "refinements/strings"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 6.2.2
+  version: 6.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -218,14 +218,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -282,8 +282,10 @@ files:
 - lib/refinements.rb
 - lib/refinements/arrays.rb
 - lib/refinements/big_decimals.rb
+- lib/refinements/files.rb
 - lib/refinements/hashes.rb
 - lib/refinements/identity.rb
+- lib/refinements/pathnames.rb
 - lib/refinements/strings.rb
 homepage: https://github.com/bkuhlmann/refinements
 licenses:
@@ -307,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Provides additional enhancements (refinements) to core Ruby objects.