muwu 3.0.0.alpha → 3.0.0

data/lib/muwu/destination_builder/destination_builder.rb

@@ -1,16 +1,16 @@
 module Muwu
   class DestinationBuilder
-    
-    
+
+
     include Muwu
-    
-    
+
+
     attr_accessor(
       :destination,
       :project
     )
-    
-    
+
+
     def self.build
       builder = new
       yield(builder)
@@ -21,24 +21,24 @@ module Muwu
     def initialize
       @destination = Destination.new
     end
-    
-    
+
+
     def build_css(project)
       depends_on_project(project)
       set_output_class
       set_output_filename_css
       set_output_working_directory
     end
-    
-    
+
+
     def build_html(project, index)
       depends_on_project(project)
       set_output_class
       set_output_filename_html(index)
       set_output_working_directory
     end
-    
-    
+
+
     def build_js(project)
       depends_on_project(project)
       set_output_class
@@ -50,13 +50,13 @@ module Muwu
     def depends_on_project(project)
       @project = project
     end
-    
-    
+
+
     def set_output_class
       @destination.output_class = @project.output_destination
     end
-    
-        
+
+
     def set_output_filename_css
       if @destination.output_class == 'file'
         @destination.output_filename = determine_output_filename_css
@@ -69,26 +69,26 @@ module Muwu
         @destination.output_filename = determine_output_filename_html(index)
       end
     end
-    
-    
+
+
     def set_output_filename_js
       if @destination.output_class == 'file'
         @destination.output_filename = determine_output_filename_js
       end
     end
-    
-    
+
+
     def set_output_working_directory
       if @destination.output_class == 'file'
-        @destination.output_working_directory = @project.working_directory
+        @destination.output_working_directory = @project.path_compiled
       end
     end
-    
-  
+
+
 
     private
-    
-    
+
+
     def determine_output_filename_css
       filename = ''
       filename.concat @project.css_basename
@@ -106,22 +106,20 @@ module Muwu
       filename.concat ".html"
       filename
     end
-    
-    
+
+
     def determine_output_filename_js
       filename = ''
       filename.concat @project.js_basename
       filename.concat ".js"
       filename
     end
-    
-    
+
+
     def index_is_integer_greater_than_zero(index)
       (Integer === index) && (index >= 1)
     end
-    
-    
+
+
   end
 end
-      
-      

data/lib/muwu/manifest_task_builder/text_item_builder.rb

@@ -153,7 +153,7 @@ module Muwu
         end
       end
 
-
+      # TODO: This method looks obsolete. Find its references.
       def determine_source_filename_implicitly
         # filename = make_filename_implicitly(outline_step)
         # filepath = make_filepath_implicitly
@@ -259,13 +259,6 @@ module Muwu
       end
 
 
-      # def make_filename_implicitly(string)
-      #   file_basename = SanitizerHelper.sanitize_text_item_path(string)
-      #   filename = file_basename + '.md'
-      #   filename
-      # end
-
-
       def make_filepath_implicitly
         path_from_project_home = ['text']
         if @project.text_block_naming_is_simple

data/lib/muwu/project/project.rb

@@ -1,10 +1,10 @@
 module Muwu
   class Project
-    
-    
+
+
     include Muwu
     include Helper
-    
+
 
     attr_accessor(
       :exceptions,
@@ -17,40 +17,29 @@ module Muwu
       :slug,
       :working_directory
     )
-    
-    
+
+
     def initialize
       @exceptions = []
       @instance_date = Time.now.strftime('%Y-%m-%d')
       @metadata = {}
       @outline = []
     end
-    
-    
-    def inspect
-      ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
-    end
-    
-    
-    def inspect_instance_variables
-      self.instance_variables.map { |v| "#{v}=#<#{instance_variable_get(v).class}>" }.join(", ")
-    end
-
 
 
     public
-    
-    
+
+
     def css_manifest_file_does_exist
       File.exists?(css_manifest_filename) == true
     end
-    
-    
+
+
     def css_manifest_filename
       File.absolute_path(File.join(path_css, 'index.scss'))
     end
-    
-    
+
+
     def css_basename
       if @options.output_file_css_basename.to_s == ''
         SanitizerHelper::sanitize_destination_file_basename(slug).downcase
@@ -58,40 +47,40 @@ module Muwu
         SanitizerHelper::sanitize_destination_file_basename(@options.output_file_css_basename).downcase
       end
     end
-    
-    
+
+
     def default_text_block_name
       Default::PROJECT_OUTLINE[:default_text_block_name]
     end
-    
-    
+
+
     def does_not_have_crucial_files
-      exceptions_include?(ProjectException::MetadataFileNotFound) &&
-      exceptions_include?(ProjectException::OptionsFileNotFound) &&
-      exceptions_include?(ProjectException::OutlineFileNotFound)
+      metadata_file_does_not_exist &&
+      options_file_does_not_exist &&
+      outline_file_does_not_exist
     end
 
 
     def exceptions_add(exception)
       @exceptions << exception
     end
-    
-    
+
+
     def exceptions_fatal
       @exceptions.select{ |e| e.type == :fatal }
     end
-    
-    
+
+
     def exceptions_include?(exception)
       @exceptions.map{ |e| e.class }.include?(exception)
     end
-    
-    
+
+
     def has_multiple_html_documents
       @manifest.documents_html_count > 1
     end
-    
-    
+
+
     def html_basename
       if @options.output_file_html_basename.to_s == ''
         SanitizerHelper::sanitize_destination_file_basename('index').downcase
@@ -99,8 +88,18 @@ module Muwu
         SanitizerHelper::sanitize_destination_file_basename(@options.output_file_html_basename).downcase
       end
     end
-    
-    
+
+
+    def inspect
+      ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
+    end
+
+
+    def inspect_instance_variables
+      self.instance_variables.map { |v| "#{v}=#<#{instance_variable_get(v).class}>" }.join(", ")
+    end
+
+
     def js_basename
       if @options.output_file_js_basename.to_s == ''
         SanitizerHelper::sanitize_destination_file_basename(slug).downcase
@@ -108,8 +107,8 @@ module Muwu
         SanitizerHelper::sanitize_destination_file_basename(@options.output_file_js_basename).downcase
       end
     end
-    
-    
+
+
     def metadata_file_does_exist
       File.exists?(metadata_filename) == true
     end
@@ -118,28 +117,28 @@ module Muwu
     def metadata_file_does_not_exist
       File.exists?(metadata_filename) == false
     end
-    
-    
+
+
     def metadata_filename
       determine_project_asset_filepath(:metadata)
     end
-    
-    
+
+
     def options_file_does_exist
       File.exists?(options_filename) == true
     end
-    
-    
+
+
     def options_file_does_not_exist
       File.exists?(options_filename) == false
     end
-    
-    
+
+
     def options_filename
       determine_project_asset_filepath(:options)
     end
-    
-    
+
+
     def outline_file_does_exist
       File.exists?(outline_filename) == true
     end
@@ -148,28 +147,28 @@ module Muwu
     def outline_file_does_not_exist
       File.exists?(outline_filename) == false
     end
-    
-    
+
+
     def outline_filename
       determine_project_asset_filepath(:outline)
     end
-    
-    
+
+
     def outline_has_more_than_one_document
       outline_length > 1
     end
-    
-    
+
+
     def outline_has_only_one_document
       outline_length == 1
     end
-    
-    
+
+
     def outline_length
       outline.length
     end
-    
-    
+
+
     def outline_text_block_names
       result = []
       outline_text_blocks.each do |text_block|
@@ -199,8 +198,8 @@ module Muwu
       end
       result
     end
-    
-    
+
+
     def outline_text_pathnames
       @options.outline_text_pathnames
     end
@@ -209,47 +208,60 @@ module Muwu
     def outline_text_pathnames_are_explicit
       @options.outline_text_pathnames == 'explicit'
     end
-    
+
 
     def outline_text_pathnames_are_flexible
       @options.outline_text_pathnames == 'flexible'
     end
 
-    
+
     def outline_text_pathnames_are_implicit
       @options.outline_text_pathnames == 'implicit'
     end
-    
+
 
     def outlined_documents
       @outline
     end
-    
-    
+
+
     def outlined_documents_by_index
       result = {}
       @outline.each_index do |index|
         result[index] = @outline[index]
-      end      
+      end
       result
     end
-    
-    
+
+
     def output_destination
       @options.output_destination
     end
-    
-    
+
+
     def output_destination_requests_stdout
       @options.output_destination == 'stdout'
     end
-    
-    
+
+
     def output_formats_several
       @options.output_formats.length > 1
     end
-    
-    
+
+
+
+    # TODO: Move path definitions into Muwu::Default::FILEPATHS
+
+    def path_compiled
+      File.absolute_path(File.join(@working_directory, 'compiled'))
+    end
+
+
+    def path_compiled_does_exist
+      Dir.exists?(path_compiled)
+    end
+
+
     def path_config
       File.absolute_path(File.join(@working_directory, 'config'))
     end
@@ -268,28 +280,31 @@ module Muwu
     def path_css_colors
       File.absolute_path(File.join(path_css, 'colors'))
     end
-    
-    
+
+
     def path_css_extensions
       File.absolute_path(File.join(path_css, 'extensions'))
     end
 
 
-    def path_images
-      File.absolute_path(File.join(@working_directory, 'images'))
-    end
-    
-    
+    # TODO: Broken due to introduction of the `/compiled` folder
+    # Keeping it as a comment in case it becomes useful in the future.
+    #
+    # def path_images
+    #   File.absolute_path(File.join(@working_directory, 'images'))
+    # end
+
+
     def path_outline
       @working_directory
     end
-    
-    
+
+
     def path_text
       File.absolute_path(File.join(@working_directory, 'text'))
     end
-    
-    
+
+
     def slug
       if @metadata.has_key?('slug')
         @metadata['slug']
@@ -297,8 +312,8 @@ module Muwu
         working_directory_name
       end
     end
-    
-    
+
+
     def sort_outline_text_blocks
       result = []
       outline_text_blocks.each do |text_block|
@@ -306,25 +321,25 @@ module Muwu
         text_block_contents = determine_text_block_contents(text_block)
         existing_block = result.select { |b| b.has_key?(text_block_name) }.flatten
         if existing_block.empty?
-          result << { text_block_name => text_block_contents }          
+          result << { text_block_name => text_block_contents }
         else
           existing_block[text_block_name].concat(text_block_contents)
         end
       end
       result
     end
-    
-    
+
+
     def text_block_naming_is_simple
       outline_text_block_names == [default_text_block_name]
     end
-    
+
 
     def text_block_naming_is_not_simple
       text_block_naming_is_simple == false
     end
 
-    
+
     def title
       if @metadata.has_key?('title')
         @metadata['title']
@@ -332,55 +347,59 @@ module Muwu
         working_directory_name
       end
     end
-    
-    
+
+
     def will_create_css_file
       @options.output_formats.include?('css')
     end
-    
-    
+
+
     def will_create_html_file_only
       @options.output_formats == ['html']
     end
-    
-    
+
+
     def will_create_javascript_file
       if will_require_javascript_libraries
         @options.output_formats.include?('js')
       end
     end
-    
-    
+
+
     def will_require_javascript_libraries
       @javascript_libraries_requested.count > 0
     end
-    
-    
+
+
     def will_embed_at_least_one_asset
       will_embed_css || will_embed_js
     end
 
 
+    # TODO: What if there's no css to embed?
+    # Consider redefining this method.
     def will_embed_css
       will_create_css_file == false
     end
-    
-    
+
+
+    # TODO: What if there's no js to embed?
+    # Consider redefining this method.
     def will_embed_js
       will_create_javascript_file == false
     end
-    
-    
+
+
     def will_generate_navigators_automatically
       (outline_has_more_than_one_document) && (@options.generate_navigators_automatically == true) && (@options.output_destination == 'file')
     end
-    
-    
+
+
     def will_generate_subcontents_automatically
       (outline_has_more_than_one_document) && (@options.generate_subcontents_automatically == true)
     end
-    
-    
+
+
     def will_render_section_numbers
       @options.render_section_numbers == true
     end
@@ -389,32 +408,32 @@ module Muwu
     def will_not_generate_navigators_automatically
       not will_generate_navigators_automatically
     end
-    
-    
+
+
     def will_not_generate_subcontents_automatically
       not will_generate_subcontents_automatically
     end
-    
-    
+
+
     def working_directory_name
       @working_directory.split(File::SEPARATOR)[-1]
     end
-    
-             
+
+
 
     private
-    
-    
+
+
     def determine_project_asset_filepath(type)
       File.absolute_path(File.join(@working_directory, Default::FILEPATHS[type], Default::FILENAMES[type]))
     end
 
-    
+
     def determine_text_block_contents(text_block)
       text_block.flatten[1]
     end
-    
-    
+
+
     def determine_text_block_name(text_block)
       directive = text_block.flatten[0]
       components = directive.partition(RegexpLib.outline_text_plus_whitespace)
@@ -424,7 +443,7 @@ module Muwu
       end
       text_block_name
     end
-    
-    
+
+
   end
-end
+end