muwu 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb244270b9a3f8c14b33190cd8145d7e2492d7360185f7004df15ddce25b8a63
-  data.tar.gz: 647c1138722fd6dc8a4bf9ad41776797b1dffed79e5dd2e39c21a0e109633831
+  metadata.gz: 5e6d222cd47218dfdadbdebbeec54a34e9a21d3fd712ea8d41167a3e4202fa76
+  data.tar.gz: 68fa281753870cecb29570f3f56897ebb8f764a6f793a4600a55c04b54d42144
 SHA512:
-  metadata.gz: f0031172eff2715affff5e76f0dcf93159e08f443a8d8efb86d1d7c237be8c3dc49a18cac38f79c23cab4e2670f7a19d180ca4eeb20c15fca4cb08ff0449181d
-  data.tar.gz: 790dcbeda168f13f47da07a868b9f71fabac2d1ecb2f015f8b6bbc94f128116be66bc0d613b418993a624858896fee2e49d7d0c0f086b0a22f560e2527bd3fcd
+  metadata.gz: 610febd5bb1e383bf2c185b4861a0029d30566e2bd445bdac8ee0c381e4b073142f9c805d0275e439c7be6d9d6217270418d2dcc5765bdf1d6584dae03a61a50
+  data.tar.gz: d5bf793b752727bc8dc9d527645996fd32dadf42a74041852ea123f7b1df39b43dac2a4ca9553bf40cd704f9d8cffc2f39714e1678d91271a2953bda73631c4d

data/lib/muwu/cli/help/concat

@@ -1,8 +1,6 @@
 - muwu concat
   - Combine all source files from the outline into a single markdown
     document.
-    
-* Compiling a project will overwrite any previous output files without
-  any warning. 
 
-* This feature is still experimental.  
+* Compiling a project will overwrite any previous output files without
+  any warning.

data/lib/muwu/cli/help/summary

@@ -10,7 +10,7 @@ Command line:
   muwu reset compiled   reset the `compiled/` subdirectory
   muwu reset css        reset the default CSS files
   muwu sync             synchronize from/to a remote location (requires rsync)
-  muwu view             view a compiled project (requires lynx)
+  muwu view             view a compiled project (shortcut for `open compiled/[index.html]`)
 
 For more detailed instructions:
   muwu help [command]

data/lib/muwu/cli/help/view

@@ -1,3 +1,3 @@
 - muwu view
-  - View a compiled project in `compiled/` using lynx. Lynx must be installed
-    on the local system.
+  - Shortcut for `open compiled/[index.html]`.
+  - Assumes a default web browser will open the file.

data/lib/muwu/controller/controller.rb

@@ -149,7 +149,7 @@ module Muwu
       if @project.does_not_have_crucial_files
         reply_folder_does_not_have_valid_project
       else
-        Viewer.new(@project)
+        Viewer.new(@project).view
       end
     end
 

data/lib/muwu/controller/controller_interaction.rb

@@ -96,8 +96,10 @@ module Muwu
     def render_reset_compiled_heading
       puts '# Muwu'
       puts '# Reset `compiled/`'
+      puts
       puts '- This will remove all contents of the `compiled/` folder.'
       puts '- This action cannot be undone.'
+      puts
     end
 
 
@@ -109,13 +111,17 @@ module Muwu
     def render_reset_css_heading(project)
       puts '# Muwu'
       puts '# Reset CSS'
-      puts '- This will reset the following files and folders to their original state:'
+      puts ''
+      puts 'This will reset the following files and folders to their original state:'
       determine_reset_css_files(project).each do |file|
-        puts "  * #{file}"
+        puts "  - #{file}"
       end
-      puts "- If #{project.path_css_extensions} does not exist, it will be created."
-      puts '  Otherwise, its existing contents will remain unchanged.'
+      puts
+      puts "If #{project.path_css_extensions} does not exist, it will be created."
+      puts 'Otherwise, its existing contents will remain unchanged.'
+      puts
       puts '- This action cannot be undone'
+      puts
     end
 
 

data/lib/muwu/default/default.rb

@@ -1,7 +1,6 @@
 module Muwu
   module Default
 
-
     FILENAMES = {
       css_manifest: 'index.scss',
       metadata: 'metadata.yml',
@@ -9,7 +8,6 @@ module Muwu
       outline: 'outline.yml'
     }
 
-
     FILEPATHS = {
       compiled: './compiled',
       css: './config/css',
@@ -19,16 +17,14 @@ module Muwu
       text: './text'
     }
 
-
     PROJECT_OPTIONS = {
-      contents_section_numbers_receive_link: true,
       generate_navigators_automatically: true,
       generate_subcontents_automatically: false,
+      generate_topic_inner_identifiers: false,
       html_head_includes_metadata_tags: true,
       html_lang: nil,
       html_uses_javascript_navigation: false,
-      markdown_allows_raw_html: true,
-      markdown_renderer: 'commonmarker',
+      markdown_allows_raw_html: false,
       outline_text_pathnames: 'flexible',
       output_destination: 'file',
       output_file_css_basename: nil,
@@ -46,11 +42,9 @@ module Muwu
       warning_if_parent_heading_lacks_source: true
     }
 
-
     PROJECT_OUTLINE = {
       default_text_block_name: 'main'
     }
 
-
   end
 end

data/lib/muwu/helper/html_href_helper.rb

@@ -1,101 +1,101 @@
 module Muwu
   module Helper
-    class HtmlHrefHelper
-  
-  
-      include Muwu
-      
-  
-      attr_accessor(
-        :origin_task,
-      )
-  
-  
-      def initialize(origin_task)
-        @origin_task = origin_task
-        @project = origin_task.project
+    module HrefHelper
+
+
+      module_function
+
+
+      def id_contents_item(topic)
+        hyphenate(['contents', topic.text_root_name, topic.id])
       end
-      
-
-            
-      public
-      
-      
-      def to_text_item(text_object)
-        result = ''
-        case @origin_task
-        when ManifestTask::Contents
-          result = target_text_filename(text_object) + attr_id(:text, text_object)
-        when ManifestTask::Subcontents
-          result = attr_id(:text, text_object)
-        end
-        result
+
+
+      def id_subcontents_item(topic)
+        hyphenate(['subcontents', topic.text_root_name, topic.id])
       end
-      
-
-      def to_contents_heading(text_object)
-        result = ''
-        case @origin_task
-        when ManifestTask::TextItem
-          filename = target_contents_filename(text_object)
-          anchor_id = attr_id(:contents, text_object)
-          result = filename + anchor_id
-        end
-        result
+
+
+      def id_topic_header(topic)
+        hyphenate(['text', topic.text_root_name, topic.id])
+      end
+
+
+      def link_to_contents_item(topic, from: nil)
+        target_filename_contents(topic, from: from) + '#' + id_contents_item(topic)
+      end
+
+
+      def link_to_project_home(project)
+        project.manifest.find_document_html_by_index(0).destination.output_filename
       end
 
 
-      def to_document_top
+      def link_to_document_top
         '#top'
       end
 
 
-      def to_project_home
-        @project.manifest.find_document_html_by_index(0).destination.output_filename
+      def link_to_subcontents_item(topic, from: nil)
+        target_filename_subcontents(topic, from: from) + '#' + id_subcontents_item(topic)
+      end
+
+
+      def link_to_topic_header(topic, from: nil)
+        target_filename_topic(topic, from: from) + '#' + id_topic_header(topic)
       end
-      
 
 
       private
-      
-      
-      def attr_id(target, text_object)
-        prefix = '#'
-        block_type = target.to_s
-        root_name = target_text_root_name(text_object)
-        section_number = target_section_number_as_attr(text_object)
-        prefix + ([block_type, root_name, section_number].compact.join('_'))
+
+
+      def self.hyphenate(a)
+        a.join('-')
       end
-      
-            
-      def target_contents_filename(text_object)
-        result = ''
-        if @project.has_multiple_html_documents
-          result = File.basename(@project.manifest.contents_block_by_name(text_object.text_root_name).destination.output_filename)
+
+
+      def self.target_filename_contents(topic, from: nil)
+        contents_destination_output_filename = topic.project.manifest.contents_block_filename_for(topic.text_root_name)
+        case from
+        when :topic
+          if contents_destination_output_filename == topic.destination.output_filename
+            return ''
+          else
+            return contents_destination_output_filename
+          end
+        else
+          return contents_destination_output_filename
         end
-        result
       end
-      
-      
-      def target_text_filename(text_object)
-        result = ''
-        if @project.has_multiple_html_documents
-          result = File.basename(text_object.destination.output_filename)
+
+
+      def self.target_filename_subcontents(topic, from: nil)
+        case from
+        when :topic
+          return ''
+        else
+          return topic.destination.output_filename
         end
-        result
-      end
-      
-      
-      def target_text_root_name(text_object)
-        text_object.text_root_name
       end
-            
-      
-      def target_section_number_as_attr(text_object)
-        text_object.numbering_to_depth_max.join('_')
+
+
+      def self.target_filename_topic(topic, from: nil)
+        case from
+        when :contents
+          contents_destination_output_filename = topic.project.manifest.contents_block_filename_for(topic.text_root_name)
+          if contents_destination_output_filename == topic.destination.output_filename
+            return ''
+          else
+            return topic.destination.output_filename
+          end
+        when :subcontents
+          return ''
+        else
+          return topic.destination.output_filename
+        end
       end
-      
-      
+
+
     end
   end
 end

data/lib/muwu/helper/outline_helper.rb

@@ -1,25 +1,25 @@
 module Muwu
   module Helper
     class OutlineHelper
-      
-      
+
+
       include Muwu::Helper
-      
-      
+
+
       def initialize(outline_fragment)
         @outline_fragment = outline_fragment
       end
-      
-            
+
+
 
       public
-      
-      
+
+
       def includes_navigator
         indicates_navigator || includes_navigator_in_array
       end
-      
-      
+
+
       def includes_navigator_in_array
         (is_array) && (@outline_fragment.select{ |step| OutlineHelper.type_of(step) == :navigator }.any?)
       end
@@ -43,8 +43,8 @@ module Muwu
       def indicates_metadata
         indicates_metadata_hash || indicates_metadata_string
       end
-      
-      
+
+
       def indicates_metadata_hash
         (is_hash) && (RegexpLib.outline_metadata =~ @outline_fragment.flatten[0])
       end
@@ -58,8 +58,8 @@ module Muwu
       def indicates_navigator
         (is_string) && (RegexpLib.outline_navigator =~ @outline_fragment)
       end
-      
-      
+
+
       def indicates_outline_fragment
         is_array
       end
@@ -93,13 +93,13 @@ module Muwu
       def indicates_title_hash
         (is_hash) && (RegexpLib.outline_title =~ @outline_fragment.flatten[0])
       end
-      
-      
+
+
       def indicates_title_string
         (is_string) && (RegexpLib.outline_title =~ @outline_fragment)
       end
-      
-      
+
+
       def is_array
         Array === @outline_fragment
       end
@@ -123,8 +123,6 @@ module Muwu
       def text_step_flexible_suggests_file
         if @outline_fragment.to_s =~ RegexpLib.file_ext_md
           true
-        elsif @outline_fragment.to_s =~ RegexpLib.file_ext_haml
-          true
         else
           false
         end
@@ -133,8 +131,8 @@ module Muwu
 
 
       protected
-      
-      
+
+
       def self.type_of(step)
         s = new(step)
         if s.indicates_contents
@@ -153,8 +151,8 @@ module Muwu
           :title
         end
       end
-            
+
 
     end
   end
-end
+end

data/lib/muwu/helper/regexp_lib.rb

@@ -1,76 +1,51 @@
 module Muwu
   module Helper
     module RegexpLib
-    
-    
+
+
       module_function
-    
-    
-      # def regexp_path_relative_current
-      #   /\A.\//
-      # end
-      #
-      #
-      # def regexp_path_segmenter_fw_slash
-      #   /[\/\\]/
-      # end
-          
-    
-      def file_ext_haml
-        /.haml\z/i
-      end
 
 
       def file_ext_md
         /.md\z/i
       end
-    
-    
-      def haml_heading
-        /\A%h\d*/i
-      end
-      
-    
-      def haml_heading_plus_whitespace
-        /\A%h\d*\s*/i
-      end
-      
-    
+
+
       def markdown_heading
         /\A#+/
       end
-    
-    
+
+
       def markdown_heading_plus_whitespace
         /\A#+\s*/
       end
-    
-    
-      def metadata_key_date_of_this_edition 
+
+
+      def metadata_key_date_of_this_edition
         /\Adate\s*of\s*this\s*edition/i
       end
-    
-    
+
+
       def not_alphanumeric_underscore_or_single_dot
         /[^a-zA-Z0-9_\.]/
       end
-    
+
 
       def outline_metadata
         /\Ametadata/i
       end
-      
-      
+
+
       def outline_navigator
         /\Anavigator/i
       end
-    
-    
+
+
       def outline_contents
         /\Acontents/i
       end
-    
-    
+
+
       def outline_subcontents
         /\Asubcontents/i
       end
@@ -79,23 +54,23 @@ module Muwu
       def outline_text
         /\Atext/i
       end
-    
-    
+
+
       def outline_text_plus_whitespace
         /\Atext\s+/i
       end
-    
-    
+
+
       def outline_title
         /\Atitle/i
       end
-    
-    
+
+
       def path_two_or_more_dots
         /\.{2,}/
       end
-    
-    
+
+
     end
   end
 end

data/lib/muwu/helper/sanitizer_helper.rb

@@ -14,22 +14,22 @@ module Muwu
       end
       
       
-      def sanitize_text_item_basename(basename)
+      def sanitize_topic_basename(basename)
         basename.to_s.gsub(RegexpLib.path_two_or_more_dots,'_')
       end
       
             
-      def sanitize_text_item_path(path)
+      def sanitize_topic_path(path)
         case path
         when Array
-          return path.map { |p| sanitize_text_item_path_segment(p) }
+          return path.map { |p| sanitize_topic_path_segment(p) }
         when Integer, String
-          return sanitize_text_item_path_segment(path)
+          return sanitize_topic_path_segment(path)
         end
       end
       
       
-      def sanitize_text_item_path_segment(path)
+      def sanitize_topic_path_segment(path)
         path.to_s.downcase.gsub(/\s/,'_').gsub(/\W/,'').gsub(/_{2,}/,'_')
       end