muwu 2.5.1

data/lib/muwu/project_builder/assets/config/css/extensions/index.scss

@@ -0,0 +1 @@
+// add `@import [filename]` commands below to build your document stylesheet

data/lib/muwu/project_builder/assets/config/css/index.scss

@@ -0,0 +1,19 @@
+// Muwu CSS Manifest
+// Only modify this file *IF* you know how to change it back.
+
+
+@import 'base/index';
+
+
+// The best way to modify the color theme:
+//   1. Put your files in the `colors` folder
+//   2. Modify the `@import [filename]` command in `colors/index.scss`
+@import 'colors/index';
+
+
+
+// The best way to include your own stylesheets:
+//   1. Put your stylesheets in the `extensions` folder
+//   2. Add an `@import [filename]` command in `extension/index.scss`
+//   3. Remove the `//` comment indicator from the next line
+// @import 'extensions/index';

data/lib/muwu/project_builder/assets/config/css_debugger/debug_section_text.scss

@@ -0,0 +1,27 @@
+html {
+  body {
+    section.text[data-depth] {
+      >* {
+        border: 1px pink solid;
+        >* {
+          border: 1px blue dotted;
+          >* {
+            border: 1px green dashed;
+            >* {
+              border: 1px orange solid;
+              >* {
+                border: 1px purple dotted;
+                >* {
+                  border: 1px brown solid;
+                  * {
+                    border: none;
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  } 
+}

data/lib/muwu/project_builder/project_reader.rb

@@ -0,0 +1,144 @@
+module Muwu
+  class ProjectReader
+
+
+    include Muwu
+    include Helper
+
+
+    require 'yaml'
+
+
+    attr_accessor(
+      :path,
+      :project,
+      :validator
+    )
+
+
+    def self.build
+      builder = new
+      yield(builder)
+      builder.project
+    end
+
+
+    def initialize
+      @project = Muwu::Project.new
+    end
+
+
+    def load_path(path)
+      @path = File.absolute_path(path)
+      @validator = ProjectValidator.new(@project)
+      phase_1_set_project_working_directory
+      phase_2_read_metadata
+      phase_2_read_options
+      phase_2_read_outline
+      phase_3_set_javascript_libraries_requested
+      phase_3_set_metadata_instance_date
+      phase_4_validate
+      phase_5_build_manifest
+    end
+
+
+    def phase_1_set_project_working_directory
+      @project.working_directory = @path
+    end
+
+
+    def phase_2_read_metadata
+      if @validator.validate_file_metadata
+        @project.metadata = YAML.load_file(@project.metadata_filename)
+      end
+    end
+
+
+    def phase_2_read_options
+      @project.options = build_options
+    end
+
+
+    def phase_2_read_outline
+      if @validator.validate_file_outline
+        @project.outline = build_outline
+      end
+    end
+
+
+    def phase_3_set_javascript_libraries_requested
+      @project.javascript_libraries_requested = determine_javascript_libraries
+    end
+
+
+    def phase_3_set_metadata_instance_date
+      @project.metadata["date of this edition"] = @project.instance_date
+    end
+
+
+    def phase_4_validate
+      @validator.validate_file_css
+      @validator.validate_output_destination_and_formats
+      @validator.validate_scenario_if_more_than_one_document
+    end
+
+
+    def phase_5_build_manifest
+      @project.manifest = build_manifest
+    end
+
+
+
+    private
+
+
+    def build_manifest
+      ManifestBuilder.build do |b|
+        b.build_from_project(@project)
+      end
+    end
+
+
+    def build_options
+      ProjectOptionsReader.build do |b|
+        b.build_from_ymlfile(@project)
+      end
+    end
+
+
+    def build_outline
+      outline = YAML.load_stream(File.read(@project.outline_filename))
+      outline.reject!{ |step| NilClass === step }
+      outline.each_with_index do |document, index|
+        if document_outline_does_not_begin_with_known_directive(document)
+          outline[index] = presume_text_block(document)
+        end
+      end
+      outline
+    end
+
+
+    def determine_javascript_libraries
+      libraries = []
+      if @project.options.html_uses_javascript_navigation
+        libraries << :navigation
+      end
+      if libraries.count > 0
+        libraries.unshift(:init)
+      end
+      libraries
+    end
+
+
+    def document_outline_does_not_begin_with_known_directive(document)
+      OutlineHelper.type_of(document[0]) == nil
+    end
+
+
+    def presume_text_block(document)
+      [{'Text' => document}]
+    end
+
+
+  end
+end

data/lib/muwu/project_builder/project_reset_css.rb

@@ -0,0 +1,95 @@
+module Muwu
+  class ProjectResetCss
+    
+    
+    include Muwu
+    
+    
+    require 'fileutils'
+    
+    
+    def initialize(project)
+      @project = project
+    end
+    
+    
+    public
+    
+    
+    def reset_css
+      phase_1_verify_or_create_css_folder
+      phase_2_clear_base_folder
+      phase_3_copy_base_css_files
+      phase_4_verify_or_create_colors_folder
+      phase_5_copy_colors_css_files
+      phase_6_copy_index
+      phase_7_verify_or_create_extensions_folder
+    end
+    
+    
+    def phase_1_verify_or_create_css_folder
+      if Dir.exists?(@project.path_config) == false
+        puts "Creating folder #{@project.path_config}"
+        FileUtils.mkdir(@project.path_config)
+      end
+      if Dir.exists?(@project.path_css) == false
+        puts "Creating folder #{@project.path_css}"
+        FileUtils.mkdir(@project.path_css)
+      end
+    end
+    
+    
+    def phase_2_clear_base_folder
+      if Dir.exists?(@project.path_css_base) == true
+        puts "Clearing folder #{@project.path_css_base}"
+        FileUtils.remove_dir(@project.path_css_base)
+      end
+    end
+    
+    
+    def phase_3_copy_base_css_files
+      folder_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css','base'))
+      folder_destination_project = @project.path_css_base
+      puts "Resetting folder #{@project.path_css_base}"
+      FileUtils.cp_r(folder_source_gem, folder_destination_project)
+    end
+        
+    
+    def phase_4_verify_or_create_colors_folder
+      if Dir.exists?(@project.path_css_colors) == false
+        puts "Creating folder #{@project.path_css_colors}"
+        FileUtils.mkdir(@project.path_css_colors)
+      end
+    end
+    
+    
+    def phase_5_copy_colors_css_files
+      colors_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css','colors','.'))
+      colors_destination_project = @project.path_css
+      puts "Resetting file #{File.join(@project.path_css_colors,'dark.scss')}"
+      puts "Resetting file #{File.join(@project.path_css_colors,'dark.scss')}"
+      puts "Resetting file #{File.join(@project.path_css_colors,'dark.scss')}"
+      FileUtils.cp_r(colors_source_gem, colors_destination_project)
+    end
+    
+    
+    def phase_6_copy_index
+      index_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css','index.scss'))
+      index_destination_project = @project.path_css
+      puts "Resetting file #{File.join(@project.path_css, 'index.scss')}"
+      FileUtils.cp_r(index_source_gem, index_destination_project)
+    end
+    
+    
+    def phase_7_verify_or_create_extensions_folder
+      if Dir.exists?(@project.path_css_extensions) == false
+        folder_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css','extensions'))
+        folder_destination_project = @project.path_css_extensions
+        puts "Creating folder #{@project.path_css_extensions}"
+        FileUtils.cp_r(folder_source_gem, folder_destination_project)
+      end
+    end
+   
+    
+  end
+end

data/lib/muwu/project_builder/project_starter.rb

@@ -0,0 +1,27 @@
+module Muwu
+  class ProjectStarter
+    
+    
+    include Muwu
+    
+    
+    def initialize(current_working_directory, metadata)
+      @current_working_directory = File.absolute_path(current_working_directory)
+      @metadata = metadata
+    end
+
+
+    public
+
+
+    def new_project
+      project = Project.new
+      project.metadata = @metadata
+      project.options = Default::PROJECT_OPTIONS
+      project.working_directory = File.absolute_path(File.join(@current_working_directory, @metadata[:slug]))
+      project
+    end
+    
+    
+  end
+end

data/lib/muwu/project_builder/project_validator.rb

@@ -0,0 +1,157 @@
+module Muwu
+  class ProjectValidator
+
+
+    include Muwu
+
+
+    def initialize(project)
+      @project = project
+    end
+
+
+
+    public
+
+
+    def validate_file_css
+      if @project.css_manifest_file_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::CssManifestFileNotFound.new(@project.css_manifest_filename)
+        return false
+      end
+    end
+
+
+    def validate_file_metadata
+      if @project.metadata_file_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::MetadataFileNotFound.new(@project)
+        return false
+      end
+    end
+
+
+    def validate_file_options
+      if @project.options_file_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::OptionsFileNotFound.new(@project)
+        return false
+      end
+    end
+
+
+    def validate_file_outline
+      if @project.outline_file_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::OutlineFileNotFound.new(@project)
+        return false
+      end
+    end
+
+
+    def validate_outline_step_navigator(index)
+      validate_outline_step_navigator_if_single_document(index)
+      return validate_outline_step_navigator_if_automatic(index)
+    end
+
+
+    def validate_outline_step_navigator_if_automatic(index)
+      if @project.will_not_generate_navigators_automatically
+        return true
+      elsif @project.will_generate_navigators_automatically
+        @project.exceptions_add ProjectException::NavigatorsWillBeGeneratedAutomatically.new(index)
+        return false
+      end
+    end
+
+
+    def validate_outline_step_navigator_if_single_document(index)
+      if @project.outline_has_only_one_document
+        @project.exceptions_add ProjectException::NavigatorNotRecommendedWithSingleDocument.new(index)
+      end
+    end
+
+
+    def validate_outline_step_subcontents(index)
+      if @project.will_not_generate_subcontents_automatically
+        return true
+      elsif @project.will_generate_subcontents_automatically
+        @project.exceptions_add ProjectException::SubcontentsWillBeGeneratedAutomatically.new(@index)
+        return false
+      end
+    end
+
+
+    def validate_output_destination_and_formats
+      if @project.output_destination_requests_stdout && @project.output_formats_several
+        @project.exceptions_add ProjectException::MultipleFormatsRequestedWithStdout.new
+      end
+    end
+
+
+    def validate_scenario_if_more_than_one_document
+      if @project.outline_has_more_than_one_document && @project.output_destination_requests_stdout
+        @project.exceptions_add ProjectException::MultipleDocumentsOutlinedWithStdout.new
+      end
+      if @project.outline_has_more_than_one_document && @project.will_embed_at_least_one_asset
+        @project.exceptions_add ProjectException::DryOutputRecommendedWithMultipleDocuments.new
+      end
+    end
+
+
+    def validate_task_metadata(task)
+      values_missing = task.metadata.select { |k,v| v.to_s == ''}
+      if values_missing.empty?
+        return true
+      else
+        values_missing.each_pair { |k,v| @project.exceptions_add ProjectException::MetadataValueNotGiven.new(task, k) }
+        return false
+      end
+    end
+
+
+    def validate_task_text_item(task)
+      if task.is_parent_heading
+        return validate_task_text_item_parent_heading(task)
+      elsif task.is_not_parent_heading
+        return validate_task_text_item_child_heading(task)
+      end
+    end
+
+
+    def validate_task_text_item_child_heading(task)
+      if task.source_file_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::TextSourceFileNotFound.new(task)
+        return false
+      end
+    end
+
+
+    def validate_task_text_item_parent_heading(task)
+      if task.source_file_does_exist
+        return true
+      else
+        if @project.options.warning_if_parent_heading_lacks_source
+          @project.exceptions_add ProjectException::TextSourceFileNotFound.new(task)
+          return false
+        end
+      end
+    end
+
+
+
+    def validate_task_title(task)
+      return validate_task_metadata(task)
+    end
+
+
+
+  end
+end