assets-publisher-for-hanami 2.0.0

data/lib/cabeza-de-termo/assets-publisher/assets/types/asset-type.rb

@@ -0,0 +1,41 @@
+require 'cabeza-de-termo/assets/library'
+require 'cabeza-de-termo/assets/rendering-scope-adaptors/hanami-rendering-scope'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class AssetType
+			def html_for(asset_uri)
+				CdT.subclass_responsibility
+			end
+
+			# Collect the assets to publish from the rendering_scope
+			def collect_assets_from(rendering_scope)
+				collect_uri_from(rendering_scope).collect do |uri|
+					new_asset_from_uri(uri)
+				end
+			end
+
+			# Answer a new Asset from the uri and type
+			def new_asset_from_uri(uri)
+				Asset.on_uri self, uri
+			end
+
+			# Collect the javascripts uri from the rendering_scope
+			def collect_uri_from(rendering_scope)
+				CdT.subclass_responsibility
+			end
+
+    		def compiler()
+    			CdT.subclass_responsibility
+    		end
+
+    		def rendering_scope_assets_collector()
+    			configuration.rendering_scope_assets_collector
+    		end
+
+			def configuration()
+				Publisher.configuration
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/assets/types/javascript-type.rb

@@ -0,0 +1,20 @@
+require_relative 'asset-type'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class JavascriptType < AssetType
+			def html_for(asset_uri)
+				"<script src=\"#{asset_uri}\" type=\"text/javascript\"></script>"
+			end
+
+			# Collect the javascripts uri from the rendering_scope
+			def collect_uri_from(rendering_scope)
+				rendering_scope_assets_collector.javascripts_from rendering_scope
+			end
+
+			def compiler()
+				configuration.javascripts_compiler
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/assets/types/stylesheet-type.rb

@@ -0,0 +1,20 @@
+require_relative 'asset-type'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class StylesheetType < AssetType
+			def html_for(asset_uri)
+				"<link href=\"#{asset_uri}\" type=\"text/css\" rel=\"stylesheet\">"
+			end
+
+			# Collect the javascripts uri from the rendering_scope
+			def collect_uri_from(rendering_scope)
+				rendering_scope_assets_collector.stylesheets_from rendering_scope
+			end
+
+			def compiler()
+				configuration.stylesheets_compiler
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/clock-cards/clock-card-machine.rb

@@ -0,0 +1,43 @@
+module CabezaDeTermo
+	module AssetsPublisher
+		# An object to detect if a compilation job needs to run or not.
+		class ClockCardMachine
+			def initialize()
+				@clock_cards = {}
+			end
+
+			def is_outdated?(compilation_job)
+				return true unless has_record_on?(compilation_job.id)
+
+				clock_cards_not_match? clock_cards[compilation_job.id], compilation_job.clock_card
+			end
+
+			def register_modifications_on(compilation_job)
+				clock_cards.delete(compilation_job.id)
+
+				CdT.object compilation_job.clock_card,
+					if_not_nil: proc { |card| clock_cards[compilation_job.id] = card unless card.has_assets_missing? }
+			end
+
+			protected
+
+			def clock_cards
+				@clock_cards
+			end
+
+			def has_record_on?(id)
+				clock_cards.key?(id)
+			end
+
+			def clock_cards_not_match?(expected_card, card)
+				!clock_cards_match?(expected_card, card)
+			end
+
+			def clock_cards_match?(expected_card, card)
+				return false unless expected_card.size == card.size
+
+				expected_card.all_marks? { |uri, time| time == card.time_for(uri) }
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/clock-cards/clock-card.rb

@@ -0,0 +1,47 @@
+module CabezaDeTermo
+	module AssetsPublisher
+		class ClockCard
+			def initialize(&block)
+				@marks = {}
+
+				block.call(self)
+			end
+
+			# Accesing
+
+			def set_mark_for(asset_uri, time)
+				marks[asset_uri] = time
+			end
+
+			def time_for(asset_uri)
+				marks[asset_uri]
+			end
+
+			# Asking
+
+			def has_time_for?(asset_uri)
+				marks.key?(asset_uri)
+			end
+
+			def all_marks?(&block)
+				marks.all?(&block)
+			end
+
+			def has_assets_missing?()
+				marks.any? { |uri, timestamp| timestamp == :not_found }
+			end
+
+			# Querying
+
+			def size()
+				marks.size
+			end
+
+			protected
+
+			def marks()
+				@marks
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/compilation-jobs/compilation-job.rb

@@ -0,0 +1,80 @@
+require 'cabeza-de-termo/assets-publisher/clock-cards/clock-card'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class CompilationJob
+			def initialize(assets: nil, destination: nil)
+				@assets = assets
+				@destination = destination
+			end
+
+			# Accessors
+
+			def assets()
+				@assets
+			end
+
+			def destination()
+				@destination
+			end
+
+			def id()
+				@destination.uri.to_s
+			end
+
+			# Asking
+			def empty?()
+				assets.empty?
+			end
+
+			# File names
+
+			def source_filenames
+				assets.collect { |asset| asset.real_path.to_s }
+			end
+
+			def destination_filename
+				destination.real_path.to_s
+			end
+
+			# Compiling
+
+			def compile_with(compiler)
+				validate_source_assets
+				compiler.compile_job self
+				self
+			end
+
+			# Html
+
+			# Answer the asset html to include in a template.
+			def html
+				destination.html
+			end
+
+			def validate_source_assets()
+				assets.each { |asset| asset.validate_real_path }
+			end
+
+			# Clock card
+
+			def clock_card()
+				ClockCard.new do |card|
+					assets.each do |asset|
+						card.set_mark_for(asset.uri.to_s, asset.modification_time)
+					end
+
+					card.set_mark_for(destination.uri.to_s, destination.modification_time)
+				end
+			end
+
+			def source_folders()
+				configuration.source_folders.collect { |path| Pathname(path).expand_path.to_s }
+			end
+
+			def configuration()
+				Publisher.configuration
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/compilation-jobs/compilation-jobs-builder.rb

@@ -0,0 +1,52 @@
+module CabezaDeTermo
+	module AssetsPublisher
+		class CompilationJobsBuilder
+			# Answer a new collection of compilation jobs for the assets
+			def self.jobs_for(asset_type, assets)
+				self.new(asset_type).jobs_for(assets)
+			end
+
+			def jobs_for(assets)
+				CdT.subclass_responsibility
+			end
+
+			# Initializing
+
+			def initialize(asset_type)
+				@asset_type = asset_type
+			end
+
+			# Accessing
+
+			def asset_type()
+				@asset_type
+			end
+
+			# Configuration
+
+			# Answer the Publisher configuration.
+			def configuration
+				Publisher.configuration
+			end
+
+			def compiled_assets_folder
+				configuration.published_assets_subfolder
+			end
+
+			# Answer the uri of the compiled asset
+			def compiled_uri
+				Pathname.new('/') + compiled_assets_folder + compiled_filename
+			end
+
+			def compiled_filename
+				CdT.subclass_responsibility
+			end
+
+			# Published asset
+
+			def asset_to_publish()
+				Asset.on_uri(asset_type, compiled_uri)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/assets-publisher/compilation-jobs/one-file-per-asset-builder.rb

@@ -0,0 +1,66 @@
+require_relative 'compilation-jobs-builder'
+require_relative 'compilation-job'
+
+module CabezaDeTermo
+   	module AssetsPublisher
+		class OneFilePerAssetBuilder < CompilationJobsBuilder
+			# Answer a collection of CompilationJob to send to a Compiler.
+			def jobs_for(assets)
+				assets.collect { |asset| new_compilation_job_for asset }
+			end
+
+			# Answer a new CompilationJob for a single asset to send to a Compiler
+			def new_compilation_job_for(asset)
+				@asset = asset
+				CompilationJob.new(assets: assets_to_compile, destination: asset_to_compile_to)
+			end
+
+			# Answer the current asset
+			def asset()
+				@asset
+			end
+
+			# Answer the asset to compile. If the asset has an absolute location
+			# we won't compile it
+			def assets_to_compile()
+				if asset.location.is_absolute?
+					asset.validate_real_path
+					return [] 
+				end
+
+				[asset]
+			end
+
+			# Answer the asset that will hold the compiled assets.
+			def asset_to_compile_to()
+				return asset if asset.location.is_absolute?
+
+				asset_to_publish
+					.set_uri_parameters(timestamp_string)
+			end
+
+			def compiled_filename
+				return asset.uri if ['.css', '.js'].include?(asset.uri.extname)
+				Pathname.new(remove_last_extension_from_uri)
+			end
+
+			def remove_last_extension_from_uri
+				asset.uri.to_s.split('.')[0..-2].join('.')
+			end
+
+			# Uri timestamp
+
+			# Answer if we must append a timestamp to the relative assets or not
+			def add_timestamps?()
+				configuration.add_timestamps_to_published_assets?
+			end
+
+			# Answer the timestamp string to add to this asset.
+			def timestamp_string()
+				return nil unless add_timestamps?
+
+				Time.now.to_s
+			end
+		end
+	end
+end

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

@@ -0,0 +1,26 @@
+require 'fileutils'
+require 'open3'
+require_relative 'compiler'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class CommandLineCompiler < Compiler
+			def initialize(&block)
+				super()
+				@block = block
+			end
+
+			def compile_assets()
+				@block.call(self, compilation_job)
+			end
+
+			def command_line(*args)
+				ouput, status = Open3.capture2e(*args)
+
+				raise_compilation_failed_error(ouput.strip) unless status.success?
+
+				ouput
+			end
+		end
+	end
+end

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

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'tilt'
+require 'cabeza-de-termo/assets-publisher/errors/compilation-job-not-supported-error'
+require 'cabeza-de-termo/assets-publisher/errors/compilation-job-failed-error'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		class Compiler
+			def compile_job(compilation_job)
+				return if compilation_job.empty?
+
+				@compilation_job = compilation_job
+
+				ensure_destination_folder_exists
+
+				compile_assets
+			end
+
+			def compilation_job()
+				@compilation_job
+			end
+
+			def source_assets()
+				@compilation_job.assets
+			end
+
+			protected
+
+			def compile_assets()
+				CdT.subclass_responsibility
+			end
+
+			def ensure_destination_folder_exists()
+				destination_folder.mkpath
+			end
+
+			def destination_folder()
+				compilation_job.destination.real_path.dirname
+			end
+
+			def raise_compilation_job_not_supported_error()
+				raise CompilationJobNotSupportedError.new(self, compilation_job)
+			end
+
+			def raise_compilation_failed_error(message)
+				raise CompilationJobFailedError.new(self, compilation_job, message)
+			end
+		end
+	end
+end