filesortd 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+example.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filesortd.gemspec
+gemspec
+
+gem 'rb-kqueue', '~> 0.2' if RbConfig::CONFIG['target_os'] =~ /freebsd/i
+gem 'rb-fsevent', '~> 0.9.1' if RbConfig::CONFIG['target_os'] =~ /darwin(1.+)?$/i
+gem 'rb-inotify', '~> 0.8.8', :github => 'mbj/rb-inotify' if RbConfig::CONFIG['target_os'] =~ /linux/i
+gem 'wdm',        '~> 0.0.3' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+
+if RbConfig::CONFIG['target_os'] =~ /darwin(1.+)?$/i
+  gem 'osx-plist'
+end
+
+group :development, :test do
+  gem 'rspec'
+  gem 'fuubar'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 myfreeweb
+
+MIT License
+
+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,66 @@
+# Filesortd
+
+A Ruby DSL for automatically sorting your files based on rules.
+Like [Hazel](http://www.noodlesoft.com/hazel.php), but cross-platform, no GUI required.
+
+## Installation
+
+    $ gem install filesortd
+
+If you're on OS X, also install osx-plist for things like `downloaded_from` (i.e. xattr support) to work:
+
+    $ gem install osx-plist
+
+## Usage
+
+    $ filesortd start yourconfig.rb
+
+yourconfig.rb:
+
+```ruby
+# DSL usage example
+
+folder "/Users/myfreeweb/Downloads" do
+
+  # Do things to files that match a glob or a regex
+  match "*.mp3" do
+    mv "/Users/myfreeweb/Music"
+
+    # Do things if running on a particular OS
+    os :osx do
+      label :orange
+    end
+  end
+
+  # Mac OS X saves the location you downloaded a file from
+  downloaded_from %r{destroyallsoftware} do
+    mv "/Users/myfreeweb/Movies/DAS"
+  end
+end
+
+
+# You can watch multiple folders at once
+
+folders "/Users/myfreeweb/Pictures", "/opt/pictures" do
+
+  # Do things to any files
+  any do
+    label :blue
+  end
+
+  match "*.png" do
+    pass "optipng"
+    label :green
+  end
+end
+```
+
+Actions:
+
+- `contents` (or `read`) -- get the contents
+- `rm` (or `remove`, `delete`, `unlink`) -- remove
+- `cp` (or `copy`) -- copy
+- `mv` (or `move`) -- move/rename
+- `pipe(cmd)` -- start the command, pass the file to stdin, get the stdout
+- `pass(cmd)` -- start the command, pass the path to the file as an argument, get the stdout
+- `label(color)` -- set the OS X Finder label (:none, :orange, :red, :yellow, :blue, :purple, :green, :gray or :grey)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/filesortd

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "filesortd"
+require "filesortd/cli"
+
+Filesortd::CLI.start

data/filesortd.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filesortd/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "filesortd"
+  gem.version       = Filesortd::VERSION
+  gem.authors       = ["myfreeweb"]
+  gem.email         = ["floatboth@me.com"]
+  gem.description   = %q{Automatic rule-based sorting for your files. Like Hazel, but doesn't need a GUI.}
+  gem.summary       = %q{Rule-based file sorting}
+  gem.homepage      = "https://github.com/myfreeweb/filesortd"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "docile"
+  gem.add_dependency "listen"
+  gem.add_dependency "popen4"
+  gem.add_dependency "thor"
+end

data/lib/filesortd/afile.rb

@@ -0,0 +1,75 @@
+require "popen4"
+require "fileutils"
+
+module Filesortd
+  class Afile
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def contents
+      File.read @path
+    end
+    alias :read :contents
+
+    def rm
+      File.unlink @path
+      @path = nil
+    end
+    alias :remove :rm
+    alias :delete :rm
+    alias :unlink :rm
+
+    def cp(target)
+      FileUtils.cp @path, target
+      @path = target
+    end
+    alias :copy :cp
+
+    def mv(target)
+      FileUtils.mv @path, target
+      @path = target
+    end
+    alias :move :mv
+
+    def pipe(cmd)
+      out = nil
+      POpen4::popen4(cmd) do |stdout, stderr, stdin, pid|
+        stdin.puts File.read(@path)
+        stdin.close
+        out = stdout.read.strip
+      end
+      out
+    end
+
+    def pass(cmd)
+      out = nil
+      POpen4::popen4("#{cmd} #{@path.shellescape}") do |stdout, stderr, stdin, pid|
+        stdin.close
+        out = stdout.read.strip
+      end
+      out
+    end
+
+    def label(lbl)
+      if lbl.is_a? Symbol
+        idx = {
+          :none => 0,
+          :orange => 1,
+          :red => 2,
+          :yellow => 3,
+          :blue => 4,
+          :purple => 5,
+          :green => 6,
+          :gray => 7,
+          :grey => 7
+        }[lbl]
+      else
+        idx = lbl
+      end
+      system %{osascript -e 'tell app "Finder" to set label index of (POSIX file "#{@path}" as alias) to #{idx}' 2&>/dev/null}
+    end
+  end
+end

data/lib/filesortd/callback.rb

@@ -0,0 +1,38 @@
+require "filesortd/matcher"
+require "filesortd/afile"
+require "docile"
+
+module Filesortd
+  class Callback
+    attr_accessor :matchers
+
+    def initialize
+      @matchers = {}
+    end
+
+    def any(&callback)
+      @matchers[AlwaysTrueMatcher.new] = callback
+    end
+
+    def match(pattern, &callback)
+      @matchers[BasenameMatcher.new(pattern)] = callback
+    end
+
+    def downloaded_from(pattern, &callback)
+      pm = Matcher.new(pattern)
+      m = XattrMatcher.new("com.apple.metadata:kMDItemWhereFroms") do |elements, path|
+        elements.map { |el| pm.match(el) }.count(true) >= 1
+      end
+      @matchers[m] = callback
+    end
+
+    def call(paths)
+      paths.each do |path|
+        @matchers.each do |matcher, callback|
+          Docile.dsl_eval(Afile.new(path), &callback) if matcher.match(path)
+        end
+      end
+    end
+
+  end
+end

data/lib/filesortd/cli.rb

@@ -0,0 +1,38 @@
+require "thor"
+require "filesortd"
+
+module Filesortd
+  class Script
+    include Filesortd
+    attr_accessor :listeners
+    def initialize
+      @listeners = []
+    end
+  end
+
+  class CLI < Thor
+    default_task :start
+
+    desc 'start FILENAME', 'Start filesortd'
+    def start(filename)
+      puts 'Started filesortd'
+      begin
+        scpt = Script.new
+        scpt.instance_eval File.read(filename)
+        loop { sleep 0.1 }
+        # sleep to prevent 100% cpu load
+      rescue Interrupt
+        scpt.listeners.each do |l|
+          l.stop
+        end
+        puts 'Stopped filesortd'
+      end
+    end
+
+    desc 'version', 'Show the Guard version'
+    map %w(-v --version) => :version
+    def version
+      puts ::Filesortd::VERSION
+    end
+  end
+end

data/lib/filesortd/cond.rb

@@ -0,0 +1,19 @@
+module Filesortd
+  def os(s, &block)
+    if s == current_os
+      block.call
+    end
+  end
+
+  private
+  def current_os
+    case RbConfig::CONFIG['target_os']
+    when /freebsd/i then :freebsd
+    when /darwin(1.+)?$/i then :osx
+    when /linux/i then :linux
+    when /mswin|mingw/i then :windows
+    else
+      :unknown
+    end
+  end
+end

data/lib/filesortd/folder.rb

@@ -0,0 +1,22 @@
+require "listen"
+require "docile"
+require "filesortd/callback"
+
+module Filesortd
+  def folders(*paths, &block)
+    paths.select! do |path|
+      e = File.exists? path
+      puts "Folder does not exist: #{path}" unless e
+      e
+    end
+    callback = Docile.dsl_eval(Callback.new, &block)
+    cb = Proc.new do |modified, added, removed|
+      puts "Processing files: #{added}"
+      callback.call added
+    end
+    l = Listen.to(*paths).latency(0.5).change(&cb)
+    l.start(false)
+    @listeners << l
+  end
+  alias :folder :folders
+end

data/lib/filesortd/matcher.rb

@@ -0,0 +1,40 @@
+module Filesortd
+  class Matcher < Struct.new(:pattern)
+    def match(s)
+      if pattern.is_a? Regexp
+        !pattern.match(s).nil? # return a boolean through "not nil"
+      elsif pattern.is_a? String
+        File.fnmatch(pattern, s)
+      end
+    end
+  end
+
+  class BasenameMatcher < Matcher
+    alias :super_match :match
+    def match(path)
+      super_match(File.basename(path))
+    end
+  end
+
+  class XattrMatcher
+    def initialize(xattr, &matcher)
+      require "osx/plist"
+      require "Shellwords"
+      @xattr = xattr
+      @matcher = matcher
+    end
+
+    def match(path)
+      return false unless `xattr -l #{path.shellescape}`.include? @xattr
+      str = [`xattr -px #{@xattr.shellescape} #{path.shellescape}`.gsub("\n", "").gsub(" ", "")].pack("H*")
+      pl = OSX::PropertyList.load(str)
+      @matcher.call(pl, path)
+    end
+  end
+
+  class AlwaysTrueMatcher
+    def match(s)
+      true
+    end
+  end
+end

data/lib/filesortd/version.rb

@@ -0,0 +1,3 @@
+module Filesortd
+  VERSION = "0.1.0"
+end

data/lib/filesortd.rb

@@ -0,0 +1,8 @@
+require "filesortd/version"
+require "filesortd/folder"
+require "filesortd/callback"
+require "filesortd/matcher"
+require "filesortd/cond"
+
+module Filesortd
+end

data/spec/afile_spec.rb

@@ -0,0 +1,64 @@
+require "filesortd/afile"
+include Filesortd
+
+describe Afile do
+  let(:path) { "/tmp/filesortdtest" }
+
+  it "shows contents" do
+    File.write path, "1"
+    Afile.new(path).contents.should == "1"
+    File.unlink path
+  end
+
+  it "copies" do
+    path2 = "/tmp/filesortdtest2"
+    File.write path, "1"
+    af = Afile.new(path)
+    af.cp path2
+    af.path.should == path2
+    File.exists?(path).should be_true
+    File.exists?(path2).should be_true
+    File.unlink path
+    File.unlink path2
+  end
+
+  it "moves" do
+    path2 = "/tmp/filesortdtest2"
+    File.write path, "1"
+    af = Afile.new(path)
+    af.mv path2
+    af.path.should == path2
+    File.exists?(path).should be_false
+    File.exists?(path2).should be_true
+    File.unlink path2
+  end
+
+  it "removes" do
+    File.write path, "1"
+    af = Afile.new(path)
+    af.rm
+    af.path.should be_nil
+    File.exists?(path).should be_false
+  end
+
+  it "pipes" do
+    File.write path, "1+2"
+    Afile.new(path).pipe("bc").should == "3"
+    File.unlink path
+  end
+
+  it "passes" do
+    File.write path, "123"
+    Afile.new(path).pass("cat").should == "123"
+    File.unlink path
+  end
+
+  it "labels" do
+    if RbConfig::CONFIG['target_os'] =~ /darwin(1.+)?$/i
+      File.write path, "123"
+      Afile.new(path).label(:red)
+      `osascript -e 'tell app "Finder" to get label index of (POSIX file "#{path}" as alias)'`.should == "2\n"
+      File.unlink path
+    end
+  end
+end

data/spec/callback_spec.rb

@@ -0,0 +1,17 @@
+require "filesortd/callback"
+include Filesortd
+
+describe Callback do
+  let(:cb) { Callback.new }
+
+  it "executes callbacks for matched paths" do
+    true_matcher = double("matcher", :match => true)
+    false_matcher = double("matcher", :match => false)
+    true_called = false_called = false
+    cb.matchers[ true_matcher] = Proc.new {  true_called = true }
+    cb.matchers[false_matcher] = Proc.new { false_called = true }
+    cb.call([""])
+    true_called.should be_true
+    false_called.should be_false
+  end
+end

data/spec/cond_spec.rb

@@ -0,0 +1,28 @@
+require "filesortd/cond"
+include Filesortd
+
+describe "os" do
+  it "executes on freebsd" do
+    RbConfig::CONFIG['target_os'] = 'freebsd'
+    os(:freebsd) { true }.should be_true
+    os(:linux) { true }.should be_nil
+  end
+
+  it "executes on osx" do
+    RbConfig::CONFIG['target_os'] = 'darwin11.3.0'
+    os(:osx) { true }.should be_true
+    os(:linux) { true }.should be_nil
+  end
+
+  it "executes on linux" do
+    RbConfig::CONFIG['target_os'] = 'linux'
+    os(:linux) { true }.should be_true
+    os(:osx) { true }.should be_nil
+  end
+
+  it "executes on windows" do
+    RbConfig::CONFIG['target_os'] = 'mingw'
+    os(:windows) { true }.should be_true
+    os(:osx) { true }.should be_nil
+  end
+end

data/spec/matcher_spec.rb

@@ -0,0 +1,47 @@
+require "filesortd/matcher"
+include Filesortd
+
+describe BasenameMatcher do
+  it "matches regexps on filenames" do
+    BasenameMatcher.new(%r{hello-[0-9]+.mp3}).match("/Some/Folder/hello-123.mp3").should be_true
+    BasenameMatcher.new(%r{hello-[0-9]+.mp3}).match("/Some/Folder/321-goodbye.mp3").should be_false
+  end
+
+  it "matches globs on filenames" do
+    BasenameMatcher.new("*.jpg").match("/Some/Folder/pic.jpg").should be_true
+    BasenameMatcher.new("*.jpg").match("/Some/Folder/pic.png").should be_false
+  end
+end
+
+describe XattrMatcher do
+  let(:path) { "/tmp/xattrtest" }
+  let(:prop) { "com.apple.metadata:kMDItemWhereFroms" }
+  let(:downloaded_das) { "62 70 6C 69 73 74 30 30 A2 01 02 5F 10 B5 68 74\n74 70 73 3A 2F 2F 73 33 2E 61 6D 61 7A 6F 6E 61\n77 73 2E 63 6F 6D 2F 64 65 73 74 72 6F 79 61 6C\n6C 73 6F 66 74 77 61 72 65 2F 64 61 73 2D 30 30\n31 34 2D 65 78 74 72 61 63 74 69 6E 67 2D 6F 62\n6A 65 63 74 73 2D 69 6E 2D 64 6A 61 6E 67 6F 2E\n6D 6F 76 3F 41 57 53 41 63 63 65 73 73 4B 65 79\n49 64 3D 41 4B 49 41 49 4B 52 56 43 45 43 58 42\n43 34 5A 47 48 49 51 26 45 78 70 69 72 65 73 3D\n31 33 35 35 33 32 35 35 31 33 26 53 69 67 6E 61\n74 75 72 65 3D 64 6C 4D 48 52 6D 73 78 64 56 70\n45 6F 4B 58 44 62 50 38 59 6F 65 36 51 37 44 77\n25 33 44 5F 10 36 68 74 74 70 73 3A 2F 2F 77 77\n77 2E 64 65 73 74 72 6F 79 61 6C 6C 73 6F 66 74\n77 61 72 65 2E 63 6F 6D 2F 73 63 72 65 65 6E 63\n61 73 74 73 2F 63 61 74 61 6C 6F 67 08 0B C3 00\n00 00 00 00 00 01 01 00 00 00 00 00 00 00 03 00\n00 00 00 00 00 00 00 00 00 00 00 00 00 00 FC" }
+
+  before { File.write  path, "123" }
+  after  { File.unlink path }
+
+  it "returns true for matched xattrs" do
+    system "xattr -wx #{prop.shellescape} '#{downloaded_das}' #{path.shellescape}"
+    m = XattrMatcher.new(prop) do |elements, path|
+      elements.map { |el| !(el =~ %r{destroyallsoftware}).nil? }.count(true) >= 1
+    end
+    m.match(path).should be_true
+  end
+
+  it "returns false for invalid xattrs" do
+    system "xattr -wx #{prop.shellescape} '#{downloaded_das}' #{path.shellescape}"
+    m = XattrMatcher.new(prop) do |elements, path|
+      elements.map { |el| !(el =~ %r{destroyNOsoftware}).nil? }.count(true) >= 1
+    end
+    m.match(path).should be_false
+  end
+
+  it "returns false for no xattrs" do
+    m = XattrMatcher.new(prop) do |elements, path|
+      elements.map { |el| !(el =~ %r{destroyallsoftware}).nil? }.count(true) >= 1
+    end
+    m.match(path).should be_false
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: filesortd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- myfreeweb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: &70354624421460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354624421460
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: &70354624420780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354624420780
+- !ruby/object:Gem::Dependency
+  name: popen4
+  requirement: &70354624420200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354624420200
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70354624419580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70354624419580
+description: Automatic rule-based sorting for your files. Like Hazel, but doesn't
+  need a GUI.
+email:
+- floatboth@me.com
+executables:
+- filesortd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/filesortd
+- filesortd.gemspec
+- lib/filesortd.rb
+- lib/filesortd/afile.rb
+- lib/filesortd/callback.rb
+- lib/filesortd/cli.rb
+- lib/filesortd/cond.rb
+- lib/filesortd/folder.rb
+- lib/filesortd/matcher.rb
+- lib/filesortd/version.rb
+- spec/afile_spec.rb
+- spec/callback_spec.rb
+- spec/cond_spec.rb
+- spec/matcher_spec.rb
+homepage: https://github.com/myfreeweb/filesortd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rule-based file sorting
+test_files:
+- spec/afile_spec.rb
+- spec/callback_spec.rb
+- spec/cond_spec.rb
+- spec/matcher_spec.rb