dry-files 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d22584a76b85c83b8d1d50e0b805335347f205f7ac7da1ea31dd538a5b459fd
-  data.tar.gz: 4054a4f0bf0daa95cc3e23937d5acb9726606cf7974159146cd21787a186549b
+  metadata.gz: 62369326685ba2aa2719ff1ffd3bda010ac51f80e6f5094fde071c6ea440d407
+  data.tar.gz: 5f629c648d5d31f4d46bf7a32b80efc6a053e79990117978f9ec3e26a2a4490f
 SHA512:
-  metadata.gz: d7881004a31c1106fb0a42b11015169fe1deac588aa1609ab3dd13c28c945f83cea7b722fb43250de665d862ec27f8f76071f88eac3b1567b2ea95a201cb8a4d
-  data.tar.gz: 3d2c8d0f875b00e889d0020a5023443b686529548bf1b28ca5007085bd88d4581affc6ad1a2d5319f861dfc768cef8e486f45959204478f05670121a239db124
+  metadata.gz: 4729286d5f15c84b98d8349104a2bd4b89106c6f9c100af996687c2968a7f9cb890fb2cca90821031ab5074172fb36d9fa0ffc15840caa31d4cbc60e4af71d2b
+  data.tar.gz: cbbda5c073e563b48145035ca9f1ed3ac7deceea3c02b78060225e8710d9bbd6cfee7727bb67fd254791689fdcb763608fc8cfaf1e4e31bcd168e96a9a5ad666

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 0.3.0 2022-09-19
+
+
+### Added
+
+- Support for `inject_line_at_class_bottom` (via #13) (@jodosha)
+
+
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-files/compare/v0.2.0...v0.3.0)
+
+## 0.2.0 2022-07-10
+
+
+### Added
+
+- Dry::Files#append to create intermediate directory and touch destination file (via #8) (@jodosha)
+
+
+[Compare v0.1.0...v0.2.0](https://github.com/dry-rb/dry-files/compare/v0.1.0...v0.2.0)
+
 ## 0.1.0 2021-05-04
 
 Initial release

data/README.md

@@ -1,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-files
 [actions]: https://github.com/dry-rb/dry-files/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-files
@@ -10,19 +11,19 @@
 [![CI Status](https://github.com/dry-rb/dry-files/workflows/ci/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/71200ee8d70b412c9e21c20b8b3b3688)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/71200ee8d70b412c9e21c20b8b3b3688)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-files.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/dry-rb/dry-files.svg?branch=main)][inchpages]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-files)
+* [User documentation](https://dry-rb.org/gems/dry-files)
 * [API documentation](http://rubydoc.info/gems/dry-files)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.5`
-* jruby >= `9.2`
+* MRI `>= 2.7.0`
+* jruby `>= 9.3` (postponed until 2.7 is supported)
 
 ## License
 

data/dry-files.gemspec

@@ -1,33 +1,35 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/files/version'
+require "dry/files/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-files'
+  spec.name          = "dry-files"
   spec.authors       = ["Luca Guidi"]
   spec.email         = ["me@lucaguidi.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Files::VERSION.dup
 
   spec.summary       = "file utilities"
   spec.description   = spec.summary
-  spec.homepage      = 'https://dry-rb.org/gems/dry-files'
+  spec.homepage      = "https://dry-rb.org/gems/dry-files"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-files.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-files/blob/master/CHANGELOG.md'
-  spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-files'
-  spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-files/issues'
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-files/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-files"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-files/issues"
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # to update dependencies edit project.yml
+
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rubocop", "~> 1.12"

data/lib/dry/files/file_system.rb

@@ -46,7 +46,7 @@ module Dry
       # @raise [Dry::Files::IOError] in case of I/O error
       #
       # @since 0.1.0
-      def open(path, mode = OPEN_MODE, *args, &blk)
+      def open(path, mode, *args, &blk)
         touch(path)
 
         with_error_handling do
@@ -345,16 +345,6 @@ module Dry
 
       private
 
-      # @since 0.1.0
-      # @api private
-      OPEN_MODE = ::File::RDWR
-      private_constant :OPEN_MODE
-
-      # @since 0.1.0
-      # @api private
-      WRITE_MODE = (::File::CREAT | ::File::WRONLY | ::File::TRUNC).freeze
-      private_constant :WRITE_MODE
-
       # Catch `SystemCallError` and re-raise a `Dry::Files::IOError`.
       #
       # `SystemCallError` is parent for all the `Errno::*` Ruby exceptions.

data/lib/dry/files/memory_file_system/node.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "English"
 require "stringio"
 
 module Dry
@@ -215,8 +214,17 @@ module Dry
         #
         # @since 0.1.0
         # @api private
-        def write(*content)
-          @content = StringIO.new(content.join($RS))
+        def write(content)
+          content = case content
+                    when String
+                      content
+                    when Array
+                      array_to_string(content)
+                    when NilClass
+                      EMPTY_CONTENT
+                    end
+
+          @content = StringIO.new(content)
           @mode = DEFAULT_FILE_MODE
         end
 
@@ -240,6 +248,14 @@ module Dry
         def executable?
           (mode & MODE_USER_EXECUTE).positive?
         end
+
+        # @since 0.3.0
+        # @api private
+        def array_to_string(content)
+          content.map do |line|
+            line.sub(NEW_LINE_MATCHER, EMPTY_CONTENT)
+          end.join(NEW_LINE) + NEW_LINE
+        end
       end
     end
   end

data/lib/dry/files/memory_file_system.rb

@@ -11,7 +11,7 @@ module Dry
     class MemoryFileSystem
       # @since 0.1.0
       # @api private
-      EMPTY_CONTENT = nil
+      EMPTY_CONTENT = ""
       private_constant :EMPTY_CONTENT
 
       require_relative "./memory_file_system/node"
@@ -33,12 +33,18 @@ module Dry
       #
       # @param path [String] the target file
       # @yieldparam [Dry::Files::MemoryFileSystem::Node]
+      # @return [Dry::Files::MemoryFileSystem::Node]
       #
       # @since 0.1.0
       # @api private
-      def open(path, *, &blk)
+      def open(path, *)
         file = touch(path)
-        blk.call(file)
+
+        if block_given?
+          yield file
+        else
+          file
+        end
       end
 
       # Read file contents

data/lib/dry/files/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   class Files
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/dry/files.rb

@@ -14,6 +14,14 @@ module Dry
     require_relative "files/error"
     require_relative "files/adapter"
 
+    # @since 0.3.0
+    # @api public
+    OPEN_MODE = ::File::RDWR
+
+    # @since 0.3.0
+    # @api public
+    WRITE_MODE = (::File::CREAT | ::File::WRONLY | ::File::TRUNC).freeze
+
     # Creates a new instance
     #
     # Memory file system is experimental
@@ -111,6 +119,22 @@ module Dry
       adapter.pwd
     end
 
+    # Opens (or creates) a new file for both read/write operations
+    #
+    # @param path [String] the target file
+    # @param mode [String,Integer] Ruby file open mode
+    # @param args [Array<Object>] ::File.open args
+    # @param blk [Proc] the block to yield
+    #
+    # @yieldparam [File,Dry::Files::MemoryFileSystem::Node] the opened file
+    #
+    # @return [File,Dry::Files::MemoryFileSystem::Node] the opened file
+    #
+    # @raise [Dry::Files::IOError] in case of I/O error
+    def open(path, mode = OPEN_MODE, *args, &blk)
+      adapter.open(path, mode, *args, &blk)
+    end
+
     # Temporary changes the current working directory of the process to the
     # given path and yield the given block.
     #
@@ -307,6 +331,7 @@ module Dry
     # @api public
     def append(path, contents)
       mkdir_p(path)
+      touch(path)
 
       content = adapter.readlines(path)
       content << newline unless newline?(content.last)
@@ -656,14 +681,92 @@ module Dry
     #   #   end
     #   # end
     def inject_line_at_block_bottom(path, target, *contents)
-      content  = adapter.readlines(path)
-      starting = index(content, path, target)
-      line     = content[starting]
-      size     = line[SPACE_MATCHER].bytesize
-      closing  = (SPACE * size) +
-                 (target.match?(INLINE_OPEN_BLOCK_MATCHER) ? INLINE_CLOSE_BLOCK : CLOSE_BLOCK)
-      ending   = starting + index(content[starting..-CONTENT_OFFSET], path, closing)
-      offset   = SPACE * (content[ending][SPACE_MATCHER].bytesize + INDENTATION)
+      content   = adapter.readlines(path)
+      starting  = index(content, path, target)
+      line      = content[starting]
+      delimiter = if line.match?(INLINE_OPEN_BLOCK_MATCHER)
+                    INLINE_BLOCK_DELIMITER
+                  else
+                    BLOCK_DELIMITER
+                  end
+      target    = content[starting..]
+      ending    = closing_block_index(target, starting, path, line, delimiter)
+      offset    = SPACE * (content[ending][SPACE_MATCHER].bytesize + INDENTATION)
+
+      contents = Array(contents).flatten
+      contents = _offset_block_lines(contents, offset)
+
+      content.insert(ending, contents)
+      write(path, content)
+    end
+
+    # Inject `contents` in `path` at the bottom of the Ruby class that matches `target`.
+    # The given `contents` will appear at the BOTTOM of the Ruby class.
+    #
+    # @param path [String,Pathname] the path to file
+    # @param target [String,Regexp] the target matcher for Ruby class
+    # @param contents [String,Array<String>] the contents to inject
+    #
+    # @raise [Dry::Files::IOError] in case of I/O error
+    # @raise [Dry::Files::MissingTargetError] if `target` cannot be found in `path`
+    #
+    # @since 0.4.0
+    # @api public
+    #
+    # @example Inject a single line
+    #   require "dry/files"
+    #
+    #   files = Dry::Files.new
+    #   path = "config/application.rb"
+    #
+    #   File.read(path)
+    #   # # frozen_string_literal: true
+    #   #
+    #   # class Application
+    #   # end
+    #
+    #   # inject a single line
+    #   files.inject_line_at_class_bottom(path, /Application/, %(attr_accessor :name))
+    #
+    #   File.read(path)
+    #   # # frozen_string_literal: true
+    #   #
+    #   # class Application
+    #   #   attr_accessor :name
+    #   # end
+    #
+    # @example Inject multiple lines
+    #   require "dry/files"
+    #
+    #   files = Dry::Files.new
+    #   path = "math.rb"
+    #
+    #   File.read(path)
+    #   # # frozen_string_literal: true
+    #   #
+    #   # class Math
+    #   # end
+    #
+    #   # inject multiple lines
+    #   files.inject_line_at_class_bottom(path,
+    #                                     /Math/,
+    #                                     ["def sum(a, b)", "  a + b", "end"])
+    #
+    #   File.read(path)
+    #   # # frozen_string_literal: true
+    #   #
+    #   # class Math
+    #   #   def sum(a, b)
+    #   #     a + b
+    #   #   end
+    #   # end
+    def inject_line_at_class_bottom(path, target, *contents)
+      content   = adapter.readlines(path)
+      starting  = index(content, path, target)
+      line      = content[starting]
+      target    = content[starting..]
+      ending    = closing_class_index(target, starting, path, line, BLOCK_DELIMITER)
+      offset    = SPACE * (content[ending][SPACE_MATCHER].bytesize + INDENTATION)
 
       contents = Array(contents).flatten
       contents = _offset_block_lines(contents, offset)
@@ -735,11 +838,38 @@ module Dry
 
     private
 
+    # @since 0.3.0
+    # @api private
+    class Delimiter
+      # @since 0.3.0
+      # @api private
+      attr_reader :opening, :closing
+
+      # @since 0.3.0
+      # @api private
+      def initialize(name, opening, closing)
+        @name = name
+        @opening = opening
+        @closing = closing
+        freeze
+      end
+    end
+
     # @since 0.1.0
     # @api private
     NEW_LINE = $/ # rubocop:disable Style/SpecialGlobalVars
     private_constant :NEW_LINE
 
+    # @since 0.3.0
+    # @api private
+    NEW_LINE_MATCHER = /#{NEW_LINE}\z/.freeze
+    private_constant :NEW_LINE_MATCHER
+
+    # @since 0.3.0
+    # @api private
+    EMPTY_LINE = /\A\z/.freeze
+    private_constant :EMPTY_LINE
+
     # @since 0.1.0
     # @api private
     CONTENT_OFFSET = 1
@@ -760,21 +890,42 @@ module Dry
     SPACE_MATCHER = /\A[[:space:]]*/.freeze
     private_constant :SPACE_MATCHER
 
-    # @since 0.1.0
+    # @since 0.3.0
     # @api private
-    INLINE_OPEN_BLOCK_MATCHER = "{"
-    private_constant :INLINE_OPEN_BLOCK_MATCHER
+    INLINE_OPEN_BLOCK = "{"
+    private_constant :INLINE_OPEN_BLOCK
 
     # @since 0.1.0
     # @api private
     INLINE_CLOSE_BLOCK = "}"
     private_constant :INLINE_CLOSE_BLOCK
 
+    # @since 0.3.0
+    # @api private
+    OPEN_BLOCK = "do"
+    private_constant :OPEN_BLOCK
+
     # @since 0.1.0
     # @api private
     CLOSE_BLOCK = "end"
     private_constant :CLOSE_BLOCK
 
+    # @since 0.1.0
+    # @api private
+    INLINE_OPEN_BLOCK_MATCHER = INLINE_CLOSE_BLOCK
+    private_constant :INLINE_OPEN_BLOCK_MATCHER
+
+    # @since 0.3.0
+    # @api private
+    INLINE_BLOCK_DELIMITER = Delimiter.new("InlineBlockDelimiter",
+                                           INLINE_OPEN_BLOCK, INLINE_CLOSE_BLOCK)
+    private_constant :INLINE_BLOCK_DELIMITER
+
+    # @since 0.3.0
+    # @api private
+    BLOCK_DELIMITER = Delimiter.new("BlockDelimiter", OPEN_BLOCK, CLOSE_BLOCK)
+    private_constant :BLOCK_DELIMITER
+
     # @since 0.1.0
     # @api private
     attr_reader :adapter
@@ -788,7 +939,7 @@ module Dry
     # @since 0.1.0
     # @api private
     def newline?(content)
-      content.end_with?(NEW_LINE)
+      content&.end_with?(NEW_LINE)
     end
 
     # @since 0.1.0
@@ -811,6 +962,25 @@ module Dry
         raise MissingTargetError.new(target, path)
     end
 
+    # @since 0.3.0
+    # @api private
+    def closing_block_index(content, starting, path, target, delimiter, count_offset = 0) # rubocop:disable Metrics/ParameterLists
+      blocks_count = content.count { |line| line.match?(delimiter.opening) } + count_offset
+      matching_line = content.find do |line|
+        blocks_count -= 1 if line.match?(delimiter.closing)
+        line if blocks_count.zero?
+      end
+
+      (content.index(matching_line) or
+        raise MissingTargetError.new(target, path)) + starting
+    end
+
+    # @since 0.4.0
+    # @api private
+    def closing_class_index(content, starting, path, target, delimiter)
+      closing_block_index(content, starting, path, target, delimiter, 1)
+    end
+
     # @since 0.1.0
     # @api private
     def _inject_line_before(path, target, contents, finder)
@@ -838,6 +1008,8 @@ module Dry
         if line.match?(NEW_LINE)
           line = line.split(NEW_LINE)
           _offset_block_lines(line, offset)
+        elsif line.match?(EMPTY_LINE)
+          line + NEW_LINE
         else
           offset + line + NEW_LINE
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-files
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="