natty-ui 0.30.0 → 0.31.0

data/lib/natty-ui/theme.rb

@@ -11,342 +11,386 @@ module NattyUI
     class << self
       # Currently used theme
       #
-      # @return [Compiled]
+      # @return [Theme]
       attr_reader :current
 
-      # @attribute [w] current
-      def current=(value)
-        case value
-        when Theme::Compiled
-          @current = value
-        when Theme
-          @current = value.compiled
-        else
-          raise(TypeError, 'Theme expected')
-        end
-      end
-
-      # Create a theme.
+      # Name of currently used theme
       #
-      # @return [Theme] new theme
-      def create
-        theme = new
-        yield(theme) if block_given?
-        theme
-      end
+      # @return [Symbol]
+      attr_reader :current_name
 
-      # Default theme.
+      # Names of all registered themes
       #
-      # @attribute [r] default
-      # @return [Theme] default theme
-      def default
-        create do |theme|
-          theme.heading_sytle = :bright_blue
-          theme.task_style = %i[bright_green b]
-          # theme.choice_style =
-          theme.choice_current_style = %i[bright_white on_blue b]
-          theme.define_marker(
-            bullet: '[bright_white]•[/fg]',
-            checkmark: '[bright_green]✓[/fg]',
-            quote: '[bright_blue]▍[/fg]',
-            information: '[bright_yellow]𝒊[/fg]',
-            warning: '[bright_yellow]![/fg]',
-            error: '[red]𝙓[/fg]',
-            failed: '[bright_red]𝑭[/fg]',
-            current: '[bright_green]➔[/fg]',
-            choice: '[bright_white]◦[/fg]',
-            current_choice: '[bright_green]➔[/fg]'
-          )
-          theme.define_section(
-            default: :bright_blue,
-            message: :bright_blue,
-            information: :bright_blue,
-            warning: :bright_yellow,
-            error: :red,
-            failed: :bright_red
-          )
-        end
-      end
+      # @attribute [r] names
+      # @return [Array<Symbol>]
+      def names = @ll.keys.sort!
 
-      def emoji
-        create do |theme|
-          theme.heading_sytle = :bright_blue
-          theme.task_style = %i[bright_green b]
-          # theme.choice_style =
-          theme.choice_current_style = %i[bright_white on_blue b]
-          theme.define_marker(
-            bullet: '▫️',
-            checkmark: '✅',
-            quote: '[bright_blue]▍[/fg]',
-            information: '📌',
-            warning: '⚠️',
-            error: '❗️',
-            failed: '‼️',
-            current: '➡️',
-            choice: '[bright_white]•[/fg]',
-            current_choice: '[bright_green]●[/fg]'
-          )
-          theme.define_section(
-            default: :bright_blue,
-            message: :bright_blue,
-            information: :bright_blue,
-            warning: :bright_yellow,
-            error: :red,
-            failed: :bright_red
-          )
+      # Use a theme
+      #
+      # @param name [Symbol]
+      # @return [Symbol] name of used theme
+      def use(name)
+        sel = find(name).last
+        if sel.is_a?(Proc)
+          sel[builder = Builder.new]
+          sel = @ll[name][-1] = builder.build.freeze
         end
+        @current = sel
+        @current_name = name
       end
-    end
 
-    attr_accessor :section_border
-    attr_reader :mark,
-                :border,
-                :heading,
-                :heading_sytle,
-                :section_styles,
-                :task_style,
-                :choice_current_style,
-                :choice_style
+      # Get the descrition of a theme.
+      #
+      # @param name [Symbol]
+      # @return [String] description of the theme
+      def description(name) = find(name).first
 
-    def heading_sytle=(value)
-      @heading_sytle = Utils.style(value)
-    end
+      # Register a theme
+      #
+      # @param name [Symbol] theme name
+      # @param description [#to_s] theme description
+      # @yieldparam builder [Builder] theme build helper
+      # @return [Theme] itself
+      def register(name, description = nil, &block)
+        raise(ArgumentError, 'block missing') unless block
+        @ll[name.to_sym] = [description&.to_s || name.to_s.capitalize, block]
+        self
+      end
 
-    def task_style=(value)
-      @task_style = Utils.style(value)
-    end
+      private
 
-    def choice_current_style=(value)
-      @choice_current_style = Utils.style(value)
+      def find(name)
+        @ll.fetch(name) { raise(ArgumentError, "no such theme - #{name}") }
+      end
     end
 
-    def choice_style=(value)
-      @choice_style = Utils.style(value)
-    end
+    # @todo This chapter needs more documentation.
+    #
+    # Helper class to define a {Theme}.
+    #
+    class Builder
+      attr_accessor :section_border
+      attr_reader :mark,
+                  :border,
+                  :heading,
+                  :heading_sytle,
+                  :section_styles,
+                  :task_style,
+                  :choice_current_style,
+                  :choice_style,
+                  :sh_out_style,
+                  :sh_err_style
 
-    def compiled = Compiled.new(self).freeze
+      def heading_sytle=(value)
+        @heading_sytle = Utils.style(value)
+      end
 
-    def define_marker(**defs)
-      @mark.merge!(defs)
-      self
-    end
+      def task_style=(value)
+        @task_style = Utils.style(value)
+      end
 
-    def define_border(**defs)
-      defs.each_pair do |name, str|
-        s = str.to_s
-        case Text.width(s, bbcode: false)
-        when 1
-          @border[name.to_sym] = "#{s * 11}  "
-        when 11
-          @border[name.to_sym] = "#{s}  "
-        when 13
-          @border[name.to_sym] = s
-        else
-          raise(
-            TypeError,
-            "invalid boder definition for #{name} - #{str.inspect}"
-          )
-        end
+      def choice_current_style=(value)
+        @choice_current_style = Utils.style(value)
       end
-      self
-    end
 
-    def define_heading(*defs)
-      @heading = defs.flatten.take(6)
-      @heading += Array.new(6 - @heading.size, @heading[-1])
-      self
-    end
+      def choice_style=(value)
+        @choice_style = Utils.style(value)
+      end
 
-    def define_section(**defs)
-      defs.each_pair do |name, style|
-        style = Utils.style(style)
-        @section_styles[name.to_sym] = style if style
+      def sh_out_style=(value)
+        @sh_out_style = Utils.style(value)
       end
-      self
-    end
 
-    class Compiled
-      attr_reader :task_style,
-                  :choice_current_style,
-                  :choice_style,
-                  :option_states
+      def sh_err_style=(value)
+        @sh_err_style = Utils.style(value)
+      end
 
-      def defined_marks = @mark.keys.sort!
-      def defined_borders = @border.keys.sort!
-      def heading(index) = @heading[index.to_i.clamp(1, 6) - 1]
+      # @return [Theme] new theme
+      def build = Theme.new(self)
 
-      def mark(value)
-        return @mark[value] if value.is_a?(Symbol)
-        (element = Str.new(value, true)).empty? ? @mark[:default] : element
+      def define_marker(**defs)
+        @mark.merge!(defs)
+        self
       end
 
-      def border(value)
-        return @border[value] if value.is_a?(Symbol)
-        case Text.width(value = value.to_s, bbcode: false)
-        when 1
-          "#{value * 11}  "
-        when 11
-          "#{value}  "
-        when 13
-          value
-        else
-          @border[:default]
+      def define_border(**defs)
+        defs.each_pair do |name, str|
+          s = str.to_s
+          case Text.width(s, bbcode: false)
+          when 1
+            @border[name.to_sym] = "#{s * 11}  "
+          when 11
+            @border[name.to_sym] = "#{s}  "
+          when 13
+            @border[name.to_sym] = s
+          else
+            raise(
+              TypeError,
+              "invalid boder definition for #{name} - #{str.inspect}"
+            )
+          end
         end
+        self
       end
 
-      def section_border(kind)
-        kind.is_a?(Symbol) ? @sections[kind] : @sections[:default]
+      def define_heading(*defs)
+        @heading = defs.flatten.take(6)
+        @heading += Array.new(6 - @heading.size, @heading[-1])
+        self
       end
 
-      def initialize(theme)
-        @heading = create_heading(theme.heading, theme.heading_sytle).freeze
-        @border = create_border(theme.border).freeze
-        @mark = create_mark(theme.mark).freeze
-        @task_style = as_style(theme.task_style)
-        @choice_current_style = as_style(theme.choice_current_style)
-        @choice_style = as_style(theme.choice_style)
-        @sections =
-          create_sections(
-            SectionBorder.create(border(theme.section_border)),
-            theme.section_styles.dup.compare_by_identity
-          )
-        @option_states = create_option_states
+      def define_section(**defs)
+        defs.each_pair do |name, style|
+          style = Utils.style(style)
+          @section_styles[name.to_sym] = style if style
+        end
+        self
       end
 
       private
 
-      def as_style(value) = (Ansi[*value].freeze if value)
-
-      def create_option_states
-        # [current?][selected?]
-        c = @mark[:current_choice]
-        n = @mark[:none]
-        sel = @mark[:checkmark]
-        uns = @mark[:choice]
-        {
-          false => { false => n + uns, true => n + sel }.compare_by_identity,
-          true => { false => c + uns, true => c + sel }.compare_by_identity
-        }.compare_by_identity.freeze
+      def initialize
+        define_heading(%w[╸╸╺╸╺━━━ ╴╶╴╶─═══ ╴╶╴╶─── ════ ━━━━ ────])
+        @mark = {
+          default: '•',
+          bullet: '•',
+          checkmark: '✓',
+          quote: '▍',
+          information: '𝒊',
+          warning: '!',
+          error: '𝙓',
+          failed: '𝑭',
+          current: '➔',
+          choice: '◦',
+          current_choice: '◉',
+          sh_out: ':',
+          sh_err: '𝙓'
+        }
+        @border = {
+          ######### 0123456789012
+          default: '┌┬┐├┼┤└┴┘│─╶╴',
+          defaulth: '───────── ─╶╴',
+          defaultv: '││││││││││ ',
+          double: '╔╦╗╠╬╣╚╩╝║═',
+          doubleh: '═════════ ═',
+          doublev: '║║║║║║║║║║ ',
+          heavy: '┏┳┓┣╋┫┗┻┛┃━╺╸',
+          heavyh: '━━━━━━━━━ ━╺╸',
+          heavyv: '┃┃┃┃┃┃┃┃┃┃ ',
+          rounded: '╭┬╮├┼┤╰┴╯│─╶╴'
+        }
+        @section_border = :rounded
+        @section_styles = {}
       end
+    end
 
-      def create_sections(template, styles)
-        Hash
-          .new do |h, kind|
-            h[kind] = SectionBorder.new(*template.parts(styles[kind])).freeze
-          end
-          .compare_by_identity
-      end
+    attr_reader :task_style,
+                :choice_current_style,
+                :choice_style,
+                :sh_out_style,
+                :sh_err_style,
+                :option_states
+
+    def defined_marks = @mark.keys.sort!
+    def defined_borders = @border.keys.sort!
+    def heading(index) = @heading[index.to_i.clamp(1, 6) - 1]
+
+    def mark(value)
+      return @mark[value] if value.is_a?(Symbol)
+      (element = Str.new(value, true)).empty? ? @mark[:default] : element
+    end
 
-      def create_mark(mark)
-        return {} if mark.empty?
-        mark = mark.to_h { |n, e| [n.to_sym, Str.new("#{e} ")] }
-        mark[:none] ||= Str.new('  ', 2)
-        with_default(mark)
+    def border(value)
+      return @border[value] if value.is_a?(Symbol)
+      case Text.width(value = value.to_s, bbcode: false)
+      when 1
+        "#{value * 11}  "
+      when 11
+        "#{value}  "
+      when 13
+        value
+      else
+        @border[:default]
       end
+    end
 
-      def create_border(border)
-        return {} if border.empty?
-        with_default(border.transform_values { _1.dup.freeze })
-      end
+    def section_border(kind)
+      kind.is_a?(Symbol) ? @sections[kind] : @sections[:default]
+    end
 
-      def create_heading(heading, style)
-        return create_styled_heading(heading, style) if style
-        heading.map do |left|
-          right = " #{left.reverse}"
-          [left = Str.new("#{left} ", true), Str.new(right, left.width)]
-        end
-      end
+    def initialize(theme)
+      @heading = create_heading(theme.heading, theme.heading_sytle).freeze
+      @border = create_border(theme.border).freeze
+      @mark = create_mark(theme.mark).freeze
+      @task_style = as_style(theme.task_style)
+      @choice_current_style = as_style(theme.choice_current_style)
+      @choice_style = as_style(theme.choice_style)
+      @sh_out_style = as_style(theme.sh_out_style)
+      @sh_err_style = as_style(theme.sh_err_style)
+      @sections =
+        create_sections(
+          SectionBorder.create(border(theme.section_border)),
+          theme.section_styles.dup.compare_by_identity
+        )
+      @option_states = create_option_states
+    end
 
-      def create_styled_heading(heading, style)
-        heading.map do |left|
-          right = Ansi.decorate(left.reverse, *style)
-          [
-            left = Str.new("#{Ansi.decorate(left, *style)} ", true),
-            Str.new(" #{right}", left.width)
-          ]
+    private
+
+    def as_style(value) = (Ansi[*value].freeze if value)
+
+    def create_option_states
+      # [current?][selected?]
+      c = @mark[:current_choice]
+      n = @mark[:none]
+      sel = @mark[:checkmark]
+      uns = @mark[:choice]
+      {
+        false => { false => n + uns, true => n + sel }.compare_by_identity,
+        true => { false => c + uns, true => c + sel }.compare_by_identity
+      }.compare_by_identity.freeze
+    end
+
+    def create_sections(template, styles)
+      Hash
+        .new do |h, kind|
+          h[kind] = SectionBorder.new(*template.parts(styles[kind])).freeze
         end
+        .compare_by_identity
+    end
+
+    def create_mark(mark)
+      return {} if mark.empty?
+      mark = mark.to_h { |n, e| [n.to_sym, Str.new("#{e} ")] }
+      mark[:none] ||= Str.new('  ', 2)
+      with_default(mark)
+    end
+
+    def create_border(border)
+      return {} if border.empty?
+      with_default(border.transform_values { _1.dup.freeze })
+    end
+
+    def create_heading(heading, style)
+      return create_styled_heading(heading, style) if style
+      heading.map do |left|
+        right = " #{left.reverse}"
+        [left = Str.new("#{left} ", true), Str.new(right, left.width)]
       end
+    end
 
-      def with_default(map)
-        map.default = (map[:default] ||= map[map.first.first])
-        map.compare_by_identity
+    def create_styled_heading(heading, style)
+      heading.map do |left|
+        right = Ansi.decorate(left.reverse, *style)
+        [
+          left = Str.new("#{Ansi.decorate(left, *style)} ", true),
+          Str.new(" #{right}", left.width)
+        ]
       end
+    end
 
-      SectionBorder =
-        Struct.new(:top, :top_left, :top_right, :bottom, :prefix) do
-          def self.create(border)
-            mid = border[10] * 2
-            mid2 = mid * 2
-            right = "#{border[11]}#{border[12] * 2}"
-            new(
-              border[0] + mid2 + right,
-              border[0] + mid,
-              mid + right,
-              border[6] + mid2 + right,
-              border[9]
-            )
-          end
+    def with_default(map)
+      map.default = (map[:default] ||= map[map.first.first])
+      map.compare_by_identity
+    end
 
-          def parts(style)
-            unless style
-              return [
-                Str.new(top, 6),
-                Str.new("#{top_left} ", 4),
-                Str.new(" #{top_right}", 6),
-                Str.new(bottom, 6),
-                Str.new("#{prefix} ", 2)
-              ]
-            end
+    SectionBorder =
+      Struct.new(:top, :top_left, :top_right, :bottom, :prefix) do
+        def self.create(border)
+          mid = border[10] * 2
+          mid2 = mid * 2
+          right = "#{border[11]}#{border[12] * 2}"
+          new(
+            border[0] + mid2 + right,
+            border[0] + mid,
+            mid + right,
+            border[6] + mid2 + right,
+            border[9]
+          )
+        end
+
+        def parts(style)
+          if style
             style = Ansi[*style]
-            [
-              # TODO: use rather [/fg]
-              Str.new("#{style}#{top}#{Ansi::RESET}", 6),
-              Str.new("#{style}#{top_left}#{Ansi::RESET} ", 4),
-              Str.new(" #{style}#{top_right}#{Ansi::RESET}", 6),
-              Str.new("#{style}#{bottom}#{Ansi::RESET}", 6),
-              Str.new("#{style}#{prefix}#{Ansi::RESET} ", 2)
-            ]
+            reset = Ansi::RESET
           end
+          [
+            Str.new("#{style}#{top}#{reset}", 6),
+            Str.new("#{style}#{top_left}#{reset} ", 4),
+            Str.new(" #{style}#{top_right}#{reset}", 6),
+            Str.new("#{style}#{bottom}#{reset}", 6),
+            Str.new("#{style}#{prefix}#{reset} ", 2)
+          ]
         end
-
-      private_constant :SectionBorder
+      end
+    private_constant :SectionBorder
+
+    @ll = {}
+
+    register(:mono, 'Monochrome – Non-ANSI fallback', &:itself)
+
+    register(:default, 'Default – uses default colors') do |theme|
+      theme.heading_sytle = :bright_blue
+      theme.task_style = %i[bright_green b]
+      # theme.choice_style =
+      theme.sh_out_style = :default
+      theme.sh_err_style = :bright_yellow
+      theme.choice_current_style = %i[bright_white on_blue b]
+      theme.define_marker(
+        bullet: '[bright_white]•[/fg]',
+        checkmark: '[bright_green]✓[/fg]',
+        quote: '[bright_blue]▍[/fg]',
+        information: '[bright_yellow]𝒊[/fg]',
+        warning: '[bright_yellow]![/fg]',
+        error: '[red]𝙓[/fg]',
+        failed: '[bright_red]𝑭[/fg]',
+        current: '[bright_green]➔[/fg]',
+        choice: '[bright_white]◦[/fg]',
+        current_choice: '[bright_green]➔[/fg]',
+        sh_out: '[bright_white]:[/fg]',
+        sh_err: '[red]𝙓[/fg]'
+      )
+      theme.define_section(
+        default: :bright_blue,
+        message: :bright_blue,
+        information: :bright_blue,
+        warning: :bright_yellow,
+        error: :red,
+        failed: :bright_red
+      )
     end
-    # private_constant :Compiled
-
-    private
 
-    def initialize
-      define_heading(%w[╸╸╺╸╺━━━ ╴╶╴╶─═══ ╴╶╴╶─── ════ ━━━━ ────])
-      @mark = {
-        default: '•',
-        bullet: '•',
-        checkmark: '✓',
-        quote: '▍',
-        information: '𝒊',
-        warning: '!',
-        error: '𝙓',
-        failed: '𝑭',
-        current: '➔',
-        choice: '◦',
-        current_choice: '◉'
-      }
-      @border = {
-        ######### 0123456789012
-        default: '┌┬┐├┼┤└┴┘│─╶╴',
-        defaulth: '───────── ─╶╴',
-        defaultv: '││││││││││ ',
-        double: '╔╦╗╠╬╣╚╩╝║═',
-        doubleh: '═════════ ═',
-        doublev: '║║║║║║║║║║ ',
-        heavy: '┏┳┓┣╋┫┗┻┛┃━╺╸',
-        heavyh: '━━━━━━━━━ ━╺╸',
-        heavyv: '┃┃┃┃┃┃┃┃┃┃ ',
-        rounded: '╭┬╮├┼┤╰┴╯│─╶╴'
-      }
-      @section_border = :rounded
-      @section_styles = {}
+    register(:emoji, 'Emoji – emoticons and default colors') do |theme|
+      theme.heading_sytle = :bright_blue
+      theme.task_style = %i[bright_green b]
+      # theme.choice_style =
+      theme.sh_out_style = :default
+      theme.sh_err_style = :bright_red
+      theme.choice_current_style = %i[bright_white on_blue b]
+      theme.define_marker(
+        bullet: '▫️',
+        checkmark: '✅',
+        quote: '[bright_blue]▍[/fg]',
+        information: '📌',
+        warning: '⚠️',
+        error: '❗️',
+        failed: '‼️',
+        current: '➡️',
+        choice: '[bright_white]•[/fg]',
+        current_choice: '[bright_green]●[/fg]',
+        sh_out: '[white b]:[/]',
+        sh_err: '❗️'
+      )
+      theme.define_section(
+        default: :bright_blue,
+        message: :bright_blue,
+        information: :bright_blue,
+        warning: :bright_yellow,
+        error: :red,
+        failed: :bright_red
+      )
     end
 
-    self.current = Terminal.colors == 2 ? new : default
+    use(Terminal.colors == 2 ? :mono : :default)
   end
 end