muwu 3.0.0.beta4 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a763a6ef4bc3f58893ea96ce27730e5bfc906b4fcc64aa587421413b8cc9e55
-  data.tar.gz: be89ad33637f0d913fa990f8b997672be8a5d1d775411225a2db8e7dbbec1651
+  metadata.gz: e2c92b3ed920a385c367fdb42b072943e08cbe720e8b0fce3c2ef7b40235b13e
+  data.tar.gz: 6d903e1f206fb36d2d8e37cbdff8137efbd0a7e8478dad7e22f80574f08061da
 SHA512:
-  metadata.gz: 7583d200eccf408768f7f19c58a20ce453c97f562663daa3afd2336015ee3863c7784a5a8a59bac3d948c35d866a4d790df9c65630288dfbefb8c1c38fce89c8
-  data.tar.gz: 2b54db763ffcd73e063a01887b31240bf7db6e60bf9e98d0224fe48f1bce99f91f2b86f76c2c92ccb2f9374a5eacd29951000a8cb47346d00b9f2bbd0edae618
+  metadata.gz: c39adc090bb2734d3263ca40889b8f398918d0f68d6199a5a485c8da50b521d0dfa0347f7f06f26228d1ea61cdf6155c22c1ee6183d405f24e57191aff8126ab
+  data.tar.gz: 7f11e98b6a1c803314942dbfc8a0777456080a1a09cd0599978e1caf10faacfed9023448c4ca24f8207759c1d77d6505107f3213c030eeb2f34343c6e7db06df

data/lib/muwu.rb

@@ -1,7 +1,7 @@
 module Muwu
 
 
-  VERSION = '3.0.0.beta4'
+  VERSION = '3.0.0.rc1'
 
   GEM_HOME_LIB = File.absolute_path(File.join(File.dirname(__FILE__)))
   GEM_HOME_LIB_MUWU = File.absolute_path(File.join(GEM_HOME_LIB, 'muwu'))
@@ -26,7 +26,7 @@ module Muwu
 
 
   def debug(file, line, info)
-    logger.new(STDERR).debug("#{file} #{line} #{info}")
+    Logger.new(STDERR).debug("#{file} #{line} #{info}")
   end
 
 

data/lib/muwu/default/default.rb

@@ -21,8 +21,6 @@ module Muwu
 
 
     PROJECT_OPTIONS = {
-      # TODO: this was probably an anti-pattern
-      # compile_all_resets_compiled_folder: true,
       contents_section_numbers_receive_link: true,
       generate_navigators_automatically: true,
       generate_subcontents_automatically: false,

data/lib/muwu/manifest_task_builder/text_item_builder.rb

@@ -153,7 +153,7 @@ module Muwu
         end
       end
 
-
+      # TODO: This method looks obsolete. Find its references.
       def determine_source_filename_implicitly
         # filename = make_filename_implicitly(outline_step)
         # filepath = make_filepath_implicitly
@@ -259,13 +259,6 @@ module Muwu
       end
 
 
-      # def make_filename_implicitly(string)
-      #   file_basename = SanitizerHelper.sanitize_text_item_path(string)
-      #   filename = file_basename + '.md'
-      #   filename
-      # end
-
-
       def make_filepath_implicitly
         path_from_project_home = ['text']
         if @project.text_block_naming_is_simple

data/lib/muwu/project/project.rb

@@ -287,7 +287,9 @@ module Muwu
     end
 
 
-    # DEPRECATED
+    # TODO: Broken due to introduction of the `/compiled` folder
+    # Keeping it as a comment in case it becomes useful in the future.
+    #
     # def path_images
     #   File.absolute_path(File.join(@working_directory, 'images'))
     # end
@@ -374,11 +376,15 @@ module Muwu
     end
 
 
+    # TODO: What if there's no css to embed?
+    # Consider redefining this method.
     def will_embed_css
       will_create_css_file == false
     end
 
 
+    # TODO: What if there's no js to embed?
+    # Consider redefining this method.
     def will_embed_js
       will_create_javascript_file == false
     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

@@ -3,8 +3,6 @@ module Muwu
 
 
     attr_accessor(
-      # TODO: this was probably an anti-pattern
-      # :expunge_when_compiling_all,
       :generate_navigators_automatically,
       :generate_subcontents_automatically,
       :html_head_includes_metadata_tags,

data/lib/muwu/project_options_builder/project_option_validator_value.rb

@@ -106,12 +106,6 @@ module Muwu
     end
 
 
-    # TODO: this was probably an anti-pattern
-    # def validate_option_compile_all_resets_compiled_folder
-    #   return validate_option_boolean
-    # end
-
-
     def validate_option_contents_section_numbers_receive_link
       return validate_option_boolean
     end

data/lib/muwu/publish/publish.rb

@@ -9,7 +9,7 @@ module Muwu
       @path_local = project.path_compiled + File::SEPARATOR
       @path_remote = project.options.remote_publish
       @project = project
-      @switches = args.push(project.options.rsync_options).sort.join(' ')
+      @switches = args.push(project.options.rsync_options).flatten.sort.join(' ')
     end
 
 
@@ -52,16 +52,5 @@ module Muwu
     end
 
 
-    # def scp(filename)
-    #   filename_local = File.join(@path_local, filename)
-    #   filename_remote = File.join(@path_remote, filename)
-    #   begin
-    #     system "scp #{filename_local} #{filename_remote}", exception: true
-    #   rescue Errno::ENOENT
-    #     raise ProjectExceptionHandler::Fatal.new(ProjectException::ScpNotAvailable.new)
-    #   end
-    # end
-
-
   end
 end

data/lib/muwu/render_html_partial/render_document_html.rb

@@ -4,12 +4,12 @@ module Muwu
 
 
       include Muwu
-      
-      
+
+
       require 'sassc'
-        
-  
-      attr_accessor( 
+
+
+      attr_accessor(
         :destination,
         :head_css_filename,
         :head_css_method,
@@ -23,15 +23,15 @@ module Muwu
         :project,
         :tasks
       )
-      
-      
+
+
       def initialize
         @head_metadata = {}
         @tasks = []
       end
-      
-      
-      
+
+
+
       public
 
 
@@ -72,9 +72,9 @@ module Muwu
 
 
       def render_head
-        @destination.padding_vertical(1) do 
+        @destination.padding_vertical(1) do
           write_tag_head_open
-          @destination.margin_indent do 
+          @destination.margin_indent do
             write_tag_title
             render_head_meta_tags
             render_head_css
@@ -105,7 +105,7 @@ module Muwu
       def render_head_css_link
         write_tag_link_stylesheet
       end
-  
+
 
       def render_head_js
         case @head_js_method
@@ -124,14 +124,14 @@ module Muwu
         end
         write_tag_script_close
       end
-  
-  
+
+
       def render_head_js_lib_navigation
         if @project.options.html_uses_javascript_navigation
           write_js_lib_navigation
         end
       end
-  
+
 
       def render_head_js_link
         write_tag_script_src
@@ -148,8 +148,8 @@ module Muwu
         write_tag_meta_generator
         write_tag_meta_viewport
       end
-      
-      
+
+
       def render_tag_html_open
         write_tag_doctype
         if @html_lang
@@ -158,8 +158,8 @@ module Muwu
           write_tag_html_open
         end
       end
-  
-  
+
+
       def write_css_if_manifest_exists
         if @project.exceptions_include?(ProjectException::CssManifestFileNotFound)
           write_css_missing_comment
@@ -167,10 +167,10 @@ module Muwu
           write_css
         end
       end
-      
+
 
       def write_css
-        @destination.write_inline sassc::Engine.new(File.read(@project.css_manifest_filename), syntax: :scss, load_paths: ['config/css']).render
+        @destination.write_inline SassC::Engine.new(File.read(@project.css_manifest_filename), syntax: :scss, load_paths: ['config/css']).render
       end
 
 
@@ -180,14 +180,14 @@ module Muwu
         @destination.write_line "  - CSS manifest file could not be found."
         @destination.write_line "  - Expecting `#{project.css_manifest_filename}`"
         @destination.write_line "*/"
-      end      
-  
-  
+      end
+
+
       def write_js_library(library)
         @destination.write_inline RenderHtmlPartial::JsLibrary.new.find(library)
       end
-      
-      
+
+
       def write_tag_body_close
         @destination.write_line tag_body_close
       end
@@ -196,8 +196,8 @@ module Muwu
       def write_tag_body_open
         @destination.write_line tag_body_open
       end
-      
-      
+
+
       def write_tag_doctype
         @destination.write_line tag_doctype
       end
@@ -236,18 +236,18 @@ module Muwu
       def write_tag_meta(key, value)
         @destination.write_line tag_meta(key, value)
       end
-  
-  
+
+
       def write_tag_meta_charset_utf8
         @destination.write_line tag_meta_charset_utf8
       end
-      
-      
+
+
       def write_tag_meta_generator
         @destination.write_line tag_meta_generator
       end
-  
-  
+
+
       def write_tag_meta_viewport
         @destination.write_line tag_meta_viewport
       end
@@ -261,13 +261,13 @@ module Muwu
       def write_tag_script_close
         @destination.write_line tag_script_close
       end
-  
-  
+
+
       def write_tag_script_open
         @destination.write_line tag_script_open
       end
-  
-  
+
+
       def write_tag_script_src
         @destination.write_line tag_script_src
       end
@@ -276,13 +276,13 @@ module Muwu
       def write_tag_style_close
         @destination.write_line tag_style_close
       end
-  
-  
+
+
       def write_tag_style_open
         @destination.write_line tag_style_open
       end
-  
-  
+
+
       def write_tag_title
         @destination.write_line tag_title
       end
@@ -290,8 +290,8 @@ module Muwu
 
 
       private
-      
-      
+
+
       def tag_body_close
         "</body>"
       end
@@ -305,8 +305,8 @@ module Muwu
       def tag_doctype
         "<!DOCTYPE html>"
       end
-  
-    
+
+
       def tag_head_close
         "</head>"
       end
@@ -340,23 +340,23 @@ module Muwu
       def tag_meta(key, value)
         "<meta name='#{key}' value='#{value}'>"
       end
-  
-  
+
+
       def tag_meta_charset_utf8
         "<meta charset='UTF-8'>"
       end
-      
-      
+
+
       def tag_meta_generator
         "<meta name='generator' content='Muwu #{Muwu::VERSION}'>"
       end
-  
-  
+
+
       def tag_meta_instance_date
         "<meta name='date_of_this_edition' value='#{@project.instance_date}'>\n"
       end
 
-  
+
       def tag_meta_viewport
         "<meta name='viewport' content='width=device-width, initial-scale=1, user-scalable=yes'>"
       end
@@ -365,32 +365,32 @@ module Muwu
       def tag_script_close
         "</script>"
       end
-  
-  
+
+
       def tag_script_open
         "<script>"
       end
-  
-  
+
+
       def tag_script_src
         "<script src='#{@head_js_filename}'></script>"
       end
 
-  
+
       def tag_style_close
         "</style>"
       end
-  
-  
+
+
       def tag_style_open
         "<style>"
       end
-  
-  
+
+
       def tag_title
         "<title>#{@html_title}</title>"
       end
-  
+
 
     end
   end

data/lib/muwu/sync/sync.rb

@@ -9,7 +9,7 @@ module Muwu
       @path_local = project.working_directory + File::SEPARATOR
       @path_remote = project.options.remote_sync
       @project = project
-      @switches = args.push(project.options.rsync_options).sort.join(' ')
+      @switches = args.push(project.options.rsync_options).flatten.sort.join(' ')
     end
 
 

data/test/what_no_tests.md

@@ -1,5 +1,3 @@
 # What, no tests?!!
 
-Sorry not-sorry for the lack of unit tests. The author understands their value. However, the author lacks institutional training in software development, and has not yet found any relatable resources to learn test-driven development.
-
-(The author also tunes out any examples invoking foo bar baz.) 
+Currently there is no test suite. The developer understands the value of automated tests; however, the developer lacks institutional training in software development, and has not yet found any resources that teach test-driven development in a meaningful way.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muwu
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta4
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Eli Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker