fun_with_files 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf6595c5de6273e8d7fb668ddc70d161a1354c4c
-  data.tar.gz: 4938516e5ad413f8ffa722985d963fcb6eb1f039
+  metadata.gz: 6d1ccc274aea1937c63f81c2fe7897349aadbdc9
+  data.tar.gz: 5ae174de323cfa4aba42d459b5848416c173bcfa
 SHA512:
-  metadata.gz: 09db56d93b3cde0407d1f0e7d8691ab0373158301828ee5af974c1cb259369c2f8a5c43c79eb37352760bede2d5d4d4f310887b9129aba917100109643138787
-  data.tar.gz: 06690ccc56d90230e7d8c55a9f9372cc74dc9f6ff1104fe7f8ea26c1efdb601b5ff221a0c4250630d40ab7e2a065cc71ff124545de1ed1a66405fc591ffbc49a
+  metadata.gz: 8125f7794e66f690c5180e88f6d827463d251878417e1689e2360bac84ad9d9909530a2c299409468558320817763a2d66ac4bf45308e6cacdca26363a63eda4
+  data.tar.gz: 13c43cb5c978693715ffa1a21c72c07c464eaab0deb4260826b49d120748967ed7fd20c65234888347a2a96ab59529a6517a10c304dc99d9cf0bae33046661c1

data/Gemfile

@@ -10,9 +10,9 @@ group :development do
   # gem "shoulda", "~> 3", ">= 3.5"
   # gem "rdoc", "~> 3.12"
   # gem "bundler", "~> 1.5"
-  # gem "jeweler", "~> 2.0"
+  # gem "juwelier", "~> 2.0"
   # gem "debugger", "~> 1.6"
-  gem "fun_with_testing", "~> 0.0"
+  gem "fun_with_testing", "~> 0.0", ">= 0.0.5"
 end
 
 gem "xdg", "~> 2"

data/README.rdoc

@@ -108,7 +108,7 @@ DirectoryBuilder is a class for defining and populating a file hierarchy with re
 
 == Contributing to fun_with_files
 
-Boilerplate from Jeweler, but seems to make sense.
+Boilerplate from Juwelier, but seems to make sense.
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.

data/Rakefile

@@ -14,8 +14,8 @@ end
 
 require 'rake'
 
-# require 'jeweler'
-Jeweler::Tasks.new do |gem|
+# require 'juwelier'
+Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "fun_with_files"
   gem.homepage = "http://github.com/darthschmoo/fun_with_files"
@@ -50,7 +50,7 @@ DESC
               ]
 end
 
-Jeweler::RubygemsDotOrgTasks.new
+Juwelier::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/lib/fun_with/files/core_extensions/file.rb

@@ -1,5 +1,17 @@
-class File < IO
-  def fwf_filepath( *args )
-    FunWith::Files::FilePath.new( self.path, *args )
+module FunWith
+  module Files
+    module CoreExtensions
+      module File
+        def fwf_filepath( *args )
+          FunWith::Files::FilePath.new( self.path, *args )
+        end
+        
+        # I'm not sure this is the most intuitive meaning, but it seems better than
+        # delegating to Object.
+        def fwf_blank?
+          ! self.fwf_filepath.exist?
+        end
+      end
+    end
   end
 end

data/lib/fun_with/files/core_extensions/set.rb

@@ -0,0 +1,12 @@
+module FunWith
+  module Files
+    module CoreExtensions
+      module Set
+        def fwf_blank?
+          self.length == 0
+        end
+      end
+    end
+  end
+end
+

data/lib/fun_with/files/core_extensions/true_class.rb

@@ -0,0 +1,11 @@
+module FunWith
+  module Files
+    module CoreExtensions
+      module TrueClass
+        def fwf_blank?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/files/digest_methods.rb

@@ -1,5 +1,7 @@
 module FunWith
   module Files
+    DIGEST_METHODS = [:md5, :sha1, :sha2, :sha224, :sha256, :sha384, :sha512]
+    
     module DigestMethods
       def md5
         digest( Digest::MD5 )
@@ -28,10 +30,27 @@ module FunWith
       def sha512
         digest( Digest::SHA512 )
       end
-
+      
       def digest( digest_class = Digest::MD5 )
         self.file? ? digest_class.hexdigest( self.read ) : ""
       end
+      
+      # Takes any of the above-named digest functions, determines
+      # whether the file matches a given digest string.
+      # 
+      # Multiple digests can be given simultaneously.  All must pass.
+      #
+      # TODO: how to get around the :md6 problem?  That is, where the
+      # user is sending the wrong key, and hence not getting false back
+      def valid_digest?( opts )
+        for method, digest in opts
+          if DIGEST_METHODS.include?( method )
+            return false unless self.send( method ) == digest
+          end
+        end
+        
+        return true
+      end 
     end
   end
 end

data/lib/fun_with/files/directory_builder.rb

@@ -9,6 +9,7 @@ module FunWith
       def initialize( path )
         @paths = []
         @current_path = path.fwf_filepath
+        @current_file = nil
         make_path
       end
       
@@ -79,7 +80,7 @@ module FunWith
       # end
       
       # if file not given, the result is appended to the current file.
-      def download( url, file = nil )
+      def download( url, file = nil, opts = {} )
         if file
           if file.fwf_filepath.relative?
             file = FunWith::Files::FilePath.new( @current_path, file )
@@ -89,7 +90,7 @@ module FunWith
             download_to_target( url, f )
           end
         elsif @current_file
-          download_to_target( url, @current_file )
+          download_to_target( url, @current_file, opts )
         else
           puts "No current file to append #{url} to."
         end
@@ -132,8 +133,8 @@ module FunWith
         @current_file = nil
       end
       
-      def download_to_target( url, file )
-        Downloader.new.download( url, file )
+      def download_to_target( url, file, signatures = {} )
+        Downloader.new.download( url, file, signatures )
       end
     end
   end

data/lib/fun_with/files/downloader.rb

@@ -1,21 +1,46 @@
 require 'open-uri'            # needed by Utils::Downloader
 require 'net/http'
+require 'net/https'
+require 'openssl'
 require 'timeout'
 
 
 module FunWith
   module Files
     class Downloader
+      def self.download( *args )
+        self.new.download( *args )
+      end
+      
       # stolen from:
       # http://stackoverflow.com/questions/2263540/how-do-i-download-a-binary-file-over-http-using-ruby
-      def download( url, io )
+      
+      # options:
+      #    :md5 => <digest>  :  Running md5 on the downloaded file should result in an error
+      #    :sha256 => <digest> : 
+      def download( url, io, opts = {} )
         @uri = URI.parse( url )
         @io  = io
 
         open( url ) do |f|
           @io << f.read
         end
-
+        
+        io_path = @io.fwf_filepath
+        
+        if io_path.file?
+          if io_path.valid_digest?( opts )
+            true
+          else
+            warn( "File may not have downloaded correctly, or is validating against a bad hash #{io_path} #{opts.inspect}")
+            false
+          
+          end
+        else
+          warn( "File did not download correctly, or was deleted: #{io_path}")
+          false
+        end
+        
         # @io << Net::HTTP.get( @uri )
 
         # Net::HTTP.start( @uri.host, @uri.port ) do |http| 
@@ -28,6 +53,10 @@ module FunWith
         #     end
         #   end
         # end
+        
+        
+        
+        
       rescue Exception => e
         handle_network_errors( e )
       end

data/lib/fun_with/files/file_orderer.rb

@@ -38,6 +38,8 @@ module FunWith
           
           collector
         end
+        
+        ordered_files
       end
     end
   end

data/lib/fun_with/files/file_path.rb

@@ -1,10 +1,9 @@
 module FunWith
   module Files
     class FilePath < Pathname
-
       SUCC_DIGIT_COUNT = 6
       DEFAULT_TIMESTAMP_FORMAT = "%Y%m%d%H%M%S%L"
-      
+
       def initialize( *args )
         super( File.join( *args ) )
       end
@@ -25,9 +24,22 @@ module FunWith
           Dir.mktmpdir.fwf_filepath
         end
       end
+      
+      # The file is created within a temporary directory
+      def self.tmpfile( ext = :tmp, &block )
+        filename = rand( 2 ** 64 ).to_s(16).fwf_filepath.ext( ext )
+        
+        if block_given?
+          self.tmpdir do |tmp|
+            yield tmp.join( filename ).touch
+          end
+        else
+          self.tmpdir.join( filename ).touch
+        end
+      end
 
       def join( *args, &block )
-        joined_path = self.class.new( super(*args) )
+        joined_path = self.class.new( super( *(args.map(&:to_s) ) ) )
         yield joined_path if block_given?
         joined_path
       end
@@ -273,6 +285,8 @@ module FunWith
           end
         end
       end
+      
+      alias :<< :append
 
       # Returns a [list] of the lines in the file matching the given file.  Contrast with
 
@@ -302,12 +316,84 @@ module FunWith
       end
 
       # Does not return a filepath
+      #
+      # TODO: Why not?
       def basename_no_ext
         self.basename.to_s.split(".")[0..-2].join(".")
       end
 
-      def without_ext
-        self.gsub(/\.#{self.ext}$/, '')
+      # Returns the path, stripped of the final extension (.ARG).
+      # The result cannot destroy a dotfile or leave an empty
+      # path
+      #   "~/.bashrc".without_ext( .bashrc )  => "~/.bashrc",
+      # if an argument is given, the final ext must match
+      # the given argument, or a copy of the unaltered path
+      # is returned.
+      #
+      # Also:
+      #    Don't add a leading ./ when the original didn't have one
+      #    Case InSeNSItive, because I can't think of a use case for "only"
+      #       strip the extension if the capitalization matches
+      #    Chews up any number of leading '.'s
+      #    For the moment, 
+      def without_ext( ext_val = nil )
+        ext_chopper_regex = if ext_val.fwf_blank?
+                              /\.+\w+$/i             # any ending "word characters"
+                            else
+                              # It's okay for the caller to make the leading period explicit
+                              ext_val = ext_val.to_s.gsub( /^\./, '' )
+                              /\.+#{ext_val}+$/i
+                            end
+
+        chopped_str = @path.gsub( ext_chopper_regex, "" )
+        
+        do_we_chop = if chopped_str == @path   # no change, then sure, why not?
+                       true
+                     elsif chopped_str.fwf_blank? || chopped_str[-1] == self.separator() || chopped_str[-1] == "."
+                       false
+                     else
+                       true
+                     end
+                     
+        self.class.new( do_we_chop ? chopped_str : @path )
+        
+        # # If the results fail to live up to some pre-defined
+        #
+        #
+        #
+        # # do we or don't we?
+        # chop_extension = true
+        #
+        # #   Don't if there's an extension mismatch
+        # #   Don't if the remainder is a /. (original was a dot_file)
+        #
+        #
+        #
+        #
+        #
+        #
+        # _dirname, _basename, _ext = self.dirname_and_basename_and_ext
+        # debugger if _basename =~ "hello"
+        # ext_val = ext_val.to_s
+        #
+        # # 1) Only perform if the extension match the one given (or was a blank ext given?)
+        #
+        #
+        #
+        # new_path = @path.clone
+        #
+        # current_ext = self.ext
+        #
+        # e = e.to_s
+        #
+        # if e.fwf_present?
+        #   new_path.gsub!( /\.#{e}$/, "" )
+        #   result = self.gsub(/#{ not_beginning_of_line_or_separator}\.#{self.ext}$/, '')
+        # else
+        #   self.clone
+        # end
+        #
+        # self.class.new( new_path )
       end
 
       # Two separate modes.  With no arguments given, returns the current extension as a string (not a filepath)
@@ -584,6 +670,9 @@ module FunWith
       #   end
       #   # otherwise we're installing a separator
       # end
+      def separator
+        File::SEPARATOR
+      end
 
       protected
       # TODO: Need a separate API for user to call

data/lib/fun_with_files.rb

@@ -4,15 +4,59 @@ require 'pathname'    # stdlib
 require 'tmpdir'      # Dir.tmpdir
 
 
-for fil in ["string", "array", "false", "hash", "nil", "object"]
-  require_relative File.join( "fun_with", "files", "core_extensions", fil )
-end
+# Do the bare minimum to get FilePath.requir working
+# file_path = File.join( "fun_with", "files", "file_path" )
+# string_behavior = File.join( "fun_with", "files", "string_behavior" )
+#
+#
+# require_relative file_path
+# require_relative string_behavior
+#
+# FunWith::Files::FilePath.send( :include, FunWith::Files::StringBehavior )
+# FunWith::Files::FilePath.new( "fun_with" ).requir
+#
+# debugger
+
+
+
+core_extension_folder = File.join( "lib", "fun_with", "files", "core_extensions" )
 
-for klass in ["String", "Object", "NilClass", "Hash", "FalseClass", "Array"]
-  Kernel.const_get(klass).send( :include, FunWith::Files::CoreExtensions.const_get(klass))  
+for fil in Dir.glob( File.join( core_extension_folder, "*.rb" ) )
+  # Dir.glob targets the root directory, while require_relative is relative to lib/,
+  # so the [4..-4] removes the leading lib/ and the trailing extension to make it
+  # require_relative-friendly.
+  require_path = fil[4..-4]   # 
+  basename = File.basename( fil )[0..-4]
+  # debugger if basename =~ /class/
+  
+  target_class_str = basename.split( "_" ).map(&:capitalize).join("")
+  target_class = Kernel.const_get( target_class_str )
+  mixin_class_str  = "FunWith::Files::CoreExtensions::#{target_class_str}"
+
+  # puts "Basename: #{basename}"
+  # puts "Mixin: " + mixin_class_str.inspect
+  # puts "Target: #{target_class}"
+  # puts "requiring: #{require_path}"
+  require_relative require_path
+  mixin_class = Kernel.const_get( mixin_class_str )
+  # puts mixin_class.to_s
+  
+  target_class.send( :include, mixin_class )
 end
 
 
+
+# for fil in ["string", "array", "false", "hash", "nil", "object",]
+#   require_relative File.join( "fun_with", "files", "core_extensions", fil )
+# end
+#
+# for klass in ["String", "Object", "NilClass", "Hash", "FalseClass", "Array", "Set"]
+#   puts klass
+#   debugger if klass == "Set"
+#   Kernel.const_get(klass).send( :include, FunWith::Files::CoreExtensions.const_get(klass))
+# end
+#
+
 for fil in ["file_path", "string_behavior", "file_manipulation_methods", "file_permission_methods", "digest_methods", "file_requirements"]
   require_relative File.join( "fun_with", "files", fil )
 end

data/test/test_core_extensions.rb

@@ -26,6 +26,7 @@ class TestCoreExtensions < FunWith::Files::TestCase
     should "fwf_blank? nicely." do
       assert_equal false, { 1 => 2 }.fwf_blank?
       assert_equal true, {}.fwf_blank?
+      assert_equal true, true.fwf_present?
     end
   end
 end

data/test/test_descent.rb

@@ -7,11 +7,11 @@ class TestDescent < FunWith::Files::TestCase
     ascent = []
     descent = []
     
-    FunWith::Files.root.ascend do |path|
+    root.ascend do |path|
       ascent << path
     end
     
-    FunWith::Files.root.descend do |path|
+    root.descend do |path|
       descent << path
     end
 

data/test/test_directory_builder.rb

@@ -54,7 +54,7 @@ class TestDirectoryBuilder < FunWith::Files::TestCase
         gemfile = b.current_path.join("Gemfile")
         assert gemfile.exist?
         assert !gemfile.zero?
-        assert_equal 1, gemfile.grep( /jeweler/ ).length
+        assert_equal 1, gemfile.grep( /juwelier/ ).length
       end
     end
   
@@ -72,7 +72,7 @@ class TestDirectoryBuilder < FunWith::Files::TestCase
         DirectoryBuilder.tmpdir do |b|
           gist_url = "http://bannedsorcery.com/downloads/testfile.txt"
           gist_text = "This is a file\n==============\n\n**silent**: But _bold_! [Link](http://slashdot.org)\n"
-          b.download( gist_url, "gist.txt" )
+          b.download( gist_url, "gist.txt", :md5 => "f498e76ea5690a4c29ef97d0a1d8e58e", :sha1 => "ccabf74107cba7ad69f70e45c04c3876e7f34630" )
         
           b.file( "gist.txt.2" ) do
             b.download( gist_url )

data/test/test_file_manipulation.rb

@@ -13,7 +13,7 @@ class TestFileManipulation < FunWith::Files::TestCase
     
     should "copy LICENSE.txt" do
       copied = @license.cp( "test", "tmp" )
-      assert_match /LICENSE\.txt/, copied.to_s
+      assert_match( /LICENSE\.txt/, copied.to_s ) 
       assert_file copied
       assert_file_has_content copied
     end
@@ -120,7 +120,7 @@ class TestFileManipulation < FunWith::Files::TestCase
       
       file_def = file_abc.cp( dir_def )
       
-      assert_match /abc\.txt/, file_def.path
+      assert_match( /abc\.txt/, file_def.path )
       assert_file_contents file_def, /rent/
       
       

data/test/test_file_path.rb

@@ -32,7 +32,7 @@ class TestFilePath < FunWith::Files::TestCase
       assert_equal root, f1.up.up.up.up.up.up.up
       
       #invoking up didn't change original
-      assert_match /ask_for_floyd/, f1.to_s
+      assert_match( /ask_for_floyd/, f1.to_s )
       
       assert_equal f1, f2.down( "monkeylips" ).down( "ask_for_floyd" )
       assert_equal f1, f2.down( "monkeylips", "ask_for_floyd" )
@@ -216,34 +216,82 @@ class TestFilePath < FunWith::Files::TestCase
     end
   end
   
-  context "test ext()" do
+  context "testing extension methods" do
     setup do
-      @path = "hello.txt".fwf_filepath
+      @hello_path = "hello.txt".fwf_filepath
+      @dot_path0 = ".config".fwf_filepath
+      @dot_path1 = "~/.ssh".fwf_filepath
     end
     
-    should "not change path when sent nil as an argument" do
-      assert_equal @path.path, @path.ext( nil ).path
-    end
+    context "test ext()" do
     
-    should "append when given symbol" do
-      assert_equal @path.path + ".tgz", @path.ext( :tgz ).path
-    end
+      should "not change path when sent nil as an argument" do
+        assert_equal @hello_path.path, @hello_path.ext( nil ).path
+      end
     
-    should "append when given string" do
-      assert_equal @path.path + ".tgz", @path.ext( 'tgz' ).path
-    end
+      should "append when given symbol" do
+        assert_equal @hello_path.path + ".tgz", @hello_path.ext( :tgz ).path
+      end
+    
+      should "append when given string" do
+        assert_equal @hello_path.path + ".tgz", @hello_path.ext( 'tgz' ).path
+      end
+    
+      should "append correctly when given leading ." do
+        assert_equal @hello_path.path + ".tgz", @hello_path.ext( '.tgz' ).path
+      end
     
-    should "append correctly when given leading ." do
-      assert_equal @path.path + ".tgz", @path.ext( '.tgz' ).path
+      should "append multiple extensions as separate args" do
+        assert_equal @hello_path.path + ".backup.tar.gz", @hello_path.ext( :backup, "tar", nil, ".gz" ).path
+      end
+    
+      should "append multiple extensions as a single string" do
+        assert_equal @hello_path.path + ".backup.tar.gz", @hello_path.ext( ".backup.tar.gz" ).path
+      end
     end
     
-    should "append multiple extensions as separate args" do
-      assert_equal @path.path + ".backup.tar.gz", @path.ext( :backup, "tar", nil, ".gz" ).path
+    context "test without_ext()" do
+      setup do
+
+      end
+      
+      should "pop the extension (normal)" do
+        #debugger
+        assert_equal "hello", @hello_path.without_ext.to_s
+        assert_equal "hello", @hello_path.without_ext("txt").path
+        assert_equal "hello", @hello_path.without_ext(".txt").path
+        assert_equal "hello.txt", @hello_path.without_ext(".html").path
+        assert_equal "hello.txt", @hello_path.without_ext("html").path
+        
+        assert_equal "hello", @hello_path.without_ext(:txt).path
+      end
+      
+      should "not affect dot files" do
+        assert_equal ".config", @dot_path0.without_ext.path
+        assert_equal ".config", @dot_path0.without_ext("config").path
+        assert_equal ".config", @dot_path0.without_ext(".config").path
+        assert_equal ".config", @dot_path0.without_ext(:config).path
+      end
     end
     
-    should "append multiple extensions as a single string" do
-      assert_equal @path.path + ".backup.tar.gz", @path.ext( ".backup.tar.gz" ).path
+    # Why does it return a filepath for the dirname piece, strings for the other two pieces?
+    context "test dirname_and_basename_and_ext" do
+    end
+  end
+  
+  context "test join()" do
+    setup do 
+      @path = "/".fwf_filepath
     end
     
+    should "accept all manner of arguments" do
+      expected = "/bin/0/file.rb".fwf_filepath
+      result = @path.join( :bin, 0, "file.rb" )
+      
+      assert_equal expected, result
+      
+      result = @path / :bin / 0 / "file.rb"
+      assert_equal expected, result
+    end
   end
 end

data/test/test_fun_with_files.rb

@@ -26,7 +26,7 @@ class TestFunWithFiles < FunWith::Files::TestCase
       assert_respond_to( FunWith::Files, :root )
       assert_respond_to( FunWith::Files, :version )
       
-      assert_equal "0.0.13", FunWith::Files.version   # Gotta change with every point release.  Ick.
+      assert_equal "0.0.14", FunWith::Files.version   # Gotta change with every point release.  Ick.
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_files
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Bryce Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-26 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdg
@@ -28,6 +28,9 @@ dependencies:
   name: fun_with_testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
@@ -35,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
@@ -59,12 +65,14 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - "./lib/fun_with/files/core_extensions/array.rb"
-- "./lib/fun_with/files/core_extensions/false.rb"
+- "./lib/fun_with/files/core_extensions/false_class.rb"
 - "./lib/fun_with/files/core_extensions/file.rb"
 - "./lib/fun_with/files/core_extensions/hash.rb"
-- "./lib/fun_with/files/core_extensions/nil.rb"
+- "./lib/fun_with/files/core_extensions/nil_class.rb"
 - "./lib/fun_with/files/core_extensions/object.rb"
+- "./lib/fun_with/files/core_extensions/set.rb"
 - "./lib/fun_with/files/core_extensions/string.rb"
+- "./lib/fun_with/files/core_extensions/true_class.rb"
 - "./lib/fun_with/files/digest_methods.rb"
 - "./lib/fun_with/files/directory_builder.rb"
 - "./lib/fun_with/files/downloader.rb"
@@ -136,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A mashup of several File, FileUtils, and Dir class functions, with a peppy,