borrower 0.6.0 → 0.7.0

data/lib/borrower.rb

@@ -36,10 +36,12 @@ module Borrower::DSL
   def borrow path, options={}, &block
     destination = options.delete(:to) { raise ArgumentError, "missing 'to:' argument" }
     content = Borrower.take(path)
-    content = Borrower.merge(content, options) if options.fetch(:merge) { false }
-    if block_given?
-      content = yield content
+
+    if content.ascii_only?
+      content = Borrower.merge(content, options) if options.fetch(:merge) { false }
+      content = yield content if block_given?
     end
+
     Borrower.put content, destination
   end
 

data/lib/borrower/content.rb

@@ -9,18 +9,14 @@ module Borrower
         path  = Borrower.find(path)
         obj = Item.new( path )
 
-        if obj.remote? && obj.exists?
-          return obj.body
-        else
-          return IO.read(path)
-        end
+        return obj.content if obj.exists?
 
         raise "nothing exists at the provided path '#{path}'"
       end
 
       def put content, destination
         FileUtils.mkdir_p( File.dirname(destination) )
-        File.open( destination, 'w', internal_encoding: content.encoding ) do |file|
+        File.open( destination, 'wb' ) do |file|
           file.write content
         end
       end
@@ -44,8 +40,12 @@ module Borrower
         end
       end
 
-      def body
-        @_response.body
+      def content
+        if remote? && exists?
+          @_response.body
+        else
+          IO.read( @path )
+        end
       end
 
       private

data/lib/borrower/manifest.rb

@@ -1,3 +1,5 @@
+require 'borrower/manifest/config_file'
+
 module Borrower
   class Manifest
 
@@ -7,6 +9,12 @@ module Borrower
     def initialize
       @files = {}
       @directories = []
+
+      if Manifest::ConfigFile.present?
+        @manifest_file = Manifest::ConfigFile.new
+        @files = @files.merge( @manifest_file.files )
+        @directories = @directories.push( *@manifest_file.directories )
+      end
     end
 
     def file name, path

data/lib/borrower/manifest/config_file.rb

@@ -0,0 +1,42 @@
+module Borrower
+  class Manifest
+    class ConfigFile
+
+      attr_reader :files
+      attr_reader :directories
+
+      SOURCE_FILE = ::Borrower::Content::Item.new( 'manifest.borrower' )
+
+      class << self
+
+        def present?
+          SOURCE_FILE.exists?
+        end
+
+      end
+
+      def initialize
+        require 'yaml'
+
+        @files = {}.merge( manifest_file[:files] )
+        @directories = [].push( *manifest_file[:directories] )
+      end
+
+      private
+
+        def manifest_file
+          return @_manifest_file if @manifest_file
+
+          @_manifest_file = {
+            files: raw_manifest_file['files'],
+            directories: raw_manifest_file['directories'].split(' ')
+          }
+        end
+
+        def raw_manifest_file
+          YAML.load( SOURCE_FILE.content )
+        end
+
+    end
+  end
+end

data/lib/borrower/version.rb

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

data/spec/borrower/manifest_spec.rb

@@ -4,39 +4,98 @@ describe Borrower::Manifest do
 
   before :each do
     given_files [ "baz.txt", "files/baz.txt", "files/woo.txt", "files/foo.txt" ]
-    Borrower.manifest do |m|
-      m.file "me", File.join( TMP, "test.txt" )
-      m.file "remote", "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt"
-      m.dir File.join( TMP )
-      m.dir File.join( TMP, 'files' )
-    end
   end
 
   after :each do
     cleanup_tmp
   end
 
-  it "finds a file path based on key name if set" do
-    Borrower.find("me").should == File.join( TMP, "test.txt" )
-  end
+  let(:me_key)      { "me" }
+  let(:me_file)     { File.join( TMP, "test.txt" ) }
+  let(:remote_key)  { "remote" }
+  let(:remote_file) { "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt" }
+  let(:base_dir)  { File.join( TMP ) }
+  let(:files_dir) { File.join( TMP, 'files' ) }
 
-  it "returns remote paths if given fully resolved" do
-    Borrower.find("http://google.com").should == "http://google.com"
-  end
+  context "with no manifest file" do
 
-  it "finds named remote files" do
-    Borrower.find("remote").should == "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt"
-  end
+    before :each do
+      Borrower.manifest do |m|
+        m.file me_key, me_file
+        m.file remote_key, remote_file
+        m.dir base_dir
+        m.dir files_dir
+      end
+    end
+
+    it "finds a file path based on key name if set" do
+      Borrower.find(me_key).should == me_file
+    end
+
+    it "returns remote paths if given fully resolved" do
+      Borrower.find("http://google.com").should == "http://google.com"
+    end
+
+    it "finds named remote files" do
+      Borrower.find(remote_key).should == remote_file
+    end
+
+    it "creates list of files from directories" do
+      Borrower.find("baz.txt").should       == File.join( TMP, "baz.txt" )
+      Borrower.find("files/baz.txt").should == File.join( TMP, "files/baz.txt" )
+      Borrower.find("woo.txt").should       == File.join( TMP, "files/woo.txt" )
+      Borrower.find("foo.txt").should       == File.join( TMP, "files/foo.txt" )
+    end
+
+    it "raises error if no file is found" do
+      expect { Borrower.find("doesnt_exist.txt") }.to raise_error
+    end
 
-  it "creates list of files from directories" do
-    Borrower.find("baz.txt").should == File.join( TMP, "baz.txt" )
-    Borrower.find("files/baz.txt").should == File.join( TMP, "files/baz.txt" )
-    Borrower.find("woo.txt").should == File.join( TMP, "files/woo.txt" )
-    Borrower.find("foo.txt").should == File.join( TMP, "files/foo.txt" )
   end
 
-  it "raises error if no file is found" do
-    expect { Borrower.find("doesnt_exist.txt") }.to raise_error
+  context "with a borrower manifest file" do
+
+    before :each do
+      # ensure the manifest is reset
+      if Borrower.send(:instance_variable_defined?, :@_manifest)
+        Borrower.send(:remove_instance_variable, :@_manifest)
+      end
+
+      # move working dir to TMP
+      Dir.chdir TMP
+    end
+
+    after :each do
+      # move the working dir to root
+      Dir.chdir ROOT
+    end
+
+    before :each do
+      given_config %Q{
+files:
+  #{me_key}: #{me_file}
+  #{remote_key}: #{remote_file}
+
+directories:
+  #{base_dir}
+  #{files_dir}
+      }
+    end
+
+    it "detects that it is present" do
+      Borrower::Manifest::ConfigFile.present?.should be_true
+    end
+
+    it "adds the given files to the manifest" do
+      Borrower.manifest.files[me_key].should == me_file
+      Borrower.manifest.files[remote_key].should == remote_file
+    end
+
+    it "add the given directories to the manifest" do
+      Borrower.manifest.directories.include?( base_dir ).should be_true
+      Borrower.manifest.directories.include?( files_dir ).should be_true
+    end
+
   end
 
 end

data/spec/borrower_spec.rb

@@ -67,4 +67,31 @@ describe Borrower do
     Borrower.take( file_destination ).should == "Hi I'm a file foo"
   end
 
+  context "binary files" do
+
+    let(:binary_file) { File.join( Dir.pwd, 'spec/fixture', 'image.png' ) }
+    let(:binary_dest) { File.join( TMP, 'image.png' ) }
+
+    it "borrows them as it would any other file" do
+      borrow binary_file, to: binary_dest
+
+      expect( File.exists?(binary_dest) ).to be_true
+    end
+
+    it "skips merge attempts" do
+      borrow binary_file, to: binary_dest, merge: true
+
+      expect( File.exists?(binary_dest) ).to be_true
+    end
+
+    it "skips block manipulation" do
+      borrow binary_file, to: binary_dest do |f|
+        f.gsub( "foo", "bar" )
+      end
+
+      expect( File.exists?(binary_dest) ).to be_true
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,7 +1,14 @@
 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
 
 def given_files list
   FileUtils.mkdir_p TMP
@@ -20,8 +27,8 @@ def given_file name, content
   end
 end
 
-def given_config contents
-  File.open( File.join( TMP, '.borrower' ), 'w' ) do |file|
+def given_config content
+  File.open( File.join( TMP, 'manifest.borrower' ), 'w' ) do |file|
     file.write content
   end
 end

metadata

@@ -1,79 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: borrower
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  prerelease:
+  version: 0.7.0
 platform: ruby
 authors:
 - Steven Sloan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     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
-description: ! ' For borrowing little snippets of the web, or files, or really any
-  snippet of string. '
+    none: false
+  prerelease: false
+  type: :runtime
+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.rb
 - lib/borrower/merge.rb
 - lib/borrower/public_api.rb
 - lib/borrower/version.rb
-- lib/borrower.rb
-- spec/borrower/manifest_spec.rb
-- spec/borrower/merge_spec.rb
+- lib/borrower/manifest/config_file.rb
 - spec/borrower_spec.rb
 - spec/spec_helper.rb
+- spec/borrower/manifest_spec.rb
+- spec/borrower/merge_spec.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'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
-signing_key: 
+rubyforge_project:
+rubygems_version: 1.8.24
+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/manifest_spec.rb
-- spec/borrower/merge_spec.rb
 - spec/borrower_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/borrower/manifest_spec.rb
+- spec/borrower/merge_spec.rb