muwu 2.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dafa3354f3a57677adacf16fe9372167ce2572b68e445fb0f95192142c116633
+  data.tar.gz: 83130270c6bcfbbb7c3fd46a3cc8825441999eae801dd1ba15368acffc315464
+SHA512:
+  metadata.gz: 8a036a78dd8a1ef10f0776a7d014c4e953ababeb0ca154e0718499a8252b06b3b4a708fa9c4542803a986e70f0fdad4bef8e9997b541eabb9f01858f82118722
+  data.tar.gz: 819c5595a937ff67464e3829b0243d86a2cf3b429bcadf232dfc13eea7995d9c6fe583c48f39555479597a66ebc4cff2dc95eb199693ffd10dcb3d9850a281df

data/bin/muwu

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/muwu.rb'
+
+Muwu::Cli.new(ARGV).evaluate_arguments

data/lib/muwu.rb

@@ -0,0 +1,38 @@
+module Muwu
+
+
+  VERSION = '2.5.1'
+
+  GEM_HOME_LIB = File.absolute_path(File.join(File.dirname(__FILE__)))
+  GEM_HOME_LIB_MUWU = File.absolute_path(File.join(GEM_HOME_LIB, 'muwu'))
+
+
+  require 'commonmarker'
+  require 'fileutils'
+  require 'haml'
+  require 'iso-639'
+  require 'logger'
+  require 'motion-markdown-it'
+  require 'motion-markdown-it-plugins'
+  require 'sassc'
+  require 'yaml'
+
+
+  require_relative 'muwu_loader'
+
+
+
+  module_function
+
+
+  def debug(file, line, info)
+    logger.new(STDERR).debug("#{file} #{line} #{info}")
+  end
+
+
+  def read(path)
+    ProjectReader.build { |b| b.load_path(path) }
+  end
+
+
+end

data/lib/muwu/cli/cli.rb

@@ -0,0 +1,143 @@
+module Muwu
+  class Cli
+
+
+    include Muwu
+    
+
+    def initialize(args)
+      @args = args.map do |a|
+        case a
+        when nil
+          nil
+        else
+          a.downcase.strip
+        end
+      end
+      
+      @current_working_directory = Dir.pwd
+    end
+
+
+
+    public
+
+
+    def evaluate_arguments
+      if @args == []
+        puts CliHelp.new(:summary).message
+      elsif @args != []
+        case @args[0]
+        when 'compile'
+          evaluate_command_compile
+        when 'concat'
+          evaluate_command_concat
+        when 'help'
+          evaluate_command_help
+        when 'inspect'
+          evaluate_command_inspect
+        when 'new'
+          evaluate_command_new
+        when 'reset'
+          evaluate_command_reset
+        when '--version'
+          puts VERSION
+        else
+          puts CliHelp.new(:summary).message
+        end
+      end
+    end
+
+
+
+    private
+
+
+    def evaluate_command_compile
+      if @args[1] == nil
+        Controller.new(@current_working_directory).compile
+
+      elsif @args[1] == 'css'
+        Controller.new(@current_working_directory).compile_css
+        
+      elsif @args[1] == 'html'
+        evaluate_command_compile_html
+
+      elsif @args[1] == 'js'
+        Controller.new(@current_working_directory).compile_js
+
+      else
+        puts CliHelp.new(:compile).message
+      end
+    end
+    
+    
+    def evaluate_command_compile_html
+      if @args[2] == nil
+        Controller.new(@current_working_directory).compile_html
+        
+      elsif @args[2] =~ /\A[0-9]+\z/
+        Controller.new(@current_working_directory).compile_html_by_index(@args[2].to_i)
+
+      else
+        puts CliHelp.new(:compile).message
+      end
+    end
+    
+    
+    def evaluate_command_concat
+      Controller.new(@current_working_directory).concat
+    end
+      
+
+
+    def evaluate_command_help
+      if @args[1] == nil
+        puts CliHelp.new(:summary).message
+
+      else
+        case @args[1]
+        when 'compile'
+          puts CliHelp.new(:compile).message
+        when 'concat'
+          puts CliHelp.new(:concat).message
+        when 'inspect'
+          puts CliHelp.new(:inspect).message
+        when 'new'
+          puts CliHelp.new(:new).message
+        when 'reset'
+          puts CliHelp.new(:reset).message
+        else
+          puts CliHelp.new(:summary).message
+        end
+      end
+    end
+
+
+    def evaluate_command_inspect
+      Controller.new(@current_working_directory).inspect
+    end
+
+
+    def evaluate_command_new
+      Controller.new(@current_working_directory).new_project
+    end
+
+
+    def evaluate_command_reset
+      if @args[1] == nil
+        puts CliHelp.new(:reset).message
+        
+      else
+        case @args[1]
+        when 'css'
+          Controller.new(@current_working_directory).reset_css
+        else
+          puts CliHelp.new(:reset).message
+        end
+      end
+    end
+    
+
+  end
+end

data/lib/muwu/cli/cli_help.rb

@@ -0,0 +1,28 @@
+module Muwu
+  class CliHelp
+
+
+      def initialize(message)
+        @heading = File.open(File.join(GEM_HOME_LIB_MUWU,'cli/help/heading')).read.strip
+        @version = "#{version_statement}\n"
+        @message = File.open(File.join(GEM_HOME_LIB_MUWU,'cli/help',message.to_s.downcase)).read.strip
+      end
+
+
+      def message
+        [@heading, @version, @message].join("\n")
+      end
+
+
+
+      private
+
+
+      def version_statement
+        "\# version #{VERSION}"
+      end
+
+
+  end
+end
+

data/lib/muwu/cli/help/compile

@@ -0,0 +1,22 @@
+- muwu compile
+  - Compile all parts of the the project located in the current working
+    directory.
+
+- muwu compile css
+  - Compile only the stylesheet for the project.
+
+- muwu compile html
+  - Compile only the html file(s) for the project.
+
+- muwu compile html [index]
+  - Compile only a single outlined content document, indicated by
+    [index]. Use the command `muwu inspect` to determine the index
+    number of a document.
+
+- muwu compile js
+  - Compile only the javascript library (if applicable) for the project.
+
+* Compiling a project will overwrite any previous output files without
+  any warning. 
+  
+* You can specify output filenames in `options.yml`.

data/lib/muwu/cli/help/concat

@@ -0,0 +1,8 @@
+- muwu concat
+  - Combine all source files from the outline into a single markdown
+    document.
+    
+* Compiling a project will overwrite any previous output files without
+  any warning. 
+
+* This feature is still experimental.  

data/lib/muwu/cli/help/heading

@@ -0,0 +1,2 @@
+# muwu - Markup Writeup
+# Compiles markup files (Markdown and YAML) into an HTML document

data/lib/muwu/cli/help/inspect

@@ -0,0 +1,7 @@
+- muwu inspect
+  - Inspect the project in the current working directory, and show details
+    about the project, the project outline, and the project manifest (the list
+    of documents that would be produced by the command `muwu compile`.)
+  
+* Inspecting a project does not create or overwrite any files.
+  

data/lib/muwu/cli/help/new

@@ -0,0 +1,8 @@
+- muwu new
+  - Create a new project as a subdirectory from the current working directory.
+    Muwu will ask for a directory name. If the directory does not exist, Muwu
+    will create it and fill it with a blank new project.
+  
+* Only alphanumeric (a-z, A-Z, 0-9) and underscore (_) characters are allowed
+  in the directory name.
+  

data/lib/muwu/cli/help/reset

@@ -0,0 +1,14 @@
+- reset css
+  - Reset the `config/css` folder. The following files and folders will
+    revert to their original state:
+    
+    - config/css/base/
+    - config/css/colors/dark.scss
+    - config/css/colors/index.scss
+    - config/css/colors/light.scss
+    - config/css/index.scss
+
+  * If `config/css/extensions` does exist, it and its contents will remain
+    unchanged.
+    
+  * If `config/css/extensions` does not exist, Muwu will create it.

data/lib/muwu/cli/help/summary

@@ -0,0 +1,14 @@
+"muwu – Because sometimes WYSIWYG is not WYW."
+
+Command line:
+  muwu compile          compile a project into an HTML document suite
+  muwu concat           combine all source text into a single .md file
+  muwu help             show this message
+  muwu inspect          inspect a project
+  muwu new              create a new project directory
+  muwu reset css        reset the default CSS files
+
+All comands operate within the current working directory.
+
+For more detailed instructions:
+  muwu help [command]

data/lib/muwu/controller/controller.rb

@@ -0,0 +1,120 @@
+module Muwu
+  class Controller
+
+
+    include Muwu
+    
+
+    def initialize(current_working_directory)
+      @current_working_directory = File.absolute_path(current_working_directory)
+      @project = nil
+    end
+
+
+
+    public
+
+
+    def compile
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderHtml.new(@project).render
+      end
+    end
+    
+    
+    def compile_css
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderHtml.new(@project).render_css_only
+      end
+    end
+    
+    
+    def compile_html_by_index(index)
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderHtml.new(@project).render_html_by_index(index)
+      end
+    end
+    
+
+    def compile_html
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderHtml.new(@project).render_html_only
+      end
+    end
+    
+    
+    def compile_js
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderHtml.new(@project).render_js_only
+      end
+    end
+    
+    
+    def concat
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderConcat.new(@project).render
+      end
+    end
+    
+    
+    def inspect
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      else
+        RenderInspector.new(@project).render_inspector
+      end
+    end
+
+
+    def new_project
+      metadata = ControllerInteraction.new.request_metadata
+      @project = ProjectStarter.new(@current_working_directory, metadata).new_project
+      ProjectWriter.new(@project).write
+    end
+    
+    
+    def reset_css
+      @project = read_project_from_current_working_directory
+      if @project.does_not_have_crucial_files
+        reply_folder_does_not_have_valid_project
+      elsif ControllerInteraction.new.confirm_reset_css(@project)
+        ProjectResetCss.new(@project).reset_css
+      end
+    end
+
+
+
+    private
+        
+    
+    def read_project_from_current_working_directory
+      ProjectReader.build { |b| b.load_path(@current_working_directory) }
+    end
+
+
+    def reply_folder_does_not_have_valid_project
+      puts @project.exceptions
+      puts "Is this a Muwu project folder?"
+    end
+
+  end
+end

data/lib/muwu/controller/controller_interaction.rb

@@ -0,0 +1,146 @@
+module Muwu
+  class ControllerInteraction
+
+
+    attr_accessor :slug
+
+
+    def initialize
+      @slug = ''
+    end
+    
+    
+    
+    public
+    
+    
+    def confirm_reset_css(project)
+      render_reset_css_heading(project)
+      render_reset_css_prompt
+      @answer = $stdin.gets.chomp.strip.downcase
+      if @answer == 'y'
+        return true
+      else
+        return false
+      end
+    end
+    
+    
+    def request_metadata
+      request_metadata_phase_1_render_heading
+      request_metadata_phase_2_request_and_set_slug
+      { slug: @slug }
+    end
+    
+    
+    def request_metadata_phase_1_render_heading
+      render_new_project_heading
+      render_lf
+    end
+    
+    
+    def request_metadata_phase_2_request_and_set_slug
+      render_slug_heading
+      while @slug == ''
+        render_slug_can_not_be_blank
+        render_slug_prompt
+        @slug = $stdin.gets.chomp.strip
+        if @slug.match(/\W/)
+          @slug.gsub!(/\W/,'')
+          render_slug_was_sanitized(result: @slug)
+        end
+      end
+      render_lf
+    end
+        
+    
+    
+    private
+    
+    
+    
+    def determine_reset_css_files(project)
+      [
+        File.join(project.path_css_base),
+        File.join(project.path_css_colors, 'dark.scss'),
+        File.join(project.path_css_colors, 'index.scss'),
+        File.join(project.path_css_colors, 'light.scss'),
+        File.join(project.path_css, 'index.scss'),
+      ]
+    end
+        
+
+    def render_lf
+      puts "\n"
+    end
+    
+    
+    def render_new_project_heading
+      puts '# Muwu'
+      puts '# New Project'
+    end
+    
+    
+    def render_reset_css_heading(project)
+      puts '# Muwu'
+      puts '# Reset CSS'
+      puts 
+      puts '- This will reset the following files and folders to their original state:'
+      puts 
+      determine_reset_css_files(project).each do |file|
+        puts "  - #{file}"
+      end
+      puts
+      puts "* If #{project.path_css_extensions} does not exist, it will be created."
+      puts '  Otherwise, its existing contents will remain unchanged.'
+      puts
+    end
+    
+    
+    def render_reset_css_prompt
+      print '> Continue with CSS reset? (y/N) '
+    end
+    
+    
+    def render_slug_heading
+      puts '# Project Directory Name'
+      puts '- Word characters `[a-zA-Z0-9_]` only; non-word characters will be removed.'
+    end
+    
+    
+    def render_slug_prompt
+      print '> Directory Name for project: '
+    end
+    
+    
+    def render_slug_can_not_be_blank
+      puts '- Directory Name can not be blank.'
+    end
+    
+    
+    def render_slug_was_sanitized(result: nil)
+      puts '- Directory Name contained non-word characters that were removed.'
+      if result
+        puts "  - Modified Directory Name: `#{result}`"
+      end
+    end
+    
+    
+    def render_title_heading
+      puts "\n"
+      puts '# Project Title'
+    end
+    
+    
+    def render_title_prompt
+      print '> Title of project: '
+    end
+    
+    
+    def render_title_can_not_be_blank
+      puts '- Title can not be blank.'
+    end
+
+
+  end
+end