muwu 2.5.1

data/lib/muwu/project_builder/project_writer.rb

@@ -0,0 +1,127 @@
+module Muwu
+  class ProjectWriter
+
+
+    include Muwu
+    include Helper
+
+
+    require 'fileutils'
+    require 'yaml'
+    
+    
+    attr_accessor(
+      :project
+    )
+
+
+    def initialize(project)
+      @project = project
+    end
+
+
+    public
+
+
+    def write
+      if Dir.exist?(@project.working_directory) == false
+        puts '# Writing project'
+        phase_1_make_project_folder
+        phase_2_make_project_subfolders
+        phase_2_make_folder_css_and_copy_files
+        phase_3_write_file_metadata_yml
+        phase_3_write_file_options_yml
+        phase_3_write_file_outline_yml
+        puts "\n"
+        puts '# Project written.'
+
+      elsif Dir.exist?(@project.working_directory) == true
+        raise ProjectExceptionHandler::Fatal.new(ProjectException::TargetProjectFolderAlreadyExists.new(@project))
+
+      end
+    end
+    
+    
+    def phase_1_make_project_folder
+      announce_and_execute_dir_mkdir(@project.working_directory)
+    end
+    
+    
+    def phase_2_make_project_subfolders
+      announce_and_execute_dir_mkdir(@project.path_config)
+      announce_and_execute_dir_mkdir(@project.path_images)
+      announce_and_execute_dir_mkdir(@project.path_text)
+    end
+    
+
+    def phase_2_make_folder_css_and_copy_files
+      folder_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css'))
+      folder_destination_project = @project.path_css
+      announce_and_execute_fileutils_cp_r(folder_source_gem, folder_destination_project)
+    end
+
+
+    def phase_3_write_file_metadata_yml
+      announce_and_execute_yaml_dump(HashHelper.human_readable_hash(@project.metadata), @project.metadata_filename)
+    end
+
+
+    def phase_3_write_file_options_yml
+      announce_and_execute_yaml_dump(HashHelper.human_readable_hash(@project.options), @project.options_filename)
+    end
+
+
+
+    def phase_3_write_file_outline_yml
+      if @project.outline.any?
+        phase_3_write_file_outline_yml_dump
+      elsif @project.outline.empty?
+        phase_3_write_file_outline_yml_blank
+      end
+    end
+    
+    
+    def phase_3_write_file_outline_yml_dump
+      announce_and_execute_yaml_dump(@project.outline, @project.outline_filename)
+    end
+
+
+    def phase_3_write_file_outline_yml_blank
+      announce_and_execute_fileutils_touch(@project.outline_filename)
+    end
+
+
+
+    private
+
+
+    def announce_and_execute_dir_mkdir(dir)
+      print "- Making directory".ljust(18)
+      puts "  `#{dir}`"
+      Dir.mkdir(dir)
+    end
+
+
+    def announce_and_execute_fileutils_cp_r(folder_source_gem, folder_destination_project)
+      print "- Writing tree".ljust(18)
+      puts "  `#{folder_destination_project}`"
+      FileUtils.cp_r(folder_source_gem, folder_destination_project)
+    end
+
+
+    def announce_and_execute_fileutils_touch(filename)
+      print "- Writing file".ljust(18)
+      puts "  `#{filename}`"
+      FileUtils.touch(filename)
+    end
+
+
+    def announce_and_execute_yaml_dump(obj, filename)
+      print "- Writing file".ljust(18)
+      puts "  `#{filename}`"
+      File.open(filename,'w') { |file| YAML.dump(obj, file, canonical: false) }
+    end
+
+
+  end
+end

data/lib/muwu/project_exception/css_manifest_file_not_found.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class CssManifestFileNotFound
+
+
+      def initialize(css_manifest_filename)
+        @css_manifest_filename = css_manifest_filename
+      end
+      
+
+      def report 
+        "The css manifest file `#{@css_manifest_filename}` could not be found."
+      end
+      
+
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/dry_output_recommended_with_multiple_documents.rb

@@ -0,0 +1,19 @@
+module Muwu
+  module ProjectException
+    class DryOutputRecommendedWithMultipleDocuments
+      
+      
+      def report
+        "Shared assets will be embedded. Including `css` and `js` in `output_formats` is recommended with multiple documents."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+    end
+  end
+end
+        

data/lib/muwu/project_exception/metadata_file_not_found.rb

@@ -0,0 +1,24 @@
+module Muwu
+  module ProjectException
+    class MetadataFileNotFound
+
+
+
+      def initialize(project)
+        @filename = project.metadata_filename
+      end
+      
+      
+      def report
+        "The metadata file `#{@filename}` could not be found."
+      end
+
+      
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/metadata_value_not_given.rb

@@ -0,0 +1,42 @@
+module Muwu
+  module ProjectException
+    class MetadataValueNotGiven
+      
+      
+      include Muwu
+   
+   
+      def initialize(task, key)
+        @task = task
+        @index = task.document_index
+        @key = key
+      end
+      
+      
+      def report
+        "Metadata value for `#{@key}` not found (document #{@index}, block `#{block_type}`)."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+      
+      private
+      
+      
+      def block_type
+        case @task
+        when ManifestTask::Metadata
+          'metadata'
+        when ManifestTask::Title
+          'title'
+        end
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/project_exception/multiple_documents_outlined_with_stdout.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class MultipleDocumentsOutlinedWithStdout
+
+
+      def report
+        'The output destination `stdout` can only accommodate a single outlined document.'
+      end
+
+      
+      def type
+        :fatal
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/multiple_formats_requested_with_stdout.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class MultipleFormatsRequestedWithStdout
+
+
+      def report
+        'The output destination `stdout` can only accommodate a single output format.'
+      end
+
+      
+      def type
+        :fatal
+      end      
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/navigator_not_recommended_with_stdout.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class NavigatorNotRecommendedWithSingleDocument
+   
+   
+      def initialize(index)
+        @index = index
+      end
+      
+      
+      def report
+        "Navigator not recommended with a single outlined document."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/project_exception/navigators_will_be_generated_automatically.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class NavigatorsWillBeGeneratedAutomatically
+   
+   
+      def initialize(index)
+        @index = index
+      end
+      
+      
+      def report
+        "Navigators will be generated automatically. Ignoring outline directive (document #{@index})."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/project_exception/option_key_not_understood.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class OptionKeyNotUnderstood
+
+
+      def initialize(key)
+        @key = key
+      end
+      
+
+      def report
+        "The option key `#{@key}` is not understood."
+      end
+      
+      
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/option_not_validatable.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class OptionNotValidatable
+
+
+      def initialize(key)
+        @key = key
+      end
+      
+
+      def report
+        "The option `#{@key}` cannot be validated. (Muwu::ProjectOptionValidatorValue)"
+      end
+      
+      
+      def type
+        :internal
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/option_value_not_understood.rb

@@ -0,0 +1,24 @@
+module Muwu
+  module ProjectException
+    class OptionValueNotUnderstood
+
+
+      def initialize(key, value)
+        @key = key
+        @value = value
+      end
+      
+
+      def report
+        "For option key `#{@key}`, the value `#{@value}` is not understood."
+      end
+
+
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/options_file_not_found.rb

@@ -0,0 +1,24 @@
+module Muwu
+  module ProjectException
+    class OptionsFileNotFound
+      
+      
+      def initialize(project)
+        @filename = project.options_filename
+      end
+      
+      
+      def report
+        "The options file `#{@filename}` could not be found."
+      end
+      
+      
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end    
+    

data/lib/muwu/project_exception/outline_file_not_found.rb

@@ -0,0 +1,24 @@
+module Muwu
+  module ProjectException
+    class OutlineFileNotFound
+      
+      
+      def initialize(project)
+        @filename = project.outline_filename
+      end
+      
+      
+      def report
+        "The outline file `#{@filename}` could not be found."
+      end
+      
+      
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end    
+