catalog 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd0b3cd70c85b5bd03633460099dbe638c5276da
+  data.tar.gz: 4778008a6d5863df65ba2f8d01bee7408ab82253
+SHA512:
+  metadata.gz: 274bcea64b0b28a55d5fa8f9abd5cd961ada060d8c8d35e8931dbb38adf53163f58a59d31fae4da4b7fb8bb6965281452bbabd86db05926bc66d51cfc65d10e8
+  data.tar.gz: 3bb23e9d4ba7070a23afd16301936a3f09a5e20039d8c1cfdc061d2467460369660387b98880ac6d0c2112957809441a7fed92ad8d8c4b27af6ed40a64c6d3c3

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    catalog (0.1.1)
+      hashie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hashie (3.3.1)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  catalog!
+  rake
+  rspec

data/catalog.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'catalog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'catalog'
+  spec.version       = Catalog::VERSION
+  spec.authors       = ['Samuel Garneau']
+  spec.email         = ['sam@garno.me']
+  spec.description   = 'Catalog prevent your download folder from being a mess on Mac Os X.'
+  spec.summary       = 'Catalog prevent your download folder from being a mess on Mac Os X.'
+  spec.homepage      = 'https://github.com/garno/catalog'
+  spec.license       = 'BSD 3-Clause'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'hashie'
+end

data/lib/catalog.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require 'hashie'
+require 'shellwords'
+
+# Core
+require 'catalog/organizer'
+require 'catalog/config'
+
+# Models
+require 'catalog/models/document'
+require 'catalog/models/drawer'
+
+# Services
+require 'catalog/services/drawer_matcher'
+require 'catalog/services/document_mover'
+
+# Errors
+require 'catalog/errors/configuration_missing'
+
+module Catalog
+end

data/lib/catalog/config.rb

@@ -0,0 +1,21 @@
+module Catalog
+  module Config
+    def self.drawers
+      config.drawers
+    end
+
+  private
+
+    def self.config
+      unless @config
+        raw_content = File.read(File.expand_path('~/.catalog.yml'))
+        yaml_content = YAML.load(raw_content)
+        @config = Hashie::Mash.new(yaml_content)
+      end
+
+      @config
+    rescue Errno::ENOENT
+      raise Catalog::Error::ConfigurationMissing
+    end
+  end
+end

data/lib/catalog/errors/configuration_missing.rb

@@ -0,0 +1,9 @@
+module Catalog
+  module Error
+    class ConfigurationMissing < StandardError
+      def to_s
+        '~/.catalog.yml is missing'
+      end
+    end
+  end
+end

data/lib/catalog/models/document.rb

@@ -0,0 +1,9 @@
+module Catalog
+  class Document
+    attr_accessor :path
+
+    def initialize(path:)
+      @path = path
+    end
+  end
+end

data/lib/catalog/models/drawer.rb

@@ -0,0 +1,14 @@
+module Catalog
+  class Drawer
+    attr_accessor :rule, :path
+
+    def initialize(rule:, path:)
+      @rule = rule
+      @path = path
+    end
+
+    def self.all
+      Catalog::Config.drawers.map { |attributes| self.class.new(attributes) }
+    end
+  end
+end

data/lib/catalog/organizer.rb

@@ -0,0 +1,27 @@
+module Catalog
+  class Organizer
+    def initialize(base_path:)
+      @base_path = base_path
+    end
+
+    def run!
+      new_documents.each do |document|
+        matcher = DrawerMatcher.new(document: document)
+
+        if matcher.match?
+          DocumentMover.new(document: document, drawer: matcher.drawer).move!
+        end
+      end
+    end
+
+  private
+
+    def new_documents
+      unorganized_files.map { |path| Document.new(path: path) }
+    end
+
+    def unorganized_files
+      Dir[File.expand_path(@base_path)].reject { |path| File.directory?(path) }
+    end
+  end
+end

data/lib/catalog/services/document_mover.rb

@@ -0,0 +1,23 @@
+module Catalog
+  class DocumentMover
+    def initialize(document:, drawer:)
+      @document = document
+      @drawer = drawer
+    end
+
+    def move!
+      create_drawer_folder!
+      move_file!
+    end
+
+  private
+
+    def create_drawer_folder!
+      FileUtils.mkdir_p(@drawer.path) unless File.directory?(@drawer.path)
+    end
+
+    def move_file!
+      FileUtils.mv(@document.path, @drawer.path)
+    end
+  end
+end

data/lib/catalog/services/drawer_matcher.rb

@@ -0,0 +1,32 @@
+module Catalog
+  class DrawerMatcher
+    # Accessors
+    attr_reader :drawer
+
+    def initialize(document:)
+      @document = document
+    end
+
+    def match?
+      Catalog::Drawer.all.each do |drawer|
+        document_where_froms.each do |url|
+          @drawer = drawer if /#{drawer.rule}/.match(url)
+
+          break if @drawer
+        end
+
+        break if @drawer
+      end
+
+      !@drawer.nil?
+    end
+
+  private
+
+    def document_where_froms
+      # TODO: Have an helper to execute shell commands. Will
+      #       be a lot easier to test.
+      @document_where_froms ||= URI.extract(`mdls -name kMDItemWhereFroms #{Shellwords.shellescape(@document.path)}`)
+    end
+  end
+end

data/lib/catalog/version.rb

@@ -0,0 +1,3 @@
+module Catalog
+  VERSION = '0.1.1'
+end

data/spec/services/document_mover_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Catalog::DocumentMover do
+  let(:mover) { Catalog::DocumentMover.new(document: document, drawer: drawer) }
+  let(:document) { Catalog::Document.new(path: '/path/to/document.pdf') }
+  let(:drawer) { Catalog::Drawer.new(path: '/path/to/drawer', rule: nil) }
+
+  describe :move! do
+    specify do
+      expect(File).to receive(:directory?).with(drawer.path).and_return(true)
+      expect(FileUtils).to receive(:mv).with(document.path, drawer.path)
+
+      mover.move!
+    end
+  end
+
+  describe :create_drawer_folder! do
+    specify do
+      expect(File).to receive(:directory?).with(drawer.path).and_return(false)
+      expect(FileUtils).to receive(:mkdir_p).with(drawer.path)
+
+      mover.send(:create_drawer_folder!)
+    end
+  end
+end

data/spec/services/drawer_matcher_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.describe Catalog::DrawerMatcher do
+  let(:matcher) { Catalog::DrawerMatcher.new(document: document) }
+  let(:document) { Catalog::Document.new(path: '/path/to/document') }
+
+  before { expect(Catalog::Drawer).to receive(:all).and_return(drawers) }
+
+  describe :match? do
+    let(:drawers) { [Catalog::Drawer.new(rule: 'basecamp', path: '/path/to/drawer')] }
+
+    context 'with a matching drawer' do
+      specify do
+        expect(matcher).to receive(:document_where_froms).and_return(['http://basecamp.com/path/to/document.pdf'])
+        expect(matcher.match?).to be_truthy
+      end
+    end
+
+    context 'with no matching drawer' do
+      specify do
+        expect(matcher).to receive(:document_where_froms).and_return(['http://pivotaltracker.com/path/to/document.pdf'])
+        expect(matcher.match?).to be_falsey
+      end
+    end
+
+    context 'with two matching drawers' do
+      let(:drawers) do
+        [
+          Catalog::Drawer.new(rule: 'basecamp', path: '/path/to/drawer'),
+          Catalog::Drawer.new(rule: 'base', path: '/path/to/drawer')
+        ]
+      end
+
+      specify do
+        expect(matcher).to receive(:document_where_froms).and_return(['http://basecamp.com/path/to/document.pdf'])
+        expect(matcher.match?).to be_truthy
+
+        # For now, Catalog simply select the first
+        # matching drawer. Keep that in mind.
+        expect(matcher.drawer).to eq(drawers.first)
+      end
+    end
+  end
+
+  describe :document_where_froms do
+    pending
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'catalog'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: catalog
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Samuel Garneau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Catalog prevent your download folder from being a mess on Mac Os X.
+email:
+- sam@garno.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- catalog.gemspec
+- lib/catalog.rb
+- lib/catalog/config.rb
+- lib/catalog/errors/configuration_missing.rb
+- lib/catalog/models/document.rb
+- lib/catalog/models/drawer.rb
+- lib/catalog/organizer.rb
+- lib/catalog/services/document_mover.rb
+- lib/catalog/services/drawer_matcher.rb
+- lib/catalog/version.rb
+- spec/services/document_mover_spec.rb
+- spec/services/drawer_matcher_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/garno/catalog
+licenses:
+- BSD 3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Catalog prevent your download folder from being a mess on Mac Os X.
+test_files: []