dusel 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+growl
+doc

data/Gemfile

@@ -1,14 +1,4 @@
 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 "rspec", "~> 2.3.0"
-  gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
-end
+# Specify your gem's dependencies in dusel.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'rspec', :cli => '--options spec/.rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -0,0 +1,41 @@
+# Dusel
+
+A tiny DSL to create, if desired temporary structures, of nested folders and
+files
+
+
+## Installation
+
+Run in your shell:
+
+```
+gem install dusel
+```
+
+In your application:
+
+```
+require 'dusel'
+```
+
+
+## Documentation
+
+Documentation is provided in the Yardoc format by the nice folks at
+[rubydoc.info](http://rubydoc.info/):
+
+[http://rubydoc.info/github/johannesh/dusel/master/frames](dusel @ rubydoc.info)
+
+
+## Contribution
+
+* 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 and submit a pull request from a feature or bugfix branch
+* Please include specs. This is important so we don't break your changes unintentionally in a future version.
+* Please don't modify the Rakefile, version, or history. If you do change these files, please isolate a separate commit so we can cherry-pick around it.
+
+
+## Copyright
+
+Copyright (c) 2011 Johannes Huning. See LICENSE for further details.

data/Rakefile

@@ -1,44 +1 @@
-# 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 = "dusel"
-  gem.homepage = "https://github.com/johannesh/dusel"
-  gem.license = "MIT"
-  gem.summary = %Q{Tiny DSL to create (temporary) files and folders}
-  gem.description = %Q{Dusel is a tiny DSL to create (nested) folders and
-                       directories}
-  gem.email = "hi@johanneshuning.com"
-  gem.authors = ["Johannes Huning"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new
+require "bundler/gem_tasks"

data/dusel.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dusel/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dusel"
+  s.version     = Dusel::VERSION
+  s.authors     = ["Johannes Huning"]
+  s.email       = ["johannesh@allnightdrive.com"]
+  s.homepage    = "https://github.com/johannesh/dusel"
+  s.summary     = 'Tiny DSL to create (temporary) structures files and folders'
+  s.description = "A tiny DSL to create, if desired temporary, " +
+    "structures of nested folders and files"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   =
+    `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Specify any dependencies here
+  %w{rspec guard guard-rspec guard-bundler rb-readline}.each { |dep|
+    s.add_development_dependency dep
+  }
+
+  if RUBY_PLATFORM =~ /darwin/
+    %w{rb-fsevent growl}.each { |dep|
+      s.add_development_dependency dep
+    }
+  end
+
+  if RUBY_PLATFORM =~ /linux/
+    %w{rb-inotify libnotify}.each { |dep|
+      s.add_development_dependency dep
+    }
+  end
+end

data/lib/dusel.rb

@@ -1,40 +1,128 @@
-libdir = File.dirname(__FILE__)
-$:.unshift libdir  unless $:.include?(libdir)
+$:.push File.expand_path('..', __FILE__)
 
 require 'tmpdir'
 require 'securerandom'
-
 require 'dusel/instance_methods'
 require 'dusel/version'
 
+
+# @author Johannes Huning
+# @version 1.1
 module Dusel
+  # Creates a new directory
+  #
+  # @version 1.0
+  # @since 0.0.1
+  #
+  # @note When using an implicit parent, the parent will not be removed
+  #  during {InstanceMethods#collapse}
+  #
+  # @param [optional, String] name
+  #   the new directory's name, leave blank to create a directory
+  #   with a random name
+  # @param [optional, String, Dir] parent
+  #   the new directory's parent directory, leave blank to create an implicit
+  #   temporary directory as the parent
+  # @param [optional, Block] block
+  #   block to yield the new directory to
+  # @return [Dir]
+  #   the new directory itself *or* if an block of arity +> 1+ was passed,
+  #   the block's return value
+  #
+  # @yieldparam [optional, Dir] dir  the new directory
+  #
+  # @example
+  #  Dusel.dir
+  #  # => #<Dir:...1dt72r3/df9b27558ec7e828>
+  #
+  #  Dusel.dir('foo')
+  #  # => #<Dir:...1222-80088-1d4rxor/foo>
+  #
+  #  Dusel.dir('foo', '/tmp')
+  #  # => #<Dir:/tmp/foo>
+  #
+  #  Dusel.dir('foo', '/tmp') { |dir| puts "Inside #{dir.path}" }
+  #  # Inside /tmp/foo
+  #  # => nil
   def self.dir(name = nil, parent = nil, &block)
     parent ||= Dir.mktmpdir()
     parent = parent.path   if parent.kind_of?(Dir)
     Dir.open(parent).dir(name, &block)
   end
 
+
+  # Creates a new file
+  #
+  # @version 1.0
+  # @since 0.0.1
+  #
+  # @note When using an implicit parent, the parent will not be removed
+  #  during {InstanceMethods#collapse}
+  #
+  # @note In case a block of arity +== 0+ is passed, the block's value will be
+  #  written to the file. The file is rewinded afterwards
+  #
+  # @param [optional, String] name
+  #   the new file's name, leave blank to create a file
+  #   with a random name
+  # @param [optional, String, Dir] parent
+  #   the new file's parent directory, leave blank to create an implicit
+  #   temporary directory as the parent
+  # @param [optional, Block] block
+  #   block to yield the new file to
+  # @return [File]
+  #   the new file itself *or* if an block of arity +== 1+ was passed,
+  #   the block's return value
+  #
+  # @yieldparam [optional, File] file  the new file
+  #
+  # @example
+  #  Dusel.file
+  #  # => #<File:...612-iscq6w/1dee3c34>
+  #
+  #  Dusel.file('foo')
+  #  # => #<File:...612-1wanjci/foo>
+  #
+  #  Dusel.file('foo', '/tmp')
+  #  # => #<File:/tmp/foo>
+  #
+  #  Dusel.file('foo', '/tmp') { |file| puts "File #{file.path}" }
+  #  # File /tmp/fooo
+  #  # => nil
+  #
+  #  file = Dusel.file { "bar" }
+  #  # => #<File:...612-1s02yue/61b9ef62>
+  #  file.read
+  #  # => "bar"
   def self.file(name = nil, parent = nil, &block)
     parent ||= Dir.mktmpdir()
     parent = parent.path  if parent.kind_of?(Dir)
     Dir.open(parent).file(name, &block)
   end
 
-  def self.rm!(tree)
-    tree.rm!
-  end
-
-  def self.included(base)
-    base.__send__(:include, InstanceMethods)
-  end
 
   private
 
-  def self.random_name(length = 16)
-    SecureRandom.hex(length / 2)
+  # Generates a random string usable as a file name
+  #
+  # @version 1.0
+  # @since 0.0.1
+  #
+  # @param [optional, Fixnum] length
+  #   the string's desired length
+  # @return [String]
+  #   the random string
+  def self.random_name(length = 8)
+    SecureRandom.hex((length / 2) + 1)[0..(length - 1)]
   end
 end
 
+
+# TODO: Document!
+#
+# @version 1.0
+# @since 0.0.1
 class Dir
-  include Dusel
+  # Add dusel's capabilities to Dir
+  include Dusel::InstanceMethods
 end

data/lib/dusel/instance_methods.rb

@@ -1,14 +1,64 @@
 require 'tmpdir'
 
+
+# @author Johannes Huning
+# @version 1.0
 module Dusel
   module InstanceMethods
+    # Creates a new directory inside the parent
+    #
+    # @version 1.0
+    # @since 0.0.1
+    #
+    # @param [optional, String] name
+    #   the new directory's name, leave blank to create a directory
+    #   with a random name
+    # @param [optional, Block] block
+    #   block to yield the new directory to
+    # @return [Dir]
+    #   the new directory itself *or* if an block of arity +> 1+ was passed,
+    #   the block's return value
+    #
+    # @yieldparam [optional, Dir] dir  the new directory
+    #
+    # @example
+    #  parent = Dusel.dir
+    #  # => #<Dir:...829-7r79si/df71aead>
+    #
+    #  parent.dir('foo')
+    #  # => #<Dir:...829-7r79si/df71aead/foo>
+    #
+    #  parent.dir('bar').dir('baz')
+    #  # => #<Dir:...829-7r79si/df71aead/bar/baz>
+    #
+    #  child = parent.dir {
+    #    dir {
+    #      dir {
+    #        dir {
+    #          file { 'contents' }
+    #        }
+    #      }
+    #      dir {
+    #        file { 'contents' }
+    #      }
+    #    }
+    #  }
+    #
+    #  puts `tree #{child.path}`
+    #  # ...829-7r79si/df71aead/70b3a439
+    #  # `-- ade003c9
+    #  #     |-- 5f8b5c3e
+    #  #     |   `-- 07c89af4
+    #  #     |       `-- ab8e7c24
+    #  #     `-- 863be86f
+    #  #         `-- 1f925fc1
     def dir(name = nil, &block)
-      new_path = __named_path(name)
+      new_path = named_path_(name)
       Dir.mkdir new_path
       new_dir = Dir.new(new_path)
 
-      @__dusel_dirs ||= []
-      @__dusel_dirs << new_dir
+      @dusel_dirs ||= []
+      @dusel_dirs << new_dir
 
       if block
         if block.arity < 1
@@ -22,12 +72,50 @@ module Dusel
       end
     end
 
+
+    # Creates a new file
+    #
+    # @version 1.0
+    # @since 0.0.1
+    #
+    # @note In case a block of arity +== 0+ is passed, the block's value will be
+    #  written to the file. The file is rewinded afterwards
+    #
+    # @param [optional, String] name
+    #   the new file's name, leave blank to create a file
+    #   with a random name
+    # @param [optional, Block] block
+    #   block to yield the new file to
+    # @return [File]
+    #   the new file itself *or* if an block of arity +== 1+ was passed,
+    #   the block's return value
+    #
+    # @yieldparam [optional, File] file  the new file
+    #
+    # @example
+    #  Dusel.file
+    #  # => #<File:...612-iscq6w/1dee3c34>
+    #
+    #  Dusel.file('foo')
+    #  # => #<File:...612-1wanjci/foo>
+    #
+    #  Dusel.file('foo', '/tmp')
+    #  # => #<File:/tmp/foo>
+    #
+    #  Dusel.file('foo', '/tmp') { |file| puts "File #{file.path}" }
+    #  # File /tmp/fooo
+    #  # => nil
+    #
+    #  file = Dusel.file { "bar" }
+    #  # => #<File:...612-1s02yue/61b9ef62>
+    #  file.read
+    #  # => "bar"
     def file(name = nil, &block)
-      new_path = __named_path(name)
+      new_path = named_path_(name)
       new_file = File.open(new_path, "w+")
 
-      @__dusel_files ||= []
-      @__dusel_files << new_file
+      @dusel_files ||= []
+      @dusel_files << new_file
 
       if block
         if block.arity < 1
@@ -42,15 +130,48 @@ module Dusel
       end
     end
 
-    def rm!
-      @__dusel_files.each { |file| File.delete(file.path) }  if @__dusel_files
-      @__dusel_dirs.each { |dir| dir.rm! }  if @__dusel_dirs
+
+    # Recursively removes this directory and all it's children
+    #
+    # @version 1.0
+    # @since 0.0.1
+    #
+    # @return result of +Dir#rmdir+ for this directory
+    #
+    # @example
+    #  parent = Dusel.dir {
+    #    dir {
+    #      dir {
+    #        dir {
+    #          file { 'contents' }
+    #        }
+    #      }
+    #      dir {
+    #        file { 'contents' }
+    #      }
+    #    }
+    #  }
+    #  # => #<Dir:...222-82137-ue6ci2/5e1cb6fe>
+    #  parent.collapse
+    #  # => 0
+    #  puts `file #{parent.path}`
+    #  # ...5e1cb6fe: cannot open `...5e1cb6fe' (No such file or directory)
+    def collapse
+      @dusel_files.each { |file| File.delete(file.path) }  if @dusel_files
+      @dusel_dirs.each { |dir| dir.collapse }  if @dusel_dirs
       Dir.rmdir(self.path())
     end
 
+
     private
 
-    def __named_path(name = nil)
+    # Appends the given name onto this directory's path
+    #
+    # @version 1.0
+    # @since 0.0.1
+    #
+    # @return this directory's path appended by the new files name
+    def named_path_(name = nil)
       name ||= Dusel.__send__(:random_name)
       File.join(self.path, name)
     end

data/lib/dusel/version.rb

@@ -1,3 +1,3 @@
 module Dusel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/.rspec

@@ -0,0 +1 @@
+--color --format progress --fail-fast

data/spec/{dusel_spec.rb → lib/dusel_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe 'Dusel' do
   describe '.dir' do
@@ -17,6 +17,7 @@ describe 'Dusel' do
     end
   end
 
+
   describe '.file' do
     it "should create a file inside a random directory if no parent given" do
       first_path = Dusel.file { |f| File.dirname(f.path) }
@@ -33,6 +34,7 @@ describe 'Dusel' do
     end
   end
 
+
   describe ".random_name" do
     it "should generate random strings" do
       Dusel.__send__(:random_name).should_not eq(Dusel.__send__(:random_name))
@@ -43,6 +45,7 @@ describe 'Dusel' do
     end
   end
 
+
   describe '#dir' do
     it "should create a folder with random name if none given" do
       Dusel.dir { |d|
@@ -66,6 +69,7 @@ describe 'Dusel' do
     end
   end
 
+
   describe '#file' do
     it "should create a file with random name if none given" do
       Dusel.dir { |d|
@@ -97,13 +101,14 @@ describe 'Dusel' do
     end
   end
 
-  describe '#remove' do
+
+  describe '#collapse' do
     it "should close and remove all directories and files recusively" do
       dir = Dusel.dir {
         file
         dir { file }
       }
-      Dusel.rm!(dir)
+      dir.collapse
       File.exist?(dir.path).should be_false
     end
   end

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
 require 'dusel'
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
+  config.mock_with :rspec
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dusel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,55 +9,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-06 00:00:00.000000000Z
+date: 2011-12-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18440160 !ruby/object:Gem::Requirement
+  requirement: &9084680 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18440160
+  version_requirements: *9084680
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &18439580 !ruby/object:Gem::Requirement
+  name: guard
+  requirement: &9084470 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18439580
+  version_requirements: *9084470
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &18438900 !ruby/object:Gem::Requirement
+  name: guard-rspec
+  requirement: &9084210 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18438900
+  version_requirements: *9084210
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &18438240 !ruby/object:Gem::Requirement
+  name: guard-bundler
+  requirement: &9083950 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18438240
+  version_requirements: *9083950
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &18437660 !ruby/object:Gem::Requirement
+  name: rb-readline
+  requirement: &9083690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,30 +65,55 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18437660
-description: ! "Dusel is a tiny DSL to create (nested) folders and\n                       directories"
-email: hi@johanneshuning.com
+  version_requirements: *9083690
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &9083380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9083380
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &9083180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *9083180
+description: A tiny DSL to create, if desired temporary, structures of nested folders
+  and files
+email:
+- johannesh@allnightdrive.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
 files:
-- .document
+- .gitignore
 - .rspec
 - Gemfile
-- LICENSE.txt
-- README.markdown
+- Guardfile
+- LICENSE
+- README.md
 - Rakefile
 - VERSION
+- dusel.gemspec
 - lib/dusel.rb
 - lib/dusel/instance_methods.rb
 - lib/dusel/version.rb
-- spec/dusel_spec.rb
+- spec/.rspec
+- spec/lib/dusel_spec.rb
 - spec/spec_helper.rb
+- spec/support/.gitkeep
 homepage: https://github.com/johannesh/dusel
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -99,9 +124,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -602893548499290189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -113,5 +135,9 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Tiny DSL to create (temporary) files and folders
-test_files: []
+summary: Tiny DSL to create (temporary) structures files and folders
+test_files:
+- spec/lib/dusel_spec.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+has_rdoc: 

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/README.markdown

@@ -1,17 +0,0 @@
-# Dusel
-
-Tiny DSL to create (temporary) files and folders
-
-## Contributing to Dusel
-
-* 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) 2011 Johannes Huning. See LICENSE.txt for further details.