wriggle 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+rdoc
+pkg
+.yardoc/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 rspeicher
+
+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,39 @@
+# Wriggle
+
+A simple directory crawler DSL.
+
+## Usage
+
+    require 'wriggle'
+
+    wriggle '/path/to/files' do
+
+      # Build an array of Ruby code files
+      ruby_files = []
+      file :rb do |path|
+        ruby_files << path
+      end
+
+      # Build an array of video files
+      video_files = []
+      file %w(mpg mpeg wmv avi mkv) do |path|
+        video_files << path
+      end
+
+      # Delete directories that are empty
+      directory do |path|
+        Dir.rmdir(path) unless Dir.entries(path).length > 2
+      end
+    end
+
+## Note on Patches/Pull Requests
+
+* Fork
+* Code
+* Commit
+* Push
+* Pull Request
+
+## Copyright
+
+Copyright (c) 2010 rspeicher. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "wriggle"
+    gem.summary = %Q{A simple directory crawler DSL.}
+    gem.description = %Q{A simple directory crawler DSL.}
+    gem.email = "rspeicher@gmail.com"
+    gem.homepage = "http://github.com/tsigo/wriggle"
+    gem.authors = ["rspeicher"]
+    gem.add_development_dependency "rspec", "~> 1.3.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/wriggle.rb

@@ -0,0 +1,112 @@
+require 'find'
+
+# = Wriggle
+#
+# A simple directory crawler DSL.
+#
+# == Usage
+#
+#   require 'wriggle'
+#
+#   wriggle '/path/to/files' do
+#
+#     # Build an array of Ruby code files
+#     ruby_files = []
+#     file :rb do |path|
+#       ruby_files << path
+#     end
+#
+#     # Build an array of video files
+#     video_files = []
+#     file %w(mpg mpeg wmv avi mkv) do |path|
+#       video_files << path
+#     end
+#
+#     # Delete directories that are empty
+#     directory do |path|
+#       Dir.rmdir(path) unless Dir.entries(path).length > 2
+#     end
+#   end
+module Wriggle
+  # Crawl the given +path+
+  #
+  # @raise ArgumentError Given path does not exist or is not a directory
+  def wriggle(path, &block)
+    raise ArgumentError, "#{path} does not exist or is not a directory" unless File.directory?(path)
+
+    Wriggle.new(path, &block)
+  end
+
+  class Wriggle
+    attr_accessor :root, :file_blocks, :directory_blocks
+
+    def initialize(root, &block)
+      @root             = root
+      @file_blocks      = []
+      @directory_blocks = []
+
+      crawl(&block)
+    end
+
+    def crawl(&block)
+      Find.find(root) do |current|
+        instance_eval(&block)
+
+        if File.file?(current)
+          dispatch_file(current)
+        elsif File.directory?(current)
+          dispatch_directory(current)
+        end
+      end
+    end
+
+    # Define a block to be called when a file is encountered
+    #
+    # Provide one or more extensions to limit the files yielded.
+    #
+    # == Examples:
+    #   file :rb { |file| ... }
+    #   file :rb, :rdoc { |file| ... }
+    #   file %w(mpeg mpeg wmv avi mkv) { |file| ... }
+    #
+    # @raise ArgumentError When no block provided
+    def file(*extensions, &block)
+      raise ArgumentError, "a block is required" unless block_given?
+      file_blocks << {:ext => extensions.flatten, :block => block}
+    end
+
+    # Define a block to be called when a directory is encountered
+    #
+    # @raise ArgumentError When no block provided
+    def directory(&block)
+      raise ArgumentError, "a block is required" unless block_given?
+      directory_blocks << {:block => block}
+    end
+
+    private
+
+    def dispatch_file(path)
+      extension = File.extname(path)
+
+      file_blocks.each do |group|
+        if group[:ext].empty?
+          group[:block].call(path)
+        else
+          # Requested specific extensions only
+          # Check if any of the extensions match the current file's extension (with or without the period)
+          if group[:ext].any? { |v| v.to_s == extension or v.to_s == extension[1..-1] }
+            group[:block].call(path)
+          end
+        end
+      end
+    end
+
+    def dispatch_directory(path)
+      directory_blocks.each do |group|
+        group[:block].call(path)
+      end
+    end
+  end
+end
+
+self.send(:include, Wriggle)

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'wriggle'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

data/spec/wriggle_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Wriggle do
+  # 1.8.7's Find uses relative paths, while 1.9.2's uses absolutes,
+  # so we'll call expand_path and make sure our specs use this method
+  def valid_dir
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  it "should require a path argument" do
+    lambda { wriggle() {} }.should raise_error(ArgumentError)
+  end
+
+  it "should raise an ArgumentError when given an invalid path" do
+    lambda { wriggle('/path/to/nothing') {} }.should raise_error(ArgumentError, /does not exist/)
+  end
+
+  it "should raise an ArgumentError when given a non-directory" do
+    lambda { wriggle(__FILE__) {} }.should raise_error(ArgumentError, /is not a directory/)
+  end
+
+  context "given a valid path" do
+    describe "#file" do
+      it "should raise an ArgumentError when not given a block" do
+        lambda { wriggle(valid_dir) { file } }.should raise_error(ArgumentError, /a block is required/)
+      end
+
+      it "should not include directories when only a file block is provided" do
+        actual = []
+        wriggle(valid_dir) do
+          file do |path|
+            actual << path
+          end
+        end
+
+        actual.should include("#{valid_dir}/spec.opts")
+        actual.should include("#{valid_dir}/wriggle_spec.rb")
+        actual.should_not include("#{valid_dir}/spec")
+      end
+
+      it "should only include files of the type specified" do
+        actual = []
+        wriggle(valid_dir) do
+          file :rb do |path|
+            actual << path
+          end
+        end
+
+        actual.should include("#{valid_dir}/wriggle_spec.rb")
+        actual.should_not include("#{valid_dir}/spec.opts")
+        actual.should_not include("#{valid_dir}")
+      end
+    end
+
+    describe "#directory" do
+      it "should raise an ArgumentError when not given a block" do
+        lambda { wriggle(valid_dir) { directory } }.should raise_error(ArgumentError, /a block is required/)
+      end
+
+      it "should not include files when only a directory block is provided" do
+        actual = []
+        wriggle(valid_dir) do
+          directory do |path|
+            actual << path
+          end
+        end
+
+        actual.should include("#{valid_dir}")
+        actual.should_not include("#{valid_dir}/wriggle_spec.rb")
+      end
+    end
+  end
+end

data/wriggle.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wriggle}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["rspeicher"]
+  s.date = %q{2010-10-09}
+  s.description = %q{A simple directory crawler DSL.}
+  s.email = %q{rspeicher@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/wriggle.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/wriggle_spec.rb",
+     "wriggle.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tsigo/wriggle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple directory crawler DSL.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/wriggle_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: wriggle
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- rspeicher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: A simple directory crawler DSL.
+email: rspeicher@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/wriggle.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/wriggle_spec.rb
+- wriggle.gemspec
+has_rdoc: true
+homepage: http://github.com/tsigo/wriggle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple directory crawler DSL.
+test_files: 
+- spec/spec_helper.rb
+- spec/wriggle_spec.rb