file_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ff24fa1a91f9106b1650b273cded718c4f6ddc1
+  data.tar.gz: 088f764abfd51f0ec0969aaeae1a9e2eb788a7a7
+SHA512:
+  metadata.gz: a9729cce5ef8687002ccbdeb4588e8135c749c2e135d4f6777abc4ca1b4c2af6ea4a98494ab02f187ce2efdf6d52445b225347a223b0cebd81554d1825296cf9
+  data.tar.gz: 07a14450b4a35f9ef8ec25b5a6087c447aebe7b0c0dfcdbf8320b9fe643ab95eb4e432d596fe8424369ba73cc46609ddea58672cbb4b06d1867e935086110e75

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.1.1"
+  - "1.9.3"
+  - jruby-19mode
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_tree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 aliakb
+
+MIT License
+
+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.md

@@ -0,0 +1,85 @@
+# FileTree
+FileTree is a ruby library for creating file/directory trees from your code, mostly for testing, where you need to generate file/directory input for your components. The tree gets created somewhere under system's temporary directory (Dir::mktmpdir is used to create a top-level directory).
+
+## Requirements
+* Ruby 1.9 or greater
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'file_tree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_tree
+
+## Usage
+Start by adding _file_tree_ module to your project:
+```ruby
+require "rubygems"
+require "file_tree"
+```
+Now add file tree DSL to your class/module. Depending on the context you may use _include_ or _extend_:
+```ruby
+include FileTree
+```
+
+Now you're ready to create directories and populate them with some files.
+### Directory with files and subdirectories
+```ruby
+path = root_dir do
+  dir "dir1-1" do
+    file "file1"
+    file "file2"
+  end
+  dir "dir1-2"
+  dir "dir1-3" do
+    file "file3"
+    file "file4"
+  end
+  file "file5"
+  file "file6"
+end
+```
+Now path variable stores path to the directory that you have just created. Files will be of random size and content; zero-length files are possible, as well as binary and text files.
+### Content type
+You can explicitly specify whether your files should have binary or text content:
+```ruby
+root_dir do
+  file "data.bin", :binary
+  file "data.txt", :text
+  file "empty", :empty
+  file "random-1", :random
+  file "random-2"
+end
+```
+("random-2" file will have random content because of the default content type specified in FileTree::Defaults.content_type variable)
+### Predefined content
+There may be times where you want your files to store some predefined content. This is doable.
+```ruby
+root_dir do
+  file "test1.txt", "This is a test!!!"
+  file "test2.txt", "This is only a test!"
+end
+```
+### Configuration
+The library has a bunch of parameters for you to play with. Messing with them is not necessary - the default values work just fine. All settings are gathered inside FileTree::Defaults module.
+
+Setting              | Default              | Meaning
+-------------------- | -------------------- | -------------------------------------------------
+content_type         | :random              | Default content type for files
+min_file_size        | 1024                 | minimal size for non-empty files
+max_file_size        | 3072                 | maximal size for non-empty files
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/file_tree/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/file_tree.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_tree"
+  spec.version       = FileTree::VERSION
+  spec.authors       = ["aliakb"]
+  spec.email         = ["abaturytski@gmail.com"]
+  spec.summary       = "DSL for creating file trees."
+  spec.description   = "DSL for creating file trees; mostly for tests which consume files and directories."
+  spec.homepage      = "https://github.com/aliakb/file_tree"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+end

data/lib/file_tree.rb

@@ -0,0 +1,38 @@
+require "file_tree/version"
+require "file_tree/defaults"
+require "file_tree/content_generator"
+require "tmpdir"
+
+module FileTree
+  extend self
+
+  def self.with_context_dir(dir, &block)
+    dir_stack.push(dir)
+    yield dir if block_given?
+    dir
+  ensure
+    dir_stack.pop
+  end
+
+  def self.dir_stack
+    Thread.current[:file_tree_dir_stack] ||= []
+  end
+
+  def root_dir(&block)
+    dir = Dir.mktmpdir
+    FileTree.with_context_dir(dir, &block)
+  end
+
+  def dir(name, &block)
+    dir = File.join(FileTree.dir_stack[-1], name)
+    Dir.mkdir(dir)
+    FileTree.with_context_dir(dir, &block)
+  end
+
+  def file(name, content = Defaults.content_type)
+    content = ContentGenerator.create(content) unless content.is_a?(String)
+    path = File.join(FileTree.dir_stack[-1], name)
+    File.open(path, "wb"){|stream| stream << content}
+    path
+  end
+end

data/lib/file_tree/content_generator.rb

@@ -0,0 +1,33 @@
+module FileTree
+  module ContentGenerator
+    LETTERS = ["a".."z", "A".."Z", "0".."9", " ", "\n", "_", "*"].map{|i| Array(i)}.flatten
+    CONTENT_TYPES = [:binary, :text, :empty]
+
+    def self.create(type)
+      type = CONTENT_TYPES.sample if type == :random
+
+      case type
+        when :binary
+          create_binary_content
+        when :text
+          create_text_content
+        when :empty
+          ""
+        else
+          raise(ArgumentError, "Unsupported content type: #{type}")
+      end
+    end
+
+    def self.create_binary_content
+      Random.new.bytes(random_file_size)
+    end
+
+    def self.create_text_content
+      (1..random_file_size).map{LETTERS.sample}.join
+    end
+
+    def self.random_file_size
+      rand(Defaults.min_file_size..Defaults.max_file_size)
+    end
+  end
+end

data/lib/file_tree/defaults.rb

@@ -0,0 +1,21 @@
+module FileTree
+  module Defaults
+    class << self
+
+      attr_writer(:content_type)
+      def content_type
+        @content_type || :random
+      end
+
+      attr_writer(:min_file_size)
+      def min_file_size
+        @min_file_size || 1024
+      end
+
+      attr_writer(:max_file_size)
+      def max_file_size
+        @max_file_size || 3 * 1024
+      end
+    end
+  end
+end

data/lib/file_tree/version.rb

@@ -0,0 +1,3 @@
+module FileTree
+  VERSION = "0.1.0"
+end

data/spec/file_tree_spec.rb

@@ -0,0 +1,200 @@
+require "spec_helper"
+
+describe FileTree do
+  include FileTree
+
+  let(:random_content) {FileTree::ContentGenerator.create(:random)}
+
+  def test_root(&block)
+    dir = root_dir(&block)
+  ensure
+    FileUtils.rm_rf(dir)
+  end
+
+  context "#root_dir" do
+    it "should yield" do
+      expect{|b| test_root(&b)}.to yield_control
+    end
+
+    it "should not raise with no code block" do
+      expect{test_root}.to_not raise_error
+    end
+
+    it "should create a temp directory" do
+      temp_dir = Dir.mktmpdir
+      Dir.should_receive(:mktmpdir).once.and_return(temp_dir)
+      test_root
+    end
+
+    it "should yield a directory name" do
+      temp_dir = Dir.mktmpdir
+      Dir.stub(:mktmpdir).and_return(temp_dir)
+
+      expect{|b| test_root(&b)}.to yield_with_args(temp_dir)
+    end
+
+    it "should return a directory name" do
+      temp_dir = Dir.mktmpdir
+      Dir.stub(:mktmpdir).and_return(temp_dir)
+
+      test_root.should eql temp_dir
+    end
+  end
+
+  context "dir" do
+    let(:root) {@root}
+    around(:each) do |example|
+      test_root do |dir|
+        @root = dir
+        example.run
+      end
+    end
+
+    it "should yield" do
+      expect{|b| dir("foo", &b)}.to yield_control
+    end
+
+    it "should yield a directory name" do
+      expect{|b| dir("foo", &b)}.to yield_with_args(File.join(root, "foo"))
+    end
+
+    it "should return a directory name" do
+      expected = File.join(root, "test")
+      dir("test").should eql expected
+    end
+
+    it "should return a directory name when called with a block" do
+      expected = File.join(root, "test")
+      dir("test"){}.should eql expected
+    end
+
+    it "should create directory under the root" do
+      expected = File.join(root, "test")
+      Dir.should_receive(:mkdir).once.with(expected)
+      dir "test"
+    end
+
+    it "should return an existing directory" do
+      File.directory?(dir("foo")).should be_true
+    end
+
+    context "nested" do
+      around(:each) do |example|
+        dir "top" do |dir|
+          @root = dir
+          example.run
+        end
+      end
+
+      it "should create a subdirectory" do
+        expected = File.join(root, "test")
+        dir("test").should eql expected
+      end
+    end
+  end
+
+  context "file" do
+    context "in root" do
+      let(:root) {@root}
+
+      around(:each) do |example|
+        test_root do |dir|
+          @root = dir
+          example.run
+        end
+      end
+
+      it "should create a file" do
+        expected = File.join(root, "test")
+        File.should_receive(:open).with(expected, "wb").and_call_original
+
+        file "test"
+      end
+
+      it "should return path" do
+        expected = File.join(root, "test")
+        file("test").should eql expected
+      end
+
+      it "should use explicity specified content" do
+        content = random_content
+        path = file("test", content)
+
+        IO::binread(path).should eql content
+      end
+    end
+
+    context "in subdirectory" do
+      let(:root) {@root}
+
+      around(:each) do |example|
+        test_root do
+          dir "subdir" do |dir|
+            @root = dir
+
+            example.run
+          end
+        end
+      end
+
+      it "should create a file" do
+        expected = File.join(root, "test")
+        file("test").should eql expected
+      end
+
+      it "should use text content by default" do
+        FileTree::Defaults.stub(:content_type).and_return(:text)
+        content = FileTree::ContentGenerator.create_text_content
+        FileTree::ContentGenerator.should_receive(:create_text_content).once.and_return(content)
+
+        path = file("test")
+        IO.binread(path).should eql content
+      end
+
+      it "should use binary content by default" do
+        FileTree::Defaults.stub(:content_type).and_return(:binary)
+        content = FileTree::ContentGenerator.create_binary_content
+        FileTree::ContentGenerator.should_receive(:create_binary_content).once.and_return(content)
+
+        path = file "test"
+        IO.binread(path).should eql content
+      end
+
+      it "should use randomized text content by default" do
+        FileTree::ContentGenerator::CONTENT_TYPES.should_receive(:sample).once.and_return(:text)
+        FileTree::ContentGenerator.should_receive(:create_text_content).once.and_call_original
+
+        file "test"
+      end
+
+      it "should use randomized binary content by default" do
+        FileTree::ContentGenerator::CONTENT_TYPES.should_receive(:sample).once.and_return(:binary)
+        FileTree::ContentGenerator.should_receive(:create_binary_content).once.and_call_original
+
+        file "test"
+      end
+
+      it "should use random text content" do
+        FileTree::ContentGenerator::CONTENT_TYPES.should_receive(:sample).once.and_return(:text)
+        FileTree::ContentGenerator.should_receive(:create_text_content).once.and_call_original
+        file "foo", :random
+      end
+
+      it "should use random binary content" do
+        FileTree::ContentGenerator::CONTENT_TYPES.should_receive(:sample).once.and_return(:binary)
+        FileTree::ContentGenerator.should_receive(:create_binary_content).once.and_call_original
+        file "foo", :random
+      end
+
+      it "should create an empty file" do
+        path = file "empty", :empty
+        File.file?(path).should be_true
+        File.size(path).should be_zero
+      end
+
+      it "should raise for unsupported type" do
+        expect{file("test", :unsupported)}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "simplecov"
+SimpleCov.start
+
+require "file_tree"

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: file_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aliakb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: DSL for creating file trees; mostly for tests which consume files and
+  directories.
+email:
+- abaturytski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_tree.gemspec
+- lib/file_tree.rb
+- lib/file_tree/content_generator.rb
+- lib/file_tree/defaults.rb
+- lib/file_tree/version.rb
+- spec/file_tree_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aliakb/file_tree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DSL for creating file trees.
+test_files:
+- spec/file_tree_spec.rb
+- spec/spec_helper.rb