borrower 0.0.3 → 0.1.0

data/lib/borrower/manifest.rb

@@ -0,0 +1,46 @@
+module Borrower
+
+  class << self
+    def manifest &block
+      @_manifest ||= Manifest.new
+      yield @_manifest if block_given?
+    end
+
+    def find file
+      path = @_manifest.files.fetch(file) { false }
+      return path if path
+
+      matches = []
+      @_manifest.directories.each do |dir|
+        Dir[File.join( dir, '*' )].each do |possibility|
+          matches << possibility if possibility.match( file )
+        end
+      end
+
+      path = matches.sort { |a,b| a.length <=> b.length }.first
+      return path if path
+
+      raise "Could not file #{file}"
+    end
+  end
+
+  class Manifest
+
+    attr_reader :files
+    attr_reader :directories
+
+    def initialize
+      @files = {}
+      @directories = []
+    end
+
+    def file name, path
+      @files[name] = path
+    end
+
+    def dir dir
+      @directories.push dir
+    end
+
+  end
+end

data/lib/borrower/merge.rb

@@ -0,0 +1,35 @@
+module Borrower
+  class << self
+    def merge content, options={}
+      Merge.new( content, options ).output
+    end
+  end
+
+  class Merge
+    def initialize content, options={}
+      @content = content
+      @comment_symbol = options.fetch(:comment) { default_comment_symbol }
+    end
+
+    def output
+      merge_borrow_statements
+    end
+
+    private
+
+      def default_comment_symbol
+        "#"
+      end
+
+      def merge_borrow_statements
+        @content.gsub /(?:#{@comment_symbol})= borrow '(.*?)'/ do |match|
+          contents_from_file($1)
+        end
+      end
+
+      def contents_from_file path
+        ::Borrower::Path.contents(::Borrower.find(path))
+      end
+
+  end
+end

data/lib/borrower/transport.rb

@@ -3,8 +3,11 @@ module Borrower
 
     # routes a file from -> to
     # @param from [String]
-    def move from, to
-      put( take(from), to )
+    # @param args [Hash]
+    def move from, to, args={}
+      content = take(from)
+      content = Borrower.merge(content) if args[:merge]
+      put( content, to )
     end
 
     # handles taking a file

data/lib/borrower/version.rb

@@ -1,3 +1,3 @@
 module Borrower
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/borrower.rb

@@ -6,6 +6,8 @@ require "uri"
 
 # borrower
 require 'borrower/version'
+require 'borrower/manifest'
+require 'borrower/merge'
 require 'borrower/path'
 require 'borrower/transport'
 
@@ -20,11 +22,8 @@ module Borrower::DSL
   # @param args [Hash] only to: is looked at
   #
   def borrow path, args
-    unless args.has_key? :to
-      raise ArgumentError, "missing 'to:' argument"
-    end
-
-    Borrower::Transport.move path, args[:to]
+    destination = args.delete(:to) { raise ArgumentError, "missing 'to:' argument" }
+    Borrower::Transport.move path, destination, args
   end
 
 end

data/spec/borrower/manifest_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+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.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
+
+  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
+
+end

data/spec/borrower/merge_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "moving files with a merge" do
+
+  before :each do
+    given_file "foo.txt", "hello I'm merged text"
+    Borrower.manifest do |m|
+      m.file "foo.txt", File.join( TMP, "foo.txt" )
+    end
+  end
+
+  after :each do
+    cleanup_tmp
+  end
+
+  it "merges contents of files" do
+    Borrower.merge("#= borrow 'foo.txt'").should == "hello I'm merged text"
+  end
+
+  it "lets you pass other comment symbols" do
+    Borrower.merge("//= borrow 'foo.txt'", comment: "//" ).should == "hello I'm merged text"
+  end
+
+  it "handles multiple files to merge with" do
+    given_file "woo.txt", "woo"
+    given_file "multiple.txt", <<-content
+      #= borrow 'foo.txt'
+      #= borrow 'woo.txt'
+
+      Some other things
+    content
+    Borrower.manifest do |m|
+      m.file 'multiple.txt', File.join( TMP, 'multiple.txt' )
+      m.file 'woo.txt', File.join( TMP, 'woo.txt' )
+    end
+
+    Borrower.merge(Borrower::Transport.take(Borrower.find("multiple.txt"))).should == <<-output
+      hello I'm merged text
+      woo
+
+      Some other things
+    output
+  end
+
+end

data/spec/borrower/transport_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'borrower/transport'
+
+describe Borrower::Transport do
+  include Borrower::Transport
+
+  before :each do
+    given_file "file.txt", "Hi I'm a file"
+  end
+
+  after :each do
+    cleanup_tmp
+  end
+
+  let (:local_file)       { File.join( TMP, 'file.txt' ) }
+  let (:destination_path) { File.join( TMP, 'destination/file.txt' ) }
+
+
+  describe "#take" do
+    it "returns the correct contents" do
+      take( local_file ).should == "Hi I'm a file"
+    end
+  end
+
+  describe "#put" do
+
+    it "puts a string to a file" do
+      put "hello", destination_path
+      take( destination_path ).should == "hello"
+    end
+  end
+
+  describe "#move" do
+
+    it "moves the file" do
+      move( local_file, destination_path )
+      take( destination_path ).should == "Hi I'm a file"
+    end
+
+    it "overwrites an existing file" do
+      put "hello", destination_path
+      take( destination_path ).should == "hello" # just to make sure it was written to begin with
+      move( local_file, destination_path )
+      take( destination_path ).should == "Hi I'm a file"
+    end
+  end
+
+end

data/spec/borrower_spec.rb

@@ -2,26 +2,37 @@ require 'spec_helper'
 
 describe Borrower do
 
-  describe "#borrow" do
-    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
-
-    after(:each) do
-      `rm -rf #{File.dirname(path)}`
-    end
-
-    it "borrows local files" do
-      borrow File.join( Dir.pwd, 'spec/fixture', 'file.txt'), to: path
-      Borrower::Transport.take( path ).should == "Hi I'm a file"
-    end
-
-    it "borrows remote files" do
-      borrow "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt", to: path
-      Borrower::Transport.take( path ).should == "Hello I'm a file"
-    end
-
-    it "raises an error if missing to:" do
-      expect{ borrow( "foo", away: "bar" )}.to raise_error(ArgumentError)
-    end
+  before :each do
+    given_file "file.txt", "Hi I'm a file"
+    given_file "merge.txt", "#= borrow '#{File.join( TMP, 'file.txt')}'"
+  end
+
+  after :each do
+    cleanup_tmp
+  end
+
+  let (:local_file)       { File.join( TMP, 'file.txt' ) }
+  let (:merge_file)       { File.join( TMP, 'merge.txt' ) }
+  let (:remote_file)      { "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt" }
+  let (:file_destination) { File.join( TMP, 'destination/file.txt' ) }
+
+  it "borrows local files" do
+    borrow local_file, to: file_destination
+    Borrower::Transport.take( file_destination ).should == "Hi I'm a file"
+  end
+
+  it "borrows remote files" do
+    borrow remote_file, to: file_destination
+    Borrower::Transport.take( file_destination ).should == "Hello I'm a file"
+  end
+
+  it "merges files if merge is set to true" do
+    borrow merge_file, to: file_destination, merge: true
+    Borrower::Transport.take( file_destination ).should == "Hi I'm a file"
+  end
+
+  it "raises an error if missing arg with key 'to'" do
+    expect{ borrow( "foo", away: "bar" )}.to raise_error(ArgumentError)
   end
 
 end

data/spec/spec_helper.rb

@@ -1,2 +1,32 @@
 require 'rspec'
-require 'borrower'
+require 'borrower'
+require 'fileutils'
+
+TMP = File.join( Dir.pwd, "tmp" )
+
+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 contents
+  File.open( File.join( TMP, '.borrower' ), 'w' ) do |file|
+    file.write content
+  end
+end
+
+def cleanup_tmp
+  `rm -rf #{TMP}`
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borrower
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -35,14 +35,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/borrower/manifest.rb
+- lib/borrower/merge.rb
 - lib/borrower/path.rb
 - lib/borrower/transport.rb
 - lib/borrower/version.rb
 - lib/borrower.rb
+- spec/borrower/manifest_spec.rb
+- spec/borrower/merge_spec.rb
+- spec/borrower/transport_spec.rb
 - spec/borrower_spec.rb
-- spec/path_spec.rb
 - spec/spec_helper.rb
-- spec/transport_spec.rb
 homepage: http://github.com/stevenosloan/borrower
 licenses: []
 post_install_message: 
@@ -69,7 +72,9 @@ specification_version: 3
 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/transport_spec.rb
 - spec/borrower_spec.rb
-- spec/path_spec.rb
 - spec/spec_helper.rb
-- spec/transport_spec.rb
+has_rdoc: 

data/spec/path_spec.rb

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-describe Borrower::Path do
-
-  describe "#remote?" do
-    it "realizes a remote vs. local paths" do
-      Borrower::Path.remote?("http://google.com").should be_true
-      Borrower::Path.remote?("/path/to/file.rb").should be_false
-    end
-  end
-
-  describe "#exists?" do
-
-    it "recognizes missing files" do
-      Borrower::Path.exists?("this/file/is/missing.rb").should be_false
-      Borrower::Path.exists?("http://www.google.com/this/is/missing").should be_false
-    end
-
-    it "recognizes existing files" do
-      Borrower::Path.exists?( "http://www.google.com" ).should be_true
-      Borrower::Path.exists?( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should be_true
-    end
-
-  end
-
-  describe "#contents" do
-
-    it "returns the content of the files" do
-      Borrower::Path.contents( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should == "Hi I'm a file"
-    end
-
-    it "returns the content of a remote file" do
-      Borrower::Path.contents( "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt" ).should == "Hello I'm a file"
-    end
-
-    it "raises an error for a missing file" do
-      expect{ Borrower::Path.contents( "this/file/is/missing.rb" ) }.to raise_error(RuntimeError)
-      expect{ Borrower::Path.contents("http://www.google.com/this/is/missing") }.to raise_error(RuntimeError)
-    end
-
-  end
-
-end

data/spec/transport_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-require 'borrower/transport'
-
-describe Borrower::Transport do
-  include Borrower::Transport
-
-  describe "#take" do
-    it "returns the correct contents" do
-      take( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should == "Hi I'm a file"
-    end
-  end
-
-  describe "#put" do
-    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
-
-    after(:each) do
-      `rm -rf #{File.dirname(path)}`
-    end
-
-    it "puts a string to a file" do
-      put "hello", path
-      take( path ).should == "hello"
-    end
-  end
-
-  describe "#move" do
-    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
-
-    after(:each) do
-      `rm -rf #{File.dirname(path)}`
-    end
-
-    it "moves the file" do
-      move( File.join( Dir.pwd, 'spec/fixture', 'file.txt'), path )
-      take( path ).should == "Hi I'm a file"
-    end
-
-    it "overwrites an existing file" do
-      put "hello", path
-      take( path ).should == "hello" # just to make sure it was written to begin with
-      move( File.join( Dir.pwd, 'spec/fixture', 'file.txt'), path )
-      take( path ).should == "Hi I'm a file"
-    end
-  end
-
-end