assets-publisher-for-hanami 2.0.0

data/lib/cabeza-de-termo/assets-publisher/compilers/tilt-compiler.rb

@@ -0,0 +1,47 @@
+require 'fileutils'
+require 'tilt'
+require_relative 'compiler'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class TiltCompiler < Compiler
+			protected
+
+			def source_asset
+				compilation_job.assets.first
+			end 
+
+			def compile_assets()
+				validate_assets_collection
+
+				compile_single_asset
+			end
+
+			def compile_single_asset()
+				just_copy? ? copy! : compile!
+			end
+
+			def validate_assets_collection()
+				raise_compilation_job_not_supported_error unless source_assets.size == 1
+			end
+
+			def just_copy?()
+				['.css', '.js'].include?(source_asset.real_path.extname)
+			end
+
+			def copy!()
+				::FileUtils.copy_file(source_asset.real_path, compilation_job.destination_filename)
+			end
+
+			def compile!()
+				::File.open(compilation_job.destination_filename, 'w') do |file|
+					file.write( render_source )
+				end
+			end
+
+			def render_source()
+				Tilt.new(source_asset.real_path).render
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/configuration/configuration.rb

@@ -0,0 +1,66 @@
+module CabezaDeTermo
+	module AssetsPublisher
+		# The Publisher configuration.
+		class Configuration
+			# Initialize the instance
+			def initialize
+				@source_folders = []
+
+				destination_folder nil
+				add_timestamps_to_published_assets true
+				stylesheets_compiler {}
+				javascripts_compiler {}
+				use_rendering_scope_assets_collector nil
+			end
+
+			# Answer if the Publisher will add a timestamp to the assets with relative paths
+			def add_timestamps_to_published_assets?
+				@add_timestamps_to_published_assets
+			end
+
+			# Set if the Publisher will add a timestamp to the assets with relative paths
+			def add_timestamps_to_published_assets(boolean)
+				@add_timestamps_to_published_assets = boolean
+			end
+
+			# Answer the asset sources collection
+			def source_folders
+				@source_folders
+			end
+
+			def destination_folder(folder)
+				@destination_folder = folder
+			end
+
+			def destination_path
+				::Pathname.new(@destination_folder)
+			end
+
+			def published_assets_subfolder
+				::Pathname.new('assets')
+			end
+
+			def stylesheets_compiler(&block)
+				return @stylesheets_compiler_block.call if block.nil?
+				@stylesheets_compiler_block = block
+			end
+
+			def javascripts_compiler(&block)
+				return @javascripts_compiler_block.call if block.nil?
+				@javascripts_compiler_block = block
+			end
+
+			def command_line_compiler(&block)
+				CommandLineCompiler.new(&block)
+			end
+
+			def use_rendering_scope_assets_collector(rendering_scope_assets_collector)
+				@rendering_scope_assets_collector = rendering_scope_assets_collector
+			end
+
+			def rendering_scope_assets_collector()
+				@rendering_scope_assets_collector
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/errors/asset-not-found-error.rb

@@ -0,0 +1,12 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class AssetNotFoundError < Error
+			def initialize(asset_uri)
+				super("The asset '#{asset_uri}' was not found.")
+				@asset_uri = asset_uri
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/errors/compilation-job-failed-error.rb

@@ -0,0 +1,14 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class CompilationJobFailedError < Error
+			def initialize(compiler, compilation_job, message)
+				super(message)
+
+				@compiler = compiler
+				@compilation_job = compilation_job
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/errors/compilation-job-not-supported-error.rb

@@ -0,0 +1,14 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class CompilationJobNotSupportedError < Error
+			def initialize(compiler, compilation_job, message)
+				super(message)
+
+				@compiler = compiler
+				@compilation_job = compilation_job
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/errors/error.rb

@@ -0,0 +1,6 @@
+module CabezaDeTermo
+	module AssetsPublisher
+		class Error < ::StandardError
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/errors/unknown-asset-location-error.rb

@@ -0,0 +1,12 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class UnknownAssetLocationError < Error
+			def initialize(asset_uri)
+				super("Unkown location for '#{asset_uri}'.")
+				@asset_uri = asset_uri
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/helpers/helper.rb

@@ -0,0 +1,27 @@
+require 'cabeza-de-termo/assets-publisher/publisher'
+
+module CabezaDeTermo
+  module AssetsPublisher
+  	# The View helper.
+  	# To use it, add this to your view:
+  	# 
+  	# 	module Web
+  	# 		module Views
+  	# 	    	class YourView
+  	# 	      	include CabezaDeTermo::AssetsPublisher::Helper
+  	# 	        ...
+  	# 	    	end
+  	# 	  	end
+  	# 	end
+  	#
+  	# This will publish only one method to your views: #assets_publisher. From that method 
+  	# you can call the Publisher protocol.
+    module Helper
+    	# Answer the Publisher to collect and publish stylesheets and javascripts from
+    	# your current view.
+    	def assets_publisher
+    		Publisher.new
+    	end
+    end
+  end
+end

data/lib/cabeza-de-termo/assets-publisher/locations/absolute-location.rb

@@ -0,0 +1,25 @@
+require_relative 'location'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class AbsoluteLocation < Location
+			# Answer the path of the asset uri.
+			def real_path_of(uri)
+				Pathname.new(destination_path.to_s + uri.to_s).expand_path
+			end
+
+			# Asking
+
+			def is_absolute?()
+				true
+			end
+
+			protected
+
+			# Answer the path of the folder where compiled assets are published
+			def destination_path
+				configuration.destination_path
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/locations/location.rb

@@ -0,0 +1,54 @@
+require 'cabeza-de-termo/assets-publisher/errors/unknown-asset-location-error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class Location
+			# Answer a new location for the uri
+			def self.from(uri)
+				class_for_uri(uri).new(uri)
+			end
+
+			# Answer the class to use for the uri
+			def self.class_for_uri(uri)
+				uri = Pathname.new(uri)
+
+				return class_named("CabezaDeTermo::AssetsPublisher::AbsoluteLocation") if uri.absolute?
+				return class_named("CabezaDeTermo::AssetsPublisher::SourceLocation") if uri.relative?
+
+				raise UnknownAssetLocationError.new(uri)
+			end
+
+			# Answer a class from its fully quilified name
+			def self.class_named(fully_qualified)
+				fully_qualified.split('::').inject(Object) do |mod, class_name|
+					mod.const_get(class_name)
+				end
+			end
+
+			# Instance methods
+
+			def initialize(uri)
+				@uri = uri
+			end
+
+			# Answer the Publisher configuration.
+			def configuration
+				Publisher.configuration
+			end
+
+			# Asking
+
+			def is_absolute?()
+				false
+			end
+
+			# Answer the path of the asset uri
+			def real_path_of(uri)
+				CdT.subclass_responsibility
+			end
+		end
+	end
+end
+
+require_relative 'source-location'
+require_relative 'absolute-location'

data/lib/cabeza-de-termo/assets-publisher/locations/source-location.rb

@@ -0,0 +1,13 @@
+require_relative 'location'
+require 'cabeza-de-termo/assets-publisher/source-finders/assets-finder'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class SourceLocation < Location
+			# Answer the path of the asset uri
+			def real_path_of(uri)
+				(AssetsFinder.asset_source_path_of uri).expand_path
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/publisher.rb

@@ -0,0 +1,142 @@
+require 'cdt/utilities/bind'
+require 'cdt/utilities/subclass-responsibility'
+require 'cdt/utilities/if-not-nil'
+require_relative 'version'
+require_relative 'configuration/configuration'
+require_relative 'assets/asset'
+require_relative 'compilation-jobs/one-file-per-asset-builder'
+require_relative 'compilers/tilt-compiler'
+require_relative 'compilers/command-line-compiler'
+require_relative 'clock-cards/clock-card-machine'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		# The collector and publisher of the stylesheets and javascripts from the current view.
+		class Publisher
+
+			@configuration_prototype = nil
+
+			@clock_card_machine = ClockCardMachine.new
+
+			@configurations_per_thread = {}
+
+			# Class methods
+			class << self
+				# Answer the Publihser configuration
+				def configuration()
+					configurations_per_thread[::Thread.current]
+				end
+
+				# Pass the config to the block to allow the app to configure the Publisher
+				def configure(&block)
+					CdT.bind_block_evaluation_to configuration_prototype, &block
+				end
+
+				def clock_card_machine()
+					@clock_card_machine
+				end
+
+				def configurations_per_thread()
+					@configurations_per_thread
+				end
+
+				# Answer the Publihser configuration
+				def configuration_prototype()
+					@configuration_prototype ||= default_configuration
+				end
+
+				def reset_configuration_prototype()
+					@configuration_prototype = nil
+				end
+
+				def default_configuration()
+					CdT.bind_block_evaluation_to(Configuration.new) do
+						add_timestamps_to_published_assets true
+
+						stylesheets_compiler { TiltCompiler.new }
+						javascripts_compiler { TiltCompiler.new }
+
+						use_rendering_scope_assets_collector CabezaDeTermo::Assets::HanamiRenderingScope
+
+						self
+					end
+				end
+			end
+
+			# Instance methods
+
+			# Collect and publish the stylesheets from the rendering_scope. Answer the html to include
+			# in your template.
+			def stylesheets_for(rendering_scope)
+				with_configuration_copy do
+					compile_and_build_html_for(StylesheetType.new, rendering_scope)
+				end
+			end
+
+			# Collect and publish the javascripts from the rendering_scope. Answer the html to include
+			# in your template.
+			def javascripts_for(rendering_scope)
+				with_configuration_copy do
+					compile_and_build_html_for(JavascriptType.new, rendering_scope)
+				end
+			end
+
+			protected
+
+			def compile_and_build_html_for(asset_type, rendering_scope)
+				compile_assets_and_build_html_for asset_type, assets_for(asset_type, rendering_scope)
+			end
+
+			def compile_assets_and_build_html_for(asset_type, assets)
+				jobs = compilation_jobs_for(asset_type, assets)
+
+				compile_jobs(asset_type, jobs)
+				jobs_html(jobs)
+			end
+
+			def compile_jobs(asset_type, compilation_jobs)
+				compilation_jobs.each do |job|
+					compile(job, asset_type)
+				end
+			end
+
+			def compile(compilation_job, asset_type)
+				return unless clock_card_machine.is_outdated? compilation_job
+
+				compilation_job.compile_with(asset_type.compiler)
+
+				clock_card_machine.register_modifications_on compilation_job
+			end
+
+			def jobs_html(compilation_jobs)
+				compilation_jobs.inject('') do |html, compilation_job|
+					html += compilation_job.html
+				end
+			end
+
+			# Create and answer a new comopilation job
+			def compilation_jobs_for(asset_type, assets)
+				OneFilePerAssetBuilder.jobs_for asset_type, assets
+			end
+
+			def assets_for(asset_type, rendering_scope)
+				asset_type.collect_assets_from(rendering_scope)
+			end
+
+			def clock_card_machine()
+				self.class.clock_card_machine
+			end
+
+			def with_configuration_copy(&block)
+				begin
+					self.class.configurations_per_thread[::Thread.current] = 
+						self.class.configuration_prototype.dup
+
+					block.call
+				ensure
+					self.class.configurations_per_thread.delete(::Thread.current)
+				end
+			end
+		end
+	end
+end