muwu 2.5.1

data/lib/muwu/default/default.rb

@@ -0,0 +1,51 @@
+module Muwu
+  module Default
+    
+    
+    FILENAMES = {
+      css_manifest: 'index.scss',
+      metadata: 'metadata.yml',
+      options: 'options.yml',
+      outline: 'outline.yml'
+    }
+
+    
+    FILEPATHS = {
+      css: './config/css',
+      metadata: '',
+      options: '',
+      outline: '',
+      text: './text'
+    }
+
+    
+    PROJECT_OPTIONS = {
+      generate_navigators_automatically: true,
+      generate_subcontents_automatically: false,
+      html_head_includes_metadata_tags: true,
+      html_lang: nil,
+      html_uses_javascript_navigation: false,
+      markdown_allows_raw_html: true,
+      markdown_renderer: 'commonmarker',
+      outline_text_pathnames: 'flexible',
+      output_destination: 'file',
+      output_file_css_basename: nil,
+      output_file_html_basename: 'index',
+      output_file_js_basename: nil,
+      output_formats: ['html','css','js'],
+      render_punctuation_smart: true,
+      render_section_end_links: ['contents', 'top'],
+      render_section_numbers: true,
+      render_sections_distinctly_depth_max: nil,
+      render_title_section_metadata: ['title', 'subtitle', 'author'],
+      warning_if_parent_heading_lacks_source: true
+    }
+    
+    
+    PROJECT_OUTLINE = {
+      default_text_block_name: 'main'
+    }
+    
+    
+  end
+end

data/lib/muwu/destination/destination.rb

@@ -0,0 +1,212 @@
+module Muwu
+  class Destination
+    
+    
+    include Muwu
+
+
+    attr_accessor(
+      :margin_current,
+      :output_class,
+      :output_filename,
+      :output_working_directory
+    )
+    attr_writer(
+      :output
+    )
+    
+    
+    MARGIN = '  '
+    
+    
+    def initialize
+      @margin_depth = 0
+      @output = nil
+    end
+    
+    
+    def inspect
+      ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
+    end
+
+    
+    def inspect_instance_variables
+      self.instance_variables.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(", ")
+    end
+      
+    
+    
+    public
+    
+    
+    def margin_dec
+      @margin_depth = @margin_depth.to_i - 1
+    end
+
+  
+    def margin_inc
+      @margin_depth = @margin_depth.to_i + 1
+    end
+
+  
+    def margin_indent
+      margin_inc
+      yield
+      margin_dec
+    end
+
+
+    def margin_to_zero
+      @margin_depth = 0
+    end
+        
+    
+    def output
+      begin
+        if output_is_closed
+          raise ProjectExceptionHandler::Fatal.new(ProjectException::OutputNotOpen.new)
+        elsif output_is_opened
+          @output
+        end
+      end
+    end
+        
+    
+    def output_is_closed
+      @output == nil
+    end
+    
+    
+    def output_is_opened
+      @output != nil
+    end
+        
+    
+    def output_stream
+      announce_open
+      output_open
+      yield
+      output_close
+    end
+    
+    
+    def padding_vertical(n)
+      output.print ("\n" * n)
+      yield
+      output.print ("\n" * n)
+    end    
+    
+    
+    def write_inline(value)
+      write_value(value)
+    end
+
+    
+    def write_inline_end(value)
+      write_value(value)
+      write_lf
+    end
+
+    
+    def write_inline_indented(value)
+      write_margin
+      write_value(value)
+    end
+    
+    
+    def write_lf
+      output.print "\n"
+    end
+    
+    
+    def write_line(value)
+      write_margin
+      write_value(value)
+      write_lf
+    end
+
+
+    def write_margin
+      output.print render_current_margin
+    end
+    
+    
+    def write_value(value)
+      output.print value
+    end
+        
+        
+
+    private
+    
+        
+    def announce_open
+      if @output_class == 'file'
+        puts "- Writing `#{output_filename}`."
+      end
+    end
+    
+
+    def destination_file_open
+      filename = File.join(@output_working_directory, @output_filename)
+      File.new(filename, 'w')
+    end
+        
+    
+    def destination_stdout
+      $stdout
+    end
+    
+    
+    def output_close
+      begin
+        if output_is_closed
+          raise ProjectExceptionHandler::Fatal.new(ProjectException::OutputNotOpen.new)
+        elsif output_is_opened
+          output_close_assignment
+        end
+      end
+      margin_to_zero
+    end
+        
+    
+    def output_close_assignment
+      if File === @output
+        @output.close
+        @output = nil
+      else
+        @output = nil
+      end
+    end
+      
+    
+    def output_open
+      margin_to_zero
+      begin
+        if output_is_opened
+          raise ProjectExceptionHandler::Fatal.new(ProjectException::OutputAlreadyOpen.new)
+        elsif output_is_closed
+          output_open_assignment
+        end
+      end
+    end
+
+
+    def output_open_assignment
+      case @output_class
+      when 'file'
+        @output = destination_file_open
+      when 'stdout'
+        @output = destination_stdout
+      end
+    end    
+    
+        
+    def render_current_margin
+      (MARGIN * @margin_depth.to_i)
+    end
+    
+    
+  end      
+end
+

data/lib/muwu/destination_builder/destination_builder.rb

@@ -0,0 +1,127 @@
+module Muwu
+  class DestinationBuilder
+    
+    
+    include Muwu
+    
+    
+    attr_accessor(
+      :destination,
+      :project
+    )
+    
+    
+    def self.build
+      builder = new
+      yield(builder)
+      builder.destination
+    end
+
+
+    def initialize
+      @destination = Destination.new
+    end
+    
+    
+    def build_css(project)
+      depends_on_project(project)
+      set_output_class
+      set_output_filename_css
+      set_output_working_directory
+    end
+    
+    
+    def build_html(project, index)
+      depends_on_project(project)
+      set_output_class
+      set_output_filename_html(index)
+      set_output_working_directory
+    end
+    
+    
+    def build_js(project)
+      depends_on_project(project)
+      set_output_class
+      set_output_filename_js
+      set_output_working_directory
+    end
+
+
+    def depends_on_project(project)
+      @project = project
+    end
+    
+    
+    def set_output_class
+      @destination.output_class = @project.output_destination
+    end
+    
+        
+    def set_output_filename_css
+      if @destination.output_class == 'file'
+        @destination.output_filename = determine_output_filename_css
+      end
+    end
+
+
+    def set_output_filename_html(index)
+      if @destination.output_class == 'file'
+        @destination.output_filename = determine_output_filename_html(index)
+      end
+    end
+    
+    
+    def set_output_filename_js
+      if @destination.output_class == 'file'
+        @destination.output_filename = determine_output_filename_js
+      end
+    end
+    
+    
+    def set_output_working_directory
+      if @destination.output_class == 'file'
+        @destination.output_working_directory = @project.working_directory
+      end
+    end
+    
+  
+
+    private
+    
+    
+    def determine_output_filename_css
+      filename = ''
+      filename.concat @project.css_basename
+      filename.concat ".css"
+      filename
+    end
+
+
+    def determine_output_filename_html(index)
+      filename = ''
+      filename.concat @project.html_basename
+      if index_is_integer_greater_than_zero(index)
+        filename.concat "_#{index}"
+      end
+      filename.concat ".html"
+      filename
+    end
+    
+    
+    def determine_output_filename_js
+      filename = ''
+      filename.concat @project.js_basename
+      filename.concat ".js"
+      filename
+    end
+    
+    
+    def index_is_integer_greater_than_zero(index)
+      (Integer === index) && (index >= 1)
+    end
+    
+    
+  end
+end
+      
+      

data/lib/muwu/helper/hash_helper.rb

@@ -0,0 +1,37 @@
+module Muwu
+  module Helper
+    module HashHelper
+
+
+      module_function
+      
+      
+      def human_readable_hash(incoming_hash)
+        result_hash = {}
+        incoming_hash.each_pair do |k, v|
+          key = human_readable_key(k)
+          value = human_readable_value(v)
+          result_hash[key] = value
+        end
+        result_hash
+      end
+      
+      
+      def human_readable_key(k)
+        k.to_s.gsub(/\A:/,'')
+      end
+      
+      
+      def human_readable_value(v)
+        case v
+        when Array
+          return v.join(', ')
+        else
+          return v
+        end
+      end
+
+    
+    end
+  end  
+end

data/lib/muwu/helper/html_href_helper.rb

@@ -0,0 +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
+      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
+      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
+      end
+
+
+      def to_document_top
+        '#top'
+      end
+
+
+      def to_project_home
+        @project.manifest.find_document_html_by_index(0).destination.output_filename
+      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('_'))
+      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)
+        end
+        result
+      end
+      
+      
+      def target_text_filename(text_object)
+        result = ''
+        if @project.has_multiple_html_documents
+          result = File.basename(text_object.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('_')
+      end
+      
+      
+    end
+  end
+end