io-pipe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a88bbfa83b7c2313a08e8e2cbcf41cb706025159bf1f7095657aa5da0dd5e1d
+  data.tar.gz: 8429d494b63a70b5fe3f318bc15711bcee07c09cbac180a4c56603e239347c39
+SHA512:
+  metadata.gz: 62ce181ef05bc5fe05bbe1829a011eaf47ce049192757efd4d61c9ab208279f2cc0dc405e397ab88d177352788e74410ba6416788e12c38518679d823f924448
+  data.tar.gz: 5c19f484755bcf217b6ea76521472d346c5b9ac398c0ccf164f9ea339b391567d443ebaf03827c0028c461ce2622f51a0d148584d5027cedeba6119a1364184c

data/.document

@@ -0,0 +1,3 @@
+README.md
+lib
+io-pipe.rdoc

data/.rdoc_options

@@ -0,0 +1,3 @@
+---
+main_page: README.md
+title: IO::Pipe Documentation

data/LICENSE.md

@@ -0,0 +1,24 @@
+Copyright (c) 2023, Nobuyoshi Nakada <nobu@ruby-lang.org>.
+
+Ruby License.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,48 @@
+# IO::Pipe
+
+This library provides extended `` Kernel#` ``.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add io-pipe
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install io-pipe
+
+## Usage
+
+With redirection.
+
+```shell-session
+$ ruby -I./lib -rio/pipe -e 'using IO::Pipe' -e 'p *`cp`.redirect(err: %i[child out])'
+"cp: missing file operand\n"
+"Try 'cp --help' for more information.\n"
+```
+
+With chomping.
+
+```shell-session
+$ ruby -I./lib -rio/pipe -e 'using IO::Pipe' -e 'p *`ls *.md`.each(chomp: true)'
+"README.md"
+```
+
+With different line separator and chomping.
+
+```shell-session
+$ ruby -I./lib -rio/pipe -e 'using IO::Pipe' -e 'p *`git ls-files -z *.md`.each("\0", chomp: true)'
+"LICENSE.md"
+"README.md"
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install
+dependencies
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nobu/io-pipe.
+```

data/lib/io/pipe.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class IO; end
+
+# Module to refine <tt>Kernel#`</tt> method.
+module IO::Pipe
+  # The version number
+  VERSION = "0.0.1"
+
+  #:stopdoc:
+  Command = Data.define(:command, :each_args, :each_kwds, :open_args)
+  #:startdoc:
+
+  ##
+  # Wrapper of command and options.
+  class Command
+    include Enumerable
+
+    ##
+    # :attr_reader: command
+    #
+    # \Command string or array to start a process.
+
+    ##
+    # :attr_reader: each_args
+    #
+    # Positional arguments to be passed to +#each+ method.
+
+    ##
+    # :attr_reader: each_kwds
+    #
+    # Keyword arguments to be passed to +#each+ method.
+
+    ##
+    # :attr_reader: open_args
+    #
+    # Arguments to be passed to +#open+ method.
+
+    # Creates instance.
+    def initialize(command:, each_args: nil, each_kwds: nil, open_args: {})
+      super
+    end
+
+    # Starts the command with +open_args+.
+    def open(&block)
+      IO.popen(command, **open_args, &block)
+    end
+
+    code = []
+
+    %i[
+      read read_nonblock readline readlines readpartial
+      readchar readbyte ungetbyte ungetc getbyte getc gets
+    ].map do |m|
+      code << "def #{m}(...) = open {|f| f.#{m}(...)}\n"
+    end
+
+    # Iterates command outputs.
+    def each(*args, **kwds, &block)
+      if block_given?
+        open {|f| f.each(*each_args, *args, **each_kwds, **kwds, &block)}
+      else
+        with(each_args: args, each_kwds: kwds)
+      end
+    end
+
+    %i[
+      each_line each_byte each_char each_codepoint
+    ].map do |m|
+      code << "def #{m}(*args, **kwds, &block) = open {|f| f.#{m}(*each_args, *args, **each_kwds, **kwds, &block)}\n"
+    end
+
+    eval code.join("")
+
+    # Redirects outputs.
+    def redirect(**to)
+      open_args.update(to)
+      self
+    end
+
+    alias to_str read
+    alias to_s read
+  end
+
+  ##
+  # Creates IO::Pipe::Command with +str+.
+  def `(str) = Command.new(str)
+
+  refine(::Kernel) {
+    ##
+    # Extended <tt>Kernel#`</tt> that creates IO::Pipe::Command with +str+.
+    def `(str) = Command.new(str)
+  }
+end

data/sig/io/pipe.rbs

@@ -0,0 +1,2 @@
+module IO::Pipe
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: io-pipe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nobuyoshi Nakada
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies: []
+description: An extension to the backtick method to allow additional optionsto be
+  passed to the command and IO#each method.
+email:
+- nobu@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".rdoc_options"
+- LICENSE.md
+- README.md
+- lib/io/pipe.rb
+- sig/io/pipe.rbs
+homepage: https://github.com/nobu/io-pipe
+licenses:
+- Ruby
+- BSD-2-Clause
+metadata:
+  source_code_uri: https://github.com/nobu/io-pipe
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Extended pipe command
+test_files: []