dutiful 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6accd15285afd3686ae7f9734291ed27ffd6409
-  data.tar.gz: 180766e86e1aa148189557e706168bc16c237d4a
+  metadata.gz: 77661dc7c89c798e383b4866921f2d12d10e4c63
+  data.tar.gz: 4e7a2cc9951499ab8761dbd8547a56bd1e1f50d6
 SHA512:
-  metadata.gz: defc3556e4b1652c792fb7a9e8a0da99d085d6c9e291e1857fe7bbc03c9902dd31243ff20636a188ca637ba0e288406574b648375dfad59e3b83d73b0ecb3217
-  data.tar.gz: e5b1708c80fe35343b227b75141c3ef7a6627f4b54afdfe9bbf5868b293a99cddae5bfda251b843ae610f6b9f688df0daa591869498837faecb6c82325364900
+  metadata.gz: e3febcb417b4a94930ddad87562e7d013481848eaa2ae6f83e9a822a39a76bcdf905f7e722ab8d5fbfa80212066b1608dd6d36f6ef5e4ba6e4eae8db5601df49
+  data.tar.gz: 60f80377d514e640f756b942901a6f8ccd2d8fbc869d9fa5f0e69347c18f6922fce176ce9eab9a2e1279d84a4b14ccb598e2e3aa91197f9436e33cdbbfe060c5

data/db/osx-screencapture.toml

@@ -0,0 +1,7 @@
+[application]
+name = 'OSX Screencapture'
+
+[[default]]
+description = 'Change where screenshots are saved to'
+domain      = 'com.apple.screencapture'
+key         = 'location'

data/lib/dutiful/application.rb

@@ -3,8 +3,14 @@ class Dutiful::Application
     @path = path
   end
 
+  def defaults
+    return [] unless Dutiful::Config.osx?
+
+    Array(content[:default]).map { |default| Dutiful::ApplicationDefault.new default }
+  end
+
   def files
-    content[:file].map { |file| Dutiful::ApplicationFile.new file[:path], file[:condition] }
+    Array(content[:file]).map { |file| Dutiful::ApplicationFile.new file[:path], file[:condition] }
   end
 
   def name
@@ -12,25 +18,19 @@ class Dutiful::Application
   end
 
   def backup(&block)
-    sync backup_only: true, &block
+    (files + defaults).each do |file|
+      if file.exist?
+        yield file, file.backup if block_given?
+      else
+        yield file if block_given?
+      end
+    end
   end
 
   def restore(&block)
-    sync restore_only: true, &block
-  end
-
-  def sync(backup_only: false, restore_only: false)
-    files.each do |file|
-      if file.should_sync?
-        result = if backup_only && file.exist?
-                   Dutiful::Config.storage.backup(file)
-                 elsif restore_only && file.has_backup?
-                   Dutiful::Config.storage.restore(file)
-                 else
-                   Dutiful::Config.storage.sync(file)
-                 end
-
-        yield file, result if block_given?
+    (files + defaults).each do |file|
+      if file.has_backup?
+        yield file, file.restore if block_given?
       else
         yield file if block_given?
       end
@@ -38,21 +38,17 @@ class Dutiful::Application
   end
 
   def exist?
-    files.any? &:exist?
+    files.any?(&:exist?) || defaults.any?(&:exist?)
   end
 
   def has_backup?
-    files.any? &:has_backup?
+    files.any?(&:has_backup?) || defaults.any?(&:has_backup?)
   end
 
-  def should_sync?
+  def tracked?
     exist? || has_backup?
   end
 
-  def synced?
-    files.all? &:synced?
-  end
-
   def self.all
     Dir["#{Dutiful.dir}/db/*.toml"].map do |filename|
       Dutiful::Application.new filename

data/lib/dutiful/application_default.rb

@@ -0,0 +1,83 @@
+class Dutiful::ApplicationDefault
+  Result = Struct.new(:error, :success?)
+
+  def initialize(hash)
+    @description = hash[:description]
+    @domain      = hash[:domain]
+    @key         = hash[:key]
+  end
+
+  def backup
+    FileUtils.mkdir_p File.dirname "#{backup_path}"
+    File.open(backup_path, 'w') { |file| file << value }
+
+    Result.new nil, true
+  rescue => ex
+    Result.new ex.message, false
+  end
+
+  def backup_value
+    value = nil
+    File.open(backup_path) { |file| value = file.read }
+
+    value
+  end
+
+  def restore
+    `defaults write #{@domain} #{@key} #{backup_value}`
+    Result.new nil, true
+  rescue => ex
+    Result.new ex.message, false
+  end
+
+  def name
+    "#{@domain} #{@key}"
+  end
+
+  def value
+    @value ||= `defaults read #{@domain} #{@key} 2>/dev/null`
+  end
+
+  def exist?
+    @exists ||= begin
+                   @value = `defaults read #{@domain} #{@key} 2>/dev/null`
+                   $?.success?
+                 end
+  end
+
+  def has_backup?
+    File.exist? backup_path
+  end
+
+  def tracked?
+    exist? || has_backup?
+  end
+
+  def in_sync?
+    value == backup_value
+  end
+
+  def to_s
+    if exist?
+      if has_backup?
+        if in_sync?
+          "#{name} ✔".green
+        else
+          "#{name} (modified)".yellow
+        end
+      else
+        "#{name} (pending backup)".yellow
+      end
+    elsif has_backup?
+      "#{name} (pending restore)".yellow
+    else
+      "#{name} does not exist (skipping)".light_black
+    end
+  end
+
+  private
+
+  def backup_path
+    Dutiful::Config.storage.path "defaults/#{@domain}/#{@key}"
+  end
+end

data/lib/dutiful/application_file.rb

@@ -1,17 +1,16 @@
 class Dutiful::ApplicationFile
-  attr_reader :full_path, :path
+  attr_reader :path
 
   def initialize(path, condition)
-    @command         = condition[:command] if condition
-    @expected_output = condition[:expected_output] if condition
-    @expected_status = condition[:expected_status] if condition
-    @path            = path
+    @condition, @path = condition, path
+  end
 
-    if directory?
-      @full_path = "#{File.expand_path "~/#{path}"}/"
-    else
-      @full_path = File.expand_path "~/#{path}"
-    end
+  def backup
+    Dutiful::Config.storage.backup self
+  end
+
+  def restore
+    Dutiful::Config.storage.restore self
   end
 
   def backup_path
@@ -22,46 +21,70 @@ class Dutiful::ApplicationFile
     File.mtime backup_path if has_backup?
   end
 
-  def timestamp
-    File.mtime full_path if exist?
+  def command
+    @condition[:command] if has_condition?
   end
 
-  def meets_conditions?
-    if has_condition?
-      output = `#{@command}`
+  def expected_output
+    @condition[:expected_output] if has_condition?
+  end
 
-      if @expected_status
-        $?.exitstatus == @expected_status
-      else
-        $?.success? && output.strip == @expected_output
-      end
+  def expected_status
+    @condition[:expected_status] if has_condition?
+  end
+
+  def full_path
+    if directory?
+      "#{File.expand_path "~/#{path}"}/"
     else
-      true
+      File.expand_path "~/#{path}"
     end
   end
 
+  def name
+    path
+  end
+
+  def timestamp
+    File.mtime full_path if exist?
+  end
+
   def directory?
     path.chars.last == '/'
   end
 
   def exist?
-    File.exist? full_path
+    File.exist?(full_path) && meets_conditions?
   end
 
   def has_backup?
-    Dutiful::Config.storage.exist? self
+    Dutiful::Config.storage.exist?(self) && meets_conditions?
   end
 
   def has_condition?
-    @command
+    @condition
+  end
+
+  def meets_conditions?
+    if has_condition?
+      output = `#{command}`
+
+      if expected_status
+        $?.exitstatus == expected_status
+      else
+        $?.success? && output.strip == expected_output
+      end
+    else
+      true
+    end
   end
 
-  def should_sync?
-    (exist? || has_backup?) && meets_conditions?
+  def tracked?
+    exist? || has_backup?
   end
 
-  def synced?
-    has_backup? && Dutiful::Config.storage.synced?(self)
+  def in_sync?
+    has_backup? && Dutiful::Config.storage.in_sync?(self)
   end
 
   def to_s
@@ -69,7 +92,7 @@ class Dutiful::ApplicationFile
 
     if exist?
       if has_backup?
-        if synced?
+        if in_sync?
           "#{path} ✔".green
         else
           "#{path} (modified)".yellow
@@ -80,7 +103,7 @@ class Dutiful::ApplicationFile
     elsif has_backup?
       "#{path} (pending restore)".yellow
     else
-      "#{path} does not exist (skipping)".yellow
+      "#{path} does not exist (skipping)".light_black
     end
   end
 end

data/lib/dutiful/commands/backup.rb

@@ -1,21 +1,23 @@
 class Dutiful::Command::Backup < Clamp::Command
+  option ['-q', '--quiet'], :flag, 'Quiet mode'
   option ['-v', '--verbose'], :flag, 'Verbose mode'
 
   def execute
-    puts "Storage: #{Dutiful::Config.storage.name}\n\n"
+    Dutiful::Logger.set quiet?, verbose?
+    Dutiful::Logger.info "Storage: #{Dutiful::Config.storage.name}\n\n"
 
     Dutiful::Application.each do |application|
-      puts "#{application.name}:\n" if application.should_sync? && application.exist? || verbose?
+      Dutiful::Logger.info "#{application.name}:\n" if application.exist? || verbose?
 
       application.backup do |file, result|
         if result
           if result.success?
-            puts "  #{file.path} ✔".green
+            Dutiful::Logger.success "  #{file.name} ✔"
           else
-            puts "  #{file.path} ✖ - #{result.error}".red
+            Dutiful::Logger.error "  #{file.name} ✖ - #{result.error}"
           end
         elsif verbose?
-          puts "  #{file}"
+          Dutiful::Logger.info "  #{file}"
         end
       end
     end

data/lib/dutiful/commands/list.rb

@@ -2,13 +2,18 @@ class Dutiful::Command::List < Clamp::Command
   option ['-v', '--verbose'], :flag, 'Verbose mode'
 
   def execute
-    puts "Storage: #{Dutiful::Config.storage.name}\n\n"
+    Dutiful::Logger.set false, verbose?
+    Dutiful::Logger.info "Storage: #{Dutiful::Config.storage.name}\n\n"
 
     Dutiful::Application.each do |application|
-      puts "#{application.name}:\n" if application.should_sync? || verbose?
+      Dutiful::Logger.info "#{application.name}:\n" if application.tracked? || verbose?
 
       application.files.map do |file|
-        puts "  #{file}" if (file.should_sync?) || verbose?
+        Dutiful::Logger.info "  #{file}" if file.tracked? || verbose?
+      end.compact.join("\n")
+
+      application.defaults.map do |default|
+        Dutiful::Logger.info "  #{default}" if default.tracked? || verbose?
       end.compact.join("\n")
     end
   end

data/lib/dutiful/commands/main.rb

@@ -1,11 +1,23 @@
 class Dutiful::Command::Main < Clamp::Command
   option ['-v', '--version'], :flag, 'Show version' do
-    puts "dutiful #{Dutiful::VERSION}"
+    Dutiful::Logger.info "dutiful #{Dutiful::VERSION}"
+    exit 0
+  end
+
+  option ['--init'], :flag, 'Initialize your computer with dutiful.' do
+    if File.exist? Dutiful::Config::PATH
+      Dutiful::Logger.warning "Configuration file already exist: '~/.dutiful/config.toml'."
+      exit 1
+    end
+
+    FileUtils.mkdir_p Dutiful.dir
+    FileUtils.cp File.expand_path("#{Dutiful.dir}/template/config.toml"), Dutiful::Config::PATH
+
+    Dutiful::Logger.success "Configuration file successfully created: '~/.dutiful/config.toml'."
     exit 0
   end
 
   subcommand 'backup',  'Backup all preference files',  Dutiful::Command::Backup
   subcommand 'list',    'List all preference files',    Dutiful::Command::List
   subcommand 'restore', 'Restore all preference files', Dutiful::Command::Restore
-  subcommand 'sync',    'Sync all preference files',    Dutiful::Command::Sync
 end

data/lib/dutiful/commands/restore.rb

@@ -1,21 +1,23 @@
 class Dutiful::Command::Restore < Clamp::Command
+  option ['-q', '--quiet'], :flag, 'Quiet mode'
   option ['-v', '--verbose'], :flag, 'Verbose mode'
 
   def execute
-    puts "Storage: #{Dutiful::Config.storage.name}\n\n"
+    Dutiful::Logger.set quiet?, verbose?
+    Dutiful::Logger.info "Storage: #{Dutiful::Config.storage.name}\n\n"
 
     Dutiful::Application.each do |application|
-      puts "#{application.name}:\n" if application.should_sync? && application.has_backup? || verbose?
+      Dutiful::Logger.info "#{application.name}:\n" if application.has_backup? || verbose?
 
       application.restore do |file, result|
         if result
           if result.success?
-            puts "  #{file.path} ✔".green
+            Dutiful::Logger.success "  #{file.name} ✔"
           else
-            puts "  #{file.path} ✖ - #{result.error}".red
+            Dutiful::Logger.error "  #{file.name} ✖ - #{result.error}"
           end
         elsif verbose?
-          puts "  #{file}"
+          Dutiful::Logger.info "  #{file}"
         end
       end
     end

data/lib/dutiful/commands.rb

@@ -4,5 +4,4 @@ require 'clamp'
 require 'dutiful/commands/backup'
 require 'dutiful/commands/list'
 require 'dutiful/commands/restore'
-require 'dutiful/commands/sync'
 require 'dutiful/commands/main'

data/lib/dutiful/config.rb

@@ -12,6 +12,10 @@ class Dutiful::Config
     end
   end
 
+  def self.osx?
+    `uname -s`.strip == 'Darwin'
+  end
+
   private
 
   def self.content

data/lib/dutiful/logger.rb

@@ -0,0 +1,22 @@
+class Dutiful::Logger
+  def self.set(quiet, verbose)
+    @quiet   = quiet
+    @verbose = verbose
+  end
+
+  def self.info(message)
+    puts message unless @quiet
+  end
+
+  def self.success(message)
+    puts message.green unless @quiet
+  end
+
+  def self.warning(message)
+    puts message.yellow unless @quiet
+  end
+
+  def self.error(message)
+    puts message.red unless @quiet
+  end
+end

data/lib/dutiful/storage.rb

@@ -56,7 +56,7 @@ class Dutiful::Storage
     end
   end
 
-  def synced?(file)
+  def in_sync?(file)
     if file.directory?
       Dir.glob("#{file.full_path}*").all? do |file_path|
         filename = File.basename(file_path)

data/lib/dutiful/version.rb

@@ -1,3 +1,3 @@
 module Dutiful
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/lib/dutiful.rb

@@ -5,9 +5,11 @@ module Dutiful
 end
 
 require 'dutiful/application'
+require 'dutiful/application_default'
 require 'dutiful/application_file'
 require 'dutiful/commands'
 require 'dutiful/config'
+require 'dutiful/logger'
 require 'dutiful/storage'
 require 'colorize'
 require 'rsync'

data/template/config.toml

@@ -0,0 +1,6 @@
+[storage]
+# If the storage name is either iCloud or Dropbox, the storage path will default to
+# '~/Dropbox' and '~/Library/Mobile Documents' respectively.
+
+name = 'iCloud'           # The storage name is going to be printed when running the dutiful commands.
+#path = '~/custom-folder' # The folder where your preference files are synced to.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dutiful
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Bruno Pinto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +127,7 @@ files:
 - db/git.toml
 - db/iterm2.toml
 - db/oh-my-zsh.toml
+- db/osx-screencapture.toml
 - db/popcorn-time.toml
 - db/rubymine.toml
 - db/the_silver_searcher.toml
@@ -123,16 +138,18 @@ files:
 - db/zsh.toml
 - lib/dutiful.rb
 - lib/dutiful/application.rb
+- lib/dutiful/application_default.rb
 - lib/dutiful/application_file.rb
 - lib/dutiful/commands.rb
 - lib/dutiful/commands/backup.rb
 - lib/dutiful/commands/list.rb
 - lib/dutiful/commands/main.rb
 - lib/dutiful/commands/restore.rb
-- lib/dutiful/commands/sync.rb
 - lib/dutiful/config.rb
+- lib/dutiful/logger.rb
 - lib/dutiful/storage.rb
 - lib/dutiful/version.rb
+- template/config.toml
 homepage: http://github.com/bpinto/dutiful
 licenses:
 - MIT
@@ -156,5 +173,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: dutiful-0.0.9
+summary: dutiful-0.0.10
 test_files: []

data/lib/dutiful/commands/sync.rb

@@ -1,23 +0,0 @@
-class Dutiful::Command::Sync < Clamp::Command
-  option ['-v', '--verbose'], :flag, 'Verbose mode'
-
-  def execute
-    puts "Storage: #{Dutiful::Config.storage.name}\n\n"
-
-    Dutiful::Application.each do |application|
-      puts "#{application.name}:\n" if application.should_sync? || verbose?
-
-      application.sync do |file, result|
-        if result
-          if result.success?
-            puts "  #{file.path} ✔".green
-          else
-            puts "  #{file.path} ✖ - #{result.error}".red
-          end
-        elsif verbose?
-          puts "  #{file}"
-        end
-      end
-    end
-  end
-end