directree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d683e802122afc050f39ac35b866f7b25a23c8a
+  data.tar.gz: 1dcf82c56b663dab1e971b573eecd5ebecf51858
+SHA512:
+  metadata.gz: 14d5690304204fb2aaa675dc3e7078d1bb148af954ee736ca462e29bee7a52d299749cff13422a0197a2600e5430ec98a663e18fc114ba863fe2bfe093de0ba3
+  data.tar.gz: 1603a39d2ebd3dffe74d848dbe52c5bd87435fcd904dedd2b27c64cb0ba775add3a45496b0d3cfd8de7373c4e80b766a2a53bfc9b7e4a6904231a2f35e7b977d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kunal Dabir
+
+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,72 @@
+directree.rb
+============
+
+A simple DSL to create Directory Tree and Files with content.
+
+A [Directree](https://github.com/kdabir/directree) implementation powered by ruby.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'directree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install directree
+
+## Usage
+
+    require 'directree'
+
+    Directree.create("mygem") {
+        dir("lib")
+        dir("spec"){
+            file("spec_helper.rb") {
+                <<-EOF
+                RSpec.configure do |config|
+                    config.color_enabled = true
+                end
+                EOF
+            }
+        }
+        file("README.txt") {
+            "This is README of mygem"
+        }
+    }
+
+That's it, Seriously !!
+
+Verify it:
+
+    $ tree mygem
+    mygem
+    |-- README.txt
+    |-- lib
+    `-- spec
+        `-- spec_helper.rb
+
+    2 directories, 2 files
+
+And check the file content
+
+    $ cat mygem/spec/spec_helper.rb
+            RSpec.configure do |config|
+                config.color_enabled = true
+            end
+
+
+See the [specs](tree/master/spec) for more details usage
+
+## Contributing
+
+1. Fork it ( https://github.com/kdabir/directree.rb/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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/directree.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'directree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "directree"
+  spec.version       = Directree::VERSION
+  spec.authors       = ["Kunal Dabir"]
+  spec.email         = ["kunal.dabir@gmail.com"]
+  spec.summary       = %q{create directory trees and files with contents}
+  spec.description   = %q{directree is convenient DSL for creating directory tree and text files with content}
+  spec.homepage      = "http://github.com/kdabir/directree.rb"
+  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"
+  spec.add_development_dependency 'rspec'
+end

data/lib/directree.rb

@@ -0,0 +1,84 @@
+require "directree/version"
+require 'fileutils'
+require 'pathname'
+
+module Directree
+
+  def self.create name, opts={}, &block
+    tree = build(name,opts,&block)
+    tree.create
+    tree
+  end
+
+  def self.build name, opts={}, &block
+    DirTree.new(name, opts, &block)
+  end
+
+  class DirTree
+    attr_reader :path, :opts, :children
+
+    def initialize name, opts={}, &block
+      @path = name
+      @opts = opts
+      @children ||= []
+      self.instance_eval &block if block_given?
+    end
+
+    def dir name, opts={}, &block
+      @children << DirTree.new(join_path(@path, name), opts, &block)
+    end
+
+    def file name, opts={}, &block
+      @children << WritableFile.new(join_path(@path, name), opts, &block)
+    end
+
+    def create
+      FileUtils::mkdir_p @path
+      @children.each{ |child| child.create}
+    end
+
+    def [](index_or_name)
+      if index_or_name.is_a? Integer
+        @children[index_or_name]
+      else
+        @children.find {|p| File.basename(p.path) == index_or_name}
+      end
+    end
+
+    def walk &block
+      [block.call(self), children.collect {|child|
+        if child.respond_to?(:walk)
+          child.walk(&block)
+        else
+          block.call(child)
+        end
+      }].flatten
+    end
+
+    private
+    def join_path parent, child
+      (Pathname(parent) + child).to_s
+    end
+  end
+
+
+  class WritableFile
+    attr_reader :path, :opts
+
+    def initialize name, opts={}, &block
+      @path = name
+      @opts = opts
+      @block = block if block_given?
+    end
+
+    def create
+      File.open(@path, 'w') {|f| f.write(content) }
+    end
+
+    def content
+      @block.call(@path, @opts) if @block
+    end
+
+  end
+
+end

data/lib/directree/version.rb

@@ -0,0 +1,3 @@
+module Directree
+  VERSION = "0.0.1"
+end

data/spec/directree_spec.rb

@@ -0,0 +1,250 @@
+require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
+
+describe Directree do
+
+  it "should give current version" do
+    (Directree::VERSION).should == "0.0.1"
+  end
+
+  it "should build tree from Module helper method" do
+    d = Directree.build("a", append:true) {
+      file("LICENSE.txt")
+      dir("bin")
+      dir("lib")
+      dir("spec") {
+        file("spec_helper.rb") {
+          <<-EOF
+          RSpec.configure do |config|
+            config.color_enabled = true
+          end
+          EOF
+        }
+      }
+
+    }
+    d.path.should == "a"
+    d["spec"]["spec_helper.rb"].path.should == "a/spec/spec_helper.rb"
+    d["spec"]["spec_helper.rb"].content.should include("RSpec.configure")
+  end
+
+  describe Directree::WritableFile do
+    context "new" do
+      it "should initialize with a File with name" do
+        f = Directree::WritableFile.new "a.txt"
+        f.path.should == "a.txt"
+      end
+
+      it "should init with dir name and options" do
+        f = Directree::WritableFile.new "a.txt", append:true
+        f.path.should == "a.txt"
+        f.opts.should == {append:true}
+      end
+
+      it "should init with dir name and block" do
+        f = Directree::WritableFile.new "a", overwrite:true do
+          "this will be the content of file"
+        end
+        f.path.should == "a"
+        f.opts.should == {overwrite:true}
+      end
+
+      it "should not call the block when initializing" do
+        called = false
+        Directree::WritableFile.new "a.txt", overwrite:true do
+          called = true
+        end
+        called.should be(false)
+      end
+    end
+
+    context "content" do
+
+      it "should be able to get content returned from block" do
+        f = Directree::WritableFile.new "a.txt", overwrite:true do |path, opts|
+          "this should be content"
+        end
+        f.content.should == "this should be content"
+      end
+
+      it "should call block with path and opts" do
+        called = false
+        f = Directree::WritableFile.new "a.txt", overwrite:true do |path, opts|
+          called = true
+          path.should == "a.txt"
+          opts.should == {overwrite:true}
+        end
+        f.content
+        called.should be(true)
+      end
+    end
+
+  end
+
+  describe Directree::DirTree do
+
+    context "new" do
+
+      it "should initialize with a directory name" do
+        d = Directree::DirTree.new "a"
+        d.path.should == "a"
+      end
+
+      it "should init with dir name and options" do
+        d = Directree::DirTree.new "a", overwrite:true
+        d.path.should == "a"
+        d.opts.should == {overwrite:true}
+      end
+
+      it "should init with dir name and block" do
+        d = Directree::DirTree.new "a", overwrite:true do
+          a = "something that doesn't matter"
+        end
+        d.path.should == "a"
+        d.opts.should == {overwrite:true}
+      end
+
+      it "should init with a block that can call method on self" do
+        called = false
+        Directree::DirTree.new "a", overwrite:true do
+          called = true
+          path.should == "a"
+          opts.should == {overwrite:true}
+        end
+        called.should be(true)
+      end
+    end
+
+    context "nesting" do
+
+      it "should be able to represent nested dir inside dir" do
+        d = Directree::DirTree.new("a")
+        d.dir("b", overwrite:true)
+        d.children.first.path.should == "a/b"
+      end
+
+      it "should be able to represent nested file inside dir" do
+        d = Directree::DirTree.new("a")
+        d.file("b.txt", append:true)
+        d.children.first.path.should == "a/b.txt"
+      end
+
+      it "should be able to represent n level nested dir inside dir" do
+        a = Directree::DirTree.new("a")
+        a.dir("b", overwrite:true) {
+          dir("c") {
+            dir("d")
+          }
+        }
+        a.children.first.path.should == "a/b"
+        a['b']['c']['d'].path.should == "a/b/c/d"
+      end
+
+      it "should be able to represent n level nested files and dir inside dir" do
+        a = Directree::DirTree.new("a")
+        a.dir("b", overwrite:true) {
+          dir("c") {
+            dir("d")
+            file('e.txt')
+          }
+          file "f.txt", create:false do
+            "this would be file's content"
+          end
+        }
+        a['b']['c']['d'].path.should == "a/b/c/d"
+        a['b']['c']['e.txt'].path.should == "a/b/c/e.txt"
+        a['b']['f.txt'].path.should == "a/b/f.txt"
+      end
+    end
+
+    context "access" do
+      a = Directree::DirTree.new("a") {
+        dir("b") {
+          dir("c")
+          file("d")
+        }
+      }
+
+      it "should be able to access by array index" do
+        a[0].path.should == "a/b"
+        a[0][0].path.should == "a/b/c"
+        a[0][1].path.should == "a/b/d"
+      end
+
+      it "should be able to access by name" do
+        a['b'].path.should == "a/b"
+        a['b']['c'].path.should == "a/b/c"
+        a['b']['d'].path.should == "a/b/d"
+      end
+    end
+
+
+    context "traversal" do
+      a = Directree::DirTree.new("a") {
+        dir("b") {
+          dir("c", required:true) {
+            file("1.txt")
+          }
+          dir("d")
+          file("2.txt", create:false)
+        }
+      }
+
+      it "should traverse every file" do
+        files = []
+        a.walk { |f| files << f.path }
+        files.should ==  ["a", "a/b", "a/b/c", "a/b/c/1.txt", "a/b/d", "a/b/2.txt"]
+      end
+
+      it "should traverse every file and get its opts" do
+        files = []
+        a.walk { |f| files << f.opts }
+        files.should == [{}, {}, {:required=>true}, {}, {}, {:create=>false}]
+      end
+    end
+  end
+
+  context "integration-testing" do
+
+    before(:each) do
+      @path = Dir.mktmpdir + "/directest"
+      FileUtils.mkdir_p(@path)
+      Dir.chdir(@path)
+      #puts "using #{@path} for integration tests"
+    end
+
+    after(:each) do
+      FileUtils.rm_rf("directest")
+    end
+
+    it "should create directories and files" do
+      a = Directree::DirTree.new("a") {
+        dir("b") {
+          dir("c", required:true) {
+            file("1.txt") {
+              "hello world"
+            }
+          }
+          dir("d")
+          file("2.txt", create:false)
+        }
+      }
+      a.create
+
+      Dir["**/*/"].should == ["a/", "a/b/", "a/b/c/", "a/b/d/"] # for directories
+      File.read("a/b/c/1.txt").should == "hello world"
+      File.read("a/b/2.txt").should == ""
+    end
+
+    it "should create from module" do
+      Directree.create("x") {
+        file "y.txt" do
+          "content of y.txt"
+        end
+      }
+      File.read("x/y.txt").should == "content of y.txt"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'directree'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: directree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kunal Dabir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: directree is convenient DSL for creating directory tree and text files
+  with content
+email:
+- kunal.dabir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- directree.gemspec
+- lib/directree.rb
+- lib/directree/version.rb
+- spec/directree_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kdabir/directree.rb
+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.0
+signing_key: 
+specification_version: 4
+summary: create directory trees and files with contents
+test_files:
+- spec/directree_spec.rb
+- spec/spec_helper.rb