rbytes 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8780a2ff433a3b3e11c59a05fe7bf73a1a742463c659bbf8abd835b17242d43
-  data.tar.gz: 10fd5d4eb9271e6e3be8fe2f71262e03a743dbf077b71a925498796c20e2cafe
+  metadata.gz: 040b91d608de3f8f28c7e81b3b63c604370779ed8321baa8d8a26ad249365927
+  data.tar.gz: 8b99d75e94487d7999284caf0b6ad07fd7feb8771d4ba7ab20d85e0e7c248449
 SHA512:
-  metadata.gz: c681d786e67cf6423e95b78b687bfec4dea5460ec3238656ed3319347240eae199a21fbf5bc05fb3d67a70fdd6862797712401085e239ce94c56ccb25f7ceea9
-  data.tar.gz: e8fae36e2fa7daa3acfd71a760b969e6c09c23dc248f1bedd479930e7c9e064b7c6027e987fa61683250c36a65398cc784f174f2f9890ce0a3764300abe76088
+  metadata.gz: bfbb924533307fed9c3ba1d62f4720ee62eb5e139946829f3f1f4d2c045a365424b42258193e9e523737ddb5f37714410028f0a74a61063ec25b883d3068cedf
+  data.tar.gz: 506aa21f7128feb9d7f71e25b94d94f4f1fcbfc3b2fcfb53d9ee295ae4cfba46384349659a9b766a1bd1287e4b9c606ac2a27af1e5f2ca510873f8f5ee247c0c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.3.0 (2026-02-13)
+
+- Add Charm Ruby integration.
+
 ## 0.2.0 (2023-04-15)
 
 - Add `#import_template` directive to inline other templates.

data/lib/ruby_bytes/charmed.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+require "lipgloss"
+require "gum"
+
+class Rbytes
+  module Charmed
+    # See https://gist.github.com/JBlond/2fea43a3049b38287e5e9cefc87b2124?permalink_comment_id=3892823#gistcomment-3892823
+    FG_COLORS = {
+      black: "8",
+      red: "9",
+      green: "10",
+      yellow: "11",
+      blue: "12",
+      magenta: "13",
+      cyan: "14",
+      white: "15",
+      grey: "243"
+    }.freeze
+
+    BG_COLORS = {
+      black: "16",
+      red: "124",
+      green: "28",
+      yellow: "214",
+      blue: "25",
+      magenta: "95",
+      cyan: "45",
+      white: "231",
+      grey: "252"
+    }.freeze
+
+    # Print a message to the user.
+    # say accumulates messages to print them in a box in case more than a single message is provided.
+    # the empty string is used to flush the output; any other command flushes the output, too.
+    def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
+      return if quiet?
+
+      return draw_box! if message == ""
+
+      buffer = set_color(message, *Array(color))
+
+      append_to_current_box(buffer)
+    end
+
+    STATUS_COLORS = {
+      debug: :grey,
+      info: :blue,
+      warn: :yellow,
+      error: :red,
+      fatal: :red
+    }.freeze
+
+    # Print a status badge followed by a message (e.g. "  create  config/routes.rb").
+    # Thor default: right-aligns the status word, colors it, appends the message.
+    def say_status(status, message, log_status = true)
+      return if quiet? || log_status == false
+
+      draw_box!
+
+      color_code = log_status.is_a?(Symbol) ? FG_COLORS.fetch(log_status) : FG_COLORS.fetch(STATUS_COLORS.fetch(status, STATUS_COLORS[:info]))
+
+      status_style = Lipgloss::Style.new.bold(true).foreground(color_code).inline(true)
+      buffer = "#{status_style.render(status.to_s.upcase)}\t#{message}"
+
+      stdout.puts(buffer)
+      stdout.flush
+    end
+
+    # Print an error message to $stderr.
+    # Thor default: same as +say+ but writes to $stderr.
+    def say_error(message = "", color = :red, force_new_line = (message.to_s !~ /( |\t)\Z/))
+      return if quiet?
+
+      draw_box!
+
+      # Print error in a box
+      error_style = Lipgloss::Style.new
+        .padding(1, 1)
+        .align(:center)
+        .background(FG_COLORS.fetch(color))
+      buffer = error_style.render(message)
+      stderr.puts(buffer)
+      stderr.flush
+    end
+
+    # Print an unformatted error statement to $stderr (legacy Thor method).
+    # Thor default: $stderr.puts statement.
+    def error(statement)
+      say_error(statement)
+    end
+
+    # Print an array of strings in evenly-spaced columns.
+    # Thor default: calculates column widths and pads with spaces.
+    def print_in_columns(array)
+      return if quiet?
+
+      draw_box!
+
+      return if array.empty?
+
+      if array.size <= 4
+        stdout.puts Lipgloss::List.new.items(array.map(&:to_s)).render
+        stdout.flush
+        return
+      end
+
+      col_width = array.map { |e| e.to_s.size }.max + 2
+      cols = [terminal_width / col_width, array.size].min.clamp(4..)
+
+      # Shrink columns so the last row has at least cols-2 items
+      while cols > 4
+        remainder = array.size % cols
+        break if remainder.zero? || remainder >= cols - 2
+        cols -= 1
+      end
+
+      even_style = Lipgloss::Style.new.width(col_width).inline(true).align(:center).background("254").foreground("0")
+      odd_style = Lipgloss::Style.new.width(col_width).inline(true).align(:center).background("234")
+
+      rows = array.each_slice(cols).map.with_index do |row, ri|
+        Lipgloss.join_horizontal(:top, *row.map.with_index { |item, ci| ((ri + ci).even? ? even_style : odd_style).render(item.to_s) })
+      end
+
+      buffer = Lipgloss.join_vertical(:left, *rows)
+
+      stdout.puts(buffer)
+      stdout.flush
+    end
+
+    # Print a 2-D array as an aligned table.
+    # Thor default: ASCII table with optional indent, colwidth, borders.
+    #
+    # ==== Options
+    #   indent<Integer>   – indent the first column
+    #   colwidth<Integer> – force the first column width
+    #   borders<Boolean>  – draw borders
+    def print_table(data, options = {})
+      return if quiet?
+
+      draw_box!
+
+      data = data.dup
+      headers = data.shift
+
+      header_style = Lipgloss::Style.new.bold(true).foreground("12")
+      even_style = Lipgloss::Style.new.background("254").foreground("0")
+      odd_style = Lipgloss::Style.new.background("234")
+
+      table = Lipgloss::Table.new
+        .headers(headers)
+        .rows(data)
+        .style_func(rows: data.size, columns: headers.size) do |row, column|
+          if row == Lipgloss::Table::HEADER_ROW
+            header_style
+          elsif row.even?
+            even_style
+          else
+            odd_style
+          end
+        end
+
+      buffer = table.render
+
+      stdout.puts(buffer)
+      stdout.flush
+    end
+
+    # Print a long string, word-wrapped to the terminal width.
+    # Thor default: wraps text at terminal_width minus indent.
+    #
+    # ==== Options
+    #   indent<Integer> – left-indent each line
+    def print_wrapped(message, options = {})
+      return if quiet?
+
+      draw_box!
+
+      style = Lipgloss::Style.new.background("234")
+      buffer = style.render(message)
+      super(buffer)
+    end
+
+    # ── Input ─────────────────────────────────────────────────────────────
+
+    # Prompt the user for a single line of text.
+    # Thor default: readline with optional :default, :limited_to, :echo, :path.
+    def ask(statement, *args)
+      draw_box!
+
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      # color = args.first
+
+      if options[:limited_to]
+        Gum.choose(options[:limited_to], header: statement, selected: options[:default])
+      else
+        Gum.input(value: options[:default], prompt: "> ", header: statement)
+      end.then { |v| handle_gum_result(v) }
+    end
+
+    # Ask a yes/no question, return true when the user answers "y" or "yes".
+    # Thor default: regex match on the answer string.
+    def yes?(statement, color = nil)
+      draw_box!
+
+      handle_gum_result(
+        Gum.choose(%w[Yes No], header: statement, selected: "Yes")
+      ).then { |res| res == "Yes" }
+    end
+
+    # Ask a yes/no question, return true when the user answers "n" or "no".
+    # Thor default: inverse of +yes?+.
+    def no?(statement, color = nil)
+      draw_box!
+
+      handle_gum_result(
+        Gum.choose(%w[Yes No], header: statement, selected: "Yes")
+      ).then { |res| res == "No" }
+    end
+
+    # ── Formatting / Utility ──────────────────────────────────────────────
+
+    # Apply color and style to a string.
+    # Thor default: wraps string in ANSI escape codes.
+    def set_color(string, *colors)
+      style = Lipgloss::Style.new.inline(true)
+      colors.each do |c|
+        case c
+        when :bold then style = style.bold(true)
+        when :on_black, :on_red, :on_green, :on_yellow, :on_blue, :on_magenta, :on_cyan, :on_white
+          style = style.background(BG_COLORS.fetch(c.to_s.sub("on_", "").to_sym))
+        when Symbol then style = style.foreground(FG_COLORS.fetch(c))
+        end
+      end
+
+      style.render(string.to_s)
+    end
+
+    # Return the width (in columns) of the current terminal.
+    # Thor default: detects via IO/stty (class method on Thor::Shell::Terminal).
+    def terminal_width
+      Thor::Shell::Terminal.terminal_width
+    end
+
+    private
+
+    def box_buffer
+      @box_buffer ||= []
+    end
+
+    def append_to_current_box(line)
+      box_buffer << line
+    end
+
+    def draw_box!
+      return stdout.puts if box_buffer.empty?
+
+      # Single line is printed as is
+      buffer =
+        if box_buffer.size == 1
+          box_buffer.first
+        else
+          Lipgloss::Style.new
+            .border(:normal)
+            .padding(1, 2)
+            .align(:center)
+            .render(box_buffer.join("\n"))
+        end
+
+      stdout.puts(buffer)
+      stdout.flush
+
+      box_buffer.clear
+    end
+
+    def handle_gum_result(res)
+      # nil means user cancelled
+      # https://github.com/marcoroth/gum-ruby/blob/faf9e2ccefa6457708a4eb31c992e0ccf585a998/lib/gum/command.rb#L46
+      Kernel.exit(130) if res.nil?
+      res
+    end
+  end
+end

data/lib/ruby_bytes/thor.rb

@@ -3,12 +3,12 @@
 class Rbytes < Thor
   desc "template", "Load and run generator from RailsBytes"
   def template(url)
-    puts "Run template from: #{url}"
+    say_status :info, "Run template from: #{url}"
 
     # require gems typically used in templates
     require "bundler"
 
-    Base.new.apply(url)
+    Base.new.apply(url, verbose: false)
   end
 
     # Rails core extensions can be used in templates.
@@ -449,6 +449,15 @@ class Rbytes < Thor
     include Thor::Actions
     include Rails::Actions
 
+    unless ENV["RBYTES_DISABLE_GUM"] == "1"
+      begin
+        require "ruby_bytes/charmed"
+        Thor::Shell::Color.prepend Charmed
+      rescue LoadError
+        # No gum available
+      end
+    end
+
     # Custom methods defined on AppGenerator
     # https://github.com/rails/rails/blob/38275763257221e381cd4e37958ce1413fd0433c/railties/lib/rails/generators/rails/app/app_generator.rb#L558
     def file(*args, &block)

data/lib/ruby_bytes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyBytes # :nodoc:
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/templates/rbytes/rbytes.rb

@@ -3,12 +3,12 @@
 class Rbytes < Thor
   desc "template", "Load and run generator from RailsBytes"
   def template(url)
-    puts "Run template from: #{url}"
+    say_status :info, "Run template from: #{url}"
 
     # require gems typically used in templates
     require "bundler"
 
-    Base.new.apply(url)
+    Base.new.apply(url, verbose: false)
   end
 
   <%= include "core_ext", indent: 2 %>
@@ -20,6 +20,15 @@ class Rbytes < Thor
     include Thor::Actions
     include Rails::Actions
 
+    unless ENV["RBYTES_DISABLE_GUM"] == "1"
+      begin
+        require "ruby_bytes/charmed"
+        Thor::Shell::Color.prepend Charmed
+      rescue LoadError
+        # No gum available
+      end
+    end
+
     # Custom methods defined on AppGenerator
     # https://github.com/rails/rails/blob/38275763257221e381cd4e37958ce1413fd0433c/railties/lib/rails/generators/rails/app/app_generator.rb#L558
     def file(*args, &block)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rbytes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +79,7 @@ files:
 - README.md
 - bin/rbytes
 - lib/rbytes.rb
+- lib/ruby_bytes/charmed.rb
 - lib/ruby_bytes/cli.rb
 - lib/ruby_bytes/compiler.rb
 - lib/ruby_bytes/publisher.rb
@@ -99,7 +99,6 @@ metadata:
   documentation_uri: http://github.com/palkan/rbytes
   homepage_uri: http://github.com/palkan/rbytes
   source_code_uri: http://github.com/palkan/rbytes
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby Bytes is a tool to build application templates for Ruby and Rails applications
 test_files: []