muwu 2.5.1

data/lib/muwu/manifest_task_builder/metadata_builder.rb

@@ -0,0 +1,118 @@
+module Muwu
+  module ManifestTaskBuilders
+    class MetadataBuilder
+
+
+      include Muwu
+      include Helper
+      
+
+      attr_accessor(
+        :outline_fragment_metadata,
+        :parent_document,
+        :project,
+        :task
+      )
+
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.task
+      end
+
+
+      def initialize
+        @task = ManifestTask::Metadata.new
+      end
+
+
+      def build_from_outline(outline_fragment_metadata, parent_document)
+        @destination = parent_document.destination
+        @outline_fragment_metadata = outline_fragment_metadata
+        @parent_document = parent_document
+        @project = parent_document.project
+        phase_1_set_parent
+        phase_1_set_project
+        phase_2_set_destination
+        phase_2_set_metadata
+        phase_3_validate_metadata_values_exist
+      end
+
+
+      def phase_1_set_parent
+        @task.parent_document = @parent_document
+      end
+  
+
+      def phase_1_set_project
+        @task.project = @project
+      end
+
+
+      def phase_2_set_destination
+        @task.destination = @destination
+      end
+
+
+      def phase_2_set_metadata
+        @task.metadata = determine_metadata
+      end
+      
+      
+      def phase_3_validate_metadata_values_exist
+        ProjectValidator.new(@project).validate_task_metadata(@task)
+      end
+      
+  
+  
+      private
+
+  
+      def determine_metadata
+        case @outline_fragment_metadata
+        when String
+          determine_metadata_all
+        when Hash
+          determine_metadata_selected
+        end
+      end
+      
+      
+      def determine_metadata_all
+        @project.metadata.merge(determine_metadata_date_of_this_edition)
+      end
+      
+
+      def determine_metadata_selected
+        metadata = {}
+        keys = @outline_fragment_metadata.flatten[1]
+        keys.each do |key|
+          if key =~ RegexpLib.metadata_key_date_of_this_edition
+            metadata.merge!(determine_metadata_date_of_this_edition(key: key))
+          else
+            metadata.merge!(determine_metadata_selected_and_validate(key))
+          end
+        end
+        metadata
+      end
+      
+      
+      def determine_metadata_selected_and_validate(key)
+        metadata = @project.metadata.select { |k,v| k.downcase == key.downcase }
+        if metadata.empty?
+          metadata = {key => nil}
+        end
+        metadata
+      end
+      
+      
+      def determine_metadata_date_of_this_edition(key: 'date of this edition')
+        metadata = {key => @project.metadata["date of this edition"]}
+        metadata
+      end
+    
+    
+    end
+  end
+end

data/lib/muwu/manifest_task_builder/navigator_builder.rb

@@ -0,0 +1,78 @@
+module Muwu
+  module ManifestTaskBuilders
+    class NavigatorBuilder
+      
+      
+      include Muwu
+      
+      
+      attr_accessor(
+        :document,
+        :navigator,
+        :outline_step,
+        :project
+      )
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.navigator
+      end
+      
+      
+      def initialize
+        @navigator = ManifestTask::Navigator.new
+      end
+      
+      
+      def build_from_outline(document)
+        @document = document
+        @project = document.project
+        set_destination
+        set_document_home_index
+        set_document_next_index
+        set_document_prev_index
+        set_heading
+        set_index
+        set_project
+      end
+      
+      
+      def set_destination
+        @navigator.destination = @document.destination
+      end
+      
+      
+      def set_document_home_index
+        @navigator.document_home_index = 0
+      end
+      
+      
+      def set_document_next_index
+        @navigator.document_next_index = (@document.index + 1) % @project.outline.length
+      end
+
+
+      def set_document_prev_index
+        @navigator.document_prev_index = (@document.index - 1) % @project.outline.length
+      end
+      
+      
+      def set_heading
+        @navigator.heading = @project.title
+      end
+            
+      
+      def set_index
+        @navigator.index = @document.index
+      end
+      
+      
+      def set_project
+        @navigator.project = @project
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/manifest_task_builder/subcontents_builder.rb

@@ -0,0 +1,90 @@
+module Muwu
+  module ManifestTaskBuilders
+    class SubcontentsBuilder
+
+
+      include Muwu
+      include Helper
+      
+
+      attr_accessor(
+        :manifest_subcontents,
+        :outline_subcontents,
+        :parent_document,
+        :project
+      )
+
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.manifest_subcontents
+      end
+
+
+      def initialize
+        @manifest_subcontents = ManifestTask::Subcontents.new
+      end
+
+
+      def build_from_document(outline_step, parent_document)
+        @outline_subcontents = outline_step
+        @parent_document = parent_document
+        @project = parent_document.project
+        phase_1_set_parent
+        phase_1_set_project
+        phase_2_set_destination
+        phase_2_set_text_root_name
+        phase_3_set_item_depth_max
+        phase_3_set_will_render_section_numbers
+      end
+
+
+      def phase_1_set_parent
+        @manifest_subcontents.parent = @parent_document
+      end
+
+  
+      def phase_1_set_project
+        @manifest_subcontents.project = @project
+      end
+
+
+      def phase_2_set_destination
+        @manifest_subcontents.destination = @parent_document.destination
+      end
+      
+      
+      def phase_2_set_text_root_name
+        @manifest_subcontents.text_root_name = determine_text_root_name
+      end
+      
+      
+      def phase_3_set_item_depth_max
+        @manifest_subcontents.item_depth_max = @project.options.render_sections_distinctly_depth_max
+      end
+      
+
+      def phase_3_set_will_render_section_numbers
+        @manifest_subcontents.will_render_section_numbers = @project.options.render_section_numbers
+      end
+  
+
+
+      private
+
+
+      def determine_text_root_name
+        components = @outline_subcontents.partition(RegexpLib.outline_text_plus_whitespace)
+        text_block_name = components[2].to_s.downcase.strip
+        if text_block_name == ''
+          text_block_name = @project.default_text_block_name
+        end
+        text_block_name
+      end
+      
+  
+      
+    end
+  end
+end

data/lib/muwu/manifest_task_builder/text_builder.rb

@@ -0,0 +1,125 @@
+module Muwu
+  module ManifestTaskBuilders
+    class TextBuilder
+
+
+      include Muwu
+      include Helper
+
+
+      attr_accessor(
+        :outline_text,
+        :parent_document,
+        :project,
+        :text
+      )
+
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.text
+      end
+
+
+      def initialize
+        @text = ManifestTask::Text.new
+      end
+
+
+      def build_from_outline(outline_text, parent_document)
+        @outline_text = outline_text
+        @parent_document = parent_document
+        @project = parent_document.project
+        set_project
+        set_destination
+        set_naming
+        set_numbering
+        set_sections
+      end
+
+    
+      def set_destination
+        @text.destination = @parent_document.destination
+      end
+
+  
+      def set_naming
+        @text.naming = [determine_text_block_name]
+      end
+
+
+      def set_numbering
+        @text.numbering = []
+      end
+        
+
+      def set_project
+        @text.project = @project
+      end
+  
+  
+      def set_sections
+        @text.sections = build_sections
+      end
+
+
+
+      private
+
+
+      def build_sections
+        sections = []
+        child_steps = determine_text_block_steps
+        if child_steps.empty? == false
+          child_section_numbering = section_number_extend(@text.numbering)
+          child_steps.each do |step|
+            child_section_numbering = section_number_find(child_section_numbering, step)
+            sections << build_text_item(step, child_section_numbering)
+          end
+        end
+        sections
+      end
+  
+  
+      def build_text_item(step, section_numbering)
+        ManifestTaskBuilders::TextItemBuilder.build do |b|
+          b.build_from_outline_fragment_text(step, section_numbering, @text)
+        end
+      end
+
+
+      def determine_text_block_name
+        directive = @outline_text.flatten[0]
+        components = directive.partition(RegexpLib.outline_text_plus_whitespace)
+        text_block_name = components[2].to_s.downcase.strip
+        if text_block_name == ''
+          text_block_name = @project.default_text_block_name
+        end
+        text_block_name
+      end
+  
+  
+      def determine_text_block_steps
+        @outline_text.flatten[1]
+      end
+
+
+      def section_number_extend(number_incoming)
+        number_outgoing = number_incoming.clone
+        number_outgoing << 0
+        number_outgoing
+      end
+
+      
+      def section_number_find(number_incoming, step)
+        number_outgoing = number_incoming.clone
+        sorted_outline_steps = @project.outline_text_blocks_named(@text.text_root_name)
+        number_outgoing[-1] = sorted_outline_steps.index(step) + 1
+        number_outgoing
+      end
+      
+  
+    end
+  end
+end

data/lib/muwu/manifest_task_builder/text_item_builder.rb

@@ -0,0 +1,314 @@
+module Muwu
+  module ManifestTaskBuilders
+    class TextItemBuilder
+
+
+      include Muwu
+      include Helper
+
+
+      attr_accessor(
+        :heading_data,
+        :numbering,
+        :outline_fragment,
+        :parent_manifest_text,
+        :project,
+        :source_filename,
+        :text_item
+      )
+
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.text_item
+      end
+
+
+      def initialize
+        @text_item = ManifestTask::TextItem.new
+      end
+
+
+      def build_from_outline_fragment_text(outline_fragment, numbering, parent_manifest_text)
+        @numbering = numbering
+        @outline_fragment = outline_fragment
+        @parent_manifest_text = parent_manifest_text
+        @project = parent_manifest_text.project
+        phase_1_set_project
+        phase_2_set_source_filename
+        phase_3_set_heading
+        phase_4_set_destination
+        phase_4_set_naming
+        phase_4_set_numbering
+        phase_5_set_sections
+        phase_6_validate_file_presence
+      end
+
+
+      def phase_1_set_project
+        @text_item.project = @project
+      end
+
+
+      def phase_2_set_source_filename
+        @source_filename = determine_source_filename
+        @text_item.source_filename = @source_filename
+      end
+
+
+      def phase_3_set_heading
+        @heading_data = determine_heading_data
+        @text_item.heading = @heading_data[:heading]
+        @text_item.heading_origin = @heading_data[:origin]
+      end
+
+
+      def phase_4_set_destination
+        @text_item.destination = @parent_manifest_text.destination
+      end
+
+
+      def phase_4_set_naming
+        if Hash === @outline_fragment
+          @text_item.naming = [@parent_manifest_text.naming, SanitizerHelper.sanitize_text_item_path(outline_step)].flatten
+        else
+          @text_item.naming = [@parent_manifest_text.naming, @heading_data[:heading]].flatten
+        end
+      end
+
+
+      def phase_4_set_numbering
+        @text_item.numbering = @numbering
+      end
+
+
+      def phase_5_set_sections
+        if Hash === @outline_fragment
+          @text_item.sections = determine_sections
+        end
+      end
+
+
+      def phase_6_validate_file_presence
+        ProjectValidator.new(@project).validate_task_text_item(@text_item)
+      end
+
+
+
+      private
+
+
+      def build_text_item(step, section_numbering)
+        ManifestTaskBuilders::TextItemBuilder.build do |b|
+          b.build_from_outline_fragment_text(step, section_numbering, @text_item)
+        end
+      end
+
+
+      def determine_child_steps_from_outline
+        [@outline_step.flatten[1]].flatten
+      end
+
+
+      def determine_sections
+        sections = []
+        child_steps = [@outline_fragment.flatten[1]].flatten
+        if child_steps.empty? == false
+          child_section_numbering = section_number_extend(@text_item.numbering)
+          child_steps.each do |step|
+            child_section_numbering = section_number_increment(child_section_numbering)
+            sections << build_text_item(step, child_section_numbering)
+          end
+        end
+        sections
+      end
+
+
+      def determine_source_filename
+        if @project.outline_text_pathnames_are_explicit
+          determine_source_filename_explicitly
+        elsif @project.outline_text_pathnames_are_flexible
+          determine_source_filename_flexibly
+        elsif @project.outline_text_pathnames_are_implicit
+          determine_source_filename_implicitly
+        else
+          determine_source_filename_explicitly
+        end
+      end
+
+
+      def determine_source_filename_explicitly
+        filename = SanitizerHelper.sanitize_text_item_basename(outline_step)
+        filepath = ['text']
+        File.join([filepath, filename].flatten)
+      end
+
+
+      def determine_source_filename_flexibly
+        if OutlineHelper.new(outline_step).text_step_flexible_suggests_file
+          determine_source_filename_explicitly
+        else
+          determine_source_filename_implicitly
+        end
+      end
+
+
+      def determine_source_filename_implicitly
+        # filename = make_filename_implicitly(outline_step)
+        # filepath = make_filepath_implicitly
+        # File.join([filepath, filename].flatten)
+        determine_source_filename_cascade_implicitly
+      end
+
+
+      def determine_source_filename_cascade_implicitly
+        source_filename = ''
+        file_path = make_filepath_implicitly
+        file_basename = SanitizerHelper.sanitize_text_item_path(outline_step)
+        file_name_md = file_basename + '.md'
+        file_name_haml = file_basename + '.haml'
+        file_attempt_md = File.join([file_path, file_name_md].flatten)
+        file_attempt_haml = File.join([file_path, file_name_haml].flatten)
+        if File.exists?(file_attempt_md)
+          source_filename = file_attempt_md
+        elsif File.exists?(file_attempt_haml)
+          source_filename = file_attempt_haml
+        else
+          source_filename = file_attempt_md
+        end
+        source_filename
+      end
+
+
+      def determine_heading_data
+        if @text_item.source_file_does_exist
+          determine_heading_from_file
+        elsif @text_item.source_file_does_not_exist
+          determine_heading_from_file_basename_or_outline
+        end
+      end
+
+
+      def determine_heading_from_file
+        case File.extname(@text_item.source_filename_absolute).downcase
+        when '.haml'
+          determine_heading_from_file_haml
+        when '.md'
+          determine_heading_from_file_md
+        else
+          determine_heading_from_file_basename
+        end
+      end
+
+
+      def determine_heading_from_file_basename
+        heading = File.basename(@text_item.source_filename, '.*')
+        origin = :basename
+        { heading: heading, origin: origin }
+      end
+
+
+      def determine_heading_from_file_basename_or_outline
+        case @project.outline_text_pathnames
+        when 'explicit'
+          heading = File.basename(@text_item.source_filename, '.*')
+          origin = :basename
+        when 'flexible', 'implicit'
+          heading = outline_step
+          origin = :outline
+        else
+          heading = ''
+          origin = nil
+        end
+        { heading: heading, origin: origin }
+      end
+
+
+      def determine_heading_from_file_haml
+        first_line = File.open(@text_item.source_filename_absolute, 'r') { |f| f.gets("\n").to_s }
+        if first_line =~ RegexpLib.haml_heading
+          determine_heading_from_file_haml_first_line(first_line)
+        else
+          determine_heading_from_file_basename_or_outline
+        end
+      end
+
+
+      def determine_heading_from_file_haml_first_line(first_line)
+        heading = first_line.gsub(RegexpLib.haml_heading_plus_whitespace,'').strip
+        origin = :text_source
+        { heading: heading, origin: origin }
+      end
+
+
+      def determine_heading_from_file_md
+        first_line = File.open(@text_item.source_filename_absolute, 'r') { |f| f.gets("\n").to_s }
+        if first_line =~ RegexpLib.markdown_heading
+          determine_heading_from_file_md_first_line(first_line)
+        else
+          determine_heading_from_file_basename_or_outline
+        end
+      end
+
+
+      def determine_heading_from_file_md_first_line(first_line)
+        heading = first_line.gsub(RegexpLib.markdown_heading_plus_whitespace,'').strip
+        origin = :text_source
+        { heading: heading, origin: origin }
+      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
+          path_from_project_home.concat(@parent_manifest_text.naming_downcase_without_text_root)
+        elsif @project.text_block_naming_is_not_simple
+          path_from_project_home.concat(@parent_manifest_text.naming_downcase)
+        end
+        safe_path_from_project_home = SanitizerHelper.sanitize_text_item_path(path_from_project_home)
+        safe_path_from_project_home
+      end
+
+
+
+      def outline_step
+        case @outline_fragment
+        when Hash
+          @outline_fragment.flatten[0].to_s
+        else
+          @outline_fragment.to_s
+        end
+      end
+
+
+      def outline_step_sanitized
+        SanitizerHelper.sanitize_text_item_path(outline_step)
+      end
+
+
+      def section_number_extend(number_incoming)
+        number_outgoing = number_incoming.clone
+        number_outgoing << 0
+        number_outgoing
+      end
+
+
+      def section_number_increment(number_incoming)
+        number_outgoing = number_incoming.clone
+        number_outgoing[-1] = number_outgoing[-1].next
+        number_outgoing
+      end
+
+
+
+    end
+  end
+end