rdiff-simple 0.0.9 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15b76630f1141cfacad11232d8406ba3b4d72d92
+  data.tar.gz: e6662d1deeed21bbaf612dd7f738dad38cef680b
+SHA512:
+  metadata.gz: 949f2b75133ac93f0e5945e7279f020b4917cfa2ee7cf3c35ab7cfe372d43668300f620f1ac8f76438aca75d1bae45dd52f5c2d81f913398395b5d83d8fa5883
+  data.tar.gz: 4007f8fb8fda98a34f063214ae65bf87d2b2cb2ff7e99fe2e3d1a12bbceb44a2061f7988b809a1139f556733b65ffda5878e57b753ba7c47e3c317e961e675ae

data/Gemfile

@@ -1,15 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in rdiff-simple.gemspec
 gemspec
-
-group :development, :test do
-  gem "rake"
-  gem "rspec", "~> 2"
-  gem "coveralls"
-end
-
-group :development do
-  gem "bundler", "~> 1.3"
-  gem "guard-rspec"
-end

data/README.md

@@ -16,12 +16,34 @@ A simple wrapper around rdiff-backup
 
 $ gem install rdiff-simple
 
+## Quick Start
+
+In your file:
+
+```ruby
+  require 'rdiff_simple'
+
+  backup = RdiffSimple::RdiffBackup.new
+  backup.execute('/source', '/destination', :print_statistics, exclude: '/source/private')
+```
+
 ## Usage
 
-$ rdiff-simple
+Arguments Order is:
+
+- `source`
+- `destination`
+- `flag options like --exclude-other-filesystems`
+- `hash arguments like --exclude /usr/bin`
+
+All multi-word symbols should be converted to underscores: `--exclude-other-filesystems` becomes `:exclude_other_filesystems`.
+
+The `execute` method will return the exit code from rdiff-backup.  In order to get the output from rdiff-backup pass in a [`Logger`][logger] to [`RdiffBackup.new`][new].
 
 ## License
 
 Released under the MIT License.  See the [LICENSE][] file for further details.
 
 [license]: LICENSE.txt
+[logger]: http://www.ruby-doc.org/stdlib-2.0.0/libdoc/logger/rdoc/Logger.html
+[new]: http://rubydoc.info/github/ketiko/rdiff-simple/master/RdiffSimple/RdiffBackup#initialize-instance_method

data/Rakefile

@@ -1,8 +1,8 @@
-require 'rubygems'
-require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
+Bundler.require(:default)
+
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/rdiff_simple.rb

@@ -1,6 +1,7 @@
+require 'logger'
+require 'open3'
+require 'active_support/all'
 require 'rdiff_simple/version'
-require 'rdiff_simple/exit_codes'
-require 'rdiff_simple/errors'
-require 'rdiff_simple/commands'
+require 'rdiff_simple/options_parser'
 require 'rdiff_simple/rdiff_backup'
 

data/lib/rdiff_simple/options_parser.rb

@@ -0,0 +1,17 @@
+module RdiffSimple
+  class OptionsParser
+    def self.parse(*args)
+      options = args.extract_options!
+
+      args.reverse!
+
+      source = args.pop
+      destination = args.pop
+
+      flags = args.reverse.map { |flag| flag.size == 1 ? "-#{flag}" : "--#{flag}" } * ' '
+      arguments = options.map { |key, value| (key.size == 1 ? "-#{key}" : "--#{key}") + " #{value}" } * ' '
+
+      "#{flags} #{arguments} #{source} #{destination}".dasherize.strip
+    end
+  end
+end

data/lib/rdiff_simple/rdiff_backup.rb

@@ -1,22 +1,20 @@
-require 'open3'
 
 module RdiffSimple
   class RdiffBackup
-    attr_reader :output_log
+    def initialize(logger = Logger.new(STDOUT), open3 = Open3)
+      @logger = logger
+      @open3 = open3
+    end
 
     def execute(*args)
-      raise NotInstalledError, 'rdiff-backup not installed' unless installed?
+      command_arguments = OptionsParser.parse(*args)
 
-      command = ['rdiff-backup', args].flatten!.compact.join(' ').strip
+      out, err, result = @open3.capture3("rdiff-backup #{command_arguments}".strip)
 
-      @output_log, status = Open3.capture2e(command)
-      status == EXIT_CODE[:success]
-    end
+      @logger.info(out) if out.length > 0
+      @logger.error(err) if err.length > 0
 
-    private
-    def installed?
-      output, status = Open3.capture2e(COMMANDS[:installed])
-      status == EXIT_CODE[:success]
+      return result.exitstatus
     end
   end
 end

data/lib/rdiff_simple/version.rb

@@ -1,3 +1,3 @@
 module RdiffSimple
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/rdiff-simple.gemspec

@@ -20,4 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.extra_rdoc_files = [ "LICENSE.txt", "README.md" ]
   spec.rdoc_options     = [ "--charset=UTF-8" ]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "guard-rspec"
 end

data/spec/lib/rdiff_simple/options_parser_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe RdiffSimple::OptionsParser do
+  subject { RdiffSimple::OptionsParser.parse('~/Documents', '~/Test', :b, :exclude_other_filesystems, verbosity: 5, exclude: '*.png', r: Date.today) }
+
+  describe '.parse' do
+    it 'converts options to long argument format' do
+      expect(subject).to match /\s--verbosity\s/
+    end
+
+    it 'sets value for argument' do
+      expect(subject).to match /\s--verbosity 5\s/
+    end
+
+    it 'converts symbols to dasherized strings' do
+      expect(subject).to match /\s--exclude-other-filesystems\s/
+    end
+
+    it 'handles single letter argument' do
+      expect(subject).to match /\A-b\s/
+    end
+
+    it 'sets value for single letter argument' do
+      expect(subject).to match /\s-r #{Date.today}\s/
+    end
+  end
+end

data/spec/lib/rdiff_simple/rdiff_backup_spec.rb

@@ -1,61 +1,20 @@
 require 'spec_helper'
 
 describe RdiffSimple::RdiffBackup do
-  let(:backup) { RdiffSimple::RdiffBackup.new }
+  let(:args) { 'rdiff-backup --exclude-other-filesystems --verbosity 5 --exclude *.png ~/Documents ~/Test' }
+  let(:status) { double('status', exitstatus: Random.rand(100)) }
+  let(:open3) { double('open3') }
+  let(:backup) { RdiffSimple::RdiffBackup.new(double('logger'), open3) }
 
-  describe '.execute' do
-    context 'when rdiff-backup is installed' do
-      before do
-        Open3.stub(:capture2e).with(RdiffSimple::COMMANDS[:installed]).and_return(['', 0])
-      end
+  subject { backup.execute('~/Documents', '~/Test', :exclude_other_filesystems, verbosity: 5, exclude: '*.png') }
 
-      context 'when no arguments are given' do
-        before do
-          Open3.stub(:capture2e).with(RdiffSimple::COMMANDS[:rdiff]).and_return(['', 1])
-        end
-
-        subject { backup.execute('') }
-
-        it { should be_false }
-      end
-
-      context 'when arguments are given' do
-        before do
-          Open3.stub(:capture2e).with("#{RdiffSimple::COMMANDS[:rdiff]} --version").and_return(['', 0])
-        end
-
-        subject { backup.execute('--version') }
-
-        it { should be_true }
-      end
+  describe '#backup' do
+    before do
+      expect(open3).to receive(:capture3).with(args) { ['', '', status] }
     end
 
-    context 'when rdiff-backup is not installed' do
-      before do
-        Open3.stub(:capture2e).with(RdiffSimple::COMMANDS[:installed]).and_return(['', 1])
-      end
-
-      it 'should raise an exception' do
-        expect { subject.execute('--version') }.to raise_error(RdiffSimple::NotInstalledError)
-      end
-    end
-  end
-
-  describe '.installed?' do
-    context 'when rdiff-backup is installed' do
-      before do
-        Open3.stub(:capture2e).with(RdiffSimple::COMMANDS[:installed]).and_return(['', 0])
-      end
-
-      it { should be_installed }
-    end
-
-    context 'when rdiff-backup is not installed' do
-      before do
-        Open3.stub(:capture2e).with(RdiffSimple::COMMANDS[:installed]).and_return(['', 1])
-      end
-
-      it { should_not be_installed }
+    it 'returns the exit code' do
+      expect(subject).to eq status.exitstatus
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require 'rubygems'
-require 'bundler/setup'
+Bundler.require(:development)
 
 if RUBY_VERSION > "1.9"
   if ENV['TRAVIS']

metadata

@@ -1,16 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rdiff-simple
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan Hansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
-dependencies: []
+date: 2013-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !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: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: guard-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'
 description: A simple wrapper around rdiff-backup
 email:
 - ketiko@gmail.com
@@ -29,17 +98,17 @@ files:
 - README.md
 - Rakefile
 - lib/rdiff_simple.rb
-- lib/rdiff_simple/commands.rb
-- lib/rdiff_simple/errors.rb
-- lib/rdiff_simple/exit_codes.rb
+- lib/rdiff_simple/options_parser.rb
 - lib/rdiff_simple/rdiff_backup.rb
 - lib/rdiff_simple/version.rb
 - rdiff-simple.gemspec
+- spec/lib/rdiff_simple/options_parser_spec.rb
 - spec/lib/rdiff_simple/rdiff_backup_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ketiko/rdiff-simple
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -47,28 +116,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 4306097889160700498
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 4306097889160700498
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A wrapper around the rdiff-backup executable
 test_files:
+- spec/lib/rdiff_simple/options_parser_spec.rb
 - spec/lib/rdiff_simple/rdiff_backup_spec.rb
 - spec/spec_helper.rb

data/lib/rdiff_simple/commands.rb

@@ -1,6 +0,0 @@
-module RdiffSimple
-  COMMANDS = {
-    rdiff: 'rdiff-backup',
-    installed: "which rdiff-backup",
-  }
-end

data/lib/rdiff_simple/errors.rb

@@ -1,3 +0,0 @@
-module RdiffSimple
-  class NotInstalledError < Exception; end
-end

data/lib/rdiff_simple/exit_codes.rb

@@ -1,5 +0,0 @@
-module RdiffSimple
-  EXIT_CODE = {
-    success: 0
-  }
-end