sicily 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c8376a664b3749b235782f42fefc7c29525516e
-  data.tar.gz: ceddf6ebb51c6b01df9edb5bbeb6357e5ed65755
+  metadata.gz: 432b38f3655122f0e77004cf6617b441da0dd434
+  data.tar.gz: 021d5745791b343d38b7f176fc554fd2d9484fa4
 SHA512:
-  metadata.gz: 0c54423dca2dcd2b2d6d0363cca7d33c432ae0488dfc84fe7115dd9a2038c55b9559af1de0b80e800dd97bef8201634d25282df7bd09c57fdb8f55d82414206c
-  data.tar.gz: 4dd1b915b7ce46d2674458f174dbb150225d6b63beca68b7e2c3d73a1f13441dd5359116b414ebea3fc45fab033c2644afdb8f6ebb0011a54e4bc9daf1cfcb4f
+  metadata.gz: 28110fe847ee56f8b433d34984739aaa269427b961ffc35f1b005c7a1be3090dbcee5720454693db4e98bec56440ef8ca5d495034c6cbdd32fcbbb8ef8f765ee
+  data.tar.gz: fe244290789b35435ed9000226bf9627b88b032425578e60227c0c695c2550e9cf2ae90b342baaaeddb8ecfc84ac4eea84d987d5abd051feb67b199e4451730a

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    sicily (0.1.0)
+    sicily (0.1.1)
       concurrent-ruby (~> 1.0.5)
+      exifr (~> 1.3.3)
       god (~> 0.13.7)
       listen (~> 3.1.5)
       mini_magick (~> 4.8.0)
@@ -15,6 +16,7 @@ GEM
     chronic (0.10.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    exifr (1.3.3)
     ffi (1.9.21)
     god (0.13.7)
     listen (3.1.5)

data/README.md

@@ -1,8 +1,6 @@
 # Sicily
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sicily`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A rule-based photo organizer written in Ruby
 
 ## Installation
 
@@ -20,32 +18,32 @@ Or install it yourself as:
 
     $ gem install sicily
 
-config/config.rb
-   
-    Sicily.configure do |config|
-        config.forbid_mv_to_children_folder = true
-        config.notify_when_done = true
-        config.num_thread_pool = 50
-    end
+And install a node package as:
+
+    $ npm install -g upload-gphotos
 
-config/.google_photo.rb
+## Usage
 
-    Sicily.configure_google do |config|
-        config.id = "abcd"
-        config.pw = "def"
-    end
+Go to your project path, and then execute:
 
-config/rules.rb
+    $ sicily generate
+    
+Modify the generated files:
 
-    Sicily.on "/Users/paul/Downloads" do
-        fit_if_photo 2000, 2000
-        google_photo
-        mv "/Users/paul/Desktop/testfolder"
-    end
+    ./config/google_photo.rb
+    ./config/rules.rb
 
-## Usage
+If you want to monitor just during the current terminal session, then execute:
 
-TODO: Write usage instructions here
+    $ sicily monitor
+    
+If you want to run a background job which runs forever, then execute:
+
+    $ sicily start
+    
+If you want to stop that background job, then execute:
+
+    $ sicily stop
 
 ## Development
 
@@ -53,6 +51,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## TODO
+* error handling
+* logging
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/eunjae-lee/sicily. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/exe/sicily

@@ -36,7 +36,12 @@ EOF
 Sicily.on "~/your_folder" do
   fit_if_photo 2000, 2000
   google_photo
-  mv "~/your_another_folder"
+  mv "~/your_another_folder/%Y/%m/%d"
+end
+
+Sicily.on "~/your_folder2" do
+  fit_if_photo 1000, 1000
+  cp "~/your_another_folder/%Y/%m/%d"
 end
 EOF
 

data/lib/sicily.rb

@@ -1,32 +1,30 @@
 require "sicily/version"
 require "sicily/config"
 require "sicily/monitor"
-require "pathname"
+require "sicily/util/file_util"
 
 module Sicily
   @monitored_paths = []
 
   def self.on(path, &block)
     if self.can_monitor?(@monitored_paths, path)
-      self.start_monitor(path, &block)
+      self.start_monitor!(path, &block)
     else
       puts "cannot monitor : #{path}"
     end
   end
 
-  def self.start_monitor(path, &block)
+  def self.start_monitor!(path, &block)
     @monitored_paths << File.expand_path(path)
     Monitor.new.on(path, &block)
   end
 
   def self.can_monitor?(prev_paths, new_path)
-    expanded_new_path = File.expand_path(new_path)
     prev_paths.each do |prev_path|
-      is_sub_folder = Pathname.new(prev_path).fnmatch?(File.join(expanded_new_path, "**")) ||
-          Pathname.new(expanded_new_path).fnmatch?(File.join(prev_path, "**"))
-      return false if is_sub_folder
+      return false if Util::FileUtil.is_related?(prev_path, new_path) ||
+          Util::FileUtil.is_related?(new_path, prev_path)
     end
 
-    return true
+    true
   end
 end

data/lib/sicily/batch_processor.rb

@@ -1,6 +1,6 @@
 require "sicily/config"
 require "sicily/file_processor"
-require "sicily/notification_util"
+require "sicily/util/notification_util"
 
 module Sicily
   class BatchProcessor
@@ -32,7 +32,7 @@ module Sicily
     end
 
     def notify(files)
-      NotificationUtil.notify(files)
+      Util::NotificationUtil.notify(files)
     end
   end
 end

data/lib/sicily/config.rb

@@ -12,12 +12,12 @@ module Sicily
 
   class Config
     include Singleton
-    attr_accessor :forbid_mv_to_children_folder,
+    attr_accessor :forbid_new_file_in_subfolder,
                   :notify_when_done,
                   :num_thread_pool
 
     def initialize
-      @forbid_mv_to_children_folder = true
+      @forbid_new_file_in_subfolder = true
       @notify_when_done = true
       @num_thread_pool = 50
     end

data/lib/sicily/file_processor.rb

@@ -1,6 +1,7 @@
 require "sicily/task/resize_task"
 require "sicily/task/google_photo_task"
 require "sicily/task/file_task"
+require "sicily/util/file_util"
 
 module Sicily
   class FileProcessor
@@ -17,7 +18,29 @@ module Sicily
     end
 
     def mv(dest_path)
-      Task::FileTask.mv @path, dest_path
+      file_task_op :mv, dest_path
+    end
+
+    def cp(dest_path)
+      file_task_op :cp, dest_path
+    end
+
+    private
+    def file_task_op(op, dest_path)
+      cannot_op = Sicily.config.forbid_new_file_in_subfolder &&
+          Util::FileUtil.is_related?(@path, dest_path)
+
+      if cannot_op
+        raise [
+                  "Cannot #{op} to child folder",
+                  "  src  : #{@path}",
+                  "  dest : #{dest_path}",
+              ].join("\n")
+        return
+      end
+
+      final_dest_path = Util::FileUtil.eval_dest_path(@path, dest_path)
+      Task::FileTask.public_send op, @path, final_dest_path
     end
   end
 end

data/lib/sicily/task/file_task.rb

@@ -5,23 +5,20 @@ module Sicily
   module Task
     class FileTask
       def self.mv(path_src, path_dest)
+        file_op :mv, path_src, path_dest
+      end
+
+      def self.cp(path_src, path_dest)
+        file_op :cp, path_src, path_dest
+      end
+
+      private
+      def self.file_op(op, path_src, path_dest)
         path_src = File.expand_path path_src
         path_dest = File.expand_path path_dest
 
-        if Sicily.config.forbid_mv_to_children_folder
-          dir_src = File.dirname path_src
-          if path_dest.start_with? dir_src
-            raise [
-              "Cannot move to children folder",
-              "  src  : #{dir_src}",
-              "  dest : #{path_dest}",
-            ].join("\n")
-            return
-          end
-        end
-
         FileUtils.mkdir_p path_dest
-        FileUtils.mv path_src, path_dest
+        FileUtils.public_send op, path_src, path_dest
       end
     end
   end

data/lib/sicily/util/exif_util.rb

@@ -0,0 +1,11 @@
+require "exifr/jpeg"
+
+module Sicily
+  module Util
+    class ExifUtil
+      def self.extract_time_from_jpeg(path)
+        EXIFR::JPEG.new(path).date_time
+      end
+    end
+  end
+end

data/lib/sicily/util/file_util.rb

@@ -0,0 +1,28 @@
+require "sicily/util/exif_util"
+require "pathname"
+
+module Sicily
+  module Util
+    class FileUtil
+      def self.is_related?(maybe_parent_path, maybe_child_path)
+        expanded_parent_path = File.expand_path(maybe_parent_path)
+        expanded_child_path = File.expand_path(maybe_child_path)
+        Pathname.new(expanded_child_path).fnmatch? File.join(expanded_parent_path, "**")
+      end
+
+      def self.eval_dest_path(src_path, dest_path)
+        time = self.extract_time(src_path)
+        time.strftime(dest_path)
+      end
+
+      def self.extract_time(path)
+        if [".jpg", ".jpeg"].include? File.extname(path).downcase
+          time_from_exif = ExifUtil.extract_time_from_jpeg(path)
+          return time_from_exif unless time_from_exif.nil?
+        end
+
+        File.ctime(path)
+      end
+    end
+  end
+end

data/lib/sicily/util/notification_util.rb

@@ -0,0 +1,14 @@
+require "terminal-notifier"
+
+module Sicily
+  module Util
+    class NotificationUtil
+      def self.notify(files)
+        msg = files.map { |file|
+          File.basename(file)
+        }.join(", ")
+        TerminalNotifier.notify(msg, :title => "Finished processing #{files.size} file(s)")
+      end
+    end
+  end
+end

data/lib/sicily/version.rb

@@ -1,3 +1,3 @@
 module Sicily
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sicily.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "whenever", "~> 0.10.0"
   spec.add_dependency "terminal-notifier", "~> 2.0.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0.5"
+  spec.add_dependency "exifr", "~> 1.3.3"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sicily
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: exifr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -161,10 +175,12 @@ files:
 - lib/sicily/config.rb
 - lib/sicily/file_processor.rb
 - lib/sicily/monitor.rb
-- lib/sicily/notification_util.rb
 - lib/sicily/task/file_task.rb
 - lib/sicily/task/google_photo_task.rb
 - lib/sicily/task/resize_task.rb
+- lib/sicily/util/exif_util.rb
+- lib/sicily/util/file_util.rb
+- lib/sicily/util/notification_util.rb
 - lib/sicily/version.rb
 - sicily.gemspec
 homepage: https://github.com/eunjae-lee/sicily

data/lib/sicily/notification_util.rb

@@ -1,12 +0,0 @@
-require "terminal-notifier"
-
-module Sicily
-  class NotificationUtil
-    def self.notify(files)
-      msg = files.map { |file|
-        File.basename(file)
-      }.join(", ")
-      TerminalNotifier.notify(msg, :title => "Finished processing #{files.size} file(s)")
-    end
-  end
-end