files 0.2.1 → 0.3.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea

data/Gemfile

@@ -5,5 +5,5 @@ gemspec
 
 group :development do
   gem "rake"
-  gem "wrong"
-end
+  gem "wrong", ">=0.6.2"
+end

data/README.md

@@ -22,7 +22,7 @@ The mixin mode is a fairly clean API, suitable for use in unit tests. After `inc
       end
     end
 
-    files.root           # returns the path to the temporary directory, creating it if necessary
+    @files.root           # returns the path to the temporary directory, creating it if necessary
 
 ## Usage (bare function mode)
 
@@ -42,6 +42,13 @@ In bare function mode, you call the `Files` method, which doesn't pollute the cu
       end
     end                         # "Files" returns a string with the path to the directory
 
+    src = '/path/to/some/data' # use '/path/to/some/data/.' to only copy contents of data folder, not data folder itself.
+
+    # creates a folder called 'target/$timestamp' relative to pwd
+    dir = Files.create :path => "target" do
+        dir "foo", :src => src do # creates 'target/$timestamp/foo', and copies src into foo [but should it copy the dir or the contents?]
+        end
+    end
 
 see `test/files_test.rb` for more usage examples
 
@@ -53,14 +60,13 @@ see `test/files_test.rb` for more usage examples
 * if the first argument to `file` is a String, then a new file is made
   * the content of the new file is either a short, descriptive message, or whatever you passed as the second argument
 * if the argument to `file` is a Ruby `File` object, then it copies the named file into the new location
+* To copy another directory to one created by this module, specifying `:src` to `dir` method
+   * [Not sure if this is implemented right... should it copy the *dir* or its *contents*?]
 
 ## TODO
 
-* test under Windows
-* :path option -- specifying the parent of the temporary dir (default: Dir.tmpdir)
 * take a hash or a YAML file or YAML string to specify the directory layout and contents
 * emit a hash or a YAML file or string to serialize the directory layout and contents for later
-* copy an entire data dir
 * support symlinks (?)
 * specify file write mode (?)
 * play nice with FakeFS (possibly with a :fake option)
@@ -70,6 +76,10 @@ see `test/files_test.rb` for more usage examples
 
 Written by Alex Chaffee <http://alexchaffee.com> <mailto:alex@stinky.com> <http://github.com/alexch> [@alexch](http://twitter.com/alexch)
 
+Patches by
+
+* [Seth Call](http://github.com/sethcall)
+
 ## License [MIT]
 
 Copyright (C) 2012 Alex Chaffee

data/Rakefile

@@ -3,5 +3,5 @@ here = File.dirname __FILE__
 
 task :default => :test
 task :test do
-  require "#{here}/test/files_test"
+  require File.join(here, "test/files_test")
 end

data/lib/files.rb

@@ -1,6 +1,6 @@
 require "files/version"
 
-module Files
+module Files              
 
   # class methods
   
@@ -9,7 +9,9 @@ module Files
   end
   
   def self.called_from level = 1
-    File.basename caller[level].split(':').first, ".rb"
+    line = caller[level]
+    line.gsub!(/^.:/, '') # correct for leading Windows C:
+    File.basename line.split(':').first, ".rb"
   end
   
   def self.create options = default_options, &block
@@ -17,8 +19,19 @@ module Files
     require 'fileutils'
 
     name = options[:name]
-    path = File.join(Dir::tmpdir, "#{name}_#{Time.now.to_i}_#{rand(1000)}")
+    root = Dir::tmpdir
 
+    # if the user specified a root directory (instead of default Dir.tmpdir)
+    if options[:path]
+      # then we will create their directory for them (test context-be friendly)
+      root = options[:path]
+      FileUtils::mkdir_p(root)
+      # if they gave relative path, this forces absolute
+      root = File.expand_path(root)
+    end
+
+    path = File.join(root, "#{name}_#{Time.now.to_i}_#{rand(1000)}")
+    d{path}
     Files.new path, block, options
   end
   
@@ -43,15 +56,25 @@ module Files
     def initialize path, block, options
       @root = path
       @dirs = []
-      dir path, &block
-      @dirs = [path]
+      dir nil, &block
       at_exit {remove} if options[:remove]
     end
 
-    def dir name, &block
-      path = "#{current}/#{name}"
+    # only 1 option supported: 'src'. if specified, is copied into 'name'
+    def dir name, options={}, &block
+      if name.nil?
+        path = current
+      else
+        path = File.join(current, name)
+      end
       Dir.mkdir path
-      @dirs << name
+      @dirs << name if name
+
+      if options[:src]
+        # copy over remote dir to this one
+        FileUtils.cp_r(options[:src], path)
+      end
+
       Dir.chdir(path) do
         instance_eval &block if block
       end
@@ -64,7 +87,7 @@ module Files
         FileUtils.cp name.path, current
         # todo: return path
       else
-        path = "#{current}/#{name}"
+        path = File.join(current, name)
         if contents.is_a? File
           FileUtils.cp contents.path, path
         else
@@ -82,7 +105,7 @@ module Files
     
     private
     def current
-      @dirs.join('/')
+      File.join @root, *@dirs
     end
     
   end

data/lib/files/version.rb

@@ -1,3 +1,3 @@
 module Files
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/test/files_test.rb

@@ -1,7 +1,16 @@
 require "wrong"
 include Wrong
 
-here = File.dirname __FILE__
+def windows?
+  require 'rbconfig'
+  RbConfig::CONFIG["host_os"] =~
+      %r!(msdos|mswin|djgpp|mingw|[Ww]indows)!
+end
+
+Wrong.config.verbose
+Wrong.config.color unless windows?
+
+here = File.expand_path(File.dirname __FILE__)
 $LOAD_PATH.unshift File.join(here, '..', 'lib')
 require "files"
 
@@ -29,11 +38,11 @@ assert { dir =~ /^#{Dir::tmpdir}/}
 
 assert { File.read("#{dir}/hello.txt") == "contents of hello.txt" }
 assert { File.read("#{dir}/web/snippet.html") == "<h1>File under F for fantastic!</h1>" }
-assert { 
+assert {
   File.read("#{dir}/web/img/cheez_doing_it_wrong.jpg") ==
   File.read("#{here}/data/cheez_doing_it_wrong.jpg")
 }
-assert { 
+assert {
   File.read("#{dir}/web/img/other.jpg") ==
   File.read("#{here}/data/cheez_doing_it_wrong.jpg")
 }
@@ -55,10 +64,8 @@ assert { File.read("#{dir}/hello.txt") == "contents of hello.txt" }
 assert { File.read("#{dir}/web/hello.html") == "contents of hello.html" }
 assert { dir.split('/').last =~ /^files_test/ }
 
-
 assert { Files.called_from(0) == "files_test" }
 
-
 dir = Files do
   dir "foo" do
     file "foo.txt"
@@ -79,6 +86,18 @@ assert { File.read("#{dir}/bar/bar.txt") == "contents of bar.txt" }
 assert { File.read("#{dir}/bar/baz/baz.txt") == "contents of baz.txt" }
 assert { File.read("#{dir}/bar/baf/baf.txt") == "contents of baf.txt" }
 
+# test for data directory copy
+src = File.expand_path("#{here}/data")
+
+files = Files.create do
+  dir "foo", :src => src do
+    # note: I'm not sure if this is desired behavior...
+    # shouldn't it put the *contents* of data into foo?
+    assert { File.exist?(File.join(Dir.pwd, 'data/cheez_doing_it_wrong.jpg'))}
+  end
+end
+
+# todo: test :target option
 
 dir = Files()
 assert { File.exist? dir and File.directory? dir}
@@ -130,15 +149,23 @@ class FilesMixinTest
         assert("the current directory is set inside a nested dir block") { File.read("sub.txt") == "contents of sub.txt" }
       end
     end
-    assert("a file created inside the dir block exists under the root dir") { 
-      File.read("#{@files.root}/bar/bar.txt") == "contents of bar.txt" 
+    assert("a file created inside the dir block exists under the root dir") {
+      File.read("#{@files.root}/bar/bar.txt") == "contents of bar.txt"
     }
-    
+
     subdir = dir "baz"
     assert("the dir method creates the dir") { File.exist?("#{@files.root}/baz")}
     assert("the dir method returns the created dir") { subdir == "#{@files.root}/baz"}
     assert { File.directory?("#{@files.root}/baz")}
-    
+
+    # this behavior is kind of a bug
+    begin
+      @content = "breakfast"
+      dir "stuff" do
+        assert("instance variables are *not* preserved in a dir block") { @content.nil? }
+      end
+    end
+
   end
 end
 FilesMixinTest.new.go

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Ever want to create a whole bunch of files at once? Like when you're
   writing tests for a tool that processes files? The Files gem lets you cleanly specify
@@ -45,7 +45,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4160850693345767944
+      hash: -3557681526261230673
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -54,10 +54,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4160850693345767944
+      hash: -3557681526261230673
 requirements: []
 rubyforge_project: files
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: a simple DSL for creating temporary files and directories