maid 0.1.0.beta1

data/spec/lib/maid/maid_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+module Maid
+  describe Maid do
+    before :each do
+      @logger = mock('Logger')
+      @logger.stub!(:progname=)
+      Logger.stub!(:new).and_return(@logger)
+    end
+
+    describe '.new' do
+      it 'should set up a logger with the default path' do
+        Logger.should_receive(:new).with(Maid::DEFAULTS[:log_path])
+        Maid.new
+      end
+
+      it 'should set up a logger with the given path, if provided' do
+        log_path = '/var/log/maid.log'
+        Logger.should_receive(:new).with(log_path)
+        Maid.new(:log_path => log_path)
+      end
+
+      it 'should make the log directory in case it does not exist' do
+        FileUtils.should_receive(:mkdir_p).with('/home/username/log')
+        Maid.new(:log_path => '/home/username/log/maid.log')
+      end
+
+      it 'should set the trash to the default path' do
+        maid = Maid.new
+        maid.trash_path.should_not be_nil
+        maid.trash_path.should == Maid::DEFAULTS[:trash_path]
+      end
+
+      it 'should set the trash to the given path, if provided' do
+        trash_path = '/home/username/.local/share/Trash/files/'
+        maid = Maid.new(:trash_path => trash_path)
+        maid.trash_path.should_not be_nil
+        maid.trash_path.should == trash_path
+      end
+
+      it 'should set the progname for the logger' do
+        @logger.should_receive(:progname=).with(Maid::DEFAULTS[:progname])
+        Maid.new
+      end
+
+      it 'should set the progname for the logger to the given name, if provided' do
+        @logger.should_receive(:progname=).with('Fran')
+        Maid.new(:progname => 'Fran')
+      end
+
+      it 'should set the file options to the defaults' do
+        Maid.new.file_options.should == Maid::DEFAULTS[:file_options]
+      end
+
+      it 'should set the file options to the given options, if provided' do
+        maid = Maid.new(:file_options => {:verbose => true})
+        maid.file_options.should == {:verbose => true}
+      end
+
+      it 'should set the rules path' do
+        Maid.new.rules_path.should == Maid::DEFAULTS[:rules_path]
+      end
+
+      it 'should set the ruels pathto the given path, if provided' do
+        maid = Maid.new(:rules_path => 'Maidfile')
+        maid.rules_path.should == 'Maidfile'
+      end
+
+      it 'should ignore nil options' do
+        maid = Maid.new(:rules_path => nil)
+        maid.rules_path.should == Maid::DEFAULTS[:rules_path]
+      end
+    end
+
+    describe '#clean' do
+      before :each do
+        @maid = Maid.new
+        @maid.stub!(:add_rules)
+        @logger.stub!(:info)
+      end
+
+      it 'should log start and finish' do
+        @logger.should_receive(:info).with('Started')
+        @logger.should_receive(:info).with('Finished')
+        @maid.clean
+      end
+
+      it 'should process the default rules' do
+        @maid.should_receive(:add_rules).with(Maid::DEFAULTS[:rules_path])
+        @maid.clean
+      end
+
+      it 'should follow the given rules, if provided' do
+        @maid.should_receive(:add_rules)
+        @maid.should_receive(:follow_rules)
+        @maid.clean
+      end
+    end
+
+    describe '#add_rules' do
+      before :each do
+        Kernel.stub!(:require)
+        @maid = Maid.new
+      end
+
+      it 'should set the Maid instance' do
+        ::Maid.should_receive(:with_instance).with(@maid)
+        @maid.add_rules('path')
+      end
+
+      it 'should require the path' do
+        path = 'rules.rb'
+        Kernel.should_receive(:require).with(path)
+        @maid.add_rules(path)
+      end
+    end
+
+    describe '#rule' do
+      before :each do
+        @maid = Maid.new
+      end
+
+      it 'should add a rule to the list of rules' do
+        @maid.rules.length.should == 0
+
+        @maid.rule 'description' do
+          'instructions'
+        end
+
+        @maid.rules.length.should == 1
+        @maid.rules.first.description.should == 'description'
+      end
+    end
+
+    describe '#follow_rules' do
+      it 'should follow each rule' do
+        n = 3
+        maid = Maid.new
+        @logger.should_receive(:info).exactly(n).times
+        rules = (1..n).map do |n|
+          mock = mock("rule ##{n}", :description => 'description')
+          mock.should_receive(:follow)
+          mock
+        end
+        maid.instance_eval { @rules = rules }
+
+        maid.follow_rules
+      end
+    end
+  end
+end

data/spec/lib/maid/rule_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+module Maid
+  describe Rule do
+    it 'should be able to be followed' do
+      rule = Rule.new 'my rule', lambda { 1 + 2 } 
+      rule.follow.should == 3
+    end
+  end
+end

data/spec/lib/maid/tools_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+module Maid
+  describe Tools do
+    before :each do
+      @home = File.expand_path('~')
+      FileUtils.stub!(:mv)
+
+      Maid.ancestors.should include(Tools)
+      @maid = Maid.new
+      @logger  = @maid.instance_eval { @logger }
+    end
+
+    describe '#move' do
+      before :each do
+        @from    = '~/Downloads/foo.zip'
+        @to      = '~/Reference/'
+        @options = @maid.file_options
+      end
+
+      it 'should move expanded paths, passing file_options' do
+        FileUtils.should_receive(:mv).with("#{@home}/Downloads/foo.zip", "#{@home}/Reference", @options)
+        @maid.move('~/Downloads/foo.zip', '~/Reference/')
+      end
+
+      it 'should log the move' do
+        @logger.should_receive(:info)
+        @maid.move(@from, @to)
+      end
+
+      it 'should not move if the target already exists' do
+        File.stub!(:exist?).and_return(true)
+        FileUtils.should_not_receive(:mv)
+        @logger.should_receive(:warn)
+
+        @maid.move(@from, @to)
+      end
+    end
+
+    describe '#trash' do
+      before :each do
+        @trash_path = @maid.trash_path
+        @path = '~/Downloads/foo.zip'
+      end
+
+      it 'should move the path to the trash' do
+        @maid.should_receive(:move).with(@path, @trash_path)
+        @maid.trash(@path)
+      end
+
+      it 'should use a safe path if the target exists' do
+        Timecop.freeze(Time.parse('2011-05-22T16:53:52-04:00')) do
+          File.stub!(:exist?).and_return(true)
+          @maid.should_receive(:move).with(@path, "#{@trash_path}/foo.zip 2011-05-22-16-53-52")
+          @maid.trash(@path)
+        end
+      end
+    end
+
+    describe '#dir' do
+      it 'should delegate to Dir#[] with an expanded path' do
+        Dir.should_receive(:[]).with("#@home/Downloads/*.zip")
+        @maid.dir('~/Downloads/*.zip')
+      end
+    end
+
+    describe '#find' do
+      it 'should delegate to Find.find with an expanded path' do
+        f = lambda { }
+        Find.should_receive(:find).with("#@home/Downloads/foo.zip", &f)
+        @maid.find('~/Downloads/foo.zip', &f)
+      end
+    end
+
+    describe '#downloaded_from' do
+      it 'should use Spotlight metadata to determine the download site' do
+        @maid.should_receive(:cmd).and_return(%Q{(\n    "http://www.site.com/foo.zip",\n"http://www.site.com/"\n)})
+        @maid.downloaded_from('foo.zip').should == ['http://www.site.com/foo.zip', 'http://www.site.com/']
+      end
+    end
+
+    describe '#duration_s' do
+      it 'should use Spotlight metadata to determine audio length' do
+        @maid.should_receive(:cmd).and_return('235.705')
+        @maid.duration_s('foo.mp3').should == 235.705
+      end
+    end
+
+    describe '#locate' do
+      it 'should use Spotlight to locate a file by name' do
+        @maid.should_receive(:cmd).and_return("/a/foo.zip\n/b/foo.zip\n")
+        @maid.locate('foo.zip').should == ['/a/foo.zip', '/b/foo.zip']
+      end
+    end
+
+    describe '#zipfile_contents' do
+      it 'should use unzip to inspect the contents of a .zip file' do
+        @maid.should_receive(:cmd).and_return("foo/foo.exe\nfoo/README.txt\n")
+        @maid.zipfile_contents('foo.zip').should == ['foo/foo.exe', 'foo/README.txt']
+      end
+    end
+
+    describe '#disk_usage' do
+      it 'should use du to find the disk usage of a file' do
+        @maid.should_receive(:cmd).and_return("136     foo.zip")
+        @maid.disk_usage('foo.zip').should == 136
+      end
+    end
+
+    describe '#git_piston' do
+      it 'should pull and push the given git repository, logging the action' do
+        @maid.should_receive(:cmd).with(%Q{cd "#@home/code/projectname" && git pull && git push 2>&1})
+        @logger.should_receive(:info)
+        @maid.git_piston('~/code/projectname')
+      end
+    end
+  end
+end

data/spec/lib/maid_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Maid do
+  it 'should include Maid::NumericExtensions' do
+    1.minute.should == 60
+  end
+end
+
+describe Maid, '.with_instance' do
+  it 'should temporarily set the instance to the given argument and execute the block' do
+    instance = mock('instance')
+    Maid.with_instance(instance) { 0 }.should == 0
+    Maid.instance_eval { @instance }.should be_nil
+  end
+end
+
+describe Maid, '.rules' do
+  it 'should run in the context of the Maid::Maid instance' do
+    instance = mock('instance')
+    instance.should_receive(:foo)
+
+    Maid.with_instance(instance) do
+      Maid.rules { foo }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rspec'
+require 'timecop'
+
+require 'maid'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: maid
+version: !ruby/object:Gem::Version 
+  hash: 62196401
+  prerelease: 6
+  segments: 
+  - 0
+  - 1
+  - 0
+  - beta
+  - 1
+  version: 0.1.0.beta1
+platform: ruby
+authors: 
+- Benjamin Oakes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 4
+        - 4
+        - 2
+        version: 4.4.2
+  type: :development
+  version_requirements: *id004
+description: Maid cleans up after you, based on rules you define.
+email: 
+- hello@benjaminoakes.com
+executables: 
+- maid
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/maid
+- lib/maid.rb
+- lib/maid/app.rb
+- lib/maid/maid.rb
+- lib/maid/numeric_extensions.rb
+- lib/maid/rule.rb
+- lib/maid/tools.rb
+- lib/maid/version.rb
+- maid.gemspec
+- spec/lib/maid/app_spec.rb
+- spec/lib/maid/maid_spec.rb
+- spec/lib/maid/rule_spec.rb
+- spec/lib/maid/tools_spec.rb
+- spec/lib/maid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.benjaminoakes.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: maid
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Maid cleans up after you, based on rules you define.
+test_files: 
+- spec/lib/maid/app_spec.rb
+- spec/lib/maid/maid_spec.rb
+- spec/lib/maid/rule_spec.rb
+- spec/lib/maid/tools_spec.rb
+- spec/lib/maid_spec.rb
+- spec/spec_helper.rb