iostreams 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16ce2bb98466540950ee6a40c9b3066630e99e7987c93621b3a175b5b027731
-  data.tar.gz: 6fb4dd208cc04a71d78ac1355f8035159a97b67f2a749dc922df3f6edf7208ac
+  metadata.gz: d2c3b941a898cf14f2e8d5ac430f55efc602126f0d2e339014cb3de97d7c9233
+  data.tar.gz: e5745a12f24746ecf624627ac45e900251b0c3b83b109d7f18c04ffaf4efeba5
 SHA512:
-  metadata.gz: e58da1ef631c0eae5574194e6586dbf7b52becc934a01a00ede0ef0f665d14f08391a5a2fee645bbe8ffe8fe8452c6d4b79eb84396f1e94e9b98ad9dea229041
-  data.tar.gz: d821299bb5742832125ff2b7a6826f68b734967ea7a5f5d94cf1b619ef3ad82dfd2c457455a5d62523ca52832f5d17b7c2f343f5f387f77abdbeaca6bff42dd7
+  metadata.gz: ae879c20c587da2b9a2c5ae36a0488346b49f11470bd812640d6ccda161434221b98cdb65c5d7cc2988492621822a4e301665033e94207f90b323299b2e0fc24
+  data.tar.gz: a325782b46feeaf314a94f758be89d02b006fabfe824c91b2ac17309841980cab4cb9129318040426d9d6582bff6dd7345bc40f9234b0cd2e89c0d5555948335

data/lib/io_streams/io_streams.rb

@@ -425,50 +425,69 @@ module IOStreams
     end
   end
 
-  # Return the complete path including supplied elements.
+  # Returns [Path] instance for the supplied complete path with optional scheme.
   #
   # Example:
-  #    IOStreams.path('sample')
-  #    # => "/default_root/sample"
+  #    IOStreams.path("/usr", "local", "sample")
+  #    # => #<IOStreams::File::Path:0x00007fec66e59b60 @path="/usr/local/sample">
   #
-  #    IOStreams.path('file.xls')
-  #    # => "/default_root/file.xls"
+  #    IOStreams.path("/usr", "local", "sample").to_s
+  #    # => "/usr/local/sample"
   #
-  #    IOStreams.path('sample', root: :ftp)
-  #    # => "/ftp_root/sample"
+  #    IOStreams.path("s3://mybucket/path/file.xls")
+  #    # => #<IOStreams::S3::Path:0x00007fec66e3a288, @path="s3://mybucket/path/file.xls">
   #
-  #    IOStreams.path('sample', 'file.xls', root: :ftp)
-  #    # => "/ftp_root/sample/file.xls"
+  #    IOStreams.path("s3://mybucket/path/file.xls").to_s
+  #    # => "s3://mybucket/path/file.xls"
   #
-  # Notes:
-  # * Add the root path first against which this path is permitted to operate.
-  #     `IOStreams.add_root_path(:default, "/usr/local/var/files")`
-  def self.path(*elements, root: :default)
-    root_path(root).join(*elements)
-  end
-
-  # When using a full path, without needing the root prefixed.
-  def self.full_path(*elements)
+  #    IOStreams.path("file.xls")
+  #    # => #<IOStreams::File::Path:0x00007fec6be6aaf0 @path="file.xls">
+  #
+  #    IOStreams.path("files", "file.xls").to_s
+  #    # => "files/file.xls"
+  def self.path(*elements)
     path = ::File.join(*elements)
     uri  = URI.parse(path)
     IOStreams.scheme(uri.scheme).path_class.new(path)
   end
 
+  # Join the supplied path elements to a root path.
+  #
+  # Example:
+  #    IOStreams.add_root(:default, "tmp/export")
+  #
+  #    IOStreams.join('file.xls')
+  #    # => #<IOStreams::File::Path:0x00007fec70391bd8 @path="tmp/export/sample">
+  #
+  #    IOStreams.join('file.xls').to_s
+  #    # => "tmp/export/sample"
+  #
+  #    IOStreams.join('sample', 'file.xls', root: :ftp)
+  #    # => #<IOStreams::File::Path:0x00007fec6ee329b8 @path="tmp/ftp/sample/file.xls">
+  #
+  #    IOStreams.join('sample', 'file.xls', root: :ftp).to_s
+  #    # => "tmp/ftp/sample/file.xls"
+  #
+  # Notes:
+  # * Add the root path first against which this path is permitted to operate.
+  #     `IOStreams.add_root(:default, "/usr/local/var/files")`
+  def self.join(*elements, root: :default)
+    root(root).join(*elements)
+  end
+
   # Return named root path
-  def self.root_path(root = :default)
+  def self.root(root = :default)
     @roots_paths[root.to_sym] || raise(ArgumentError, "Unknown root: #{root.inspect}")
   end
 
   # Add a named root path
-  def self.add_root_path(root, path)
+  def self.add_root(root, *elements)
     raise(ArgumentError, "Invalid root name #{root.inspect}") unless root.to_s =~ /\A\w+\Z/
 
-    uri                       = URI.parse(path.to_s)
-    path_class                = IOStreams.scheme(uri.scheme).path_class
-    @roots_paths[root.to_sym] = path_class.new(path)
+    @roots_paths[root.to_sym] = path(*elements)
   end
 
-  def self.root_paths
+  def self.roots
     @roots_paths.dup
   end
 

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams
-  VERSION = '0.20.0'
+  VERSION = '0.20.1'
 end

data/test/path_test.rb

@@ -3,49 +3,49 @@ require_relative 'test_helper'
 module IOStreams
   class PathTest < Minitest::Test
     describe IOStreams do
-      describe '.root_path' do
+      describe '.root' do
         it 'return default path' do
           path = ::File.expand_path(::File.join(__dir__, '../tmp/default'))
-          assert_equal path, IOStreams.root_path.to_s
+          assert_equal path, IOStreams.root.to_s
         end
 
         it 'return downloads path' do
           path = ::File.expand_path(::File.join(__dir__, '../tmp/downloads'))
-          assert_equal path, IOStreams.root_path(:downloads).to_s
+          assert_equal path, IOStreams.root(:downloads).to_s
         end
       end
 
       describe '.path' do
         it 'returns path' do
-          assert_equal IOStreams.root_path.to_s, IOStreams.path.to_s
+          assert_equal IOStreams.root.to_s, IOStreams.join.to_s
         end
 
         it 'adds path to root' do
-          assert_equal ::File.join(IOStreams.root_path.to_s, 'test'), IOStreams.path('test').to_s
+          assert_equal ::File.join(IOStreams.root.to_s, 'test'), IOStreams.join('test').to_s
         end
 
         it 'adds paths to root' do
-          assert_equal ::File.join(IOStreams.root_path.to_s, 'test', 'second', 'third'), IOStreams.path('test', 'second', 'third').to_s
+          assert_equal ::File.join(IOStreams.root.to_s, 'test', 'second', 'third'), IOStreams.join('test', 'second', 'third').to_s
         end
 
         it 'returns path and filename' do
-          path = ::File.join(IOStreams.root_path.to_s, 'file.xls')
-          assert_equal path, IOStreams.path('file.xls').to_s
+          path = ::File.join(IOStreams.root.to_s, 'file.xls')
+          assert_equal path, IOStreams.join('file.xls').to_s
         end
 
         it 'adds path to root and filename' do
-          path = ::File.join(IOStreams.root_path.to_s, 'test', 'file.xls')
-          assert_equal path, IOStreams.path('test', 'file.xls').to_s
+          path = ::File.join(IOStreams.root.to_s, 'test', 'file.xls')
+          assert_equal path, IOStreams.join('test', 'file.xls').to_s
         end
 
         it 'adds paths to root' do
-          path = ::File.join(IOStreams.root_path.to_s, 'test', 'second', 'third', 'file.xls')
-          assert_equal path, IOStreams.path('test', 'second', 'third', 'file.xls').to_s
+          path = ::File.join(IOStreams.root.to_s, 'test', 'second', 'third', 'file.xls')
+          assert_equal path, IOStreams.join('test', 'second', 'third', 'file.xls').to_s
         end
 
         it 'return path as sent in when full path' do
-          path = ::File.join(IOStreams.root_path.to_s, 'file.xls')
-          assert_equal path, IOStreams.path(path).to_s
+          path = ::File.join(IOStreams.root.to_s, 'file.xls')
+          assert_equal path, IOStreams.join(path).to_s
         end
       end
     end

data/test/test_helper.rb

@@ -35,5 +35,5 @@ end
 
 # Test paths
 root = File.expand_path(File.join(__dir__, '../tmp'))
-IOStreams.add_root_path(:default, File.join(root, 'default'))
-IOStreams.add_root_path(:downloads, File.join(root, 'downloads'))
+IOStreams.add_root(:default, File.join(root, 'default'))
+IOStreams.add_root(:downloads, File.join(root, 'downloads'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.1
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby