catalog 0.1.1 → 0.1.2

checksums.yaml

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

data/Gemfile.lock

@@ -2,13 +2,11 @@ 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)

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2014 Samuel Garneau
+
+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,64 @@
+# Catalog
+*Catalog prevents your download folder from being a mess on Mac Os X.*
+
+## The problem
+
+The *Downloads* folder on a Mac is the most clusttered folder there is. Even with the best intentions, we end up not cleaning it as often as we should.
+
+*Catalog* allow us to create rules to automatically organize your downloads based on its origin (*i.e. http://someurl.com/path/to/file.pdf*).
+
+## Installation
+
+```bash
+# Install `catalog` gem
+$ gem install catalog
+
+# Create the configuration file
+$ touch ~/.catalog
+```
+
+## State of project
+
+The current version **doesn't include a CLI**. You'll have to use it through IRB as you can see in the [How to use](#how-to-use) section. The next step will be to provide a CLI using guard and a way to easily deamonize this.
+
+## How to use
+
+As mentionned above, *catalog* does not offer a CLI at the moment. You have to load it with IRB.
+
+```ruby
+> require 'catalog'
+=> true
+
+# Default location is ~/Downloads
+> Catalog::Organizer.new.run!
+=> true
+
+# However, you can specify your own
+> Catalog::Organizer.new(base_path: '/Volumes/Downloads/').run!
+=> true
+```
+
+#### `~/.catalog` example
+
+```yaml
+drawers:
+  # Basecamp related files
+  - rule: basecamp.com\/39\/projects\/12837347\/
+    path: /Users/garno/Downloads/Basecamp/ProjectName/
+  - rule: basecamp.com
+    path: /Users/garno/Downloads/Basecamp/
+
+  # DMGs
+  - rule: \.(?:dmg)$
+    path: /Users/garno/Downloads/DMGs/
+
+  # Alfred workflows
+  - rule: \.(?:alfredworkflow)$
+    path: /Users/garno/Downloads/Alfred workflows/
+```
+
+**Rules order is really important** since a file will be moved according to the first matched rule.
+
+## License
+
+Catalog is © 2014 Samuel Garneau and may be freely distributed under the MIT license. See the LICENSE.md file for more information.

data/catalog.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   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.description   = 'Catalog prevents your download folder from being a mess on Mac Os X.'
+  spec.summary       = 'Catalog prevents your download folder from being a mess on Mac Os X.'
   spec.homepage      = 'https://github.com/garno/catalog'
-  spec.license       = 'BSD 3-Clause'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.require_paths = ['lib']
@@ -19,6 +19,4 @@ Gem::Specification.new do |spec|
   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

@@ -1,5 +1,4 @@
 require 'yaml'
-require 'hashie'
 require 'shellwords'
 
 # Core

data/lib/catalog/config.rb

@@ -1,7 +1,7 @@
 module Catalog
   module Config
     def self.drawers
-      config.drawers
+      config['drawers']
     end
 
   private
@@ -9,8 +9,7 @@ module Catalog
     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)
+        @config = YAML.load(raw_content)
       end
 
       @config

data/lib/catalog/models/drawer.rb

@@ -8,7 +8,9 @@ module Catalog
     end
 
     def self.all
-      Catalog::Config.drawers.map { |attributes| self.class.new(attributes) }
+      Catalog::Config.drawers.map do |attributes|
+        Catalog::Drawer.new(rule: attributes['rule'], path: attributes['path'])
+      end
     end
   end
 end

data/lib/catalog/organizer.rb

@@ -1,7 +1,7 @@
 module Catalog
   class Organizer
-    def initialize(base_path:)
-      @base_path = base_path
+    def initialize(base_path: nil)
+      @base_path = base_path || '~/Downloads/*'
     end
 
     def run!
@@ -12,6 +12,8 @@ module Catalog
           DocumentMover.new(document: document, drawer: matcher.drawer).move!
         end
       end
+
+      true
     end
 
   private

data/lib/catalog/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catalog
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Samuel Garneau
@@ -52,21 +52,7 @@ dependencies:
     - - ">="
       - !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.
+description: Catalog prevents your download folder from being a mess on Mac Os X.
 email:
 - sam@garno.me
 executables: []
@@ -76,6 +62,8 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
+- README.md
 - catalog.gemspec
 - lib/catalog.rb
 - lib/catalog/config.rb
@@ -91,7 +79,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/garno/catalog
 licenses:
-- BSD 3-Clause
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -112,5 +100,5 @@ 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.
+summary: Catalog prevents your download folder from being a mess on Mac Os X.
 test_files: []