muwu 3.2.0 → 4.0.0

data/lib/muwu/manifest_task_builder/{text_item_builder.rb → topic_builder.rb}

@@ -1,12 +1,15 @@
 module Muwu
   module ManifestTaskBuilders
-    class TextItemBuilder
+    class TopicBuilder
 
 
       include Muwu
       include Helper
 
 
+      @@topic_id = 0
+
+
       attr_accessor(
         :heading_data,
         :numbering,
@@ -14,19 +17,19 @@ module Muwu
         :parent_manifest_text,
         :project,
         :source_filename,
-        :text_item
+        :topic
       )
 
 
       def self.build
         builder = new
         yield(builder)
-        builder.text_item
+        builder.topic
       end
 
 
       def initialize
-        @text_item = ManifestTask::TextItem.new
+        @topic = ManifestTask::Topic.new
       end
 
 
@@ -35,63 +38,70 @@ module Muwu
         @outline_fragment = outline_fragment
         @parent_manifest_text = parent_manifest_text
         @project = parent_manifest_text.project
+        phase_1_set_id
         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_5_set_subtopics
         phase_6_validate_file_presence
       end
 
 
+      def phase_1_set_id
+        @topic.id = @@topic_id
+        @@topic_id = @@topic_id.next
+      end
+
+
       def phase_1_set_project
-        @text_item.project = @project
+        @topic.project = @project
       end
 
 
       def phase_2_set_source_filename
         @source_filename = determine_source_filename
-        @text_item.source_filename = @source_filename
+        @topic.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]
+        @topic.heading = @heading_data[:heading]
+        @topic.heading_origin = @heading_data[:origin]
       end
 
 
       def phase_4_set_destination
-        @text_item.destination = @parent_manifest_text.destination
+        @topic.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
+          @topic.naming = [@parent_manifest_text.naming, SanitizerHelper.sanitize_topic_path(outline_step)].flatten
         else
-          @text_item.naming = [@parent_manifest_text.naming, @heading_data[:heading]].flatten
+          @topic.naming = [@parent_manifest_text.naming, @heading_data[:heading]].flatten
         end
       end
 
 
       def phase_4_set_numbering
-        @text_item.numbering = @numbering
+        @topic.numbering = @numbering
       end
 
 
-      def phase_5_set_sections
+      def phase_5_set_subtopics
         if Hash === @outline_fragment
-          @text_item.sections = determine_sections
+          @topic.subtopics = determine_subtopics
         end
       end
 
 
       def phase_6_validate_file_presence
-        ProjectValidator.new(@project).validate_task_text_item(@text_item)
+        ProjectValidator.new(@project).validate_task_topic(@topic)
       end
 
 
@@ -99,9 +109,9 @@ module Muwu
       private
 
 
-      def build_text_item(step, section_numbering)
-        ManifestTaskBuilders::TextItemBuilder.build do |b|
-          b.build_from_outline_fragment_text(step, section_numbering, @text_item)
+      def build_topic(step, section_numbering)
+        ManifestTaskBuilders::TopicBuilder.build do |b|
+          b.build_from_outline_fragment_text(step, section_numbering, @topic)
         end
       end
 
@@ -111,17 +121,17 @@ module Muwu
       end
 
 
-      def determine_sections
-        sections = []
+      def determine_subtopics
+        subtopics = []
         child_steps = [@outline_fragment.flatten[1]].flatten
         if child_steps.empty? == false
-          child_section_numbering = section_number_extend(@text_item.numbering)
+          child_section_numbering = section_number_extend(@topic.numbering)
           child_steps.each do |step|
             child_section_numbering = section_number_increment(child_section_numbering)
-            sections << build_text_item(step, child_section_numbering)
+            subtopics << build_topic(step, child_section_numbering)
           end
         end
-        sections
+        subtopics
       end
 
 
@@ -139,7 +149,7 @@ module Muwu
 
 
       def determine_source_filename_explicitly
-        filename = SanitizerHelper.sanitize_text_item_basename(outline_step)
+        filename = SanitizerHelper.sanitize_topic_basename(outline_step)
         filepath = ['text']
         File.join([filepath, filename].flatten)
       end
@@ -153,57 +163,40 @@ 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
-        # File.join([filepath, filename].flatten)
-        determine_source_filename_cascade_implicitly
-      end
-
 
-      def determine_source_filename_cascade_implicitly
+      def determine_source_filename_implicitly
         source_filename = ''
         file_path = make_filepath_implicitly
-        file_basename = SanitizerHelper.sanitize_text_item_path(outline_step)
+        file_basename = SanitizerHelper.sanitize_topic_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.exist?(file_attempt_md)
-          source_filename = file_attempt_md
-        elsif File.exist?(file_attempt_haml)
-          source_filename = file_attempt_haml
-        else
-          source_filename = file_attempt_md
-        end
+        source_filename = File.join([file_path, file_name_md].flatten)
         source_filename
       end
 
 
       def determine_heading_data
-        if @text_item.source_file_does_exist
+        if @topic.source_file_does_exist
           determine_heading_from_file
-        elsif @text_item.source_file_does_not_exist
+        elsif @topic.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
+        case File.extname(@topic.source_filename_absolute).downcase
         when '.md'
           determine_heading_from_file_md
         else
+          # TODO: Obsolete? What criteria produce this outcome?
           determine_heading_from_file_basename
         end
       end
 
 
+      # TODO: Obsolete? see def determine_heading_from_file
       def determine_heading_from_file_basename
-        heading = File.basename(@text_item.source_filename, '.*')
+        heading = File.basename(@topic.source_filename, '.*')
         origin = :basename
         { heading: heading, origin: origin }
       end
@@ -212,7 +205,7 @@ module Muwu
       def determine_heading_from_file_basename_or_outline
         case @project.outline_text_pathnames
         when 'explicit'
-          heading = File.basename(@text_item.source_filename, '.*')
+          heading = File.basename(@topic.source_filename, '.*')
           origin = :basename
         when 'flexible', 'implicit'
           heading = outline_step
@@ -225,25 +218,8 @@ module Muwu
       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 }
+        first_line = File.open(@topic.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
@@ -266,12 +242,11 @@ module Muwu
         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 = SanitizerHelper.sanitize_topic_path(path_from_project_home)
         safe_path_from_project_home
       end
 
 
-
       def outline_step
         case @outline_fragment
         when Hash
@@ -283,7 +258,7 @@ module Muwu
 
 
       def outline_step_sanitized
-        SanitizerHelper.sanitize_text_item_path(outline_step)
+        SanitizerHelper.sanitize_topic_path(outline_step)
       end
 
 
@@ -301,7 +276,6 @@ module Muwu
       end
 
 
-
     end
   end
 end

data/lib/muwu/project/project.rb

@@ -287,14 +287,6 @@ module Muwu
     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

data/lib/muwu/project_builder/assets/config/css/base/html_elements.scss

@@ -20,57 +20,62 @@
 // can successfully rely on `content-box` sizing.
 //
 
-$muwu-root-font-size: 1rem;
-$muwu-root-line-height: ($muwu-root-font-size * 1.16667);
+$font-size: 1em;
+$font-size-code: ($font-size * 0.9);
+
+$header-factor: 0.125em;
+$font-size-h1: ($font-size + ($header_factor * 4));
+$font-size-h2: ($font-size + ($header_factor * 3));
+$font-size-h3: ($font-size + ($header_factor * 2));
+$font-size-h-default: $font-size-h3;
+
+$line-height: ($font-size * 1.333);
+
+$margin: $line-height;
+$margin-double: ($margin * 2);
+$margin-triple: ($margin * 3);
+$margin-half: ($margin / 2);
+$margin-quarter: ($margin / 4);
+$margin-tenth: ($margin / 10);
+$margin-contents-subtable: ($margin-quarter);
 
 * {
   box-sizing: content-box;
-  font-size: $muwu-root-font-size;
-  line-height: $muwu-root-line-height;
+  line-height: $line-height;
   margin: 0;
   padding: 0;
   text-indent: 0;
-}
-
-
-html {
-  width: 100%;
+  font-size: $font-size;
 }
 
 body {
-  margin-left: auto;
-  margin-right: auto;
-  max-width: 50rem;
+  font-family: sans-serif;
+  font-size: 1rem;
+  padding: $margin-double;
 }
 
 blockquote {
-  margin: $muwu-root-line-height 2rem;
+  margin: $margin $margin-double;
 }
 
 code {
-  font-size: $muwu-root-font-size;
-  padding: 0rem 0.15rem;
+  font-size: ($font-size * 0.9);
 }
 
 dl {
-  margin: $muwu-root-line-height 0;
-  div {
-    dt {
-      display: list-item;
-      list-style-type: none;
-      font-weight: bold;
-      p {
-        display: inline;
-      }
-    }
-    dd {
-      display: list-item;
-      list-style-type: none;
-      p {
-        display: inline;
-      }
-    }
-  }
+  margin: $margin 0;
+}
+
+dt {
+  display: list-item;
+  list-style-type: none;
+  font-weight: bold;
+  margin-top: $margin;
+}
+
+dd {
+  display: list-item;
+  list-style-type: none;
 }
 
 img {
@@ -80,33 +85,33 @@ img {
 }
 
 h1, h2, h3, h4, h5, h6 {
-  font-size: ($muwu-root-font-size * 1.125);
-  margin: $muwu-root-line-height 0rem;
+  margin: $margin 0;
+  font-size: $font-size-h-default;
 }
 
 hr {
-  margin: $muwu-root-line-height 0;
+  margin: $margin 0;
   border-width: 0;
 }
 
+main {
+  margin-left: auto;
+  margin-right: auto;
+  max-width: 40em;
+}
 ol {
-  margin: $muwu-root-line-height;
-  ol, ul {
-    margin: 0rem 1rem;
-  }
+  margin: 0 $margin;
+  padding: 0 $margin;
 }
 
 p {
-  margin: $muwu-root-line-height 0rem;
+  margin: $margin 0rem;
 }
 
 pre {
-  font-size: ($muwu-root-font-size * 0.9);
-  margin: $muwu-root-line-height 0;
-  >code {
-    font-size: ($muwu-root-font-size * 0.8);
-    padding: 0rem 0rem;
-  }
+  margin: $margin 0;
+  overflow-x: auto;
+  padding: $margin-half $margin;
 }
 
 q {
@@ -114,29 +119,19 @@ q {
 }
 
 ul {
-  margin: $muwu-root-line-height;
-  ol, ul {
-    margin: 0rem 1rem;
-  }
+  margin: 0 $margin;
+  padding: 0 $margin;
 }
 
 
 
 
 @media screen {
-  html {
-    body {
-      padding: 1.5rem;
-    }
-  }
 }
 
+
 @media print {
-  html {
-    body {
-      ol, ul {
-        page-break-inside: avoid;
-      }
-    }
+  ol, ul {
+    page-break-inside: avoid;
   }
 }

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

@@ -2,10 +2,11 @@
 @import 'section_muwu_contents';
 @import 'section_muwu_metadata';
 @import 'section_muwu_navigator';
+@import 'section_muwu_subcontents';
 @import 'section_muwu_text';
 @import 'section_muwu_title';
-@import 'section_muwu_subcontents';
+@import 'section_muwu_topic';
 
 // A better approach to CSS would be to assign classes to elements via the
 // html renderer. Until such functionality exists, messy selector chaining
-// is the incumbent design.
+// is the incumbent design.

data/lib/muwu/project_builder/assets/config/css/base/section_muwu_contents.scss

@@ -1,58 +1,36 @@
-body >div.contents {
-  margin: ($muwu-root-line-height * 4) 0;
-  >h1 {
-    font-size: ($muwu-root-font-size * 1.25);
-    margin: 0 0 ($muwu-root-line-height * 2) 0;
-    text-align: left;
-  }
-  .compiler_warning {
-    background-color: #ffa;
-    td {
-      a {
-        color: #A00;
-      }
-    }
-  }
-  >table {
-    border-collapse: collapse;
-    tr {
-      td {
-        vertical-align: top;
-        padding: 0.3rem 0.4rem;
-        table {
-          border-collapse: collapse;
-          margin-top: 0.2rem;
-          margin-bottom: -0.2rem;
-        }
-      }
-      td:first-child {
-        padding-left: 0rem;
-      }
-      td:last-child {
-        padding-right: 0rem;
-      }
-      td.heading {
-        text-align: left;
-      }
-      td.number {
-        text-align: right;
-      }
-    }
-  }
-  >ol {
-    list-style-type: none;
-    display: block;
-    margin: 0rem;
-    li {
-      margin: ($muwu-root-line-height * 0.5) 0rem;
-      a {
-        display: inline;
-      }
-      ol {
-        list-style-type: none;
-        display: block;
-        margin: 0rem 1rem;
-      }
-    }
-  }
+[data-document-block='contents'] {
+  margin: $margin-triple 0;
+}
+[data-contents='heading'] {
+  font-size: $font-size-h1;
+  margin-bottom: $margin;
+  text-align: left;
+}
+[data-contents='list'] {
+  list-style-type: none;
+  display: block;
+  margin: 0rem;
+}
+[data-contents='list-topic'] {
+  margin: $margin-half 0rem;
+}
+[data-contents='list-topic'] > [data-contents='list'] {
+  margin: 0 $margin-half;
+}
+[data-contents='table'] {
+  border-collapse: collapse;
+}
+[data-contents='table-number'] {
+  padding: $margin-quarter;
+  text-align: right;
+  vertical-align: top;
+}
+[data-contents='table-topic'] {
+  padding: $margin-quarter;
+  text-align: left;
+}
+[data-contents='table-topic'] > [data-contents='table'] {
+  border-collapse: collapse;
+  margin-top: $margin-contents-subtable;
+  margin-bottom: -($margin-contents-subtable);
 }

data/lib/muwu/project_builder/assets/config/css/base/section_muwu_metadata.scss

@@ -1,15 +1,3 @@
-body >div.metadata {
-  margin: ($muwu-root-line-height * 4) 0;
-  dl {
-    div {
-      margin: $muwu-root-line-height 0;
-      dt {
-        font-weight: bold;
-        display: block;
-      }
-      dd {
-        display: block;
-      }
-    }
-  }
+[data-document-block='metadata'] {
+  margin: $margin-triple 0;
 }

data/lib/muwu/project_builder/assets/config/css/base/section_muwu_navigator.scss

@@ -1,12 +1,7 @@
-body >div.navigator {
-  margin: ($muwu-root-line-height * 0.5) 0;
-  nav.document_links {
-    width: 100%;
-    display: flex;
-    justify-content: space-around;
-    a.document_link {
-      font-size: ($muwu-root-font-size * 0.8);
-      padding: ($muwu-root-line-height * 0.5);
-    }
-  }
+[data-document-block='navigator'] {
+  display: flex;
+  flex-direction: row;
+  justify-content: space-around;
+  font-size: 0.8em;
+  width: 100%;
 }