hanami-utils 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe9e18d01dfa9fc028b6844007dfcb410a0a03976bc84602ca1961527b9ed10
-  data.tar.gz: de05ca0f54e2f88eb25f095c110e97f6655e3598b39a107b57931615589a67e3
+  metadata.gz: e0a22471f524190c15c4669f35dcede577bbbc83216fd5646c9d904bd87038fe
+  data.tar.gz: e8b2a902b6a4d8f78467ce3608a33c3c1ab297e72b425cffecac3012f11566a2
 SHA512:
-  metadata.gz: e1279e5ab714af6ac575371da4f952349d309c7e6a804ef1aaf24f44944678dc899d15d8f9cc1e46fda6c51da6cb698d70283da61d8528aa56b8fcceebcc0516
-  data.tar.gz: 7a1215ecec9a8bc03f4b474620575f471f254c487c87f6d9415933107d1d3c598ee8815f4086e90b84a0099e1d051519eedc36ea9d313bd97730f29263fee146
+  metadata.gz: 1da17b43c1ae804f6b771a6cc6901dfd9a8e64f01dc82eae83813e72e203f9c837277a0d70b93e1d590e61079fb101a0ca9eaefb017f6a922554d4570fbc5cb3
+  data.tar.gz: 63cfd9328ff78e3f0077a702175d987d0268b20b2f61c16e4c842cd6cd1bc83aeef296bafcf431697fb3f1e678e8269e39f6f3d09078d5efe329f0882c4a173f

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Hanami::Utils
 Ruby core extentions and class utilities for Hanami
 
+## v1.1.2 - 2018-02-02
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.5
+
+### Fixed
+- [Sean Collins & Luca Guidi] Make `Utils::Files.write` idempotent: ensure to truncate the file before to write
+- [Sean Collins & Luca Guidi] Don't erase file contents when invoking `Utils::Files.touch`
+
+### Changed
+- [Sean Collins & Luca Guidi] Deprecate `Utils::Files.rewrite` in favor of `.write`
+
 ## v1.1.1 - 2017-11-22
 ### Added
 - [Luca Guidi] Introduce `Utils::Hash.deep_stringify` to recursively stringify a hash

data/lib/hanami/utils/files.rb

@@ -1,5 +1,6 @@
 require "pathname"
 require "fileutils"
+require "hanami/utils/deprecation"
 
 module Hanami
   module Utils
@@ -15,12 +16,12 @@ module Hanami
       #
       # @since 1.1.0
       def self.touch(path)
-        write(path, "")
+        mkdir_p(path)
+        FileUtils.touch(path)
       end
 
       # Creates a new file for the given path and content.
       # All the intermediate directories are created.
-      # If the path already exists, it appends the contents.
       #
       # @param path [String,Pathname] the path to file
       # @param content [String, Array<String>] the content to write
@@ -28,7 +29,7 @@ module Hanami
       # @since 1.1.0
       def self.write(path, *content)
         mkdir_p(path)
-        open(path, ::File::CREAT | ::File::WRONLY, *content)
+        open(path, ::File::CREAT | ::File::WRONLY | ::File::TRUNC, *content)
       end
 
       # Rewrites the contents of an existing file.
@@ -41,7 +42,11 @@ module Hanami
       #
       # @since 1.1.0
       def self.rewrite(path, *content)
-        open(path, ::File::TRUNC | ::File::WRONLY, *content)
+        Hanami::Utils::Deprecation.new(
+          "`.rewrite' is deprecated, please use `.write'"
+        )
+        raise Errno::ENOENT unless File.exist?(path)
+        write(path, *content)
       end
 
       # Copies source into destination.
@@ -140,7 +145,7 @@ module Hanami
         content = ::File.readlines(path)
         content.unshift("#{line}\n")
 
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Adds a new line at the bottom of the file
@@ -159,7 +164,7 @@ module Hanami
         content = ::File.readlines(path)
         content << "#{contents}\n"
 
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Replace first line in `path` that contains `target` with `replacement`.
@@ -178,7 +183,7 @@ module Hanami
         content = ::File.readlines(path)
         content[index(content, path, target)] = "#{replacement}\n"
 
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Replace last line in `path` that contains `target` with `replacement`.
@@ -197,7 +202,7 @@ module Hanami
         content = ::File.readlines(path)
         content[-index(content.reverse, path, target) - 1] = "#{replacement}\n"
 
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Inject `contents` in `path` before `target`.
@@ -217,7 +222,7 @@ module Hanami
         i       = index(content, path, target)
 
         content.insert(i, "#{contents}\n")
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Inject `contents` in `path` after `target`.
@@ -237,7 +242,7 @@ module Hanami
         i       = index(content, path, target)
 
         content.insert(i + 1, "#{contents}\n")
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Removes line from `path`, matching `target`.
@@ -254,7 +259,7 @@ module Hanami
         i       = index(content, path, target)
 
         content.delete_at(i)
-        rewrite(path, content)
+        write(path, content)
       end
 
       # Removes `target` block from `path`
@@ -293,7 +298,7 @@ module Hanami
         ending   = starting + index(content[starting..-1], path, closing)
 
         content.slice!(starting..ending)
-        rewrite(path, content)
+        write(path, content)
 
         remove_block(path, target) if match?(content, target)
       end

data/lib/hanami/utils/hash.rb

@@ -329,7 +329,7 @@ module Hanami
       #     'bignum'     => 13289301283 ** 2,
       #     'float'      => 1.0,
       #     'complex'    => Complex(0.3),
-      #     'bigdecimal' => BigDecimal.new('12.0001'),
+      #     'bigdecimal' => BigDecimal('12.0001'),
       #     'rational'   => Rational(0.3),
       #     'string'     => 'foo bar',
       #     'hash'       => { a: 1, b: 'two', c: :three },

data/lib/hanami/utils/kernel.rb

@@ -244,7 +244,7 @@ module Hanami
       #   Hanami::Utils::Kernel.Integer("1")                      # => 1
       #   Hanami::Utils::Kernel.Integer(Rational(0.3))            # => 0
       #   Hanami::Utils::Kernel.Integer(Complex(0.3))             # => 0
-      #   Hanami::Utils::Kernel.Integer(BigDecimal.new(12.00001)) # => 12
+      #   Hanami::Utils::Kernel.Integer(BigDecimal(12.00001))     # => 12
       #   Hanami::Utils::Kernel.Integer(176605528590345446089)
       #     # => 176605528590345446089
       #
@@ -311,11 +311,11 @@ module Hanami
       #   Hanami::Utils::Kernel.Integer(input) # => TypeError
       #
       #   # bigdecimal infinity
-      #   input = BigDecimal.new("Infinity")
+      #   input = BigDecimal("Infinity")
       #   Hanami::Utils::Kernel.Integer(input) # => TypeError
       #
       #   # bigdecimal NaN
-      #   input = BigDecimal.new("NaN")
+      #   input = BigDecimal("NaN")
       #   Hanami::Utils::Kernel.Integer(input) # => TypeError
       #
       #   # big rational
@@ -364,7 +364,7 @@ module Hanami
       #   Hanami::Utils::Kernel.BigDecimal("1")                      # => 1
       #   Hanami::Utils::Kernel.BigDecimal(Rational(0.3))            # => 0.3
       #   Hanami::Utils::Kernel.BigDecimal(Complex(0.3))             # => 0.3
-      #   Hanami::Utils::Kernel.BigDecimal(BigDecimal.new(12.00001)) # => 12.00001
+      #   Hanami::Utils::Kernel.BigDecimal(BigDecimal(12.00001))     # => 12.00001
       #   Hanami::Utils::Kernel.BigDecimal(176605528590345446089)
       #     # => 176605528590345446089
       #
@@ -373,7 +373,7 @@ module Hanami
       #
       #   UltimateAnswer = Struct.new(:question) do
       #     def to_d
-      #       BigDecimal.new(42)
+      #       BigDecimal(42)
       #     end
       #   end
       #
@@ -422,7 +422,7 @@ module Hanami
         when ->(a) { a.respond_to?(:to_d) }
           arg.to_d
         else
-          BigDecimal.new(arg)
+          ::Kernel.BigDecimal(arg)
         end
       rescue NoMethodError
         raise TypeError.new "can't convert #{inspect_type_error(arg)}into BigDecimal"
@@ -454,7 +454,7 @@ module Hanami
       #   Hanami::Utils::Kernel.Float("1")                      # => 1.0
       #   Hanami::Utils::Kernel.Float(Rational(0.3))            # => 0.3
       #   Hanami::Utils::Kernel.Float(Complex(0.3))             # => 0.3
-      #   Hanami::Utils::Kernel.Float(BigDecimal.new(12.00001)) # => 12.00001
+      #   Hanami::Utils::Kernel.Float(BigDecimal(12.00001))     # => 12.00001
       #   Hanami::Utils::Kernel.Float(176605528590345446089)
       #     # => 176605528590345446089.0
       #
@@ -493,11 +493,11 @@ module Hanami
       #   Hanami::Utils::Kernel.Float("2.5/1") # => 2.5
       #
       #   # bigdecimal infinity
-      #   input = BigDecimal.new("Infinity")
+      #   input = BigDecimal("Infinity")
       #   Hanami::Utils::Kernel.Float(input) # => Infinity
       #
       #   # bigdecimal NaN
-      #   input = BigDecimal.new("NaN")
+      #   input = BigDecimal("NaN")
       #   Hanami::Utils::Kernel.Float(input) # => NaN
       #
       # @example Unchecked Exceptions
@@ -606,9 +606,9 @@ module Hanami
       #
       #   Hanami::Utils::Kernel.String(Rational(-22))                 # => "-22/1"
       #   Hanami::Utils::Kernel.String(Complex(11, 2))                # => "11+2i"
-      #   Hanami::Utils::Kernel.String(BigDecimal.new(7944.2343, 10)) # => "0.79442343E4"
-      #   Hanami::Utils::Kernel.String(BigDecimal.new('Infinity'))    # => "Infinity"
-      #   Hanami::Utils::Kernel.String(BigDecimal.new('NaN'))         # => "Infinity"
+      #   Hanami::Utils::Kernel.String(BigDecimal(7944.2343, 10))     # => "0.79442343E4"
+      #   Hanami::Utils::Kernel.String(BigDecimal('Infinity'))        # => "Infinity"
+      #   Hanami::Utils::Kernel.String(BigDecimal('NaN'))             # => "Infinity"
       #
       # @example String interface
       #   require 'hanami/utils/kernel'

data/lib/hanami/utils/string.rb

@@ -212,7 +212,7 @@ module Hanami
       #
       # @param input [::String] the input
       #
-      # @return [String] the transformed string
+      # @return [::String] the transformed string
       #
       # @since 1.1.0
       #
@@ -239,7 +239,7 @@ module Hanami
       #
       # @param input [::String] the input
       #
-      # @return [String] the transformed string
+      # @return [::String] the transformed string
       #
       # @since 1.1.0
       #
@@ -282,7 +282,7 @@ module Hanami
       #
       # @param input [::String] the input
       #
-      # @return [String] the transformed string
+      # @return [::String] the transformed string
       #
       # @since 1.1.0
       #
@@ -300,7 +300,7 @@ module Hanami
       #
       # @param input [::String] the input
       #
-      # @return [String] the transformed string
+      # @return [::String] the transformed string
       #
       # @since 1.1.0
       #
@@ -386,7 +386,7 @@ module Hanami
       #
       # @param string [::String, Symbol] the value we want to initialize
       #
-      # @return [String] self
+      # @return [Hanami::Utils::String] self
       #
       # @since 0.1.0
       def initialize(string)
@@ -441,7 +441,7 @@ module Hanami
 
       # Return a CamelCase version of the string
       #
-      # @return [String] the transformed string
+      # @return [Hanami::Utils::String] the transformed string
       #
       # @since 0.1.0
       #
@@ -466,7 +466,7 @@ module Hanami
       # Revised version of `ActiveSupport::Inflector.underscore` implementation
       # @see https://github.com/rails/rails/blob/feaa6e2048fe86bcf07e967d6e47b865e42e055b/activesupport/lib/active_support/inflector/methods.rb#L90
       #
-      # @return [String] the transformed string
+      # @return [Hanami::Utils::String] the transformed string
       #
       # @since 0.1.0
       #
@@ -507,7 +507,7 @@ module Hanami
 
       # Return the string without the Ruby namespace of the class
       #
-      # @return [String] the transformed string
+      # @return [Hanami::Utils::String] the transformed string
       #
       # @since 0.1.0
       #
@@ -525,7 +525,7 @@ module Hanami
 
       # Return the top level namespace name
       #
-      # @return [String] the transformed string
+      # @return [Hanami::Utils::String] the transformed string
       #
       # @since 0.1.2
       #
@@ -602,7 +602,7 @@ module Hanami
 
       # Returns the hash of the internal string
       #
-      # @return [Fixnum]
+      # @return [Integer]
       #
       # @since 0.3.0
       def hash
@@ -611,7 +611,7 @@ module Hanami
 
       # Returns a string representation
       #
-      # @return [String]
+      # @return [::String]
       #
       # @since 0.3.0
       def to_s
@@ -633,7 +633,7 @@ module Hanami
 
       # Split the string with the given pattern
       #
-      # @return [Array<String>]
+      # @return [Array<::String>]
       #
       # @see http://www.ruby-doc.org/core/String.html#method-i-split
       #
@@ -644,7 +644,7 @@ module Hanami
 
       # Replace the given pattern with the given replacement
       #
-      # @return [String,nil]
+      # @return [::String]
       #
       # @see http://www.ruby-doc.org/core/String.html#method-i-gsub
       #
@@ -657,9 +657,10 @@ module Hanami
         end
       end
 
-      # Both forms iterate through str, matching the pattern
+      # Iterate through the string, matching the pattern.
+      # Either return all those patterns, or pass them to the block.
       #
-      # @return [String,nil]
+      # @return [Array<::String>]
       #
       # @see http://www.ruby-doc.org/core/String.html#method-i-scan
       #

data/lib/hanami/utils/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '1.1.1'.freeze
+    VERSION = '1.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-utils
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transproc
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Ruby core extentions and Hanami utilities