# A dir is a subclass of Rush::Entry that contains other entries.  Also known
# as a directory or a folder.
#
# Dirs can be operated on with Rush::Commands the same as an array of files.
# They also offer a square bracket accessor which can use globbing to get a
# list of files.
#
# Example:
#
#   dir = box['/home/adam/']
#   dir['**/*.rb'].line_count
#
# In the interactive shell, dir.ls is a useful command.
class Rush::Dir < Rush::Entry
	def dir?
		true
	end

	def full_path
		"#{super}/"
	end

	# Entries contained within this dir - not recursive.
	def contents
		find_by_glob('*')
	end

	# Files contained in this dir only.
	def files
		contents.select { |entry| !entry.dir? }
	end

	# Other dirs contained in this dir only.
	def dirs
		contents.select { |entry| entry.dir? }
	end

	# Access subentries with square brackets, e.g. dir['subdir/file'] 
	def [](key)
		key = key.to_s
		if key == '**'
			files_flattened
		elsif key.match(/\*/)
			find_by_glob(key)
		else
			find_by_name(key)
		end
	end

	def find_by_name(name)    # :nodoc:
		Rush::Entry.factory("#{full_path}/#{name}", box)
	end

	def find_by_glob(glob)    # :nodoc:
		connection.index(full_path, glob).map do |fname|
			Rush::Entry.factory("#{full_path}/#{fname}", box)
		end
	end

	# A list of all the recursively contained entries in flat form.
	def entries_tree
		find_by_glob('**/*')
	end

	# Recursively contained files.
	def files_flattened
		entries_tree.select { |e| !e.dir? }
	end

	# Recursively contained dirs.
	def dirs_flattened
		entries_tree.select { |e| e.dir? }
	end

	# Given a list of flat filenames, product a list of entries under this dir.
	# Mostly for internal use.
	def make_entries(filenames)
		filenames.map do |fname|
			Rush::Entry.factory("#{full_path}/#{fname}")
		end
	end

	# Create a blank file within this dir.
	def create_file(name)
		file = self[name].create
		file.write('')
		file
	end

	# Create an empty subdir within this dir.
	def create_dir(name)
		name += '/' unless name.tail(1) == '/'
		self[name].create
	end

	# Create an instantiated but not yet filesystem-created dir.
	def create
		connection.create_dir(full_path)
		self
	end

	# Get the total disk usage of the dir and all its contents.
	def size
		connection.size(full_path)
	end

	# Contained dirs that are not hidden.
	def nonhidden_dirs
		dirs.select do |dir|
			!dir.hidden?
		end
	end

	# Contained files that are not hidden.
	def nonhidden_files
		files.select do |file|
			!file.hidden?
		end
	end

	# Run a bash command starting in this directory.
	def bash(command)
		box.bash "cd #{full_path} && #{command}"
	end

	# Destroy all of the contents of the directory, leaving it fresh and clean.
	def purge
		connection.purge full_path
	end

	# Text output of dir listing, equivalent to the regular unix shell's ls command.
	def ls
		out = [ "#{self}" ]
		nonhidden_dirs.each do |dir|
			out << "  #{dir.name}/"
		end
		nonhidden_files.each do |file|
			out << "  #{file.name}"
		end
		out.join("\n")
	end

	# Run rake within this dir.
	def rake(*args)
		bash "rake #{args.join(' ')}"
	end

	# Run git within this dir.
	def git(*args)
		bash "git #{args.join(' ')}"
	end

	include Rush::Commands

	def entries
		contents
	end
end