muwu 2.5.1

data/lib/muwu/project_exception/outline_step_not_understood.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class OutlineStepNotUnderstood
+   
+   
+      def initialize(step)
+        @step = step
+      end
+      
+      
+      def report
+        "Outline step `#{@step}` is not understood."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/project_exception/output_already_open.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class OutputAlreadyOpen
+
+
+      def initialize
+        $stderr.puts "#{self.class}"
+      end
+
+
+      def type
+        :internal
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/output_not_open.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class OutputNotOpen
+
+
+      def initialize
+        $stderr.puts "#{self.class}"
+      end
+
+
+      def type
+        :internal
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/subcontents_will_be_generated_automatically copy.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class SubcontentsWillBeGeneratedAutomatically
+   
+   
+      def initialize(index)
+        @index = index
+      end
+      
+      
+      def report
+        "Subcontents will be generated automatically. Ignoring outline directive (document #{@index})."
+      end
+      
+      
+      def type
+        :warning
+      end
+      
+      
+    end
+  end
+end

data/lib/muwu/project_exception/target_project_folder_already_exists.rb

@@ -0,0 +1,24 @@
+module Muwu
+  module ProjectException
+    class TargetProjectFolderAlreadyExists
+      
+      
+      def initialize(project)
+        @project_folder = project.working_directory
+      end
+      
+      
+      def report
+        "The proposed directory `#{@project_folder}` already exists."
+      end
+      
+      
+      def type
+        :fatal
+      end
+
+
+    end
+  end
+end    
+    

data/lib/muwu/project_exception/text_source_file_not_found.rb

@@ -0,0 +1,26 @@
+module Muwu
+  module ProjectException
+    class TextSourceFileNotFound
+      
+      
+      def initialize(text_readfile)
+        @filename = text_readfile.source_filename
+        @numbering = text_readfile.numbering
+        @text_root_name = text_readfile.text_root_name
+      end
+      
+      
+      def report
+        "file not found  `#{@filename}`  (#{@text_root_name} #{@numbering})"
+      end
+
+
+      def type
+        :warning
+      end
+
+
+    end
+  end
+end    
+    

data/lib/muwu/project_exception_handler/fatal.rb

@@ -0,0 +1,39 @@
+module Muwu
+  module ProjectExceptionHandler
+    class Fatal < StandardError
+
+
+      def initialize(exceptions)
+        @exceptions = [exceptions].flatten
+        render_exceptions
+      end
+      
+      
+      def render_exception(exception)
+        $stderr.puts "- #{exception.class}"
+        $stderr.puts "  #{exception.report}"
+      end
+      
+      
+      def render_exceptions
+        render_header
+        @exceptions.each do |exception|
+          render_exception(exception)
+        end
+        render_lf
+      end
+      
+      
+      def render_header
+        $stderr.puts "#{self.inspect}"
+      end
+      
+      
+      def render_lf
+        $stderr.puts "\n"
+      end
+              
+
+    end
+  end
+end

data/lib/muwu/project_options/project_options.rb

@@ -0,0 +1,54 @@
+module Muwu
+  class ProjectOptions
+
+
+    attr_accessor(
+      :generate_navigators_automatically,
+      :generate_subcontents_automatically,
+      :html_head_includes_metadata_tags,
+      :html_lang,
+      :html_uses_javascript_navigation,
+      :markdown_allows_raw_html,
+      :markdown_renderer,
+      :outline_text_pathnames,
+      :output_destination,
+      :output_file_css_basename,
+      :output_file_html_basename,
+      :output_file_js_basename,
+      :output_formats,
+      :render_punctuation_smart,
+      :render_section_end_links,
+      :render_section_numbers,
+      :render_sections_distinctly_depth_max,
+      :render_title_section_metadata,
+      :warning_if_parent_heading_lacks_source
+    )
+    
+    
+    def initialize
+      Default::PROJECT_OPTIONS.each_pair do |key, value|
+        set_option(key, value)
+      end
+    end
+    
+    
+    def inspect
+      ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
+    end
+
+
+    def inspect_instance_variables
+      instance_variables.map { |v| "#{v}=#{instance_variable_get(v).inspect}" }.join(", ")
+    end
+    
+    
+    def set_option(key, value)
+      if Default::PROJECT_OPTIONS.has_key?(key)
+        key_ivsym = "@#{key.to_s}"
+        instance_variable_set(key_ivsym, value)
+      end
+    end
+      
+  
+  end
+end

data/lib/muwu/project_options_builder/project_option_validator.rb

@@ -0,0 +1,37 @@
+module Muwu
+  class ProjectOptionValidator
+   
+   
+    include Muwu
+    
+    
+    attr_reader(
+      :key,
+      :value
+    )
+   
+   
+    def initialize(key, value, project)
+      key_validator = ProjectOptionValidatorKey.new(key, value, project)
+      @key = key_validator.validated_key
+      @value = key_validator.validated_value
+    end
+    
+    
+         
+    protected
+    
+
+    def self.new_if_valid_key(key, value, project)
+      option_validator = new(key, value, project)
+      if option_validator.key
+        return option_validator
+      else
+        return nil
+      end
+    end
+
+
+    
+  end
+end

data/lib/muwu/project_options_builder/project_option_validator_key.rb

@@ -0,0 +1,56 @@
+module Muwu
+  class ProjectOptionValidatorKey
+   
+   
+    include Muwu
+   
+ 
+    def initialize(key_as_provided, value_as_provided, project)
+      @project = project
+      @key_as_provided = key_as_provided
+      @value_as_provided = value_as_provided
+
+      @key_validated = validate_key
+      @value_validated = validate_value
+    end
+    
+    
+    
+    public
+    
+    
+    def validated_key
+      @key_validated
+    end
+    
+    
+    def validated_value
+      @value_validated
+    end
+        
+    
+        
+    private
+    
+    
+    def validate_key
+      key = @key_as_provided.downcase.gsub(/\W/,'_').to_sym
+      key_is_valid = Default::PROJECT_OPTIONS.keys.include?(key)
+      if key_is_valid
+        return key
+      else
+        @project.exceptions_add ProjectException::OptionKeyNotUnderstood.new(@key_as_provided)
+        return false
+      end
+    end
+
+
+    def validate_value
+      if @key_validated
+        ProjectOptionValidatorValue.new(@key_validated, @value_as_provided, @project).validated_value
+      end
+    end
+    
+    
+  end
+end

data/lib/muwu/project_options_builder/project_option_validator_value.rb

@@ -0,0 +1,300 @@
+module Muwu
+  class ProjectOptionValidatorValue
+
+
+    require 'iso-639'
+    
+   
+    include Muwu
+    include Helper
+
+    
+    attr_accessor(
+      :key_validated,
+      :project,
+      :validation_method_name,
+      :value_provided
+    )
+   
+ 
+    def initialize(key_validated, value_provided, project)
+      @key_validated = key_validated.to_s.gsub(/\W/,'_')
+      @project = project
+      @validation_method_name = "validate_option_#{@key_validated}"
+      @value_provided = value_provided
+    end
+    
+    
+    
+    public
+    
+        
+    def validated_value
+      if private_methods.include?(@validation_method_name.to_sym)
+        return method(@validation_method_name).call
+      else
+        @project.exceptions_add ProjectException::OptionNotValidatable.new(@key_validated)
+        return nil
+      end
+    end
+    
+    
+    # def value_as_array(value)
+    #   result = []
+    #   if String === value
+    #     result = value.split(/,\s*/).map{ |v| value_as_string(v) }.sort
+    #   elsif Array === value
+    #     result = value.map{ |v| value_as_string(v) }.sort
+    #   elsif Boolean === @value_provided
+    #     result << value
+    #   end
+    #   result.reject!{ |r| r == '' }
+    #   result
+    # end
+
+
+    def value_as_array(value)
+      result = []
+      case value
+      when String
+        result = value.split(/,\s*/).map{ |v| value_as_string(v) }.sort
+      when Array
+        result = value.map{ |v| value_as_string(v) }.sort
+      when FalseClass, TrueClass
+        result << value
+      end
+      result.reject!{ |r| r == '' }
+      result
+    end
+    
+    
+    def value_as_integer(value)
+      value.to_i
+    end
+    
+    
+    def value_as_string(value)
+      value.to_s.strip.downcase
+    end
+    
+        
+    def value_provided_as_array
+      value_as_array(@value_provided)
+    end
+
+
+    def value_provided_as_integer
+      value_as_integer(@value_provided)
+    end
+    
+    
+    def value_provided_as_string
+      value_as_string(@value_provided)
+    end
+      
+
+
+    private
+    
+    
+    def validate_option_boolean
+      case @value_provided
+      when false, true
+        return @value_provided
+      when nil, '', 'nil'
+        return nil
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+    
+    
+    def validate_option_generate_navigators_automatically
+      return validate_option_boolean
+    end
+    
+    
+    def validate_option_generate_subcontents_automatically
+      return validate_option_boolean
+    end
+    
+    
+    def validate_option_html_head_includes_metadata_tags
+      return validate_option_boolean
+    end
+    
+    
+    def validate_option_html_lang
+      case @value_provided
+      when nil, 'nil'
+        return nil
+      else
+        value = ISO_639.find(value_provided_as_string)
+        if value
+          return value.alpha2
+        else
+          @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+          return nil
+        end
+      end
+    end
+    
+    
+    def validate_option_html_uses_javascript_navigation
+      return validate_option_boolean
+    end
+    
+    
+    def validate_option_markdown_allows_raw_html
+      return validate_option_boolean
+    end
+      
+    
+    def validate_option_markdown_renderer
+      value = value_provided_as_string
+      case value
+      when 'commonmarker'
+        return value
+      when 'motion-markdown-it', 'motion_markdown_it'
+        return 'motion-markdown-it'
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+    
+    
+    def validate_option_outline_text_pathnames
+      value = value_provided_as_string
+      case value
+      when 'explicit', 'flexible', 'implicit'
+        return value
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+    
+    
+    def validate_option_output_destination
+      value = value_provided_as_string
+      case value
+      when 'file', 'stdout'
+        return value
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+
+
+    def validate_option_output_file_basename
+      case @value_provided
+      when String
+        return SanitizerHelper.sanitize_destination_file_basename(File.basename(@value_provided))
+      when nil
+        return nil
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+    
+    
+    def validate_option_output_file_css_basename
+      return validate_option_output_file_basename
+    end
+    
+    
+    def validate_option_output_file_html_basename
+      return validate_option_output_file_basename
+    end
+    
+    
+    def validate_option_output_file_js_basename
+      return validate_option_output_file_basename
+    end
+    
+
+    def validate_option_output_formats
+      result = []
+      value_provided_as_array.each do |value|
+        case value
+        when 'css', 'html', 'js'
+          result << value
+        else
+          @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        end
+      end
+      return result
+    end
+    
+    
+    def validate_option_render_punctuation_smart
+      return validate_option_boolean
+    end
+  
+  
+    def validate_option_render_section_end_links
+      result = []
+      value_provided_as_array.each do |value|
+        case value
+        when false
+          result << value
+        when true
+          result = ['contents','home','top']
+        when 'contents', 'home', 'top'
+          result << value
+        else
+          @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        end
+      end
+      return result
+    end
+    
+    
+    def validate_option_render_section_numbers
+      return validate_option_boolean
+    end
+  
+
+    def validate_option_render_sections_distinctly_depth_max
+      case @value_provided
+      when false, nil, 0, '', 'nil'
+        return nil
+      when Integer
+        return @value_provided
+      else
+        @project.exceptions_add ProjectException::OptionValueNotUnderstood.new(@key_validated, @value_provided)
+        return nil
+      end
+    end
+    
+    
+    def validate_option_render_title_section_metadata
+      case @value_provided
+      when nil, '', 'nil'
+        return nil
+      when Array
+        return @value_provided
+      when String
+        return @value_provided.split(/,\s*/)
+      else
+        return [@value_provided.to_s].flatten
+      end
+    end
+    
+    
+    def validate_option_render_punctuation_smart
+      return validate_option_boolean
+    end
+  
+  
+    def validate_option_warning_if_parent_heading_lacks_source
+      return validate_option_boolean
+    end
+    
+    
+  end
+end