fun_with_files 0.0.1

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.3.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "debugger"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bryce Anderson
+
+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,19 @@
+= fun_with_files
+
+Description goes here.
+
+== Contributing to fun_with_files
+ 
+* 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.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'jeweler'
+Jeweler::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"
+  gem.license = "MIT"
+  gem.summary = "A mashup of several File, FileUtils, and Dir class functions, with a peppy, fun-loving syntax"
+  gem.description = <<-DESC
+  A more intuitive syntax for performing a variety of file actions. Examples:
+    "/".fwf_filepath.join('usr', 'bin', 'bash').touch
+    FunWith::Files::FilePath.home("Music").glob(:ext => "mp3", :recurse => true)
+    home = FunWith::Files::FilePath.home
+    home.touch( "Music", "CDs", "BubbleBoyTechnoRemixxxx2011", "01-jiggypalooza.mp3" )
+    home.touch_dir( "Music", "CDs", "ReggaeSmackdown2008" ) do |dir|
+      dir.touch( "liner_notes.txt" )
+      dir.touch( "cover.jpg" )
+      dir.touch( "01-tokin_by_the_sea.mp3" )
+      dir.touch( "02-tourists_be_crazy_mon.mp3" )
+    end
+DESC
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+  
+  
+  gem.files = Dir.glob( File.join( ".", "*.rb" ) ) + 
+              Dir.glob( File.join( ".", "lib", "**", "*.rb" ) ) + 
+              Dir.glob( File.join( ".", "test", "**", "*" ) ) +
+              [ "Gemfile", 
+                "Rakefile", 
+                "LICENSE.txt", 
+                "README.rdoc",
+                "VERSION",
+              ]
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_files #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/files/file_path.rb

@@ -0,0 +1,232 @@
+module FunWith
+  module Files
+    class FilePath < Pathname
+      def initialize( *args )
+        super( File.join( *args ) )
+      end
+
+      # args implicitly joined to cwd
+      def self.cwd( *args )
+        Dir.pwd.fwf_filepath.join( *args )
+      end
+      
+      def self.pwd( *args )
+        self.cwd( *args )
+      end
+      
+      def self.tmpdir( &block )
+        if block_given?
+          Dir.mktmpdir do |d|
+            yield d.fwf_filepath
+          end
+        else
+          Dir.mktmpdir.fwf_filepath
+        end
+      end
+
+      def self.home( *args )
+        Dir.home.fwf_filepath.join( *args )
+      end
+
+      def join( *args, &block )
+        if block_given?
+          yield self.class.new( super(*args) )
+        else
+          self.class.new( super(*args) )
+        end
+      end
+
+      alias :exists? :exist?
+      
+      def up
+        self.class.new( self.join("..") ).expand
+      end
+      
+      alias :down :join
+      
+      # opts:
+      #    :flags  =>  File::FNM_CASEFOLD  
+      #                File::FNM_DOTMATCH  
+      #                File::FNM_NOESCAPE  
+      #                File::FNM_PATHNAME  
+      #                File::FNM_SYSCASE   
+      #                See Dir documentation for details.  
+      #                  Can be given as an integer: (File::FNM_DOTMATCH | File::FNM_NOESCAPE)  
+      #                  or as an array: [File::FNM_CASEFOLD, File::FNM_DOTMATCH]
+      #                
+      #    :class  =>  [self.class] The class of objects you want returned (String, FilePath, ClassLoader, etc.)
+      #                Should probably be a subclass of FilePath or String.  Class.initialize() must accept a string
+      #                [representing a file path] as the sole argument.
+      #
+      #    :recurse => [false] 
+      #    
+      #    :ext => []  A single symbol, or a list containing strings/symbols representing file name extensions.
+      #                No leading periods kthxbai.
+      #    :sensitive => true : do a case sensitive search.  I guess the default is an insensitive search, so
+      #                         the default behaves similarly on Windows and Unix.  Not gonna fight it.
+      #
+      #    :dots => true      : include dotfiles.  Does not include . and ..s unless you also 
+      #                         specify the option :parent_and_current => true.  
+      #     
+      #    If opts[:recurse] / opts[:ext] not given, the user can get the same
+      #    results explicitly with arguments like .glob("**", "*.rb")
+      # 
+      # :all : if :all is the only argument, this is the same as .glob("**", "*")
+      def glob( *args )
+        opts = args.last.is_a?(Hash) ? args.pop : {}
+        
+        flags = case opts[:flags]
+        when NilClass
+          0
+        when Array      # should be an array of integers
+          opts[:flags].inject(0) do |memo, obj|
+            memo | obj
+          end
+        when Integer
+          opts[:flags]
+        end
+        
+        flags |= File::FNM_DOTMATCH if opts[:dots]
+        flags |= File::FNM_CASEFOLD if opts[:sensitive]
+        
+        if args.first == :all
+          args = ["**", "*"]
+        else
+          recurser = opts[:recurse] ? "**" : nil
+          extensions = case opts[:ext]
+          when Symbol, String
+            "*.#{opts[:ext]}"
+          when Array
+            extensions = opts[:ext].map(&:to_s).join(',')
+            "*.{#{extensions}}"
+          when NilClass
+            nil
+          end
+          
+          args += [recurser, extensions]
+          args.compact!
+        end
+        
+        opts[:class] ||= self.class
+        
+        files = Dir.glob( self.join(*args), flags ).map{ |f| opts[:class].new(f) }
+        files.reject!{ |f| f.basename.to_s.match(/^\.{1,2}$/) } unless opts[:parent_and_current]
+        files
+      end
+      
+      def expand
+        self.class.new( File.expand_path( self ) )
+      end
+
+      # Raises error if self is a file and args present.
+      # Raises error if the file is not accessible for writing, or cannot be created.
+      # attempts to create a directory
+      def touch( *args )
+        raise "Cannot create subdirectory to a file" if self.file? && args.length > 0
+        touched = self.join(*args)
+        dir_for_touched_file = case args.length
+          when 0
+            self.up
+          when 1
+            self
+          when 2..Infinity
+            self.join( *(args[0..-2] ) )
+          end
+        
+        self.touch_dir( dir_for_touched_file ) unless dir_for_touched_file.directory?
+        FileUtils.touch( touched )
+        return touched
+      end
+      
+      def touch_dir( *args, &block )
+        touched = self.join(*args)
+        if touched.directory?
+          FileUtils.touch( touched )    # update access time
+        else
+          FileUtils.mkdir_p( touched )  # create directory (and any needed parents)
+        end
+        
+        yield touched if block_given?
+        return touched
+      end
+      
+      def write( content = nil, &block )
+        File.open( self, "w" ) do |f|
+          f << content if content
+          if block_given?
+            yield f
+          end
+        end
+      end
+      
+      def append( content = nil, &block )
+        File.open( self, "a" ) do |f|
+          f << content if content
+          if block_given?
+            yield f
+          end
+        end
+      end
+      
+      def grep( regex )
+        return [] unless self.file?
+        matching = []
+        self.each_line do |line|
+          matching.push( line ) if line.match( regex )
+        end
+        matching
+      end
+
+      # Not the same as zero?
+      def empty?
+        raise Exceptions::FileDoesNotExist unless self.exist?
+        
+        if self.file?
+          File.size( self ) == 0
+        elsif self.directory?
+          self.glob( "**", "*" ).length == 0
+        end
+      end
+      
+      # Does not return a filepath
+      def basename_no_ext
+        self.basename.to_s.split(".")[0..-2].join(".")
+      end
+      
+      def without_ext
+        self.gsub(/\.#{self.ext}$/, '')
+      end
+      
+      # Does not return a filepath.
+      # Does not include leading period
+      def ext
+        split_basename = self.basename.to_s.split(".")
+        split_basename.length > 1 ? split_basename.last : ""
+      end
+      
+      # given an ancestor dir, returns a relative path that takes you from
+      # the ancestor dir to the pathfile.  TODO: expand to arbitrary paths, not
+      # just immediate ancestors.  For example "/usr/bin/bash".relative_to("/usr/bin/zsh") => "." ?
+      # TODO:  look at Pathname.relative_path_from.  Might just want to alias.
+      def relative_to( ancestor_dir )
+        depth = ancestor_dir.to_s.split(File::SEPARATOR).length
+        relative_path = self.to_s.split(File::SEPARATOR)
+        relative_path[(depth)..-1].join(File::SEPARATOR).fwf_filepath
+      end
+      
+      # gsub acts on the filepath, not the file contents
+      def gsub( *args )
+        self.to_s.gsub(*args).fwf_filepath
+      end
+      
+      def gsub!( *args )
+        new_path = self.to_s.gsub(*args)
+        self.instance_variable_set(:@path, new_path)
+      end
+    
+      def fwf_filepath
+        self
+      end
+    end
+  end
+end

data/lib/files/remote_path.rb

@@ -0,0 +1,7 @@
+module FunWith
+  module Files
+    class RemotePath < FilePath
+      
+    end
+  end
+end

data/lib/files/root_path.rb

@@ -0,0 +1,26 @@
+module FunWith
+  module Files
+    module RootPathExtensions
+      def root( *args )
+        if args.length > 0
+          args.unshift( @root_path )
+          FilePath.new( *args )
+        else
+          FilePath.new( @root_path )
+        end
+      end
+      
+      def set_root_path( path )
+        @root_path = FunWith::Files::FilePath.new( path )
+      end
+    end
+
+    class RootPath
+      def self.rootify( target, path )
+        raise "#{target} already responds to :root" if target.respond_to?(:root)
+        target.extend( RootPathExtensions )
+        target.set_root_path( FilePath.new( path ) )
+      end
+    end
+  end
+end

data/lib/files/string_extensions.rb

@@ -0,0 +1,5 @@
+class String
+  def fwf_filepath( *args )
+    FunWith::Files::FilePath.new( self, *args )
+  end
+end

data/lib/fun_with_files.rb

@@ -0,0 +1,12 @@
+require 'pathname'  #stdlib
+require 'tmpdir'
+require 'debugger'
+
+
+require_relative File.join("files", "file_path")
+require_relative File.join("files", "root_path")
+require_relative File.join("files", "remote_path")
+require_relative File.join("files", "string_extensions")
+
+FunWith::Files::RootPath.rootify( FunWith::Files, FunWith::Files::FilePath.new(__FILE__).dirname.up )
+

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fun_with_files'
+
+class Test::Unit::TestCase
+end

data/test/test_file_path.rb

@@ -0,0 +1,62 @@
+require 'helper'
+
+include FunWith::Files
+
+class TestFilePath < Test::Unit::TestCase
+  context "testing basics" do
+    setup do
+      
+    end
+    
+    should "initialize kindly" do
+      f1 = FilePath.new( "/", "bin", "bash" )
+      f2 = "/".fwf_filepath( "bin", "bash" )
+      assert f1.exist?
+      assert f2.exist?
+    end
+    
+    should "go up/down when asked" do
+      f1 = FilePath.new( "/", "home", "users", "monkeylips", "ask_for_floyd" )
+      f2 = FilePath.new( "/", "home", "users" )
+      root = FilePath.new( "/" )
+      
+      assert_equal f2, f1.up.up
+      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_equal f1, f2.down( "monkeylips" ).down( "ask_for_floyd" )
+      assert_equal f1, f2.down( "monkeylips", "ask_for_floyd" )
+      
+      #invoking down didn't change original
+      assert_no_match /ask_for_floyd/, f2.to_s
+    end
+  end
+  
+  context "test glob" do
+    setup do
+      @data_dir = FunWith::Files.root( 'test', 'data' )
+    end
+    
+    should "glob items in test/data directory" do
+      files = @data_dir.glob(:all)
+      assert_equal 3, files.length
+      files = @data_dir.glob(:all, :flags => [File::FNM_DOTMATCH])
+      assert_equal 7, files.length
+    end
+    
+    should "glob with case insensitive flag" do
+      files = @data_dir.glob("grep1.txt")
+      assert_equal 1, files.length
+      
+      # TODO: Case sensitive search?
+      # files = @data_dir.glob("grep1.txt", :flags => [File::FNM_CASEFOLD])
+      # assert_equal 2, files.length
+      # files = @data_dir.glob("grep1.txt", :sensitive => true)
+      # assert_equal 2, files.length
+    end
+  end
+  
+  
+end

data/test/test_root_path.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+include FunWith::Files
+
+class TestRootPath < Test::Unit::TestCase
+  should "add a root to a module" do
+    mod = Module.new
+    path = File.join("/", "usr", "bin")
+    rootify_and_test( mod, path )
+  end
+  
+  should "add a root to an object" do
+    obj = Object.new
+    path = File.join("/", "usr", "bin")
+    rootify_and_test( obj, path )
+  end
+  
+  def rootify_and_test( obj, path )
+    RootPath.rootify( obj, path )
+    assert obj.respond_to?(:root)
+    assert obj.respond_to?(:set_root_path)
+    assert_equal path, obj.root.to_s
+  end
+end

data/test/test_touching.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+include FunWith::Files
+
+class TestTouching < Test::Unit::TestCase
+  context "inside a tmpdir" do
+    setup do
+      @dir = FilePath.tmpdir
+    end
+    
+    teardown do
+      FileUtils.rmtree( @dir )
+    end
+    
+    should "touch a subdirectory" do
+      @subdir = @dir.touch_dir( "Movies", "Basketball", "Shaquille" )
+      assert_kind_of FilePath, @subdir
+      assert @subdir.directory?
+      assert_equal @dir, @subdir.up.up.up
+
+      @subdir_file = @dir.join( "Movies", "Basketball", "Shaquille", "JamNinja.m4v" ).touch
+      assert_kind_of FilePath, @subdir_file
+      assert @subdir_file.file?
+      assert_equal @dir, @subdir_file.dirname.up.up.up
+    end
+    
+    should "accept touch_dir on existing directory" do
+      assert_nothing_raised do
+        @dir.touch_dir
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_files
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "  A more intuitive syntax for performing a variety of file actions.
+  Examples:\n    \"/\".fwf_filepath.join('usr', 'bin', 'bash').touch\n    FunWith::Files::FilePath.home(\"Music\").glob(:ext
+  => \"mp3\", :recurse => true)\n    home = FunWith::Files::FilePath.home\n    home.touch(
+  \"Music\", \"CDs\", \"BubbleBoyTechnoRemixxxx2011\", \"01-jiggypalooza.mp3\" )\n
+  \   home.touch_dir( \"Music\", \"CDs\", \"ReggaeSmackdown2008\" ) do |dir|\n      dir.touch(
+  \"liner_notes.txt\" )\n      dir.touch( \"cover.jpg\" )\n      dir.touch( \"01-tokin_by_the_sea.mp3\"
+  )\n      dir.touch( \"02-tourists_be_crazy_mon.mp3\" )\n    end\n"
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ./lib/files/file_path.rb
+- ./lib/files/remote_path.rb
+- ./lib/files/root_path.rb
+- ./lib/files/string_extensions.rb
+- ./lib/fun_with_files.rb
+- ./test/data/empty.txt
+- ./test/data/grep1.txt
+- ./test/data/grep2.txt
+- ./test/helper.rb
+- ./test/test_file_path.rb
+- ./test/test_root_path.rb
+- ./test/test_touching.rb
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+homepage: http://github.com/darthschmoo/fun_with_files
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1077870850940227410
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A mashup of several File, FileUtils, and Dir class functions, with a peppy,
+  fun-loving syntax
+test_files: []