muwu 2.5.1 → 3.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dafa3354f3a57677adacf16fe9372167ce2572b68e445fb0f95192142c116633
-  data.tar.gz: 83130270c6bcfbbb7c3fd46a3cc8825441999eae801dd1ba15368acffc315464
+  metadata.gz: b7a3546ed2eb6f4dead8a472ef9460ce5696a5967892151210026e947303766e
+  data.tar.gz: f53c66c3a78df5157de9930c78444bc821eaa9de6484b628887b720c6cc4acea
 SHA512:
-  metadata.gz: 8a036a78dd8a1ef10f0776a7d014c4e953ababeb0ca154e0718499a8252b06b3b4a708fa9c4542803a986e70f0fdad4bef8e9997b541eabb9f01858f82118722
-  data.tar.gz: 819c5595a937ff67464e3829b0243d86a2cf3b429bcadf232dfc13eea7995d9c6fe583c48f39555479597a66ebc4cff2dc95eb199693ffd10dcb3d9850a281df
+  metadata.gz: 862b1e8424005ce9f952e3609634a986c0c4d31f3697b24502d1175c643cc88caef93113bd4043c9be22c8f220d5a87721923e3b0554c04cad1856fd78f16881
+  data.tar.gz: 3e61b41b6dea81978e0226542a1e06ce1caec159bb55f070c2aee54452abd852e190c6328f77b9ee365272ff0dc9c3835dad5e3747eaf3b24196a764121e67fc

data/lib/muwu.rb

@@ -1,7 +1,7 @@
 module Muwu
 
 
-  VERSION = '2.5.1'
+  VERSION = '3.0.0.alpha'
 
   GEM_HOME_LIB = File.absolute_path(File.join(File.dirname(__FILE__)))
   GEM_HOME_LIB_MUWU = File.absolute_path(File.join(GEM_HOME_LIB, 'muwu'))

data/lib/muwu/cli/cli.rb

@@ -38,8 +38,12 @@ module Muwu
           evaluate_command_inspect
         when 'new'
           evaluate_command_new
+        when 'publish'
+          evaluate_command_publish
         when 'reset'
           evaluate_command_reset
+        when 'sync'
+          evaluate_command_sync
         when '--version'
           puts VERSION
         else
@@ -105,8 +109,12 @@ module Muwu
           puts CliHelp.new(:inspect).message
         when 'new'
           puts CliHelp.new(:new).message
+        when 'publish'
+          puts CliHelp.new(:publish).message
         when 'reset'
           puts CliHelp.new(:reset).message
+        when 'sync'
+          puts CliHelp.new(:sync).message
         else
           puts CliHelp.new(:summary).message
         end
@@ -124,6 +132,11 @@ module Muwu
     end
 
 
+    def evaluate_command_publish
+      Controller.new(@current_working_directory).publish
+    end
+    
+    
     def evaluate_command_reset
       if @args[1] == nil
         puts CliHelp.new(:reset).message
@@ -138,6 +151,23 @@ module Muwu
       end
     end
     
+    
+    def evaluate_command_sync
+      if @args[1] == nil
+        puts CliHelp.new(:sync).message
+        
+      else
+        case @args[1]
+        when 'down'
+          Controller.new(@current_working_directory).sync_down(@args[2..(@args.length-1)])
+        when 'up'
+          Controller.new(@current_working_directory).sync_up(@args[2..(@args.length-1)])
+        else 
+          puts CliHelp.new(:sync).message
+        end
+      end
+    end
+    
 
   end
 end

data/lib/muwu/cli/help/publish

@@ -0,0 +1,7 @@
+- muwu publish
+  - Publishes compiled documents (as indicated by the current outline and
+    manifest) to a remote location using scp. Scp must be installed on the
+    local system.
+    
+* Specify the remote host in 'options.yml' using the 'remote_publish' value.
+

data/lib/muwu/cli/help/reset

@@ -1,4 +1,4 @@
-- reset css
+- muwu reset css
   - Reset the `config/css` folder. The following files and folders will
     revert to their original state:
     

data/lib/muwu/cli/help/summary

@@ -6,7 +6,9 @@ Command line:
   muwu help             show this message
   muwu inspect          inspect a project
   muwu new              create a new project directory
+  muwu publish          publish to a remote server (requires scp)
   muwu reset css        reset the default CSS files
+  muwu sync             syncronize from/to a remote server (requires rsync)
 
 All comands operate within the current working directory.
 

data/lib/muwu/cli/help/sync

@@ -0,0 +1,18 @@
+- muwu sync [down | up] [options]
+  - Synchronize project from/to a remote location using rsync. Rsync must be
+    installed on the local system.
+    
+- muwu sync down
+  - Use rsync to download the project from a remote host.
+  
+- muwu sync up
+  - Use rsync to upload to project to a remote host.
+  
+- [options]
+  - dry-run: invoke the rsync '-n' switch to show which files will be
+      transferred, but do not actually transfer files.
+      
+* Specify the remote host in 'options.yml' using the 'remote_sync' value.
+  
+* Muwu will invoke the rsync switches '-r' to recurse subdirectories, and
+  '-v' to give a verbose description

data/lib/muwu/controller/controller.rb

@@ -92,6 +92,12 @@ module Muwu
     end
     
     
+    def publish
+      @project = read_project_from_current_working_directory
+      Publish.new(@project).up
+    end
+    
+    
     def reset_css
       @project = read_project_from_current_working_directory
       if @project.does_not_have_crucial_files
@@ -100,6 +106,18 @@ module Muwu
         ProjectResetCss.new(@project).reset_css
       end
     end
+    
+    
+    def sync_down(args)
+      @project = read_project_from_current_working_directory
+      Sync.new(@project, args: args).down
+    end
+    
+    
+    def sync_up(args)
+      @project = read_project_from_current_working_directory
+      Sync.new(@project, args: args).up
+    end
 
 
 

data/lib/muwu/default/default.rb

@@ -33,6 +33,8 @@ module Muwu
       output_file_html_basename: 'index',
       output_file_js_basename: nil,
       output_formats: ['html','css','js'],
+      remote_publish: nil,
+      remote_sync: nil,
       render_punctuation_smart: true,
       render_section_end_links: ['contents', 'top'],
       render_section_numbers: true,

data/lib/muwu/manifest_task/document_css.rb

@@ -10,6 +10,11 @@ module Muwu
       )
       
       
+      def filename
+        @destination.output_filename
+      end
+      
+      
       def inspect
         ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
       end

data/lib/muwu/manifest_task/document_html.rb

@@ -7,7 +7,7 @@ module Muwu
         :destination,
         :css_filename,
         :css_include_method,
-        :filename,
+        # :filename,
         :index,
         :js_filename,
         :js_include_method,
@@ -40,6 +40,11 @@ module Muwu
       end
       
       
+      def filename
+        @destination.output_filename
+      end
+      
+      
       def text_blocks
         @tasks.select { |task| ManifestTask::Text === task }
       end

data/lib/muwu/manifest_task/document_js.rb

@@ -10,6 +10,11 @@ module Muwu
       )
       
       
+      def filename
+        @destination.output_filename
+      end
+      
+            
       def inspect
         ["#{self.to_s}", "{", inspect_instance_variables, "}"].join(' ')
       end
@@ -19,7 +24,7 @@ module Muwu
         self.instance_variables.map { |v| "#{v}=#<#{instance_variable_get(v).class}>" }.join(", ")
       end    
       
-            
+      
     end
   end
 end

data/lib/muwu/project_builder/project_reader.rb

@@ -78,6 +78,8 @@ module Muwu
 
     def phase_4_validate
       @validator.validate_file_css
+      @validator.validate_option_remote_publish
+      @validator.validate_option_remote_sync
       @validator.validate_output_destination_and_formats
       @validator.validate_scenario_if_more_than_one_document
     end

data/lib/muwu/project_builder/project_validator.rb

@@ -52,6 +52,20 @@ module Muwu
         return false
       end
     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)
@@ -92,8 +106,8 @@ module Muwu
         @project.exceptions_add ProjectException::MultipleFormatsRequestedWithStdout.new
       end
     end
-
-
+    
+    
     def validate_scenario_if_more_than_one_document
       if @project.outline_has_more_than_one_document && @project.output_destination_requests_stdout
         @project.exceptions_add ProjectException::MultipleDocumentsOutlinedWithStdout.new

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_options/project_options.rb

@@ -16,6 +16,8 @@ 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,

data/lib/muwu/project_options_builder/project_option_validator_value.rb

@@ -76,6 +76,11 @@ module Muwu
     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
@@ -91,6 +96,11 @@ module Muwu
     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
       
 
 
@@ -231,6 +241,16 @@ module Muwu
     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
@@ -289,8 +309,8 @@ module Muwu
     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

data/lib/muwu/publish/publish.rb

@@ -0,0 +1,47 @@
+module Muwu
+  class Publish
+    
+    
+    include Muwu
+    
+    
+    def initialize(project)
+      @documents_css = project.manifest.documents_css
+      @documents_html = project.manifest.documents_html
+      @documents_js = project.manifest.documents_js
+      @local = project.working_directory
+      @project = project
+      @remote = project.options.remote_publish
+      
+    end
+    
+    
+    def up
+      if @project.exceptions_include?(ProjectException::OptionRemotePublishValueNil)
+        raise ProjectExceptionHandler::Fatal.new(ProjectException::OptionRemotePublishValueNil.new)
+      else    
+        filenames = []
+        filenames << @documents_css.map { |d| d.filename }
+        filenames << @documents_html.map { |d| d.filename }
+        filenames << @documents_js.map { |d| d.filename }
+        filenames.flatten.each { |f| scp f }
+      end
+    end
+    
+    
+    private
+    
+    
+    def scp(filename)
+      filename_local = File.join(@local, filename)
+      filename_remote = File.join(@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_contents.rb

@@ -1,7 +1,10 @@
 module Muwu
   module RenderHtmlPartial
     class Contents
-  
+
+
+      require 'cgi'
+
 
       include Muwu
         

data/lib/muwu/sync/sync.rb

@@ -0,0 +1,69 @@
+module Muwu
+  class Sync
+
+
+    include Muwu
+    
+    
+    def initialize(project, args: [])
+      @local = project.working_directory + File::SEPARATOR
+      @project = project
+      @remote = project.options.remote_sync
+      
+      switches = ['i','r','v']
+      @args = args.map { |a| a.to_s.downcase }
+      if @args.include?('dry-run')
+        @dry_run = true
+        switches << 'n'
+      end
+      @switches = switches.sort.join
+    end
+    
+    
+    public
+    
+    
+    def down
+      if @project.exceptions_include?(ProjectException::OptionRemoteSyncValueNil)
+        raise ProjectExceptionHandler::Fatal.new(ProjectException::OptionRemoteSyncValueNil.new)
+      else
+        source = @remote
+        target = @local
+        exec_sync(source: @remote, target: @local)
+      end
+    end
+    
+    
+    def up
+      if @project.exceptions_include?(ProjectException::OptionRemoteSyncValueNil)
+        raise ProjectExceptionHandler::Fatal.new(ProjectException::OptionRemoteSyncValueNil.new)
+      else
+        source = @local
+        target = @remote
+        exec_sync(source: @local, target: @remote)
+      end
+    end
+
+
+
+    private
+    
+    
+    def exec_sync(source: nil, target: nil)
+      if source && target
+        puts "source: #{source.inspect}"
+        puts "target: #{target.inspect}"
+        puts "args: #{@args}"
+        puts "switches: -#{@switches}"
+        begin
+          system "rsync -#{@switches} #{source} #{target}", exception: true
+        rescue Errno::ENOENT
+          raise ProjectExceptionHandler::Fatal.new(ProjectException::RsyncNotAvailable.new)
+        end
+      end
+    end
+    
+    
+    
+  end
+end

data/lib/muwu_loader.rb

@@ -16,12 +16,14 @@ paths = [
   'project_exception_handler',
   'project_options',
   'project_options_builder',
+  'publish',
   'render_concat',
   'render_html',
   'render_html_builder',
   'render_html_partial',
   'render_html_partial_builder',
   'render_inspector',
+  'sync',
   'var'
 ]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muwu
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 3.0.0.alpha
 platform: ruby
 authors:
 - Eli Harrison
@@ -110,8 +110,10 @@ files:
 - lib/muwu/cli/help/heading
 - lib/muwu/cli/help/inspect
 - lib/muwu/cli/help/new
+- lib/muwu/cli/help/publish
 - lib/muwu/cli/help/reset
 - lib/muwu/cli/help/summary
+- lib/muwu/cli/help/sync
 - lib/muwu/controller/controller.rb
 - lib/muwu/controller/controller_interaction.rb
 - lib/muwu/default/default.rb
@@ -175,12 +177,16 @@ files:
 - lib/muwu/project_exception/navigators_will_be_generated_automatically.rb
 - lib/muwu/project_exception/option_key_not_understood.rb
 - lib/muwu/project_exception/option_not_validatable.rb
+- lib/muwu/project_exception/option_remote_publish_value_nil.rb
+- lib/muwu/project_exception/option_remote_sync_value_nil.rb
 - lib/muwu/project_exception/option_value_not_understood.rb
 - lib/muwu/project_exception/options_file_not_found.rb
 - lib/muwu/project_exception/outline_file_not_found.rb
 - lib/muwu/project_exception/outline_step_not_understood.rb
 - lib/muwu/project_exception/output_already_open.rb
 - lib/muwu/project_exception/output_not_open.rb
+- lib/muwu/project_exception/rsync_not_available.rb
+- lib/muwu/project_exception/scp_not_available.rb
 - lib/muwu/project_exception/subcontents_will_be_generated_automatically copy.rb
 - lib/muwu/project_exception/target_project_folder_already_exists.rb
 - lib/muwu/project_exception/text_source_file_not_found.rb
@@ -190,6 +196,7 @@ files:
 - lib/muwu/project_options_builder/project_option_validator_key.rb
 - lib/muwu/project_options_builder/project_option_validator_value.rb
 - lib/muwu/project_options_builder/project_options_reader.rb
+- lib/muwu/publish/publish.rb
 - lib/muwu/render_concat/render_concat.rb
 - lib/muwu/render_html/render_html.rb
 - lib/muwu/render_html/render_markup_to_html.rb
@@ -222,6 +229,7 @@ files:
 - lib/muwu/render_html_partial_builder/render_text_item_builder.rb
 - lib/muwu/render_html_partial_builder/render_title_builder.rb
 - lib/muwu/render_inspector/render_inspector.rb
+- lib/muwu/sync/sync.rb
 - lib/muwu/var/deflistdiv.rb
 - lib/muwu_loader.rb
 - test/what_no_tests.md
@@ -240,9 +248,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
 signing_key: