borrower 0.1.1 → 0.2.0

data/lib/borrower/manifest.rb

@@ -1,9 +1,20 @@
 module Borrower
+  class Manifest
 
-  class << self
-    def manifest &block
-      @_manifest ||= Manifest.new
-      yield @_manifest if block_given?
+    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
 
     def find file
@@ -21,37 +32,18 @@ module Borrower
     private
 
       def check_for_file_in_manifest_files file
-        @_manifest.files.fetch(file) { false }
+        files.fetch(file) { false }
       end
 
       def check_for_file_in_manifest_directories file
         matches = []
-        @_manifest.directories.each do |dir|
+        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
       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

@@ -1,11 +1,6 @@
 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 }
@@ -28,7 +23,7 @@ module Borrower
       end
 
       def contents_from_file path
-        ::Borrower::Path.contents(path)
+        Path.contents(path)
       end
 
   end

data/lib/borrower/public_api.rb

@@ -0,0 +1,64 @@
+# the public api methods for borrower
+module Borrower
+  module PublicAPI
+
+    # retrieve the contents of a file
+    # that is remote or local
+    #
+    # @param [String] from the path to the file
+    # @return [String] contents of the file
+    def take from
+      Transport.take from
+    end
+
+    # write the content to a destination file
+    #
+    # @param [String] content content for the file
+    # @param [String] to path to write contents to
+    # @return [Void]
+    def put content, to
+      Transport.put content, to
+    end
+
+    # parse through the content and merge
+    # matched file contents
+    #
+    # @param [String] content content to parse
+    # @param [Hash] options merging options
+    # @option options [String] :comment the comment delimeter to match against
+    # @return [String] the merged content
+    def merge content, options={}
+      Merge.new( content, options ).output
+    end
+
+    # returns the manifest to add lookup
+    # directories or named files
+    # @example add a file alias and directory
+    #
+    #   manifest do |m|
+    #     m.file "jquery", "http://code.jquery.com/jquery-1.10.2.min.js"
+    #     # => adds an alias for jquery
+    #     m.dir  "vendor"
+    #     # => adds the vendor dir to the lookup paths
+    #   end
+    #
+    # @yield [Manifest]
+    # @return [Manifest]
+    def manifest &block
+      @_manifest ||= Manifest.new
+      yield @_manifest if block_given?
+      return @_manifest
+    end
+
+    # lookup a file or path in the manifest
+    #
+    # @param [String] file
+    # @return [String] path to the file
+    def find file
+      manifest.find file
+    end
+
+  end
+
+  extend PublicAPI
+end

data/lib/borrower/transport.rb

@@ -2,8 +2,9 @@ module Borrower
   module Transport
 
     # routes a file from -> to
-    # @param from [String]
-    # @param args [Hash]
+    # @param [String] from
+    # @param [String] to
+    # @param [Hash] args
     def move from, to, args={}
       content = take(from)
       content = Borrower.merge(content) if args[:merge]
@@ -11,15 +12,15 @@ module Borrower
     end
 
     # handles taking a file
-    # @param from [String]
+    # @param [String] from
     # @return [String]
     def take from
       Path.contents(from)
     end
 
     # puts a file somewhere
-    # @param content [String]
-    # @param to [String]
+    # @param [String] content
+    # @param [String] to
     def put content, to
       FileUtils.mkdir_p( File.dirname(to) )
       File.open( to, 'w', internal_encoding: content.encoding ) do |file|

data/lib/borrower/version.rb

@@ -1,3 +1,3 @@
 module Borrower
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/borrower.rb

@@ -10,17 +10,25 @@ require 'borrower/manifest'
 require 'borrower/merge'
 require 'borrower/path'
 require 'borrower/transport'
+require 'borrower/public_api'
 
 module Borrower::DSL
 
   # borrow a file and put it somewhere
-  # call syntax:
+  # by adding a merge: argument of true borrower will
+  # parse the contents for additional borrow statements
+  # to merge
+  # @example borrow source to destination
+  #   borrow "source/file", to: "destination/file"
   #
-  #    Borrower.borrow "path/to/file", to: "place/to/put/file"
-  #
-  # @param path [String]
-  # @param args [Hash] only to: is looked at
+  # @example borrow and merge source to destination
+  #   borrow "source/file", to: "file/destination", merge: true
   #
+  # @param [String] path
+  # @param [Hash] args
+  # @option args [String] :to the destination path
+  # @option args [Boolean] :merge wether to merge or not, defaults to `false`
+  # @return [Void]
   def borrow path, args
     destination = args.delete(:to) { raise ArgumentError, "missing 'to:' argument" }
     Borrower::Transport.move path, destination, args

data/spec/borrower_spec.rb

@@ -18,12 +18,12 @@ describe Borrower do
 
   it "borrows local files" do
     borrow local_file, to: file_destination
-    Borrower::Transport.take( file_destination ).should == "Hi I'm a file"
+    Borrower.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"
+    Borrower.take( file_destination ).should == "Hello I'm a file"
   end
 
   it "borrows named local and remote files" do
@@ -34,13 +34,13 @@ describe Borrower do
     borrow "local", to: file_destination
     borrow "remote", to: File.join( TMP, "remote.txt" )
 
-    Borrower::Transport.take( file_destination ).should == "Hi I'm a file"
-    Borrower::Transport.take( File.join( TMP, "remote.txt" ) ).should == "Hello I'm a file"
+    Borrower.take( file_destination ).should == "Hi I'm a file"
+    Borrower.take( File.join( TMP, "remote.txt" ) ).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"
+    Borrower.take( file_destination ).should == "Hi I'm a file"
   end
 
   it "raises an error if missing arg with key 'to'" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: borrower
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -38,6 +38,7 @@ files:
 - lib/borrower/manifest.rb
 - lib/borrower/merge.rb
 - lib/borrower/path.rb
+- lib/borrower/public_api.rb
 - lib/borrower/transport.rb
 - lib/borrower/version.rb
 - lib/borrower.rb