filestr 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= Version history
+
+[0.0.1] Initial version.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 tero.isannainen@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,115 @@
+= FileStr
+
+* Introduction
+* Usage
+* Methods
+
+
+= Introduction
+
+FileStr is a library that augments String objects with File, Dir, and
+FileUtils capabilities (class methods). The String (self) is passed as
+the first argument to original class methods. With FileStr you can use
+"normal" strings as filename/dirname objects.
+
+It is sometimes inconvenient to write
+
+  File.exist?( 'report.txt' )
+
+when you could instead do
+
+  'report.txt'.f_exist?
+
+The class methods from File are prefixed with "f_", Dir methods with
+"d_", and FileUtils methods with "u_". There are some special versions
+of methods which are prefixed with "s_" (See: Methods).
+
+FileStr class inherits String class, i.e. it has all String
+methods. It also includes all the augmenting methods. You can keep
+the augmenting methods within FileStr class, or you can explicitly
+make them also part of String class.
+
+
+= Usage
+
+After requiring the "filestr" library, you have FileStr class defined
+which includes methods from File, Dir, and FileUtils.
+
+You can create a FileStr object from String:
+
+  require 'filestr'
+  fs = 'report.txt'.to_fs
+
+or
+
+  fs = 'report.txt'.fs
+
+Then you can check if the file exists?
+
+  fs.f_exist?
+
+If you execute:
+
+  String.fileStr
+
+you get all augmenting methods straight to String class and you can
+use strings directly. For example:
+
+  'report.txt'.f_exist?
+
+or
+
+  'bin'.d_exist?
+
+to test if there is a sub-directory called "bin".
+
+You can rename (move) a file with:
+
+  'report.txt'.u_mv( 'history.txt' )
+
+
+= Methods
+
+Almost all class methods from File and Dir are imported. A filtered
+selection is taken from FileUtils.
+
+Some methods from File and Dir doesn't take a name (filename, dirname)
+as the first argument. There are modified versions of these methods
+within FileStr where the "name" argument comes from self. These method
+are prefixed with "s_".
+
+List of special methods:
+  s_chmod, s_chown, s_fnmatch
+
+You can change a mode of a file:
+
+  'report.txt'.s_chmod( 0777 )
+
+There is also a special version of Dir.glob, called s_glob. s_glob
+concatenates the string (self) to the given "pattern" argument, and
+passed this to Dir.glob.
+
+The complete list of methods coming directly from File, Dir, and
+FileUtils is:
+
+  f_binread, f_binwrite, f_copy_stream, f_foreach, f_read,
+  f_readlines, f_sysopen, f_write, f_absolute_path, f_atime,
+  f_basename, f_birthtime, f_blockdev?, f_chardev?, f_ctime,
+  f_delete, f_directory?, f_dirname, f_executable?,
+  f_executable_real?, f_exist?, f_exists?, f_expand_path,
+  f_extname, f_filename, f_file?, f_ftype, f_grpowned?,
+  f_identical?, f_join, f_link, f_lstat, f_mtime, f_new, f_open,
+  f_owned?, f_path, f_pipe?, f_readable?, f_readable_real?,
+  f_readlink, f_realdirpath, f_realpath, f_rename, f_setgid?,
+  f_setuid?, f_size, f_size?, f_socket?, f_split, f_stat,
+  f_sticky?, f_symlink, f_symlink?, f_truncate, f_unlink,
+  f_world_readable?, f_world_writable?, f_writable?,
+  f_writable_real?, f_zero?, d_chdir, d_chroot, d_delete,
+  d_entries, d_exist?, d_exists?, d_foreach, d_mkdir, d_new,
+  d_open, d_rmdir, d_unlink, u_cd, u_cmp, u_mkdir_p, u_ln_s,
+  u_cp, u_cp_r, u_mv, u_rm, u_rm_f, u_rm_r, u_rm_rf, u_touch,
+  u_uptodate?
+
+You can use the original documentation of the class methods
+above. Just imagine the string (self) as being the first argument, and
+the rest are as in documentation.

data/lib/filestr.rb

@@ -0,0 +1,228 @@
+# {FileStr} is library that augments String objects with File, Dir,
+# and FileUtils capabilities (class methods). The String (self) is
+# passed as the first argument to original class methods.
+
+
+require          'fileutils'
+
+
+# {FileStr} class related module which maps missing methods to
+# {FileStr} defined methods.
+module FileStrModule
+
+    # Call FileStr supported methods (if available).
+    def method_missing( m, *args, &block )
+
+        klass = FileStr.support[ m ]
+
+        if klass
+            # Generate the actual class method name.
+            cm = m.to_s[2..-1].to_sym
+            klass.send( cm, self, *args, &block )
+        else
+            raise NoMethodError
+        end
+    end
+
+
+    # ------------------------------------------------------------
+    # File class support:
+
+    # Chmod with mode_int.
+    #
+    # @param mode_int [Integer] New file mode.
+    def s_chmod( mode_int )
+        File.chmod( mode_int, self )
+    end
+
+    # Chown with owner_int, group_int.
+    #
+    # @param owner_int [Integer] New file owner.
+    # @param group_int [Integer] New file group.
+    def s_chown( owner_int, group_int )
+        File.chown( owner_int, group_int, self )
+    end
+
+    # Fnmatch to pattern with flags.
+    #
+    # @param pattern [String]   Glob patttern for matching.
+    # @param flags   [Constant] Flags for matching.
+    def s_fnmatch( pattern, *flags )
+        File.fnmatch( pattern, self, *flags )
+    end
+
+
+    # ------------------------------------------------------------
+    # Dir class support:
+
+    # Glob with self as base string.
+    #
+    # @param pattern [String] Suffix of glob pattern (concat to self).
+    def s_glob( pattern = "", *args, &block )
+        Dir.glob( self + pattern, *args, &block )
+    end
+
+end
+
+
+# Enable use of File, Dir, and FileUtils class methods straight from
+# {FileStr}/String objects.
+class FileStr < String
+
+    include FileStrModule
+
+
+    # Extend a class (String) with {FileStr} features.
+    #
+    # @param klass [Constant] Class to extend.
+    def FileStr.extend( klass = String )
+        klass.send( :include, FileStrModule )
+    end
+
+    # Return hash describing {FileStr} provided File/Dir support.
+    def FileStr.support
+        @@fileStrSupport
+    end
+
+    # Supported methods from File, Dir, and FileUtils.
+    @@fileStrSupport = {
+
+        # File Methods from IO.
+        :f_binread          => File,
+        :f_binwrite         => File,
+        :f_copy_stream      => File,
+        # :for_fd => File, # NA
+        :f_foreach          => File,
+        # :new => File,    # NA
+        # :open => File,   # NA
+        # :pipe => File,   # NA
+        # :popen => File,  # NA
+        :f_read             => File,
+        :f_readlines        => File,
+        # :select => File, # NA
+        :f_sysopen          => File,
+        # :try_convert => File, # NA
+        :f_write            => File,
+
+        # File Methods.
+        :f_absolute_path    => File,
+        :f_atime            => File,
+        :f_basename         => File,
+        :f_birthtime        => File,
+        :f_blockdev?        => File,
+        :f_chardev?         => File,
+        # :chmod => File, # s-version
+        # :chown => File, # s-version
+        :f_ctime            => File,
+        :f_delete           => File,
+        :f_directory?       => File,
+        :f_dirname          => File,
+        :f_executable?      => File,
+        :f_executable_real? => File,
+        :f_exist?           => File,
+        :f_exists?          => File,
+        :f_expand_path      => File,
+        :f_extname          => File,
+        :f_filename         => File,
+        :f_file?            => File,
+        # :fnmatch => File,  # s-version
+        # :fnmatch? => File, # NA
+        :f_ftype            => File,
+        :f_grpowned?        => File,
+        :f_identical?       => File,
+        :f_join             => File,
+        # :lchmod => File,
+        # :lchown => File,
+        :f_link             => File,
+        :f_lstat            => File,
+        # :mkfifo => File, # Unknown
+        :f_mtime            => File,
+        :f_new              => File,
+        :f_open             => File,
+        :f_owned?           => File,
+        :f_path             => File,
+        :f_pipe?            => File,
+        :f_readable?        => File,
+        :f_readable_real?   => File,
+        :f_readlink         => File,
+        :f_realdirpath      => File,
+        :f_realpath         => File,
+        :f_rename           => File,
+        :f_setgid?          => File,
+        :f_setuid?          => File,
+        :f_size             => File,
+        :f_size?            => File,
+        :f_socket?          => File,
+        :f_split            => File,
+        :f_stat             => File,
+        :f_sticky?          => File,
+        :f_symlink          => File,
+        :f_symlink?         => File,
+        :f_truncate         => File,
+        # :umask => File, # NA
+        :f_unlink           => File,
+        # :utime => File, # NA
+        :f_world_readable?  => File,
+        :f_world_writable?  => File,
+        :f_writable?        => File,
+        :f_writable_real?   => File,
+        :f_zero?            => File,
+
+        # Dir Methods.
+        :d_chdir            => Dir,
+        :d_chroot           => Dir,
+        :d_delete           => Dir,
+        :d_entries          => Dir,
+        :d_exist?           => Dir,
+        :d_exists?          => Dir,
+        :d_foreach          => Dir,
+        # :getwd => Dir, # NA
+        # :glob => Dir,  # s-version
+        # :home => Dir,  # NA
+        :d_mkdir            => Dir,
+        :d_new              => Dir,
+        :d_open             => Dir,
+        # :pwd => Dir,   # NA
+        :d_rmdir            => Dir,
+        :d_unlink           => Dir,
+
+        # FileUtils Methods (selection).
+        :u_cd               => FileUtils,
+        :u_cmp              => FileUtils,
+        :u_mkdir_p          => FileUtils,
+        :u_ln_s             => FileUtils,
+        :u_cp               => FileUtils,
+        :u_cp_r             => FileUtils,
+        :u_mv               => FileUtils,
+        :u_rm               => FileUtils,
+        :u_rm_f             => FileUtils,
+        :u_rm_r             => FileUtils,
+        :u_rm_rf            => FileUtils,
+        :u_touch            => FileUtils,
+        :u_uptodate?        => FileUtils,
+    }
+
+end
+
+
+
+# Extend String with capability to convert itself to {FileStr}.
+class String
+
+    # Use FileStr method directly in String.
+    def String.fileStr
+        FileStr.extend( String )
+    end
+
+    # Convert String to FileStr object.
+    def toFileStr
+        FileStr.new( self )
+    end
+
+    alias to_fs toFileStr
+
+    alias fs toFileStr
+
+end
+
+require_relative 'version'

data/lib/version.rb

@@ -0,0 +1,6 @@
+class FileStr
+    VERSION = "0.0.1"
+    def FileStr.version
+        FileStr::VERSION
+    end
+end

data/test/test_all.rb

@@ -0,0 +1,55 @@
+require 'test/unit'
+
+require_relative '../lib/filestr'
+
+
+class FileStrTest < Test::Unit::TestCase
+
+    def setup
+        Dir.chdir 'test'
+    end
+
+    def teardown
+        Dir.chdir '..'
+    end
+
+    def test_filestr
+        f = "filestr.txt".to_fs
+
+        f.u_touch
+        assert_true( f.f_exist? )
+
+        f.u_rm_f
+        assert_false( f.f_exist? )
+    end
+
+
+    # Check that we are testing the current number of methods.
+    def test_string
+        String.fileStr
+
+        f = "string.txt"
+
+        f.u_touch
+        assert_true( f.f_exist? )
+
+        txt = "basic testing text\n"
+        f.f_write txt
+        assert_equal( txt, f.f_read )
+
+        list = './'.s_glob('*')
+        assert_equal( [ './string.txt', './test_all.rb' ], list )
+
+        d = 'test_dir'
+        d.d_mkdir
+        assert_true( d.d_exist? )
+        d.d_rmdir
+        assert_false( d.d_exist? )
+
+        fs = f.fs
+
+        fs.u_rm_f
+        assert_false( fs.f_exist? )
+    end
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: filestr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tero Isannainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies: []
+description: ! 'FileStr is a library that augments String objects with File, Dir,
+  and
+
+  FileUtils capabilities (class methods). The String (self) is passed as
+
+  the first argument to original class methods. With FileStr you can use
+
+  *normal* strings as filename/dirname objects.'
+email: tero.isannainen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+files:
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- lib/filestr.rb
+- lib/version.rb
+- test/test_all.rb
+homepage: 
+licenses:
+- Ruby
+post_install_message: Check README...
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Augment Strings with File, Dir, and FileUtils capabilities.
+test_files: []