module Plezi

	# File and Object Caching for Plezi
	#
	# Be aware that the cache is local, per process. It's possible to limit file caching by limiting the supported_types in Plezi::Cache::CACHABLE.
	#
	# Template rendering engines are always cached.
	module Cache
		# contains the cached data, in the format: CACHE_STORE["filename"] = CacheObject
		CACHE_STORE = {}
		CACHE_LOCK = Mutex.new
		CACHABLE = (%w{cache object slim haml css map js html scss sass coffee txt xml json yaml rb}).to_set

		# this class holds cached objects (data and modification times)
		class CacheObject
			# Cached attributes
			attr_accessor :data, :mtime

			# initialize a Cached object
			def initialize d = nil, t = Time.now
				@data = d
				@mtime = t
			end
		end

		# load the file from the cache (if exists) or the file system (if it doesn't)
		def load_file filename
			cached?(filename) ? get_cached(filename) : reload_file(filename)
		end
		# review a file's modification time
		def file_mtime filename
			return CACHE_STORE[filename].mtime if cached?(filename)
			File.mtime(filename)
		end

		# force a file onto the cache (only if it is cachable - otherwise will load the file but will not cache it).
		def reload_file filename
			if CACHABLE.include? filename.match(/\.([^\.]+)$/)[1]
				return cache_data filename, IO.binread(filename), File.mtime(filename)
			else
				return IO.binread(filename)
			end
		end
		# places data into the cache, and attempts to save the data to a file name.
		def save_file filename, data, save_to_disk = false
			cache_data filename, data if CACHABLE.include? filename.match(/\.([^\.]+)$/)[1]
			begin
				IO.binwrite filename, data if save_to_disk
			rescue
				Plezi.warn("File couldn't be written (#{filename}) - file system error?")
			end
			data
		end

		# places data into the cache, under an identifier ( file name ).
		def cache_data filename, data, mtime = Iodine.time
			CACHE_LOCK.synchronize { CACHE_STORE[filename] = CacheObject.new( data, mtime )  }
			data
		end

		# Get data from the cache. will throw an exception if there is no data in the cache.
		# 
		# If a block is passed to the method, it will allows you to modify the protected cache in a thread safe manner.
		#
		# This is useful for manipulating strings or arrays that are stored in the cache.
		def get_cached filename
			return CACHE_STORE[filename].data unless block_given?
			data = CACHE_STORE[filename].data
			CACHE_LOCK.synchronize { yield(data) }
		end

		# Remove data from the cache, if it exists.
		def clear_cached filename
			CACHE_LOCK.synchronize { CACHE_STORE.delete filename } # if CACHE_STORE[filename]
		end

		# clears all cached data.
		def clear_cache! filename
			CACHE_LOCK.synchronize { CACHE_STORE.clear } # if CACHE_STORE[filename]
		end

		# returns true if the filename is cached.
		def cached? filename
			CACHE_STORE[filename] && true
		end

		# returns true if the file exists on disk or in the cache.
		def file_exists? filename
			( CACHE_STORE[filename] || File.exist?(filename) ) && true
		end

		# returns true if the {#allow_cache_update?} is true and the file has been update since data was last cached.
		def cache_needs_update? filename
			return true if CACHE_STORE[filename].nil? || (CACHE_STORE[filename].mtime < File.mtime(filename))
			false
		end

		# # # The following was discarded because benchmarks show the difference is negligible
		# @refresh_cache ||= (ENV['ENV'] != 'production')
		# # get the cache refresh directive for {#cache_needs_update}. Defaults to ENV['ENV'] != 'production'
		# def allow_cache_update?
		# 	@refresh_cache ||= (ENV['ENV'] != 'production')
		# end
		# # set the cache refresh directive for {#cache_needs_update}
		# def allow_cache_update= val
		# 	@refresh_cache = val
		# end
		# # returns true if the {#allow_cache_update?} is true and the file has been update since data was last cached.
		# def cache_needs_update? filename
		# 	return true if CACHE_STORE[filename].nil? || (allow_cache_update? && (CACHE_STORE[filename].mtime < File.mtime(filename)))
		# 	false
		# end



	end

	public

	extend Plezi::Cache
end