maid 0.1.4.alpha.2 → 0.2.0.alpha.1

data/lib/maid/user_agent.rb

@@ -0,0 +1,21 @@
+require 'ohai'
+
+# Version information for the host system, kind of like a browser's user agent string.
+#
+# This could potentially be a part of `Platform` or `VERSION` but both of those are used when building the gemspec, which can't depend on other gems.
+module Maid::UserAgent
+  class << self
+    # This used to be called `#to_s`, but that made things difficult when testing.
+    def value
+      ohai = Ohai::System.new
+      ohai.all_plugins
+      ohai_rb = ohai['languages']['ruby']
+
+      maid     = "Maid/#{ ::Maid.const_get(:VERSION) }"
+      platform = "#{ ohai['platform'] }/#{ ohai['platform_version'] }"
+      ruby     = "Ruby/#{ ohai_rb['version'] } #{ ohai_rb['platform'] }"
+      
+      "#{ maid } (#{ platform }; #{ ruby })"
+    end
+  end
+end

data/lib/maid/version.rb

@@ -1,3 +1,3 @@
 module Maid
-  VERSION = '0.1.4.alpha.2'
+  VERSION = '0.2.0.alpha.1'
 end

data/maid.gemspec

@@ -22,12 +22,15 @@ Gem::Specification.new do |s|
   # # After a new version with the Ruby 1.9 bugfix is released, change over to `xdg`
   # s.add_dependency('xdg', '~> 2.2.2')
   s.add_dependency('maid-xdg', '= 2.2.1.2')
+  s.add_dependency('ohai', '~> 6.14.0')
+  s.add_development_dependency('fakefs', '~> 0.4.1')
   s.add_development_dependency('guard', '~> 1.5.4')
-  s.add_development_dependency('guard-rspec', '~> 2.1.2')
+  s.add_development_dependency('guard-rspec', '~> 2.2.0')
   s.add_development_dependency('rake', '~> 10.0.2')
+  s.add_development_dependency('redcarpet', '~> 2.2.2') # Soft dependency of `yard`
   s.add_development_dependency('rspec', '~> 2.12.0')
   s.add_development_dependency('timecop', '~> 0.5.3')
-  s.add_development_dependency('fakefs', '~> 0.4.1')
+  s.add_development_dependency('yard', '~> 0.8.3')
 
   if Maid::Platform.linux?
     s.add_development_dependency('rb-inotify', '~> 0.8.8')

data/spec/dependency_spec.rb

@@ -0,0 +1,38 @@
+require 'ohai'
+require 'xdg'
+
+# > What is Dependency Testing?
+# >
+# > Examines an application's requirements for pre-existing software, initial states and configuration in order to maintain proper functionality.
+# >
+# > -- http://sqa.fyicenter.com/FAQ/Software-QA-Testing/What_is_Dependency_Testing_.html
+describe 'Dependency expectations' do
+  describe Ohai do
+    before do
+      @ohai = Ohai::System.new
+      # FIXME: For some reason this is really slow when using `guard`
+      @ohai.require_plugin('os')
+    end
+  
+    it 'has platform information' do
+      @ohai.require_plugin('platform')
+      @ohai['platform'].should match(/[a-z]+/i)
+      @ohai['platform_version'].should match(/[0-9]+/)
+    end
+  
+    it 'has Ruby information' do
+      ruby = @ohai['languages']['ruby']
+      ruby['version'].should match(/^[0-9\.]+$/i)
+      ruby['platform'].should match(/[a-z0-9]+/i)
+    end
+  end
+
+  describe XDG do
+    it 'has DATA_HOME' do
+      # FIXME: This test could be cleaner.  We can't depend on the directory to already exist, even on systems that use the XDG standard.  This seems safe enough for now.
+      #
+      # More info: [XDG Base Directory Specification](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html)
+      XDG['DATA_HOME'].to_s.should match(%r{^/.*?/\.local/share$})
+    end
+  end
+end

data/spec/lib/maid/app_spec.rb

@@ -21,14 +21,14 @@ module Maid
       $stderr = STDERR
     end
 
-    before :each do
+    before do
       @app = App.new
       @app.stub!(:maid_options)
       @app.stub!(:say)
 
       TrashMigration.stub(:needed?) { false }
 
-      # NOTE It's pretty important that this is stubbed, unless you want your rules to be run over and over when you test!
+      # NOTE: It's pretty important that this is stubbed, unless you want your rules to be run over and over when you test!
       @maid = mock('Maid')
       @maid.stub!(:clean)
       @maid.stub!(:log_device)
@@ -37,7 +37,7 @@ module Maid
     end
 
     it 'should make a new Maid with the options' do
-      opts = {:foo => 'bar'}
+      opts = { :foo => 'bar' }
       @app.stub!(:maid_options).and_return(opts)
       Maid.should_receive(:new).with(opts).and_return(@maid)
       @app.clean
@@ -53,7 +53,7 @@ module Maid
     end
 
     it 'should be silent if given the --silent option' do
-      # TODO It might even make sense to wrap "maid.clean" in capture_stdout { }...
+      # TODO: It might even make sense to wrap `maid.clean` in `capture_stdout { ... }`
       capture_stdout { App.start(['clean', '--silent']) }.string.should == ''
     end
 
@@ -67,15 +67,35 @@ module Maid
   end
 
   describe App, '#version' do
+    before do
+      @app = App.new
+    end
+
     it 'should print out the gem version' do
-      app = App.new
-      app.should_receive(:say).with(VERSION)
-      app.version
+      @app.should_receive(:say).with(VERSION)
+      @app.version
+    end
+
+    context 'with the "long" option' do
+      before do
+        # FIXME: This is ugly.  Maybe use `Maid.start(%w(version --long))` instead.
+
+        # We can't simply stub `long?` because `options` is a frozen object.
+        options = mock('options', :long? => true)
+        @app.options = options
+      end
+
+      it 'should print out the gem version' do
+        ua = 'Maid/0.0.1'
+        UserAgent.stub(:value) { ua }
+        @app.should_receive(:say).with(ua)
+        @app.version
+      end
     end
   end
 
   describe App, '#maid_options' do
-    before :each do
+    before do
       @app = App.new
     end
 

data/spec/lib/maid/maid_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Maid
   describe Maid do
-    before :each do
+    before do
       @logger = double('Logger').as_null_object
       Logger.stub!(:new).and_return(@logger)
       FileUtils.stub(:mkdir_p)
@@ -95,8 +95,8 @@ module Maid
       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}
+        maid = Maid.new(:file_options => { :verbose => true })
+        maid.file_options.should == { :verbose => true }
       end
 
       it 'should set the rules path' do
@@ -115,7 +115,7 @@ module Maid
     end
 
     describe '#clean' do
-      before :each do
+      before do
         @maid = Maid.new
         @logger.stub!(:info)
       end
@@ -133,7 +133,7 @@ module Maid
     end
 
     describe '#load_rules' do
-      before :each do
+      before do
         Kernel.stub!(:load)
         @maid = Maid.new
       end
@@ -151,14 +151,14 @@ module Maid
     end
 
     describe '#rule' do
-      before :each do
+      before 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
+        @maid.rule('description') do
           'instructions'
         end
 
@@ -173,7 +173,7 @@ module Maid
         maid = Maid.new
         @logger.should_receive(:info).exactly(n).times
         rules = (1..n).map do |n|
-          mock = mock("rule ##{n}", :description => 'description')
+          mock = mock("rule ##{ n }", :description => 'description')
           mock.should_receive(:follow)
           mock
         end
@@ -184,7 +184,7 @@ module Maid
     end
 
     describe '#cmd' do
-      before :each do
+      before do
         @maid = Maid.new
       end
 

data/spec/lib/maid/numeric_extensions_spec.rb

@@ -2,24 +2,24 @@ 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
+    1.week.since?(2.weeks.ago).should 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
+    2.week.since?(1.weeks.ago).should be_false
   end
 end
 
 describe Maid::NumericExtensions::SizeToKb do
   it 'should tell you that 1 megabyte equals 1024 kilobytes' do
-    (1.megabyte == 1024.kilobytes).should be_true
+    1.megabyte.should == 1024.kilobytes
   end
 
   it 'should tell you that 1 gigabyte equals 1024 megabytes' do
-    (1.gigabyte == 1024.megabytes).should be_true
+    1.gigabyte.should == 1024.megabytes
   end
   
   it 'should tell you that 1 terabyte equals 1024 gigabytes' do
-    (1.terabyte == 1024.gigabytes).should be_true
+    1.terabyte.should == 1024.gigabytes
   end
-end
+end

data/spec/lib/maid/rule_spec.rb

@@ -3,7 +3,7 @@ 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 = Rule.new('my rule', lambda { 1 + 2 })
       rule.follow.should == 3
     end
   end

data/spec/lib/maid/tools_spec.rb

@@ -7,7 +7,7 @@ module Maid
   #
   # * [FakeFS](https://github.com/defunkt/fakefs)
   describe Tools, :fakefs => true do
-    before :each do
+    before do
       @home = File.expand_path('~')
       @now = Time.now
 
@@ -24,7 +24,7 @@ module Maid
     end
 
     describe '#move' do
-      before :each do
+      before do
         @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
         FileUtils.mkdir_p(@src_dir)
         FileUtils.touch(@src_file)
@@ -60,7 +60,7 @@ module Maid
     end
 
     describe '#trash' do
-      before :each do
+      before do
         @trash_path = @maid.trash_path
         @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
         FileUtils.mkdir_p(@src_dir)
@@ -110,7 +110,7 @@ module Maid
     end
 
     describe '#remove' do
-      before :each do
+      before do
         @src_file = (@src_dir = '~/Source/') + (@file_name = 'foo.zip')
         FileUtils.mkdir_p(@src_dir)
         FileUtils.touch(@src_file)
@@ -152,7 +152,7 @@ module Maid
     end
 
     describe '#dir' do
-      before :each do
+      before do
         @file = (dir = "#@home/Downloads/") + 'foo.zip'
         FileUtils.mkdir_p(dir)
       end
@@ -161,6 +161,12 @@ module Maid
         FileUtils.touch(@file)
         @maid.dir('~/Downloads/*.zip').should == [@file]
       end
+
+      it 'lists multiple files in alphabetical order' do
+        # It doesn't occur with `FakeFS` as far as I can tell, but Ubuntu (and possibly OS X) can give the results out of lexical order.  That makes using the `dry-run` output difficult to use.
+        Dir.stub(:[]) { %w(/home/foo/b.zip /home/foo/a.zip /home/foo/c.zip) }
+        @maid.dir('~/Downloads/*.zip').should == %w(/home/foo/a.zip /home/foo/b.zip /home/foo/c.zip)
+      end
     end
 
     describe '#mkdir' do
@@ -171,7 +177,7 @@ module Maid
     end
 
     describe '#find' do
-      before :each do
+      before do
         @file = (@dir = '~/Source/') + (@file_name = 'foo.zip')
         FileUtils.mkdir_p(@dir)
         FileUtils.touch(@file)
@@ -261,7 +267,7 @@ module Maid
 
     describe '#modified_at' do
       before do
-        @path = "~/test.txt"
+        @path = '~/test.txt'
         FileUtils.touch(File.expand_path(@path))
       end
 
@@ -289,7 +295,7 @@ module Maid
     end
 
     describe '#sync' do
-      before :each do
+      before do
         @src_dir = '~/Downloads/'
         @dst_dir = '~/Reference'
       end

data/spec/lib/maid/user_agent_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Maid
+  describe UserAgent do
+    describe 'the user agent string' do
+      it 'is formatted with the Maid version, platform version, and Ruby version' do
+	system = {
+          'platform' => 'Unix',
+          'platform_version' => '1.0',
+          'languages' => {
+            'ruby' => {
+              'version' => '1.8.8',
+              'platform' => 'pdp7',
+            }
+          }
+	}
+
+	system.stub(:all_plugins)
+
+	Ohai::System.stub(:new) { system }
+        ::Maid.stub(:const_get).with(:VERSION) { '0.0.1' }
+
+	UserAgent.value.should == 'Maid/0.0.1 (Unix/1.0; Ruby/1.8.8 pdp7)'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,8 +6,8 @@ require 'fakefs/spec_helpers'
 require 'maid'
 
 RSpec.configure do |c|
-  c.mock_with :rspec
-  c.include FakeFS::SpecHelpers, :fakefs => true
+  c.mock_with(:rspec)
+  c.include(FakeFS::SpecHelpers, :fakefs => true)
 end
 
 RSpec::Matchers.define :have_deprecated_method do |expected|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maid
 version: !ruby/object:Gem::Version
-  version: 0.1.4.alpha.2
+  version: 0.2.0.alpha.1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &5554040 !ruby/object:Gem::Requirement
+  requirement: &10448900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *5554040
+  version_requirements: *10448900
 - !ruby/object:Gem::Dependency
   name: deprecated
-  requirement: &5553020 !ruby/object:Gem::Requirement
+  requirement: &10447740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *5553020
+  version_requirements: *10447740
 - !ruby/object:Gem::Dependency
   name: maid-xdg
-  requirement: &5551980 !ruby/object:Gem::Requirement
+  requirement: &10447020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,32 @@ dependencies:
         version: 2.2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *5551980
+  version_requirements: *10447020
+- !ruby/object:Gem::Dependency
+  name: ohai
+  requirement: &10445920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 6.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *10445920
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &10443960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: *10443960
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &5551180 !ruby/object:Gem::Requirement
+  requirement: &10442880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,21 +76,21 @@ dependencies:
         version: 1.5.4
   type: :development
   prerelease: false
-  version_requirements: *5551180
+  version_requirements: *10442880
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &5550480 !ruby/object:Gem::Requirement
+  requirement: &10442340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *5550480
+  version_requirements: *10442340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &5549900 !ruby/object:Gem::Requirement
+  requirement: &10441780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +98,21 @@ dependencies:
         version: 10.0.2
   type: :development
   prerelease: false
-  version_requirements: *5549900
+  version_requirements: *10441780
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &10418840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *10418840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &5549320 !ruby/object:Gem::Requirement
+  requirement: &10418280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +120,10 @@ dependencies:
         version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *5549320
+  version_requirements: *10418280
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &5548760 !ruby/object:Gem::Requirement
+  requirement: &10417660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,21 +131,21 @@ dependencies:
         version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *5548760
+  version_requirements: *10417660
 - !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: &5548180 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &10417100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.8.3
   type: :development
   prerelease: false
-  version_requirements: *5548180
+  version_requirements: *10417100
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &5547540 !ruby/object:Gem::Requirement
+  requirement: &10416480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,7 +153,7 @@ dependencies:
         version: 0.8.8
   type: :development
   prerelease: false
-  version_requirements: *5547540
+  version_requirements: *10416480
 description: Be lazy.  Let Maid clean up after you, based on rules you define.
 email:
 - hello@benjaminoakes.com
@@ -151,6 +184,7 @@ files:
 - lib/maid/rules.sample.rb
 - lib/maid/tools.rb
 - lib/maid/trash_migration.rb
+- lib/maid/user_agent.rb
 - lib/maid/version.rb
 - maid.gemspec
 - resources/OneThingWell.png
@@ -158,6 +192,7 @@ files:
 - resources/ruby5.gif
 - script/vagrant-provision
 - script/vagrant-test
+- spec/dependency_spec.rb
 - spec/lib/maid/app_spec.rb
 - spec/lib/maid/maid_spec.rb
 - spec/lib/maid/numeric_extensions_spec.rb
@@ -165,6 +200,7 @@ files:
 - spec/lib/maid/rule_spec.rb
 - spec/lib/maid/tools_spec.rb
 - spec/lib/maid/trash_migration_spec.rb
+- spec/lib/maid/user_agent_spec.rb
 - spec/lib/maid_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/benjaminoakes/maid
@@ -193,3 +229,4 @@ signing_key:
 specification_version: 3
 summary: Be lazy.  Let Maid clean up after you, based on rules you define.
 test_files: []
+has_rdoc: