muwu 3.2.0 → 4.0.0

data/lib/muwu/render_html_partial_builder/render_topic_builder.rb

@@ -0,0 +1,281 @@
+module Muwu
+  module RenderHtmlPartialBuilder
+    class TopicBuilder
+
+
+      include Muwu
+
+      attr_accessor :renderer
+
+
+      def self.build
+        builder = new
+        yield(builder)
+        builder.renderer
+      end
+
+
+      def initialize
+        @renderer = RenderHtmlPartial::Topic.new
+      end
+
+
+      def build_from_manifest_topic(manifest_topic)
+        @manifest_topic = manifest_topic
+        @project = manifest_topic.project
+        phase_1_set_id
+        phase_1_set_commonmarker_options
+        phase_1_set_destination
+        phase_1_set_generate_inner_identifiers
+        phase_1_set_heading
+        phase_1_set_heading_origin
+        phase_1_set_numbering
+        phase_1_set_depth
+        phase_1_set_numbering_as_text
+        phase_1_set_does_have_source_text
+        phase_1_set_is_parent_heading
+        phase_1_set_text_root_name
+        phase_2_set_source_filename_absolute
+        phase_2_set_source_filename_relative
+        phase_3_set_subtopics
+        phase_3_set_source_relative_segments
+        phase_4_set_end_links
+        phase_4_set_will_render_section_number
+        phase_4_set_subtopics_are_distinct
+        phase_5_set_html_id
+      end
+
+
+      def phase_1_set_commonmarker_options
+        @renderer.commonmarker_options = { extension: {}, render: {} }
+        @renderer.commonmarker_options[:extension].merge!({ description_lists: true })
+        if @project.options.render_punctuation_smart
+          @renderer.commonmarker_options[:render].merge!({ smart: true })
+        end
+        if @project.options.markdown_allows_raw_html
+          @renderer.commonmarker_options[:render].merge!({ unsafe: true })
+        end
+      end
+
+
+      def phase_1_set_destination
+        @renderer.destination = @manifest_topic.destination
+      end
+
+
+      def phase_1_set_does_have_source_text
+        if @manifest_topic.source_file_does_exist
+          @renderer.does_have_source_text = true
+        elsif @manifest_topic.source_file_does_not_exist
+          @renderer.does_have_source_text = false
+        end
+      end
+
+
+      def phase_1_set_generate_inner_identifiers
+        @renderer.generate_inner_identifiers = @project.options.generate_topic_inner_identifiers
+      end
+
+
+      def phase_1_set_heading
+        @renderer.heading = @manifest_topic.heading
+      end
+
+
+      def phase_1_set_heading_origin
+        @renderer.heading_origin = @manifest_topic.heading_origin
+      end
+
+
+      def phase_1_set_id
+        @renderer.id = @manifest_topic.id
+      end
+
+
+      def phase_1_set_is_parent_heading
+        @renderer.is_parent_heading = @manifest_topic.is_parent_heading
+      end
+
+
+      def phase_1_set_numbering
+        @renderer.numbering = @manifest_topic.numbering
+      end
+
+
+      def phase_1_set_depth
+        @renderer.depth = @manifest_topic.topic_depth
+      end
+
+
+      def phase_1_set_numbering_as_text
+        @renderer.numbering_as_text = @manifest_topic.numbering.join('.')
+      end
+
+
+      def phase_1_set_text_root_name
+        @renderer.text_root_name = @manifest_topic.text_root_name
+      end
+
+
+      def phase_2_set_source_filename_absolute
+        if @manifest_topic.source_file_does_exist
+          @renderer.source_filename_absolute = @manifest_topic.source_filename_absolute
+        end
+      end
+
+
+      def phase_2_set_source_filename_relative
+        if @manifest_topic.source_file_does_exist
+          @renderer.source_filename_relative = @manifest_topic.source_filename_relative
+        end
+      end
+
+
+      def phase_3_set_subtopics
+        if @manifest_topic.does_have_subtopics
+          @renderer.subtopics = determine_subtopics
+        end
+      end
+
+
+      def phase_3_set_source_relative_segments
+        segments = @manifest_topic.source_filename_relative.split('/')
+        segments.last.gsub!(/\.[\w\.]*\z/,'')
+        @renderer.source_relative_segments = segments
+      end
+
+
+      def phase_4_set_end_links
+        if topic_should_have_end_links
+          @renderer.end_links = determine_end_links
+        end
+      end
+
+
+      def phase_4_set_will_render_section_number
+        @renderer.will_render_section_number = determine_whether_topic_will_render_section_number
+      end
+
+
+      def phase_4_set_subtopics_are_distinct
+        @renderer.subtopics_are_distinct = determine_whether_subtopics_are_distinct
+      end
+
+
+      def phase_5_set_html_id
+        @renderer.html_id = Helper::HrefHelper.id_topic_header(@manifest_topic)
+      end
+
+
+      private
+
+
+      def build_renderer_topic(topic)
+        RenderHtmlPartialBuilder::TopicBuilder.build do |b|
+          b.build_from_manifest_topic(topic)
+        end
+      end
+
+
+      def determine_end_links
+        end_links = {}
+        if @project.options.render_section_end_links
+          @project.options.render_section_end_links.each do |link|
+            end_links[link] = determine_end_links_href(link)
+          end
+        end
+        end_links
+      end
+
+
+      def determine_end_links_href(link)
+        case link
+        when 'contents'
+          Helper::HrefHelper.link_to_contents_item(@manifest_topic, from: :topic)
+        when 'home'
+          Helper::HrefHelper.link_to_project_home(@project)
+        when 'top'
+          Helper::HrefHelper.link_to_document_top
+        end
+      end
+
+
+      def determine_subtopics
+        subtopics = []
+        @manifest_topic.subtopics.each do |subtopic|
+          subtopics << build_renderer_topic(subtopic)
+        end
+        subtopics
+      end
+
+
+      def determine_whether_subtopics_are_distinct
+        if @manifest_topic.does_have_subtopics
+          if @project.options.render_sections_distinctly_depth_max == nil
+            return true
+          elsif @renderer.depth < @project.options.render_sections_distinctly_depth_max
+            return true
+          elsif @renderer.depth >= @project.options.render_sections_distinctly_depth_max
+            return false
+          end
+        end
+      end
+
+
+      def determine_whether_topic_will_render_section_number
+        if @project.will_render_section_numbers && topic_should_be_distinct
+          true
+        end
+      end
+
+
+      def topic_should_be_distinct
+        if @project.options.render_sections_distinctly_depth_max == nil
+          return true
+        elsif @renderer.depth <= @project.options.render_sections_distinctly_depth_max
+          return true
+        elsif @renderer.depth > @project.options.render_sections_distinctly_depth_max
+          return false
+        end
+      end
+
+
+      def topic_should_have_end_links
+        if topic_should_be_distinct
+          return topic_distinct_should_have_end_links
+        else
+          return false
+        end
+      end
+
+
+      def topic_distinct_should_have_end_links
+        if @renderer.is_parent_heading
+          return topic_distinct_parent_should_have_end_links
+        elsif @renderer.does_have_source_text
+          return true
+        end
+      end
+
+
+      def topic_distinct_parent_should_have_end_links
+        if @renderer.does_have_source_text == true
+          return true
+        elsif @renderer.does_have_source_text == false
+          return topic_distinct_parent_without_source_should_have_end_links
+        end
+      end
+
+
+      def topic_distinct_parent_without_source_should_have_end_links
+        if determine_whether_subtopics_are_distinct == true
+          return false
+        elsif determine_whether_subtopics_are_distinct == false
+          return true
+        end
+      end
+
+
+    end
+  end
+end

data/lib/muwu/render_inspector/render_inspector.rb

@@ -1,31 +1,31 @@
 module Muwu
   class RenderInspector
 
-    
+
     include Muwu
 
 
     COLUMN_LEFT = 12
     SEPARATOR = '  '
-    
-    
+
+
     def initialize(project)
       @project = project
     end
-    
-    
-    
+
+
+
     public
-    
-    
+
+
     def render_inspector
       render_inspector_project
       render_inspector_options
       render_inspector_manifest
       render_inspector_errors
     end
-  
-  
+
+
     def render_inspector_errors
       if @project.exceptions.any?
         @project.exceptions.each do |error|
@@ -34,8 +34,8 @@ module Muwu
         puts
       end
     end
-    
-      
+
+
     def render_inspector_manifest
       @project.manifest.documents.each do |document|
         case document
@@ -48,9 +48,9 @@ module Muwu
         end
       end
     end
-    
-    
-    def render_inspector_options  
+
+
+    def render_inspector_options
       puts @project.options
       @project.options.instance_variables.each do |option|
         key = option.to_s.gsub(/\A@/,'')
@@ -59,7 +59,7 @@ module Muwu
       end
       puts
     end
-  
+
 
     def render_inspector_project
       puts @project
@@ -68,17 +68,17 @@ module Muwu
       puts indent("js_libraries: #{@project.javascript_libraries_requested}")
       puts
     end
-  
-  
+
+
 
     private
-    
-    
+
+
     def column_left(text)
       text.ljust(COLUMN_LEFT)
     end
-    
-    
+
+
     def indent(text)
       column_left(text).prepend('  ')
     end
@@ -93,14 +93,14 @@ module Muwu
         puts output
       end
     end
-    
+
 
     def render_inspector_document_css(document)
       puts_line [document.to_s]
       puts_line [document.destination.to_s, document.destination.output_class, document.destination.output_filename]
       puts_line
     end
-    
+
 
     def render_inspector_document_html(document)
       puts_line [document.to_s, "index: #{document.index}"]
@@ -110,8 +110,8 @@ module Muwu
       end
       puts_line
     end
-    
-    
+
+
     def render_inspector_document_js(document)
       puts_line [document.to_s]
       puts_line [
@@ -121,16 +121,16 @@ module Muwu
       ]
       puts_line
     end
-    
-    
+
+
     def render_inspector_error_report(error)
       puts_line [
         column_left(error.type.to_s),
         error.report
       ]
     end
-    
-    
+
+
     def render_inspector_manifest_task(task)
       case task
       when ManifestTask::Contents
@@ -145,28 +145,28 @@ module Muwu
         render_inspector_manifest_task_title(task)
       when ManifestTask::Text
         render_inspector_manifest_task_text(task)
-      when ManifestTask::TextItem
-        render_inspector_manifest_task_text_item(task)
+      when ManifestTask::Topic
+        render_inspector_manifest_task_topic(task)
       end
     end
-  
-  
+
+
     def render_inspector_manifest_task_contents(contents)
       puts_line [
         indent('Contents'),
         contents.naming.inspect
       ]
     end
-  
-  
+
+
     def render_inspector_manifest_task_metadata(metadata)
-      puts_line [ 
+      puts_line [
         indent('Metadata'),
         metadata.metadata.to_s
       ]
     end
-  
-  
+
+
     def render_inspector_manifest_task_navigator(navigator)
       puts_line [
         indent('Navigator'),
@@ -175,8 +175,8 @@ module Muwu
         "next: #{navigator.document_next_index}"
       ]
     end
-    
-    
+
+
     def render_inspector_manifest_task_subcontents(contents)
       puts_line [
         indent('Subcontents'),
@@ -190,35 +190,35 @@ module Muwu
         indent('Text'),
         text.naming.inspect
       ]
-      text.sections.each do |section|
-        render_inspector_manifest_task(section)
+      text.topics.each do |topic|
+        render_inspector_manifest_task(topic)
       end
     end
-    
-  
-    def render_inspector_manifest_task_text_item(text_item)
+
+
+    def render_inspector_manifest_task_topic(topic)
       puts_line [
-        indent('| TextItem'),
-        text_item.numbering.inspect,
-        text_item.heading.inspect,
-        text_item.source_filename,
-        ('!!' if text_item.source_file_does_not_exist)
+        indent("| Topic #{topic.id}"),
+        topic.numbering.inspect,
+        topic.heading.inspect,
+        topic.source_filename,
+        ('!!' if topic.source_file_does_not_exist)
       ]
-      if text_item.does_have_child_sections
-        text_item.sections.each do |section|
-          render_inspector_manifest_task(section)
+      if topic.does_have_subtopics
+        topic.subtopics.each do |subtopic|
+          render_inspector_manifest_task(subtopic)
         end
       end
     end
-    
-  
+
+
     def render_inspector_manifest_task_title(title)
       puts_line [
         indent('Title'),
         title.metadata.to_s
       ]
     end
-    
-    
+
+
   end
 end

data/lib/muwu/viewer/viewer.rb

@@ -29,9 +29,9 @@ module Muwu
 
     def view_home_document
       begin
-        system "lynx #{@document_home_filepath}", exception: true
+        system "open #{@document_home_filepath}", exception: true
       rescue Errno::ENOENT
-        raise ProjectExceptionHandler::Fatal.new(ProjectException::LynxNotAvailable.new)
+        raise ProjectExceptionHandler::Fatal.new(ProjectException::NoHTMLViewerConfigured.new)
       end
     end
 

data/lib/muwu.rb

@@ -1,7 +1,6 @@
 module Muwu
 
-
-  VERSION = '3.2.0'
+  VERSION = '4.0.0'
 
   GEM_HOME_LIB = File.absolute_path(File.join(File.dirname(__FILE__)))
   GEM_HOME_LIB_MUWU = File.absolute_path(File.join(GEM_HOME_LIB, 'muwu'))
@@ -9,19 +8,15 @@ module Muwu
 
   require 'commonmarker'
   require 'fileutils'
-  require 'haml'
   require 'iso-639'
   require 'logger'
-  require 'motion-markdown-it'
-  require 'motion-markdown-it-plugins'
+  require 'nokogiri'
   require 'sassc'
   require 'yaml'
 
-
   require_relative 'loader'
 
 
-
   module_function