cleaner 0.0.5 → 0.0.6

data/README.md

@@ -15,6 +15,9 @@ manage '~/Downloads' do
   move :avi, :to => '~/Movies/inbox'
   move %w(mp3 ogg), :to => '~/Music/inbox'
 
+  # label all files bigger than 100MB with red color (OS X only)
+  label :color => :red, :if => proc { |file| file.size > 100.megabytes }
+
   # Remove zip files if file without zip extension exists (uncompressed files)
   delete :zip, :if => proc { |file| File.exists?(file.path_without_ext) }
 
@@ -38,15 +41,85 @@ Generate sample configuration file (~/.cleaner.rb)
 
 Run cleaner in the background. By default it will run every 1 hour.
 
-	$ cleaner start
+    $ cleaner start
 
 You can specify cleaning interval with "rails like" syntax: 20.minutes, 4.hours, 1.day
 
-	$ cleaner start 4.hours
+    $ cleaner start 4.hours
 
 Stop cleaner daemon
 
-	$ cleaner stop
+    $ cleaner stop
+
+
+## Available actions
+
+  - Deleting files
+    ```
+    delete :zip
+    ```
+  - Moving files
+    ```
+    move :pdf, :to => '~/Documents/pdfs'
+    ```
+  - Copying files
+    ```
+    copy :mp3, :to => '~/Documents/audio'
+    ```
+  - Labeling files with colors (OS X only). Available colors: :white, :orange, :red, :yellow, :blue, :purple, :green, :gray
+    ```
+    label :txt, :color => :blue
+    ```
+
+
+## Writing own actions
+
+New actions can be added easily. All you need to do is implement #execute method.
+
+Useful methods when implementing own actions:
+
+  - #files - array of filtered file paths
+  - #options - hash of options passed to action
+
+```ruby
+# Here as example is label action which sets color label on files on OS X
+module Cleaner
+  module Actions
+    class Label < Action
+      COLORS = {
+        :white  => 0,
+        :orange => 1,
+        :red    => 2,
+        :yellow => 3,
+        :blue   => 4,
+        :purple => 5,
+        :green  => 6,
+        :gray   => 7,
+      }
+      def execute
+        code = COLORS[options[:color]]
+        files.each do |path|
+          script = %Q{tell application \\"Finder\\" to set label index of file (POSIX file \\"#{path}\\") to #{code}}
+          `osascript -e "#{script}"`
+        end
+      end
+    end
+  end
+end
+```
+
+### Using custom action
+Require action in your config file and use it as any other action.
+
+```ruby
+require 'label.rb'
+manage '/add-more-colors-to-your-files' do
+  # all avi files are labeled with green color
+  label :avi, :color => :green
+  # all files bigger than 100 megabytes are labeled with red color
+  label :color => :red, :if => proc { |file| file.size > 100.megabytes }
+end
+```
 
 ## Contributions
 
@@ -57,7 +130,7 @@ To fetch & test the library for development, do:
     $ bundle
     $ bundle exec rspec
 
-If you wont to contribute, please:
+If you want to contribute, please:
 
   * Fork the project.
   * Make your feature addition or bug fix.

data/lib/cleaner.rb

@@ -5,6 +5,7 @@ require "cleaner/action"
 require "cleaner/actions/delete"
 require "cleaner/actions/move"
 require "cleaner/actions/copy"
+require "cleaner/actions/label"
 require "cleaner/file_extension"
 require "cleaner/directory"
 require "cleaner/runner"

data/lib/cleaner/actions/label.rb

@@ -0,0 +1,23 @@
+module Cleaner
+  module Actions
+    class Label < Action
+      COLORS = {
+        :white  => 0,
+        :orange => 1,
+        :red    => 2,
+        :yellow => 3,
+        :blue   => 4,
+        :purple => 5,
+        :green  => 6,
+        :gray   => 7,
+      }
+      def execute
+        code = COLORS[options[:color]]
+        files.each do |path|
+          script = %Q{tell application \\"Finder\\" to set label index of file (POSIX file \\"#{path}\\") to #{code}}
+          `osascript -e "#{script}"`
+        end
+      end
+    end
+  end
+end

data/lib/cleaner/version.rb

@@ -1,3 +1,3 @@
 module Cleaner
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/cleaner/actions/label_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Cleaner::Actions::Label do
+  before do
+    example_dir '/foo' do
+      %w(a.zip b.txt).each { |name| touch name }
+    end
+    Dir.chdir('/foo')
+  end
+
+  let(:label) { Cleaner::Actions::Label.new(%w(/foo/a.zip), :color => :red) }
+
+  it "should invoke labeling script for given file with color's code" do
+    command = "osascript -e \"tell application \\\"Finder\\\" to set label index of file (POSIX file \\\"/foo/a.zip\\\") to 2\""
+    label.should_receive(:`).with(command)
+    label.execute
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleaner
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70199256123380 !ruby/object:Gem::Requirement
+  requirement: &70255426043020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70199256123380
+  version_requirements: *70255426043020
 - !ruby/object:Gem::Dependency
   name: filelist
-  requirement: &70199256122960 !ruby/object:Gem::Requirement
+  requirement: &70255426042600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70199256122960
+  version_requirements: *70255426042600
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70199256122500 !ruby/object:Gem::Requirement
+  requirement: &70255426042140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70199256122500
+  version_requirements: *70255426042140
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70199256122080 !ruby/object:Gem::Requirement
+  requirement: &70255426041720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70199256122080
+  version_requirements: *70255426041720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70199256121660 !ruby/object:Gem::Requirement
+  requirement: &70255426041300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256121660
+  version_requirements: *70255426041300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70199256137600 !ruby/object:Gem::Requirement
+  requirement: &70255426040880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256137600
+  version_requirements: *70255426040880
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70199256137180 !ruby/object:Gem::Requirement
+  requirement: &70255426040460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256137180
+  version_requirements: *70255426040460
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70199256136760 !ruby/object:Gem::Requirement
+  requirement: &70255426040040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256136760
+  version_requirements: *70255426040040
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70199256136300 !ruby/object:Gem::Requirement
+  requirement: &70255426039580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256136300
+  version_requirements: *70255426039580
 - !ruby/object:Gem::Dependency
   name: ruby_gntp
-  requirement: &70199256135880 !ruby/object:Gem::Requirement
+  requirement: &70255426039160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70199256135880
+  version_requirements: *70255426039160
 description: ! "  Cleaner is a small tool which helps you keep your directories clean.\n
   \ With simple DSL you define set of rules, which are then periodically executed
   against specified directory.\n"
@@ -146,6 +146,7 @@ files:
 - lib/cleaner/action.rb
 - lib/cleaner/actions/copy.rb
 - lib/cleaner/actions/delete.rb
+- lib/cleaner/actions/label.rb
 - lib/cleaner/actions/move.rb
 - lib/cleaner/cli.rb
 - lib/cleaner/directory.rb
@@ -156,6 +157,7 @@ files:
 - spec/cleaner/action_spec.rb
 - spec/cleaner/actions/copy_spec.rb
 - spec/cleaner/actions/delete_spec.rb
+- spec/cleaner/actions/label_spec.rb
 - spec/cleaner/actions/move_spec.rb
 - spec/cleaner/cli_spec.rb
 - spec/cleaner/directory_spec.rb
@@ -193,6 +195,7 @@ test_files:
 - spec/cleaner/action_spec.rb
 - spec/cleaner/actions/copy_spec.rb
 - spec/cleaner/actions/delete_spec.rb
+- spec/cleaner/actions/label_spec.rb
 - spec/cleaner/actions/move_spec.rb
 - spec/cleaner/cli_spec.rb
 - spec/cleaner/directory_spec.rb