Reviser

#
# This is a simple component showing how to extend Reviser
# We are going to build a custom HTML generator with jQuery :-)
#
require 'reviser'

class MyGenerator < Reviser::Component
	#
	# We're expecting results from Checker as data
	#
	def initialize data
		super data
		#
		# We want the HTML output
		#
		@data.each do |project, results|
			results.each do |criterion, value|
				@data[project][criterion] = value.html
			end
		end
	end

	def run
		#
		# Get our template file
		#
		template = resource('html/results_template.html').read

		out = '<thead><tr>'
		#
		# Each criterion as headings
		#
		@data.values.first.keys.unshift.unshift('Projet').each { |crit| out += "<th>#{crit}</th>" }
		
		out += '</tr></thead><tbody>'
 		# Values for each project as rows
		@data.keys.each do |proj|
			out += "<tr><th>#{proj}</th>"
			@data[proj].each do |k, v|
				out += "<td>#{v.to_s.strip}</td>"
			end
			out += '</tr>'
		end
		out += '</tbody>'

		#
		# Kind of a hacky template engine
		# We replace placeholders with actual values
		#
		template.sub! '[DATA]', out
		template.sub! '[MAINCSS_PATH]', resource('css/main.css').to_path

		File.open('my_results.html', 'w') { |f| f.write template }
  end
end

require 'find'
require 'reviser'

#
# A custom criteria for reviser
#
module MyExtension
	#
	# This helper has the 'sources' methods
	# that allow you to retrieve all sources
	# files (files matching language extension)
	# as well as the 'manufacture' method,
	# needed to adapt results to out format
	#
	include Reviser::Helpers::Project

	#
	# Keep in mind that this method will be run
	# in each project's directory !
	# (that's why we use FileUtils.pwd)
	#
	def project_size
		#
		# That's the way we require gems without worrying
		# of them being installed or not !
		# require_gem is in global scope, and will raise an
		# exception if the given gem is not installed.
		# It will include it otherwise
		#
		unless defined? Filesize
			require_gem 'filesize'
		end

		size_in_bytes = size(FileUtils.pwd)
		results = Filesize.from("#{size_in_bytes} B").pretty
		#
		# The manufacture method excepts
		# a block which must describe the result contents
		# for EACH format.
		# You can also return raw data, then it'll be as it is
		# for all formats.
		#
		manufacture do |format|
			format.html { '<span style="font-weight:bold;">' + results + '</span>' }
			format.csv { results }
			format.xls { results }
		end
	end

	private
		#
		# Returns the size of all the given
		# files (even if there are also dirs)
		# in bytes
		#
		def size(dir)
			bytes = 0
			Find.find(*Dir["#{dir}/**/*"]) { |f| bytes += File.stat(f).size }

			bytes.to_f
		end
end

require 'reviser'

require_relative 'my_extension'
require_relative 'my_generator'

module MyApp
	include Reviser

	def self.run config_file = 'config.yml'
		#
		# Setup reviser
		#
		Reviser::setup config_file

		#
		# You can now use MyExtension's methods for analysis
		#
		Reviser::register :extension => 'MyExtension'
		
		#
		# You can load any built-in component (archiver, organiser, checker, generator)
		# But be aware that they have to be ran in this order, and that
		# organiser takes input from archiver, checker from organiser and generator from checker
		# If you don't respect that, nothing will work.
		# But you can run your component at any step, this won't break the process.
		#
		Reviser::load :component => 'archiver'
		Reviser::load :component => 'organiser', :input_from => 'archiver'
		Reviser::load :component => 'checker', :input_from => 'organiser'
		#
		# We run our custom generator instead :-)
		#
		# With :local => true, we tell reviser not to look for our component
		# in its core ones but to let us include it ourselves instead
		#
		Reviser::load :component => 'my_generator', :input_from => 'checker', :local => true

		# Reviser::load :component => 'generator', :input_from => 'checker'

		#
		# Run reviser
		#
		Reviser::run
	end
end

require_relative 'my_app'

#
# You can then run your app (don't forget you still need to be in a reviser workspace,
# so type/ and res/ folders must exist, as well as config.yml)
#
MyApp::run