borrower 0.7.0 → 0.8.0

data/lib/borrower/public_api.rb

@@ -8,16 +8,29 @@ module Borrower
     # @param [String] from the path to the file
     # @return [String] contents of the file
     def take from
-      Borrower::Content.get from
+      Content.get from
     end
 
     # write the content to a destination file
     #
     # @param [String] content content for the file
-    # @param [String] to path to write contents to
+    # @param [String] destination path to write contents to
+    # @param [Symbol] on_conflict what to do if the destination exists
     # @return [Void]
-    def put content, to
-      Borrower::Content.put content, to
+    def put content, destination, on_conflict=:overwrite
+
+      if on_conflict != :overwrite && Content::Item.new( destination ).exists?
+        case on_conflict
+        when :skip then return
+        when :prompt then
+          input = Util.get_input "a file already exists at #{destination}\noverwrite? (y|n): "
+          return unless input.downcase == "y"
+        when :raise_error then
+          raise "File already exists at #{destination}"
+        end
+      end
+
+      Content.put content, destination
     end
 
     # parse through the content and merge

data/lib/borrower/util.rb

@@ -0,0 +1,14 @@
+module Borrower
+  module Util
+    class << self
+
+      # get input from the command line
+      # @return [String]
+      def get_input message
+        print message
+        $stdin.gets.chomp
+      end
+
+    end
+  end
+end

data/lib/borrower/version.rb

@@ -1,3 +1,3 @@
 module Borrower
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/borrower.rb

@@ -5,6 +5,7 @@ require "net/https"
 require "uri"
 
 # borrower
+require 'borrower/util'
 require 'borrower/version'
 require 'borrower/content'
 require 'borrower/manifest'
@@ -35,6 +36,7 @@ module Borrower::DSL
   # @return [Void]
   def borrow path, options={}, &block
     destination = options.delete(:to) { raise ArgumentError, "missing 'to:' argument" }
+    on_conflict = options.delete(:on_conflict) { nil }
     content = Borrower.take(path)
 
     if content.ascii_only?
@@ -42,7 +44,7 @@ module Borrower::DSL
       content = yield content if block_given?
     end
 
-    Borrower.put content, destination
+    Borrower.put *[content, destination, on_conflict].compact
   end
 
 end

data/spec/borrower/public_api_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Borrower::PublicAPI do
+
+  after :each do
+    cleanup_tmp
+  end
+
+  describe "#put" do
+    context "when no file exists at destination" do
+      [ :overwrite, :prompt, :skip, :raise_error ].each do |on_conflict|
+        context "when on_conflict is set to :#{on_conflict}" do
+          it "puts the contents in a file at the destination" do
+            destination = File.join( TMP, 'destination/file.txt' )
+            Borrower.put "Hello World", destination, on_conflict
+
+            expect( Borrower.take(destination) ).to eq "Hello World"
+          end
+        end
+      end
+    end
+
+    context "when a file exists at destination" do
+
+      let(:destination) { File.join( TMP, "file.txt" ) }
+      before :each do
+        given_file "file.txt", "I'm conflicted"
+      end
+
+      context "when on_conflict is set to :overwrite" do
+        it "overwrites the contents of the file" do
+          Borrower.put "Hello World", destination, :overwrite
+
+          expect( Borrower.take(destination) ).not_to eq "I'm conflicted"
+          expect( Borrower.take(destination) ).to eq "Hello World"
+        end
+      end
+
+      context "when on_confict is set to :prompt" do
+        it "overwrites to file if response is y" do
+          fake_stdin("y") do
+            Borrower.put "Hello World", destination, :prompt
+          end
+
+          expect( Borrower.take(destination) ).not_to eq "I'm conflicted"
+          expect( Borrower.take(destination) ).to eq "Hello World"
+        end
+
+        it "skips file if response is no" do
+          fake_stdin("n") do
+            Borrower.put "Hello World", destination, :prompt
+          end
+
+          expect( Borrower.take(destination) ).not_to eq "Hello World"
+          expect( Borrower.take(destination) ).to eq "I'm conflicted"
+        end
+      end
+
+      context "when on_conflict is set to :skip" do
+        it "doesn't overwrite the contents of the file" do
+          Borrower.put "Hello World", destination, :skip
+
+          expect( Borrower.take(destination) ).not_to eq "Hello World"
+          expect( Borrower.take(destination) ).to eq "I'm conflicted"
+        end
+      end
+
+      context "when on_conflict is set to :raise_error" do
+        it "raises an error" do
+          expect{
+            Borrower.put "Hello World", destination, :raise_error
+          }.to raise_error
+        end
+      end
+    end
+  end
+
+end

data/spec/borrower_spec.rb

@@ -94,4 +94,18 @@ describe Borrower do
 
   end
 
+  describe "on_conflict options" do
+    it "doesn't pass an option to put if none is set" do
+      expect( Borrower ).to receive(:put).with( "Hi I'm a file", file_destination )
+
+      borrow local_file, to: file_destination
+    end
+
+    it "passes an option if set" do
+      expect( Borrower ).to receive(:put).with( "Hi I'm a file", file_destination, :skip )
+
+      borrow local_file, to: file_destination, on_conflict: :skip
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,36 +1,29 @@
 require 'rspec'
 require 'fileutils'
 
-begin
-  require 'pry-debugger'
-rescue LoadError
-  puts "no biggie, but pry debugger isn't available"
-end
-
-TMP = File.join( Dir.pwd, "tmp" )
-ROOT = Dir.pwd
+unless ENV['TRAVIS']
 
-def given_files list
-  FileUtils.mkdir_p TMP
-  Array(list).each do |f|
-    file_path = File.join( TMP, f )
-    FileUtils.mkdir_p( File.dirname(file_path) )
-    FileUtils.touch( file_path )
+  # try and load pry
+  begin
+    require 'pry'
+  rescue LoadError
+    puts "no biggie, but pry isn't available"
   end
-end
 
-def given_file name, content
-  file_path = File.join( TMP, name )
-  FileUtils.mkdir_p( File.dirname(file_path) )
-  File.open( file_path, 'w' ) do |file|
-    file.write content
-  end
+  # Silence $stdout
+  $stdout = StringIO.open('','w+')
+
 end
 
-def given_config content
-  File.open( File.join( TMP, 'manifest.borrower' ), 'w' ) do |file|
-    file.write content
-  end
+require_relative 'support/fake_stdin'
+require_relative 'support/given'
+
+TMP  = File.join( Dir.pwd, "tmp" )
+ROOT = Dir.pwd
+
+RSpec.configure do |config|
+  config.include FakeStdin
+  config.include Given
 end
 
 def cleanup_tmp

data/spec/support/fake_stdin.rb

@@ -0,0 +1,14 @@
+module FakeStdin
+
+  # Patch STDIN for a block
+  def fake_stdin *args
+    $stdin = StringIO.new
+    $stdin.puts(args.shift) until args.empty?
+    $stdin.rewind
+
+    yield
+  ensure
+    $stdin = STDIN
+  end
+
+end

data/spec/support/given.rb

@@ -0,0 +1,24 @@
+module Given
+  def given_files list
+    FileUtils.mkdir_p TMP
+    Array(list).each do |f|
+      file_path = File.join( TMP, f )
+      FileUtils.mkdir_p( File.dirname(file_path) )
+      FileUtils.touch( file_path )
+    end
+  end
+
+  def given_file name, content
+    file_path = File.join( TMP, name )
+    FileUtils.mkdir_p( File.dirname(file_path) )
+    File.open( file_path, 'w' ) do |file|
+      file.write content
+    end
+  end
+
+  def given_config content
+    File.open( File.join( TMP, 'manifest.borrower' ), 'w' ) do |file|
+      file.write content
+    end
+  end
+end

metadata

@@ -1,78 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: borrower
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.7.0
+  version: 0.8.0
+  prerelease: 
 platform: ruby
 authors:
 - Steven Sloan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.6.5
-    none: false
-  prerelease: false
-  type: :runtime
-description: ' For borrowing little snippets of the web, or files, or really any snippet
-  of string. '
+description: ! ' For borrowing little snippets of the web, or files, or really any
+  snippet of string. '
 email:
 - stevenosloan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/borrower.rb
 - lib/borrower/content.rb
+- lib/borrower/manifest/config_file.rb
 - lib/borrower/manifest.rb
 - lib/borrower/merge.rb
 - lib/borrower/public_api.rb
+- lib/borrower/util.rb
 - lib/borrower/version.rb
-- lib/borrower/manifest/config_file.rb
-- spec/borrower_spec.rb
-- spec/spec_helper.rb
+- lib/borrower.rb
 - spec/borrower/manifest_spec.rb
 - spec/borrower/merge_spec.rb
+- spec/borrower/public_api_spec.rb
+- spec/borrower_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_stdin.rb
+- spec/support/given.rb
 homepage: http://github.com/stevenosloan/borrower
 licenses:
 - MIT
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
 specification_version: 3
-summary: For borrowing little snippets of the web, or files, or really any snippet of string.
+summary: For borrowing little snippets of the web, or files, or really any snippet
+  of string.
 test_files:
-- spec/borrower_spec.rb
-- spec/spec_helper.rb
 - spec/borrower/manifest_spec.rb
 - spec/borrower/merge_spec.rb
+- spec/borrower/public_api_spec.rb
+- spec/borrower_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_stdin.rb
+- spec/support/given.rb
+has_rdoc: