module Borrower::PublicAPI
Public Instance Methods
lookup a file or path in the manifest
@param [String] file @return [String] path to the file
# File lib/borrower/public_api.rb, line 70 def find file manifest.find file 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]
# File lib/borrower/public_api.rb, line 60 def manifest &block @_manifest ||= Manifest.new yield @_manifest if block_given? return @_manifest 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
# File lib/borrower/public_api.rb, line 43 def merge content, options={} Merge.new( content, options ).output end
write the content to a destination file
@param [String] content content for the file @param [String] destination path to write contents to @param [Symbol] on_conflict what to do if the destination exists @return [Void]
# File lib/borrower/public_api.rb, line 20 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
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
# File lib/borrower/public_api.rb, line 10 def take from Content.get from end