RubyGems - k_builder - Versions diffs - 0.0.61 → 0.0.69 - Mend

k_builder 0.0.61 → 0.0.69

Files changed (19) hide show

checksums.yaml +4 -4
data/Sample-original.xml +103 -0
data/Sample.drawio +103 -0
data/Sample.xml +103 -0
data/hooks/pre-commit +2 -0
data/k_builder.gemspec +0 -1
data/lib/k_builder/assets/a.html +235 -0
data/lib/k_builder/assets/b.html +109 -0
data/lib/k_builder/assets/highlight.min.js +1120 -0
data/lib/k_builder/assets/highlight_css +1 -0
data/lib/k_builder/assets/ruby.min.js +7 -0
data/lib/k_builder/base_builder.rb +255 -28
data/lib/k_builder/commands/base_command.rb +36 -0
data/lib/k_builder/commands/code_syntax_highlighter_command.rb +71 -0
data/lib/k_builder/commands/rubo_cop_command.rb +112 -0
data/lib/k_builder/configuration.rb +22 -12
data/lib/k_builder/version.rb +1 -1
data/lib/k_builder.rb +5 -0
metadata +14 -3

data/lib/k_builder/assets/highlight_css ADDED Viewed

	@@ -0,0 +1 @@
1	+ /Users/davidcruwys/dev/slides-addons/highlight_css

data/lib/k_builder/assets/ruby.min.js ADDED Viewed

@@ -0,0 +1,7 @@
+<html>
+<head><title>404 Not Found</title></head>
+<body bgcolor="white">
+<center><h1>404 Not Found</h1></center>
+<hr><center>nginx</center>
+</body>
+</html>

data/lib/k_builder/base_builder.rb CHANGED Viewed

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 module KBuilder
+  # TODO: Why is this called BaseBuilder, why not just builder
+  # TODO: Is this really the builder pattern, it could be the class used by a director
+  #       but it is not really storing information for builder purposes.
+  #
   # Base builder defines builder methods, build method and configuration
   #
   # Convention: Setter methods (are Fluent) and use the prefix set_
   #             Getter methods (are NOT fluent) and return the stored value
   #             Setter methods (are NOT fluent) can be created as needed
   #             these methods would not be prefixed with the set_
+  # process_any_content(content: 'abc')
+  # process_any_content(content_file: 'abc.txt')
+  # process_any_content(template: 'abc {{name}}', name: 'sean')
+  # process_any_content(template_file: 'abc.txt', name: 'sean')
+  # process_any_content(content_gist:  'https://gist.github.com/klueless-io/8d4b6d199dbe4a5d40807a47fff8ed1c')
+  # process_any_content(template_gist: 'https://gist.github.com/klueless-io/8d4b6d199dbe4a5d40807a47fff8ed1c', name: 'sean')
   class BaseBuilder
     include KLog::Logging
     attr_reader :configuration
     attr_accessor :target_folders
     attr_accessor :template_folders
+    attr_accessor :last_output_file
+    attr_accessor :last_output_folder
+    # attr_accessor :last_template
+    attr_accessor :last_template_file
     # Factory method that provides a builder for a specified structure
     # runs through a configuration block and then builds the final structure
     #
@@ -59,6 +76,7 @@ module KBuilder
       }
     end
+    # rubocop:disable Metrics/AbcSize
     def debug
       log.subheading 'kbuilder'
@@ -69,8 +87,16 @@ module KBuilder
       log.info ''
       template_folders.debug(title: 'template folders (search order)')
+      log.info ''
+      log.kv 'last output file'     , last_output_file
+      log.kv 'last output folder'   , last_output_folder
+      # log.kv 'last template'        , last_template
+      log.kv 'last template file'   , last_template_file
       ''
     end
+    # rubocop:enable Metrics/AbcSize
     # ----------------------------------------------------------------------
     # Fluent interface
@@ -95,31 +121,108 @@ module KBuilder
     # Extra options will be used as data for templates, e.g
     # @option opts [String] :to Recipient email
     # @option opts [String] :body The email's body
+    def add_file_action(file, **opts)
+      {
+        action: :add_file,
+        played: false,
+        file: file,
+        opts: opts
+      }
+    end
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def add_file(file, **opts)
       # move to command
-      full_file = opts.key?(:folder_key) ? target_file(file, folder: opts[:folder_key]) : target_file(file)
+      full_file = target_file(file, **opts) # opts.key?(:folder_key) || opts.key?(:folder) ? target_file(file, folder: opts[:folder], folder_key: opts[:folder_key]) : target_file(file)
       # Need logging options that can log these internal details
-      FileUtils.mkdir_p(File.dirname(full_file))
+      mkdir_p(File.dirname(full_file))
       content = process_any_content(**opts)
-      File.write(full_file, content)
+      file_write(full_file, content, on_exist: opts[:on_exist])
       # Prettier needs to work with the original file name
-      run_prettier file if opts.key?(:pretty)
+      run_prettier file                   if opts.key?(:pretty)
+      # TODO: Add test
+      run_cop(full_file, fix_safe: true)  if opts.key?(:cop) || opts.key?(:ruby_cop)
       # Need support for rubocop -a
+      open_file(last_output_file)         if opts.key?(:open)
+      open_file(last_template_file)       if opts.key?(:open_template)
+      browse_file(last_output_file)       if opts.key?(:browse)
+      pause(opts[:pause])                 if opts[:pause]
       self
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def play_actions(actions)
+      actions.reject { |action| action[:played] }.each do |action|
+        play_action(action)
+      end
+    end
+    def play_action(action)
+      case action[:action]
+      when :add_file
+        add_file(action[:file], action[:opts])
+      when :delete_file
+        delete_file(action[:file], action[:opts])
+      when :vscode
+        vscode(action[:file_parts], action[:opts])
+      when :browse
+        browse(action[:file_parts], action[:opts])
+      when :set_current_folder
+        set_current_folder(action[:folder_key])
+      when :run_command
+        run_command(action[:command])
+      else
+        log.error "Unknown action: #{action[:action]}"
+      end
+      action[:played] = true
+    end
     alias touch add_file # it is expected that you would not supply any options, just a file name
+    def delete_file_action(file, **opts)
+      {
+        action: :delete_file,
+        played: false,
+        file: file,
+        opts: opts
+      }
+    end
+    def delete_file(file, **opts)
+      full_file = target_file(file, **opts) # = opts.key?(:folder_key) ? target_file(file, folder: opts[:folder_key]) : target_file(file)
+      File.delete(full_file) if File.exist?(full_file)
+      self
+    end
+    def file_exist?(file, **opts)
+      # full_file = opts.key?(:folder_key) ? target_file(file, folder_key: opts[:folder_key]) : target_file(file)
+      full_file = target_file(file, **opts)
+      File.exist?(full_file)
+    end
+    # ToDo
+    # def delete_folder(file)
+    #   FileUtils.remove_dir(path_to_directory) if File.directory?(path_to_directory)
+    #   self
+    # end
     def make_folder(folder_key = nil, sub_path: nil)
       folder_key  = current_folder_key if folder_key.nil?
       folder      = target_folder(folder_key)
       folder      = File.join(folder, sub_path) unless sub_path.nil?
-      FileUtils.mkdir_p(folder)
+      mkdir_p(folder)
       self
     end
@@ -140,6 +243,8 @@ module KBuilder
       begin
         IO.popen('pbcopy', 'w') { |f| f << content }
+        open_file(last_template_file) if opts.key?(:open_template)
       rescue Errno::ENOENT => e
         if e.message == 'No such file or directory - pbcopy'
           # May want to use this GEM in the future
@@ -152,15 +257,84 @@ module KBuilder
     end
     alias clipboard_copy add_clipboard
-    def vscode(*file_parts, folder: current_folder_key)
+    def vscode_action(*file_parts, folder_key: current_folder_key, file: nil)
+      {
+        action: :vscode,
+        played: false,
+        file_parts: file_parts,
+        opts: { folder_key: folder_key, file: file }
+      }
+    end
+    def vscode(*file_parts, folder_key: current_folder_key, file: nil)
       # move to command
-      file = target_file(*file_parts, folder: folder)
+      file = target_file(*file_parts, folder_key: folder_key) if file.nil?
       rc "code #{file}"
       self
     end
+    def browse_action(*file_parts, folder_key: current_folder_key, file: nil)
+      {
+        action: :browse,
+        played: false,
+        file_parts: file_parts,
+        opts: { folder_key: folder_key, file: file }
+      }
+    end
+    def browse(*file_parts, folder_key: current_folder_key, file: nil)
+      # move to command
+      file = target_file(*file_parts, folder_key: folder_key) if file.nil?
+      rc "open -a \"Google Chrome\" #{file}"
+      self
+    end
+    def open
+      open_file(last_output_file)
+      self
+    end
+    alias o open
+    def open_template
+      open_file(last_template_file)
+      self
+    end
+    alias ot open_template
+    def open_file(file)
+      if file.nil?
+        log.warn('open_file will not open when file is nil')
+        return self
+      end
+      vscode(file: file)
+      self
+    end
+    def browse_file(file)
+      if file.nil?
+        log.warn('browse_file will not browse when file is nil')
+        return self
+      end
+      browse(file: file)
+      self
+    end
+    def pause(seconds = 1)
+      sleep(seconds)
+      self
+    end
     # ----------------------------------------------------------------------
     # Attributes: Think getter/setter
     #
@@ -174,6 +348,14 @@ module KBuilder
     # Target folders and files
     # ----------------------------------------------------------------------
+    def set_current_folder_action(folder_key)
+      {
+        action: :set_current_folder,
+        played: false,
+        folder_key: folder_key
+      }
+    end
     def set_current_folder(folder_key)
       target_folders.current = folder_key
@@ -216,12 +398,18 @@ module KBuilder
     #   target_file('/abc.txt')
     #   target_file('/xyz/abc.txt')
     #   target_file('/xyz', 'abc.txt')
-    def target_file(*file_parts, folder: current_folder_key)
+    def target_file(*file_parts, folder_key: current_folder_key, folder: nil, **)
+      # TODO: Mismatch (sometimes called folder, sometimes called folder_key:)
+      if folder
+        log.error("Change folder: to folder_key: for #{folder} - #{file_parts}")
+        return
+      end
       # Absolute path
       return File.join(*file_parts) if Pathname.new(file_parts.first).absolute?
-      # Relative to :folder
-      File.join(target_folder(folder), *file_parts)
+      # Relative to :folder_key
+      File.join(target_folder(folder_key), *file_parts)
     end
     # Template folder & Files
@@ -242,7 +430,8 @@ module KBuilder
     # Gets a template_file relative to the template folder, looks first in
     # local template folder and if not found, looks in global template folder
     def find_template_file(file_parts)
-      template_folders.find_file(file_parts)
+      self.last_template_file = template_folders.find_file(file_parts)
+      last_template_file
     end
     # Building content from templates
@@ -268,15 +457,6 @@ module KBuilder
       return "content not found: #{opts[:content_file]}" if cf.nil?
-      # cf = opts[:content_file]
-      # unless File.exist?(cf)
-      #   cf_from_template_folders = find_template_file(cf)
-      #   return "Content not found: #{File.expand_path(cf)}" unless File.exist?(cf_from_template_folders)
-      #   cf = cf_from_template_folders
-      # end
       File.read(cf)
     end
@@ -320,13 +500,11 @@ module KBuilder
       Handlebars::Helpers::Template.render(template_content, opts) unless template_content.nil?
     end
-    def run_cop(file, auto_safe: false, auto_all: false)
-      cli = RuboCop::CLI.new
-      opts = ['--format', 'simple', file]
-      opts.prepend('-a') if auto_safe
-      opts.prepend('-A') if auto_all
+    def run_cop(file, **opts)
+      command = Commands::RuboCopCommand.new(file, builder: self, **opts)
+      command.execute
-      cli.run(opts)
+      self
     end
     # Need to handle absolute files, see
@@ -342,7 +520,7 @@ module KBuilder
       # Deep path create if needed
       tf = target_folder
-      FileUtils.mkdir_p(tf)
+      mkdir_p(tf)
       build_command = "cd #{tf} && #{command}"
@@ -353,5 +531,54 @@ module KBuilder
       system(build_command)
     end
     alias rc run_command
+    def run_command_action(command)
+      {
+        action: :run_command,
+        played: false,
+        command: command
+      }
+    end
+    def file_write(file, content, on_exist: :skip)
+      self.last_output_file = file # if file not found, we still want to record this as the last_output_file
+      not_found = !File.exist?(file)
+      if not_found
+        File.write(file, content)
+        return
+      end
+      return if %i[skip ignore].include?(on_exist)
+      if %i[overwrite write].include?(on_exist)
+        File.write(file, content)
+        return
+      end
+      return unless on_exist == :compare
+      vscompare(file, content)
+    end
+    def vscompare(file, content)
+      # need to use some sort of caching folder for this
+      ext = File.extname(file)
+      fn  = File.basename(file, ext)
+      temp_file = Tempfile.new([fn, ext])
+      temp_file.write(content)
+      temp_file.close
+      return if File.read(file) == content
+      system("code -d #{file} #{temp_file.path}")
+      sleep 2
+    end
+    def mkdir_p(folder)
+      @last_output_folder = FileUtils.mkdir_p(folder).first
+    end
   end
 end

data/lib/k_builder/commands/base_command.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module KBuilder
+  module Commands
+    # Base command for single responsibility actions that can be fired
+    # from methods in the builder.
+    #
+    # Uses the command pattern
+    class BaseCommand
+      include KLog::Logging
+      attr_accessor :builder
+      attr_accessor :valid
+      def initialize(**opts)
+        @builder = opts[:builder]
+        @valid = true
+      end
+      def guard(message)
+        # THIS SHOULD ONLY LOG IF DEBUGGING IS TURNED ON
+        log.error(message)
+        @valid = false
+      end
+      def valid?
+        @valid
+      end
+      def debug(title: nil)
+        log.section_heading(title) if title
+        debug_values if respond_to?(:debug_values)
+      end
+    end
+  end
+end

data/lib/k_builder/commands/code_syntax_highlighter_command.rb ADDED Viewed

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+module KBuilder
+  module Commands
+    # Run CodeSyntaxHighlighter against source code and produce a styled HTML representation
+    #
+    # Alternatives to Highlighter-js could be carbon-now and ray.so
+    class CodeSyntaxHighlighterCommand < BaseCommand
+      attr_reader :source_code
+      attr_reader :formatted_code
+      def initialize(source_code, **opts)
+        super(**opts)
+        self.source_code = source_code
+      end
+      def execute
+        return unless valid?
+        run
+      end
+      private
+      def source_code=(value)
+        @source_code = value
+        guard('Source code is required for formatting') if value.nil? || value.empty?
+      end
+      def run
+        # @formatted_code = ExecJS.eval("'red yellow blue'.split(' ')")
+        # # highlight_source = 'lib/k_builder/assets/a.js'
+        # highlight_source = 'lib/k_builder/assets/highlight.min.js'
+        # log.error ExecJS.runtime.name
+        # a = File.read(highlight_source)
+        # # context = ExecJS.compile(a)
+        # context = ExecJS.compile(highlight_source)
+        # context.call("html = hljs.highlightAuto('<h1>Hello World!</h1>').value")
+        # get_js_asset('highlight')
+        # get_js_asset('ruby')
+      end
+      # https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/highlight.min.js
+      # https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/languages/ruby.min.js
+      def get_js_asset(name)
+        url = "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.0.1/#{name}.min.js"
+        target_folder = 'lib/k_builder/assets'
+        file = "#{name}.min.js"
+        get_asset(url, target_folder, file)
+      end
+      def get_asset(url, target_folder, file)
+        local_asset_file = File.join(target_folder, file)
+        return if File.exist?(local_asset_file)
+        content = Net::HTTP.get(URI.parse(url))
+        File.write(local_asset_file, content)
+      end
+    end
+  end
+end

data/lib/k_builder/commands/rubo_cop_command.rb ADDED Viewed

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+module KBuilder
+  module Commands
+    # Run RuboCop against a file
+    class RuboCopCommand < BaseCommand
+      attr_reader :file_pattern
+      attr_reader :fix_safe
+      attr_reader :fix_unsafe
+      attr_reader :rubo_config_file
+      attr_reader :show_console
+      attr_reader :cop_options
+      attr_reader :cop_opt_values
+      # Initialize RuboCop command
+      #
+      # @param [String] file_pattern File name or file pattern
+      # @param [Hash] **opts The options
+      # @option opts [Boolean] :fix_safe RuboCop -a option will fix simple and safe issues
+      # @option opts [Boolean] :fix_unsafe RuboCop -A option will fix simple but potentially unsafe issues
+      # @option opts [Boolean] :show_console This will show in console, or if false set --out ~/last_cop.txt so that console is redirected to file
+      # @option opts [String] :rubo_config_file YAML file with RuboCop configuration options
+      #
+      # @example Cop for single file with auto fix turned on for simple issues
+      #
+      #   RubCopCommand.new('abc.rb', fix_safe: true)
+      #
+      # @example Cop for all spec files to auto simple and unsafe issues
+      #
+      #   RubCopCommand.new('spec/**/*.rb', fix_unsafe: true)
+      def initialize(file_pattern, **opts)
+        super(**opts)
+        @valid = true
+        self.file_pattern       = file_pattern
+        self.fix_safe           = opts[:fix_safe]
+        self.fix_unsafe         = opts[:fix_unsafe]
+        self.show_console       = opts[:show_console]
+        self.rubo_config_file   = opts[:rubo_config_file]
+      end
+      def execute
+        return unless valid?
+        cop_run
+      end
+      def cli_options
+        cli_options = []
+        # quite is the same as simple, except you will see nothing if no offenses
+        cli_options << '--format' << 'quiet' # 'simple'
+        cli_options << '-a' if fix_safe
+        cli_options << '-A' if fix_unsafe
+        cli_options << '--config' << rubo_config_file if rubo_config_file
+        cli_options << '--out' << File.expand_path('~/last_cop.txt') unless show_console
+        cli_options << file_pattern
+        cli_options
+      end
+      def debug_values
+        log.kv 'rubocop target', file_pattern
+        log.kv '-a', 'automatic fix for safe issues'                  if fix_safe
+        log.kv '-A', 'automatic fix for potentially unsafe issues'    if fix_unsafe
+        log.kv '-config', rubo_config_file                            if rubo_config_file
+      end
+      private
+      def file_pattern=(value)
+        @file_pattern = value
+        if value.nil? || value.empty?
+          guard 'file_pattern is required'
+        elsif Pathname.glob(value).length.zero?
+          guard 'file_pattern does not reference an existing file'
+        end
+      end
+      def fix_safe=(value)
+        @fix_safe = value || false
+      end
+      def fix_unsafe=(value)
+        @fix_unsafe = value || false
+      end
+      def show_console=(value)
+        @show_console = value || false
+      end
+      def rubo_config_file=(value)
+        @rubo_config_file = value
+        return if value.nil? || value.empty?
+        guard("Unknown RuboCop config file: #{value}") unless File.exist?(value)
+      end
+      def cop_run
+        cli = RuboCop::CLI.new
+        # log.section_heading('CLI OPTIONS')
+        # log.block cli_options
+        cli.run(cli_options)
+      end
+    end
+  end
+end

data/lib/k_builder/configuration.rb CHANGED Viewed

@@ -5,18 +5,24 @@ module KBuilder
   # Configuration for webpack5/builder
   class << self
     attr_writer :configuration
-  end
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+    def configuration(name = :default)
+      @configuration ||= Hash.new do |h, key|
+        h[key] = KBuilder::Configuration.new
+      end
+      @configuration[name]
+    end
-  def self.reset
-    @configuration = Configuration.new
-  end
+    def reset(name = :default)
+      @configuration ||= Hash.new do |h, key|
+        h[key] = KBuilder::Configuration.new
+      end
+      @configuration[name] = KBuilder::Configuration.new
+    end
-  def self.configure
-    yield(configuration)
+    def configure(name = :default)
+      yield(configuration(name))
+    end
   end
   # Does this class need to move out into k_types?
@@ -48,12 +54,16 @@ module KBuilder
       @template_folders = orig.template_folders.clone
     end
-    def debug
-      log.subheading 'kbuilder base configuration'
+    def debug(heading: 'kbuilder base configuration')
+      log.section_heading 'kbuilder base configuration' if heading
+      # TODO: Add name to configuration object
+      # Don't have support for name on the configuration object yet
+      # log.kv 'config name', name
       target_folders.debug(title: 'target_folders')
-      log.info ''
+      # log.info ''
       template_folders.debug(title: 'template folders (search order)')
       ''