muwu 2.5.1 → 3.0.0.rc1

data/lib/muwu/project_builder/project_starter.rb

@@ -1,10 +1,10 @@
 module Muwu
   class ProjectStarter
-    
-    
+
+
     include Muwu
-    
-    
+
+
     def initialize(current_working_directory, metadata)
       @current_working_directory = File.absolute_path(current_working_directory)
       @metadata = metadata
@@ -21,7 +21,7 @@ module Muwu
       project.working_directory = File.absolute_path(File.join(@current_working_directory, @metadata[:slug]))
       project
     end
-    
-    
+
+
   end
-end
+end

data/lib/muwu/project_builder/project_validator.rb

@@ -14,6 +14,16 @@ module Muwu
     public
 
 
+    def validate_dir_compiled
+      if @project.path_compiled_does_exist
+        return true
+      else
+        @project.exceptions_add ProjectException::CompiledFolderNotFound.new(@project)
+        return false
+      end
+    end
+
+
     def validate_file_css
       if @project.css_manifest_file_does_exist
         return true
@@ -54,6 +64,20 @@ module Muwu
     end
 
 
+    def validate_option_remote_publish
+      if @project.options.remote_publish.to_s == ''
+        @project.exceptions_add ProjectException::OptionRemotePublishValueNil.new
+      end
+    end
+
+
+    def validate_option_remote_sync
+      if @project.options.remote_sync.to_s == ''
+        @project.exceptions_add ProjectException::OptionRemoteSyncValueNil.new
+      end
+    end
+
+
     def validate_outline_step_navigator(index)
       validate_outline_step_navigator_if_single_document(index)
       return validate_outline_step_navigator_if_automatic(index)

data/lib/muwu/project_builder/project_writer.rb

@@ -8,8 +8,8 @@ module Muwu
 
     require 'fileutils'
     require 'yaml'
-    
-    
+
+
     attr_accessor(
       :project
     )
@@ -40,19 +40,20 @@ module Muwu
 
       end
     end
-    
-    
+
+
     def phase_1_make_project_folder
       announce_and_execute_dir_mkdir(@project.working_directory)
     end
-    
-    
+
+
     def phase_2_make_project_subfolders
+      announce_and_execute_dir_mkdir(@project.path_compiled)
       announce_and_execute_dir_mkdir(@project.path_config)
-      announce_and_execute_dir_mkdir(@project.path_images)
+      # announce_and_execute_dir_mkdir(@project.path_images)    # DEPRECATED
       announce_and_execute_dir_mkdir(@project.path_text)
     end
-    
+
 
     def phase_2_make_folder_css_and_copy_files
       folder_source_gem = File.absolute_path(File.join(Muwu::GEM_HOME_LIB, 'muwu','project_builder','assets','config','css'))
@@ -79,8 +80,8 @@ module Muwu
         phase_3_write_file_outline_yml_blank
       end
     end
-    
-    
+
+
     def phase_3_write_file_outline_yml_dump
       announce_and_execute_yaml_dump(@project.outline, @project.outline_filename)
     end
@@ -124,4 +125,4 @@ module Muwu
 
 
   end
-end
+end

data/lib/muwu/project_exception/compiled_folder_not_found.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class CompiledFolderNotFound
+
+
+      def initialize(project)
+        @compiled_folder = project.path_compiled
+      end
+
+
+      def report
+        "The folder for compiled documents `#{@compiled_folder}` could not be found."
+      end
+
+
+      def type
+        :fatal
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/lynx_not_available.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class LynxNotAvailable
+
+
+      def initialize
+        $stderr.puts "#{self.class}"
+      end
+
+
+      def report
+        "lynx is not available"
+      end
+
+
+      def type
+        :view
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/option_remote_publish_value_nil.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class OptionRemotePublishValueNil
+
+
+      def report
+        "options.yml does not include a value for remote_publish"
+      end
+
+
+      def type
+        :publish
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/option_remote_sync_value_nil.rb

@@ -0,0 +1,18 @@
+module Muwu
+  module ProjectException
+    class OptionRemoteSyncValueNil
+
+
+      def report
+        "options.yml does not include a value for remote_sync"
+      end
+
+
+      def type
+        :sync
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/rsync_not_available.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class RsyncNotAvailable
+
+
+      def initialize
+        $stderr.puts "#{self.class}"
+      end
+
+      
+      def report
+        "rsync is not available"
+      end
+
+
+      def type
+        :sync
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception/scp_not_available.rb

@@ -0,0 +1,23 @@
+module Muwu
+  module ProjectException
+    class ScpNotAvailable
+
+
+      def initialize
+        $stderr.puts "#{self.class}"
+      end
+
+      
+      def report
+        "scp is not available"
+      end
+
+
+      def type
+        :publish
+      end
+
+
+    end
+  end
+end

data/lib/muwu/project_exception_handler/fatal.rb

@@ -6,15 +6,16 @@ module Muwu
       def initialize(exceptions)
         @exceptions = [exceptions].flatten
         render_exceptions
+        exit
       end
-      
-      
+
+
       def render_exception(exception)
         $stderr.puts "- #{exception.class}"
         $stderr.puts "  #{exception.report}"
       end
-      
-      
+
+
       def render_exceptions
         render_header
         @exceptions.each do |exception|
@@ -22,17 +23,17 @@ module Muwu
         end
         render_lf
       end
-      
-      
+
+
       def render_header
         $stderr.puts "#{self.inspect}"
       end
-      
-      
+
+
       def render_lf
         $stderr.puts "\n"
       end
-              
+
 
     end
   end

data/lib/muwu/project_options/project_options.rb

@@ -16,22 +16,25 @@ module Muwu
       :output_file_html_basename,
       :output_file_js_basename,
       :output_formats,
+      :remote_publish,
+      :remote_sync,
       :render_punctuation_smart,
       :render_section_end_links,
       :render_section_numbers,
       :render_sections_distinctly_depth_max,
       :render_title_section_metadata,
+      :rsync_options,
       :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
@@ -40,15 +43,15 @@ module Muwu
     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

@@ -1,26 +1,26 @@
 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)
@@ -32,6 +32,6 @@ module Muwu
     end
 
 
-    
+
   end
-end
+end

data/lib/muwu/project_options_builder/project_option_validator_value.rb

@@ -3,32 +3,32 @@ module Muwu
 
 
     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
@@ -37,20 +37,6 @@ module Muwu
         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)
@@ -66,18 +52,23 @@ module Muwu
       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_as_string_preserving_case(value)
+      value.to_s.strip
+    end
+
+
     def value_provided_as_array
       value_as_array(@value_provided)
     end
@@ -86,17 +77,22 @@ module Muwu
     def value_provided_as_integer
       value_as_integer(@value_provided)
     end
-    
-    
+
+
     def value_provided_as_string
       value_as_string(@value_provided)
     end
-      
+
+
+    def value_provided_as_string_preserving_case
+      value_as_string_preserving_case(@value_provided)
+    end
+
 
 
     private
-    
-    
+
+
     def validate_option_boolean
       case @value_provided
       when false, true
@@ -108,23 +104,28 @@ module Muwu
         return nil
       end
     end
-    
-    
+
+
+    def validate_option_contents_section_numbers_receive_link
+      return validate_option_boolean
+    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'
@@ -139,18 +140,18 @@ module Muwu
         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
@@ -163,8 +164,8 @@ module Muwu
         return nil
       end
     end
-    
-    
+
+
     def validate_option_outline_text_pathnames
       value = value_provided_as_string
       case value
@@ -175,8 +176,8 @@ module Muwu
         return nil
       end
     end
-    
-    
+
+
     def validate_option_output_destination
       value = value_provided_as_string
       case value
@@ -200,22 +201,22 @@ module Muwu
         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 = []
@@ -229,13 +230,23 @@ module Muwu
       end
       return result
     end
-    
-    
+
+
+    def validate_option_remote_publish
+      return value_provided_as_string_preserving_case
+    end
+
+
+    def validate_option_remote_sync
+      return value_provided_as_string_preserving_case
+    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|
@@ -252,12 +263,12 @@ module Muwu
       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
@@ -270,8 +281,8 @@ module Muwu
         return nil
       end
     end
-    
-    
+
+
     def validate_option_render_title_section_metadata
       case @value_provided
       when nil, '', 'nil'
@@ -284,17 +295,22 @@ module Muwu
         return [@value_provided.to_s].flatten
       end
     end
-    
-    
+
+
     def validate_option_render_punctuation_smart
       return validate_option_boolean
     end
-  
-  
+
+
+    def validate_option_rsync_options
+      return value_provided_as_array
+    end
+
+
     def validate_option_warning_if_parent_heading_lacks_source
       return validate_option_boolean
     end
-    
-    
+
+
   end
-end
+end