spwn 0.1.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+#
+guard '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/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,110 @@
+# Spwn
+Spwn is a testing library for random file production. It basically
+allows you to quickly throw some files up, test your methods on
+them, and quickly clean up your filestructure.
+
+## Installation
+
+Throw `spwn` in your Gemfile:
+
+```ruby
+gem 'spwn'
+```
+
+and bundle
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install spwn
+```
+
+## Usage
+
+### Returning something useful
+
+> This currently is the source of a major issue. Each time a File object
+> is created a file pointer is used. The user woudl need to manually
+> `f.close` each file. I am currently building a seperate library to
+> create a `File` replacement that doesn't immediately open a file
+> buffer and has a more robust set of useful istance methods.
+
+In almost all the following methods, you will find either a [Dir][]
+or [File][] object returned to you. Why do this instead of return a
+path to the file? Easy! You can do cool stuff like this now:
+[Dir]: http://www.ruby-doc.org/core-1.9.3/Dir.html
+[File]: http://www.ruby-doc.org/core-1.9.3/File.html
+
+```ruby
+# Look! You can still get the path...
+Uber.pwd.path #=> "/home/michael/code"
+# ...but you can also iterate through files as well now!
+Uber.pwd.each { |item| puts 'item' }
+```
+which would produce
+```ruby
+.
+..
+migrateServer
+superSecretProject
+```
+or with `File` ...
+```ruby
+# return the file size in bytes
+Uber.file('Gemfile').size #=> 171
+# change file permissions (I believe this needs root permissions)
+Uber.file('Gemfile').chmod('0644')
+```
+You can also use the returned File or Dir class in that respective
+class's class methods!
+```ruby
+gemfile = Uber.file('Gemfile')
+File.executable?(gemfile) #=> false
+```
+
+### Spawning Files
+```ruby
+Spwn.file #=> <File:file1.html>
+Spwn.file #=> <File:file2.md>
+```
+
+```ruby
+Spwn.file( ext: 'md' ) #=> <File:file3.rb>
+Spwn.file( 'index.html' ) #=> <File:index.html>
+Spwn.file( count: 3 ) #=> [<File:file4.md>,<File:file5.txt>,<File:file6.rb>]
+```
+
+```ruby
+Spwn.dir #=> <Dir:dir1>
+Spwn.dir( 'spec' ) #=> <Dir:spec>
+```
+
+```ruby
+#spawn a dir and then cd inside the dir to do stuff
+Spwn.dir( 'scripts' ) do
+  Spwn.dir( 'vendor' )
+  Spwn.file( 'app.js' )
+  Dir.pwd() #=> '.../mySite/scripts'
+end
+```
+
+### removing spawned files
+All done testing and need to clean up those files? Just run
+
+```ruby
+Spwn.clean( 'spec/tmp' )
+```
+
+to empty the directory completely.
+
+## Contributing
+1. Fork it
+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 new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/spwn.rb

@@ -0,0 +1,104 @@
+require "spwn/version"
+
+class Spwn
+  class << self
+    attr_accessor :extensions
+    attr_reader :dirs, :files
+  end
+  @extensions = [
+    'html',
+    'htm',
+    'txt',
+    'rb',
+    'sh',
+    'md',
+    'markdown'
+  ]
+  @dirs = []
+  @files = []
+  #@last_dir_inc = {}
+  #@last_file_inc = {}
+
+
+  # Spwn.file( name , options={} )
+  def self.file( *args )
+    options = args.last.is_a?(Hash) ? args.last : {}
+    return spawn_multiples( :file, *args ) unless options[:count].nil?
+    name = args.first.is_a?(String) ? args.first : 'file'
+    ext = options[:ext] || @extensions.sample
+    @files << new_file = File.new( next_filename(name, ext), 'w')
+    new_file
+  end
+
+  # Spwn.dir( name , options={} )
+  def self.dir( *args, &block )
+    options = args.last.is_a?(Hash) ? args.last : {}
+    return spawn_multiples( :dir, *args, &block ) unless options[:count].nil?
+    name = args.first.is_a?(String) ? args.first : 'dir'
+
+    digit = @dirs.empty? ? '1' : next_digit( @dirs.last )
+    path = File.join(Dir.pwd, "#{name}#{digit}")
+    Dir.mkdir(path)
+    @dirs << new_dir = Dir.new(path)
+    if block_given?
+      origin = Dir.pwd
+      Dir.chdir(new_dir)
+      yield new_dir
+      Dir.chdir(origin)
+    end
+    new_dir
+  end
+
+  def self.clean( path )
+    # commenting out until I make a replacement for the File object
+    #
+    # if path.nil?
+    #   #clean all known files you have spawn
+    #   @files.each { |file| File.delete(file) }
+    #   @dirs.each { |dir| Dir.rmdir(dir) }
+    # else
+      #empty the given directory
+      path = File.expand_path(path)
+
+      #delete all files and directories
+      Dir.glob(File.join(path,'**','*')).reverse_each do |file|
+        if File.file?(file)
+          File.delete(file)
+        elsif File.directory?(file)
+          Dir.rmdir(file)
+        end
+      end
+    # end
+    @files = []
+    @dirs = []
+  end
+
+  private
+  def self.spawn_multiples( method, *args, &block )
+    raise ArgumentError "missing options hash" unless args.last.is_a? Hash
+    count = args.last[:count]
+    raise ArgumentError "count can't be less than 1" if count < 1
+    args.last[:count] = nil
+    items = []
+    count.times do
+      items << self.send( method, *args, &block )
+    end
+    items
+  end
+  def self.next_digit(item)
+    File.basename(item).match(/\d+/)[0].next
+  end
+  def self.next_filename(name, ext)
+    digit = @files.empty? ? '1' : next_digit( @files.last )
+    "#{name}#{digit}.#{ext}"
+  end
+  def self.split_filename(fullname)
+    #fullname = string.match(/\A\.?\w+/).to_s
+    split = [] << name = fullname.match(/\A\.?[a-zA-Z_]+/)
+    split << digit = fullname.match(/\d+\Z/)
+    #split << ext = string.match(/(?<=[^\A]\.)\w+\Z/)
+    split.each_index { |i| split[i] = split[i].to_s  if split[i].is_a? MatchData }
+    split[1] = split[1].to_i unless split[1].nil?
+    return split
+  end
+end

data/lib/spwn/version.rb

@@ -0,0 +1,3 @@
+class Spwn
+  VERSION = "0.1.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "pry"
+ROOT = Dir.pwd
+TESTDIR = File.join(ROOT,'spec/tmp')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/spwn_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+require 'spwn'
+
+describe Spwn do
+  before(:all) { Dir.chdir(TESTDIR) }
+  after(:each) { Spwn.clean(TESTDIR) }
+  after(:all) { Dir.chdir(ROOT) }
+
+  it "should have accessible extensions" do
+    old_exts = Spwn.extensions
+    new_exts =  ['haml', 'slim', 'yaml', 'json']
+    Spwn.extensions = new_exts
+    Spwn.extensions.should == new_exts
+    Spwn.extensions = old_exts
+  end
+
+  context '#file' do
+    it "should be instance of File" do
+      Spwn.file.should be_an_instance_of File
+    end
+    it "should spawn a file" do
+      file = Spwn.file
+      Dir.entries(Dir.pwd).should include file.path
+    end
+    it "should be included in the @files array" do
+      Spwn.files.should include Spwn.file
+    end
+    it "should have a common file name" do
+      File.basename(Spwn.file).should match /\Afile\d+/
+    end
+    it "should increment the file name" do
+      pattern = /\Afile(\d+)(?:.\w*)?/
+      Spwn.file
+      expect {
+        3.times { Spwn.file }
+      }.to change {
+        # the digit in the filename for the last spawned file
+        File.basename(Spwn.files.last).match(pattern)[1].to_i
+      }.from(1).to(4)
+    end
+    it "should allow you to define a name" do
+      file = Spwn.file('candy', ext: 'html')
+      File.basename(file).should == 'candy1.html'
+    end
+    it "should use a random extension" do
+      ext = File.extname(Spwn.file).delete '.'
+      Spwn.extensions.should include ext
+    end
+    context "options[:ext]" do
+      it "should allow the user to define an extension" do
+        ext = File.extname(Spwn.file( ext: 'rb' ))
+        ext.should == '.rb'
+      end
+    end
+    context "options[:count]" do
+      it "should return an array" do
+        Spwn.file(count: 3).should be_an_instance_of Array
+      end
+      it "should spawn that many files" do
+        expect { Spwn.file(count: 3) }.to change {
+          Dir.entries(Dir.pwd).length
+        }.by(3)
+      end
+    end
+  end
+
+  context 'dir' do
+    subject(:dir) { Spwn.dir }
+    it { should be_instance_of(Dir) }
+    it "should spawn a dir" do
+      dir()
+      Dir.entries(Dir.pwd).should include File.basename(dir)
+    end
+    it "should be included in the @dirs array" do
+      Spwn.dirs.should include dir
+    end
+    it "should have a common dir name" do
+      File.basename(dir).should match /\Adir\d+/
+    end
+    it "should increment the dir name" do
+      pattern = /\Adir(\d+)/
+      Spwn.dir
+      expect {
+        3.times { Spwn.dir }
+      }.to change {
+        # the digit in the filename for the last spawned file
+        File.basename(Spwn.dirs.last).match(pattern)[1].to_i
+      }.from(1).to(4)
+    end
+    it "should cd into the dir if a block is given" do
+      Spwn.dir do |directory|
+        Dir.pwd.should == directory.path
+      end
+    end
+    context "options[:count]"  do
+      it "should trigger spawn_multiples" do
+        Spwn.should_receive(:spawn_multiples).with(:dir, count:3)
+        Spwn.dir(count: 3)
+      end
+      it "can accept multiple arguments"do
+        Spwn.should_receive(:spawn_multiples).with(:dir, 'candy', count: 3)
+        Spwn.dir('candy', count: 3) do
+          Spwn.file
+        end
+      end
+      it "should accept a block" do
+        Spwn.should_receive(:file).exactly(3).times
+        Spwn.dir(count: 3) do |dir|
+          Spwn.file
+        end
+      end
+      it "should return an Array" do
+        Spwn.dir(count: 3).should be_an_instance_of Array
+      end
+      it "should spawn multiple dirs" do
+        expect { Spwn.dir(count: 3) }.to change{
+          Dir.entries(Dir.pwd).length
+        }.by(3)
+      end
+    end
+  end
+
+  context "clean" do
+    before(:each) do
+      Spwn.dir(count: 4) do
+        Spwn.file(count: 3)
+      end
+      clean
+    end
+    context "with directory" do
+      subject(:clean) { Spwn.clean(TESTDIR) }
+      it "can remove everything under a directory" do
+        testdir = Dir.entries(TESTDIR) - ['.','..']
+        testdir.should be_empty
+      end
+      it "should empty the @dirs array" do
+        Spwn.dirs.should be_empty
+      end
+      it "should emtpy the @files array" do
+        Spwn.files.should be_empty
+      end
+    end
+    #context "without directory" do
+    #  subject(:clean) { Spwn.clean() }
+    #  it "can remove everything it remembers" do
+    #    testdir = Dir.entries(TESTDIR) - ['.','..']
+    #    testdir.should be_empty
+    #  end
+    #  it "should empty the @dirs array" do
+    #    Spwn.dirs.should be_empty
+    #  end
+    #  it "should emtpy the @files array" do
+    #    Spwn.files.should be_empty
+    #  end
+    #end
+  end
+  context "split_filename" do
+    context "with a normal file" do
+      subject() { Spwn.split_filename("super_file21") }
+      it "should return an Array" do
+        subject.should be_an_instance_of Array
+      end
+      it "should return a file name" do
+        subject[0].should == "super_file"
+      end
+      it "should return a file number" do
+        subject[1].should == 21
+      end
+    end
+    context "with a dot file" do
+      subject() { Spwn.split_filename(".gitignore") }
+      it "should return an Array" do
+        subject.should be_an_instance_of Array
+      end
+      it "should return a file name" do
+        subject[0].should == ".gitignore"
+      end
+      it "should not return a digit" do
+        subject[1].should be_nil
+      end
+    end
+  end
+end

data/spwn.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/spwn/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Mullins"]
+  gem.email         = ["mcmullins@mail.umhb.edu"]
+  gem.summary       = %q{Spwn is a small tool for producing random files and directories for testing purposes}
+  gem.description   = %q{Spwn is a small tool for producing random files and directories for testing purposes}
+  gem.homepage      = "http://www.github.com/mcmullins/spwn"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "spwn"
+  gem.require_paths = ["lib"]
+  gem.version       = Spwn::VERSION
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rb-inotify'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: spwn
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Mullins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: rspec
+  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: rb-inotify
+  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: Spwn is a small tool for producing random files and directories for testing
+  purposes
+email:
+- mcmullins@mail.umhb.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spwn.rb
+- lib/spwn/version.rb
+- spec/spec_helper.rb
+- spec/spwn_spec.rb
+- spwn.gemspec
+homepage: http://www.github.com/mcmullins/spwn
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Spwn is a small tool for producing random files and directories for testing
+  purposes
+test_files:
+- spec/spec_helper.rb
+- spec/spwn_spec.rb