maid 0.5.0 → 0.6.0.alpha.1

data/spec/lib/maid/maid_spec.rb

@@ -9,36 +9,36 @@ module Maid
     end
 
     describe '.new' do
-      it 'should set up a logger with the default path' do
-        Logger.should_receive(:new).with(Maid::DEFAULTS[:log_device], anything, anything)
+      it 'sets up a logger with the default path' do
+        expect(Logger).to receive(:new).with(Maid::DEFAULTS[:log_device], anything, anything)
         Maid.new
       end
 
-      it 'should set up a logger with the given path, when provided' do
+      it 'sets up a logger with the given path, when provided' do
         log_device = '/var/log/maid.log'
-        Logger.should_receive(:new).with(log_device, anything, anything)
+        expect(Logger).to receive(:new).with(log_device, anything, anything)
         Maid.new(:log_device => log_device)
       end
 
-      it 'should rotate the log with the default settings' do
-        Logger.should_receive(:new).with(anything, Maid::DEFAULTS[:log_shift_age], Maid::DEFAULTS[:log_shift_size])
+      it 'rotates the log with the default settings' do
+        expect(Logger).to receive(:new).with(anything, Maid::DEFAULTS[:log_shift_age], Maid::DEFAULTS[:log_shift_size])
         Maid.new
       end
 
-      it 'should rotate the log with the given settings, when provided' do
-        Logger.should_receive(:new).with(anything, 42, 1_000_000)
+      it 'rotates the log with the given settings, when provided' do
+        expect(Logger).to receive(:new).with(anything, 42, 1_000_000)
         Maid.new(:log_shift_age => 42, :log_shift_size => 1_000_000)
       end
 
-      it 'should make the log directory in case it does not exist' do
-        FileUtils.should_receive(:mkdir_p).with('/home/username/log')
+      it 'makes the log directory in case it does not exist' do
+        expect(FileUtils).to receive(:mkdir_p).with('/home/username/log')
         Maid.new(:log_device => '/home/username/log/maid.log')
       end
 
-      it 'should take a logger object during intialization' do
+      it 'takes a logger object during intialization' do
         Logger.unstub(:new)
         maid = Maid.new(:logger => @logger)
-        maid.logger.should == @logger
+        expect(maid.logger).to eq(@logger)
       end
 
       describe 'platform-specific behavior' do
@@ -54,11 +54,11 @@ module Maid
             XDG.stub(:[]).with('DATA_HOME') { "#{ @home }/.local/share" }
           end
 
-          it 'should set the trash to the correct default path' do
+          it 'set the trash to the correct default path' do
             trash_path = "#{ @home }/.local/share/Trash/files/"
-            FileUtils.should_receive(:mkdir_p).with(trash_path).once
+            expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
             maid = Maid.new
-            maid.trash_path.should == trash_path
+            expect(maid.trash_path).to eq(trash_path)
           end
         end
 
@@ -67,60 +67,60 @@ module Maid
             Platform.stub(:osx?) { true }
           end
 
-          it 'should set the trash to the correct default path' do
+          it 'sets the trash to the correct default path' do
             trash_path = "#{ @home }/.Trash/"
-            FileUtils.should_receive(:mkdir_p).with(trash_path).once
+            expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
             maid = Maid.new
-            maid.trash_path.should == trash_path
+            expect(maid.trash_path).to eq(trash_path)
           end
         end
 
         context 'when running on an unsupported platform' do
           it 'does not implement trashing files' do
-            lambda { Maid.new }.should raise_error(NotImplementedError)
+            expect(lambda { Maid.new }).to raise_error(NotImplementedError)
           end
         end
       end
 
-      it 'should set the trash to the given path, if provided' do
+      it 'sets the trash to the given path, if provided' do
         trash_path = '/home/username/tmp/my_trash/'
-        FileUtils.should_receive(:mkdir_p).with(trash_path).once
+        expect(FileUtils).to receive(:mkdir_p).with(trash_path).once
         maid = Maid.new(:trash_path => trash_path)
-        maid.trash_path.should_not be_nil
-        maid.trash_path.should == trash_path
+        expect(maid.trash_path).not_to be_nil
+        expect(maid.trash_path).to eq(trash_path)
       end
 
-      it 'should set the progname for the logger' do
-        @logger.should_receive(:progname=).with(Maid::DEFAULTS[:progname])
+      it 'sets the progname for the logger' do
+        expect(@logger).to 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')
+      it 'sets the progname for the logger to the given name, if provided' do
+        expect(@logger).to 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]
+      it 'sets the file options to the defaults' do
+        expect(Maid.new.file_options).to eq(Maid::DEFAULTS[:file_options])
       end
 
-      it 'should set the file options to the given options, if provided' do
+      it 'sets the file options to the given options, if provided' do
         maid = Maid.new(:file_options => { :verbose => true })
-        maid.file_options.should == { :verbose => true }
+        expect(maid.file_options).to eq(:verbose => true)
       end
 
-      it 'should set the rules path' do
-        Maid.new.rules_path.should == Maid::DEFAULTS[:rules_path]
+      it 'sets the rules path' do
+        expect(Maid.new.rules_path).to eq(Maid::DEFAULTS[:rules_path])
       end
 
-      it 'should set the ruels pathto the given path, if provided' do
+      it 'sets the rules pathto the given path, if provided' do
         maid = Maid.new(:rules_path => 'Maidfile')
-        maid.rules_path.should == 'Maidfile'
+        expect(maid.rules_path).to eq('Maidfile')
       end
 
-      it 'should ignore nil options' do
+      it 'ignores nil options' do
         maid = Maid.new(:rules_path => nil)
-        maid.rules_path.should == Maid::DEFAULTS[:rules_path]
+        expect(maid.rules_path).to eq(Maid::DEFAULTS[:rules_path])
       end
     end
 
@@ -130,14 +130,14 @@ module Maid
         @logger.stub(:info)
       end
 
-      it 'should log start and finish' do
-        @logger.should_receive(:info).with('Started')
-        @logger.should_receive(:info).with('Finished')
+      it 'logs start and finish' do
+        expect(@logger).to receive(:info).with('Started')
+        expect(@logger).to receive(:info).with('Finished')
         @maid.clean
       end
 
-      it 'should follow the given rules' do
-        @maid.should_receive(:follow_rules)
+      it 'follows the given rules' do
+        expect(@maid).to receive(:follow_rules)
         @maid.clean
       end
     end
@@ -148,14 +148,14 @@ module Maid
         @maid = Maid.new
       end
 
-      it 'should set the Maid instance' do
-        ::Maid.should_receive(:with_instance).with(@maid)
+      it 'sets the Maid instance' do
+        expect(::Maid).to receive(:with_instance).with(@maid)
         @maid.load_rules
       end
 
-      it 'should give an error on STDERR if there is a LoadError' do
+      it 'gives an error on STDERR if there is a LoadError' do
         Kernel.stub(:load).and_raise(LoadError)
-        STDERR.should_receive(:puts)
+        expect(STDERR).to receive(:puts)
         @maid.load_rules
       end
     end
@@ -165,26 +165,26 @@ module Maid
         @maid = Maid.new
       end
 
-      it 'should add a rule to the list of rules' do
-        @maid.rules.length.should == 0
+      it 'adds a rule to the list of rules' do
+        expect(@maid.rules.length).to eq(0)
 
         @maid.rule('description') do
           'instructions'
         end
 
-        @maid.rules.length.should == 1
-        @maid.rules.first.description.should == 'description'
+        expect(@maid.rules.length).to eq(1)
+        expect(@maid.rules.first.description).to eq('description')
       end
     end
 
     describe '#follow_rules' do
-      it 'should follow each rule' do
+      it 'follows each rule' do
         n = 3
         maid = Maid.new
-        @logger.should_receive(:info).exactly(n).times
+        expect(@logger).to receive(:info).exactly(n).times
         rules = (1..n).map do |n|
           d = double("rule ##{ n }", :description => 'description')
-          d.should_receive(:follow)
+          expect(d).to receive(:follow)
           d
         end
         maid.instance_eval { @rules = rules }
@@ -198,12 +198,12 @@ module Maid
         @maid = Maid.new
       end
 
-      it 'should report `not-a-real-command` as not being a supported command' do
-        lambda { @maid.cmd('not-a-real-command arg1 arg2') }.should raise_error(NotImplementedError)
+      it 'reports `not-a-real-command` as not being a supported command' do
+        expect(lambda { @maid.cmd('not-a-real-command arg1 arg2') }).to raise_error(NotImplementedError)
       end
 
       it 'should report `echo` as a real command' do
-        lambda { @maid.cmd('echo .') }.should_not raise_error
+        expect(lambda { @maid.cmd('echo .') }).not_to raise_error
       end
     end
   end

data/spec/lib/maid/numeric_extensions_spec.rb

@@ -1,25 +1,25 @@
 require 'spec_helper'
 
 describe Maid::NumericExtensions::Time, '#since?' do
-  it 'should tell you that 1 week ago happened after 2 weeks ago' do
-    1.week.since?(2.weeks.ago).should be_true
+  it 'tells you that 1 week ago happened after 2 weeks ago' do
+    expect(1.week.since?(2.weeks.ago)).to be(true)
   end
 
-  it 'should tell you that 2 weeks ago was not after 1 week ago' do
-    2.week.since?(1.weeks.ago).should be_false
+  it 'tells you that 2 weeks ago was not after 1 week ago' do
+    expect(2.week.since?(1.weeks.ago)).to be(false)
   end
 end
 
 describe Maid::NumericExtensions::SizeToKb do
-  it 'should tell you that 1 megabyte equals 1024 kilobytes' do
-    1.megabyte.should == 1024.kilobytes
+  it 'tells you that 1 megabyte equals 1024 kilobytes' do
+    expect(1.megabyte).to eq(1024.kilobytes)
   end
 
-  it 'should tell you that 1 gigabyte equals 1024 megabytes' do
-    1.gigabyte.should == 1024.megabytes
+  it 'tells you that 1 gigabyte equals 1024 megabytes' do
+    expect(1.gigabyte).to eq(1024.megabytes)
   end
   
-  it 'should tell you that 1 terabyte equals 1024 gigabytes' do
-    1.terabyte.should == 1024.gigabytes
+  it 'tells you that 1 terabyte equals 1024 gigabytes' do
+    expect(1.terabyte).to eq(1024.gigabytes)
   end
 end

data/spec/lib/maid/platform_spec.rb

@@ -9,7 +9,7 @@ module Maid
     describe 'determining the host OS' do
       it 'delegates to RbConfig' do
         stub_host_os('foo')
-        subject.host_os.should == 'foo'
+        expect(subject.host_os).to eq('foo')
       end
     end
 
@@ -19,15 +19,15 @@ module Maid
       end
 
       it 'is identified as Linux' do
-        subject.linux?.should be_true
+        expect(subject.linux?).to be(true)
       end
 
       it 'is not identified as OS X' do
-        subject.osx?.should be_false
+        expect(subject.osx?).to be(false)
       end
 
       it 'locate is "locate"' do
-        Platform::Commands.locate.should match(/locate/)
+        expect(Platform::Commands.locate).to match(/locate/)
       end
     end
 
@@ -37,15 +37,15 @@ module Maid
       end
 
       it 'is not identified as Linux' do
-        subject.linux?.should be_false
+        expect(subject.linux?).to be(false)
       end
 
       it 'is identified as OS X' do
-        subject.osx?.should be_true
+        expect(subject.osx?).to be(true)
       end
 
       it 'locate is "mdfind"' do
-        Platform::Commands.locate.should match(/mdfind/)
+        expect(Platform::Commands.locate).to match(/mdfind/)
       end
     end
   end

data/spec/lib/maid/rake/single_rule_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+module Maid
+  module Rake
+    describe SingleRule do
+      subject(:single_rule) { described_class.new name, task }
+      let(:name)            { double(:rule_description) }
+      let(:task)            { Proc.new {} }
+
+      describe '#initialize' do
+        its(:name) { should eq(name) }
+        its(:task) { should eq(task) }
+      end
+
+      describe '#clean' do
+        let(:maid) { double(:maid_instance) }
+
+        before do
+          single_rule.maid_instance = maid
+        end
+
+        it 'calls #clean on maid_instance' do
+          expect(maid).to receive(:clean)
+          single_rule.clean
+        end
+      end
+
+      describe '#maid_instance' do
+        let(:maid_instance) { single_rule.maid_instance }
+
+        it 'instantiates a Maid with the proper arguments' do
+          expect(Maid).to receive(:new).with(rules_path: '/dev/null')
+          maid_instance
+        end
+
+        it 'returns a Maid instance' do
+          expect(maid_instance).to be_a(Maid)
+        end
+
+        it 'memoizes the result' do
+          expect(Maid).to receive(:new).once
+          maid_instance
+          maid_instance
+        end
+      end
+
+      describe '#define' do
+        let(:maid) { double(:maid_instance) }
+
+        before { single_rule.maid_instance = maid }
+
+        it 'defines a single rule upon maid instance' do
+          expect(maid).to receive(:rule).with(name, &task)
+          single_rule.define
+        end
+
+        it 'returns self' do
+          allow(maid).to receive(:rule).with(name, &task)
+          expect(single_rule.define).to eq(single_rule)
+        end
+      end
+
+      describe '.perform' do
+        subject(:perform) { described_class.perform name, task }
+        let(:name)        { double(:name) }
+        let(:task)        { Proc.new {} }
+
+        it 'creates an instance' do
+          expect(described_class)
+            .to receive(:new)
+            .with(name, task)
+            .and_call_original
+          perform
+        end
+
+        describe 'instance methods calling' do
+          let(:instance) { double(:single_rule).as_null_object }
+
+          before do
+            allow(described_class).to receive(:new).and_return(instance)
+          end
+
+          it 'calls #define and #clean on instance' do
+            expect(instance).to receive(:define)
+            expect(instance).to receive(:clean)
+            perform
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/maid/rake/task_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Maid
+  module Rake
+    describe Task do
+
+      before(:all) { ::Rake::TaskManager.record_task_metadata = true }
+
+      subject(:define_task) { described_class.new *args, &instructions }
+      let(:instructions)    { Proc.new {} }
+
+      describe '#initialize' do
+        before { ::Rake::Task.clear }
+
+        describe 'task body' do
+          let(:args) { :foobar }
+
+          it 'sends given instructions to SingleRule' do
+            expect(SingleRule)
+              .to receive(:perform)
+              .with('foobar', instructions)
+            define_task && ::Rake::Task[:foobar].execute
+          end
+        end
+
+        describe 'task description' do
+          context 'given just the task name as argument' do
+            let(:args) { [:foobar] }
+
+            it 'defines a rake task with default description' do
+              desc = described_class.const_get 'DEFAULT_DESCRIPTION'
+
+              define_task
+              expect(::Rake::Task[:foobar].comment).to eq(desc)
+            end
+          end
+
+          context 'given a description argument' do
+            let(:args) { [:foobar, description: 'Custom description'] }
+
+            it 'defines a rake task with the description provided' do
+              define_task
+              expect(::Rake::Task[:foobar].comment).to eq('Custom description')
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/maid/rule_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 module Maid
   describe Rule do
-    it 'should be able to be followed' do
+    it 'is able to be followed' do
       rule = Rule.new('my rule', lambda { 1 + 2 })
-      rule.follow.should == 3
+      expect(rule.follow).to eq(3)
     end
   end
 end