create-ruby-gem 0.1.0

data/lib/create_ruby_gem/ui/palette.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module CreateRubyGem
+  module UI
+    # Color constants for terminal output.
+    #
+    # Maps semantic roles (e.g. +:summary_label+, +:arg_name+) to ANSI 256-color
+    # codes or +cli-ui+ basic color names, depending on terminal capabilities.
+    class Palette
+      # ANSI reset sequence.
+      RESET = "\e[0m"
+
+      # Role-to-color mappings for 256-color terminals.
+      #
+      # @return [Hash{Symbol => Integer}]
+      ROLE_COLORS_256 = {
+        control_back: 45,
+        control_exit: 203,
+        summary_label: 213,
+        runtime_name: 111,
+        runtime_value: 190,
+        command_base: 39,
+        command_gem: 82,
+        arg_name: 117,
+        arg_eq: 250,
+        arg_value: 214
+      }.freeze
+
+      # Role-to-color mappings for basic (8/16-color) terminals.
+      #
+      # @return [Hash{Symbol => String}]
+      ROLE_COLORS_BASIC = {
+        control_back: 'cyan',
+        control_exit: 'red',
+        summary_label: 'magenta',
+        runtime_name: 'blue',
+        runtime_value: 'green',
+        command_base: 'blue',
+        command_gem: 'green',
+        arg_name: 'blue',
+        arg_eq: 'white',
+        arg_value: 'yellow'
+      }.freeze
+
+      # @param env [Hash] environment variables (defaults to +ENV+)
+      def initialize(env: ENV)
+        @env = env
+      end
+
+      # Wraps text in the appropriate ANSI color for the given role.
+      #
+      # @param role [Symbol] a key from {ROLE_COLORS_256}/{ROLE_COLORS_BASIC}
+      # @param text [String] the text to colorize
+      # @return [String]
+      def color(role, text)
+        if supports_256_colors?
+          "\e[38;5;#{ROLE_COLORS_256.fetch(role)}m#{text}#{RESET}"
+        else
+          "{{#{ROLE_COLORS_BASIC.fetch(role)}:#{text}}}"
+        end
+      end
+
+      private
+
+      # @return [Boolean]
+      def supports_256_colors?
+        term = @env.fetch('TERM', '')
+        colorterm = @env.fetch('COLORTERM', '')
+        term.include?('256color') || colorterm.match?(/truecolor|24bit|256/i)
+      end
+    end
+  end
+end

data/lib/create_ruby_gem/ui/prompter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'cli/ui'
+require_relative 'back_navigation_patch'
+
+module CreateRubyGem
+  module UI
+    # Thin wrapper around +cli-ui+ for all user interaction.
+    #
+    # Every prompt the wizard issues goes through this class, making it
+    # easy to inject a test double.
+    class Prompter
+      # Enables the +cli-ui+ stdout router and applies the Ctrl+B patch.
+      #
+      # Call once before creating a Prompter instance. Idempotent.
+      #
+      # @return [void]
+      def self.setup!
+        ::CLI::UI::StdoutRouter.enable
+        BackNavigationPatch.apply!
+      end
+
+      # @param out [IO] output stream
+      def initialize(out: $stdout)
+        @out = out
+      end
+
+      # Opens a visual frame with a title.
+      #
+      # @param title [String]
+      # @yield block executed inside the frame
+      # @return [void]
+      def frame(title, &)
+        ::CLI::UI::Frame.open(title, &)
+      end
+
+      # Presents a single-choice list.
+      #
+      # @param question [String]
+      # @param options [Array<String>]
+      # @param default [String, nil]
+      # @return [String] selected option, or {Wizard::BACK} on Ctrl+B
+      def choose(question, options:, default: nil)
+        ::CLI::UI.ask(question, options: options, default: default, filter_ui: false)
+      rescue BackKeyPressed
+        Wizard::BACK
+      end
+
+      # Prompts for free-text input.
+      #
+      # @param question [String]
+      # @param default [String, nil]
+      # @param allow_empty [Boolean]
+      # @return [String]
+      def text(question, default: nil, allow_empty: true)
+        ::CLI::UI.ask(question, default: default, allow_empty: allow_empty)
+      end
+
+      # Prompts for yes/no confirmation.
+      #
+      # @param question [String]
+      # @param default [Boolean]
+      # @return [Boolean]
+      def confirm(question, default: true)
+        ::CLI::UI.confirm(question, default: default)
+      end
+
+      # Prints a formatted message to the output stream.
+      #
+      # @param message [String] message with optional +cli-ui+ formatting tags
+      # @return [void]
+      def say(message)
+        @out.puts(::CLI::UI.fmt(message))
+      end
+    end
+  end
+end

data/lib/create_ruby_gem/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CreateRubyGem
+  # @return [String] current gem version
+  VERSION = '0.1.0'
+end

data/lib/create_ruby_gem/wizard.rb

@@ -0,0 +1,339 @@
+# frozen_string_literal: true
+
+module CreateRubyGem
+  # Step-by-step interactive prompt loop for choosing +bundle gem+ options.
+  #
+  # Walks through each supported option in {Options::Catalog::ORDER},
+  # presenting only the options supported by the detected Bundler version.
+  # Supports back-navigation via +Ctrl+B+.
+  #
+  # @see CLI#run_interactive_wizard!
+  class Wizard
+    # Sentinel returned by the prompter when the user presses Ctrl+B.
+    BACK = Object.new.freeze
+
+    # Sentinel indicating the user wants Bundler's built-in default.
+    BUNDLER_DEFAULT = Object.new.freeze
+
+    # Human-readable labels for each option key.
+    #
+    # @return [Hash{Symbol => String}]
+    LABELS = {
+      exe: 'Create executable',
+      coc: 'Add CODE_OF_CONDUCT.md',
+      changelog: 'Add CHANGELOG.md',
+      ext: 'Native extension',
+      git: 'Initialize git',
+      github_username: 'GitHub username',
+      mit: 'Include MIT license',
+      test: 'Test framework',
+      ci: 'CI provider',
+      linter: 'Linter',
+      edit: 'Editor command',
+      bundle_install: 'Run bundle install'
+    }.freeze
+
+    # Short explanations shown below each wizard step.
+    #
+    # @return [Hash{Symbol => String}]
+    HELP_TEXT = {
+      exe: 'Adds an executable file in exe/ so users can run your gem as a command.',
+      coc: 'Adds a code of conduct template for contributors.',
+      changelog: 'Adds CHANGELOG.md to track release notes.',
+      ext: 'Sets up native extension scaffolding for C, Go, or Rust.',
+      git: 'Initializes a git repository for the new gem.',
+      github_username: 'Used in links and metadata for your GitHub account.',
+      mit: 'Adds the MIT license file.',
+      test: 'Chooses which test framework files to generate.',
+      ci: 'Chooses CI pipeline config to include.',
+      linter: 'Chooses linting setup for style and quality checks.',
+      edit: 'Sets your preferred command for opening files.',
+      bundle_install: 'Runs bundle install after generating the gem.'
+    }.freeze
+
+    # Per-choice hints displayed next to enum/string choices.
+    #
+    # @return [Hash{Symbol => Hash{String => String}}]
+    CHOICE_HELP = {
+      ext: {
+        'c' => 'classic native extension path',
+        'go' => 'Go-based extension via FFI/tooling',
+        'rust' => 'Rust extension path',
+        'none' => 'no native extension'
+      },
+      test: {
+        'minitest' => 'small built-in Ruby test style',
+        'rspec' => 'popular behavior-style testing',
+        'test-unit' => 'xUnit-style test framework',
+        'none' => 'no test framework files'
+      },
+      ci: {
+        'circle' => 'CircleCI config',
+        'github' => 'GitHub Actions workflow',
+        'gitlab' => 'GitLab CI pipeline',
+        'none' => 'no CI config'
+      },
+      linter: {
+        'rubocop' => 'full-featured Ruby linting',
+        'standard' => 'zero-config style linting',
+        'none' => 'no linter config'
+      },
+      github_username: {
+        'set' => 'enter a value now',
+        'none' => 'leave unset'
+      },
+      edit: {
+        'set' => 'enter a value now',
+        'none' => 'leave unset'
+      }
+    }.freeze
+
+    # @param compatibility_entry [Compatibility::Matrix::Entry]
+    # @param defaults [Hash{Symbol => Object}] initial default values (e.g. last-used)
+    # @param prompter [UI::Prompter]
+    # @param bundler_defaults [Hash{Symbol => Object}] Bundler's own defaults
+    def initialize(compatibility_entry:, defaults:, prompter:, bundler_defaults: {})
+      @compatibility_entry = compatibility_entry
+      @bundler_defaults = symbolize_keys(bundler_defaults)
+      @prompter = prompter
+      @values = sanitize_defaults(defaults)
+    end
+
+    # Runs the wizard and returns the selected options.
+    #
+    # @return [Hash{Symbol => Object}]
+    def run
+      keys = Options::Catalog::ORDER.select { |key| @compatibility_entry.supports_option?(key) }
+      index = 0
+      while index < keys.length
+        key = keys[index]
+        answer = ask_for(key, index:, total: keys.length)
+        case answer
+        when BACK
+          index -= 1 if index.positive?
+        else
+          assign_value(key, answer)
+          index += 1
+        end
+      end
+      @values.dup
+    end
+
+    private
+
+    # @param key [Symbol]
+    # @param index [Integer]
+    # @param total [Integer]
+    # @return [Object] user answer or {BACK}
+    def ask_for(key, index:, total:)
+      definition = Options::Catalog.fetch(key)
+      label = LABELS.fetch(key)
+      question = render_question(index: index, total: total, key: key, label: label)
+      case definition[:type]
+      when :toggle
+        ask_toggle(question, key)
+      when :flag
+        ask_flag(question, key)
+      when :enum
+        ask_enum(question, key, definition)
+      when :string
+        ask_string(question, key)
+      else
+        raise Error, "Unknown option type for #{key}"
+      end
+    end
+
+    # @param question [String]
+    # @param key [Symbol]
+    # @return [true, false, nil, String]
+    def ask_toggle(question, key)
+      choices = %w[yes no]
+      current = @values[key]
+      default_choice = toggle_default_choice(current, key)
+      answer = choose_with_default_marker(question, key:, choices:, default_choice:)
+      return BACK if answer == BACK
+      return true if answer == 'yes'
+      return false if answer == 'no'
+
+      nil
+    end
+
+    # @param question [String]
+    # @param key [Symbol]
+    # @return [true, String, nil]
+    def ask_flag(question, key)
+      choices = %w[yes no]
+      current = @values[key]
+      default_choice = current == true ? 'yes' : flag_default_choice(key)
+      answer = choose_with_default_marker(question, key:, choices:, default_choice:)
+      return BACK if answer == BACK
+      return true if answer == 'yes'
+      return BUNDLER_DEFAULT if answer == 'no'
+
+      nil
+    end
+
+    # @param question [String]
+    # @param key [Symbol]
+    # @param definition [Hash]
+    # @return [String, false, String]
+    def ask_enum(question, key, definition)
+      choices = @compatibility_entry.allowed_values(key).dup
+      choices << 'none' if definition[:none]
+      current = @values[key]
+      default_choice = enum_default_choice(key, current, choices)
+      answer = choose_with_default_marker(question, key:, choices:, default_choice:)
+      return BACK if answer == BACK
+      return false if answer == 'none'
+
+      answer
+    end
+
+    # @param question [String]
+    # @param key [Symbol]
+    # @return [String, nil, String]
+    def ask_string(question, key)
+      has_current = @values[key].is_a?(String) && !@values[key].empty?
+      choices =
+        if has_current
+          %w[keep set]
+        else
+          %w[set none]
+        end
+      default_choice = has_current ? 'keep' : 'none'
+      answer = choose_with_default_marker(question, key:, choices:, default_choice:)
+      return BACK if answer == BACK
+      return BUNDLER_DEFAULT if answer == 'none'
+      return @values[key] if answer == 'keep'
+
+      default_value = key == :github_username ? nil : @values[key]
+      allow_empty = key != :github_username
+      value = @prompter.text("#{LABELS.fetch(key)}:", default: default_value, allow_empty: allow_empty)
+      value.empty? ? nil : value
+    end
+
+    # @param key [Symbol]
+    # @param value [Object]
+    # @return [void]
+    def assign_value(key, value)
+      if value.nil? || value == BUNDLER_DEFAULT
+        @values.delete(key)
+      else
+        @values[key] = value
+      end
+    end
+
+    # @param hash [Hash]
+    # @return [Hash{Symbol => Object}]
+    def symbolize_keys(hash)
+      hash.transform_keys(&:to_sym)
+    end
+
+    # Filters defaults to only supported options and removes false flags.
+    #
+    # @param hash [Hash]
+    # @return [Hash{Symbol => Object}]
+    def sanitize_defaults(hash)
+      symbolize_keys(hash)
+        .select { |key, _| @compatibility_entry.supports_option?(key) }
+        .each_with_object({}) do |(key, value), acc|
+          definition = Options::Catalog.fetch(key)
+          acc[key] = value unless definition[:type] == :flag && value == false
+        end
+    end
+
+    # @param current [Object]
+    # @param key [Symbol]
+    # @return [String]
+    def toggle_default_choice(current, key)
+      return 'yes' if current == true
+      return 'no' if current == false
+
+      @bundler_defaults[key] == true ? 'yes' : 'no'
+    end
+
+    # @param key [Symbol]
+    # @return [String]
+    def flag_default_choice(key)
+      @bundler_defaults[key] == true ? 'yes' : 'no'
+    end
+
+    # @param key [Symbol]
+    # @param current [Object]
+    # @param choices [Array<String>]
+    # @return [String]
+    def enum_default_choice(key, current, choices)
+      return 'none' if current == false && choices.include?('none')
+      return current if current.is_a?(String) && choices.include?(current)
+
+      bundler_default = @bundler_defaults[key]
+      return 'none' if bundler_default == false && choices.include?('none')
+      return bundler_default if bundler_default.is_a?(String) && choices.include?(bundler_default)
+
+      choices.first
+    end
+
+    # Presents a choice list with the default marked and reordered first.
+    #
+    # @param question [String]
+    # @param key [Symbol]
+    # @param choices [Array<String>]
+    # @param default_choice [String]
+    # @return [String] the raw choice value, or {BACK}
+    def choose_with_default_marker(question, key:, choices:, default_choice:)
+      selected_default = choices.include?(default_choice) ? default_choice : choices.first
+      ordered_choices = reorder_default_first(choices, selected_default)
+      rendered_pairs = ordered_choices.map do |choice|
+        [render_choice_label(key, choice, default_choice: selected_default), choice]
+      end
+      rendered = rendered_pairs.map(&:first)
+      answer = @prompter.choose(question, options: rendered, default: rendered.first)
+      return BACK if answer == BACK
+
+      rendered_index = rendered.index(answer)
+      return ordered_choices[rendered_index] if rendered_index
+
+      selected_default
+    end
+
+    # @param choices [Array<String>]
+    # @param default_choice [String]
+    # @return [Array<String>]
+    def reorder_default_first(choices, default_choice)
+      return choices.dup unless choices.include?(default_choice)
+
+      [default_choice] + choices.reject { |choice| choice == default_choice }
+    end
+
+    # @param index [Integer]
+    # @param total [Integer]
+    # @param key [Symbol]
+    # @param label [String]
+    # @return [String]
+    def render_question(index:, total:, key:, label:)
+      step = format('%<current>02d/%<total>02d', current: index + 1, total: total)
+      "{{cyan:#{step}}} {{bold:#{label}}} - #{HELP_TEXT.fetch(key)}"
+    end
+
+    # @param key [Symbol]
+    # @param choice [String]
+    # @param default_choice [String]
+    # @return [String]
+    def render_choice_label(key, choice, default_choice:)
+      label = choice
+      hint = choice_hint(key, choice)
+      label = "#{label} - #{hint}" if hint
+      label = "#{label} (default)" if choice == default_choice
+      label
+    end
+
+    # @param key [Symbol]
+    # @param choice [String]
+    # @return [String, nil]
+    def choice_hint(key, choice)
+      return "use #{@values[key]}" if choice == 'keep' && @values[key].is_a?(String) && !@values[key].empty?
+
+      CHOICE_HELP.dig(key, choice)
+    end
+  end
+end

data/lib/create_ruby_gem.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'create_ruby_gem/version'
+require_relative 'create_ruby_gem/error'
+require_relative 'create_ruby_gem/detection/bundler_version'
+require_relative 'create_ruby_gem/detection/bundler_defaults'
+require_relative 'create_ruby_gem/detection/runtime'
+require_relative 'create_ruby_gem/options/catalog'
+require_relative 'create_ruby_gem/compatibility/matrix'
+require_relative 'create_ruby_gem/options/validator'
+require_relative 'create_ruby_gem/command_builder'
+require_relative 'create_ruby_gem/config/store'
+require_relative 'create_ruby_gem/runner'
+require_relative 'create_ruby_gem/ui/palette'
+require_relative 'create_ruby_gem/ui/prompter'
+require_relative 'create_ruby_gem/wizard'
+require_relative 'create_ruby_gem/cli'
+
+# Interactive TUI wizard for +bundle gem+.
+#
+# Detects the user's Ruby/Bundler versions, shows only compatible options
+# via a static compatibility matrix, and builds the correct +bundle gem+
+# command. Config (presets, last-used options) is stored in
+# +~/.config/create-ruby-gem/config.yml+.
+#
+# @see CreateRubyGem::CLI Entry point
+# @see CreateRubyGem::Compatibility::Matrix Bundler version compatibility
+module CreateRubyGem
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: create-ruby-gem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonid Svyatov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cli-kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: cli-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Interactive CLI wizard for bundle gem. Walks you through every option,
+  saves presets, and remembers your choices. No more bundle gem flags look-ups!
+email:
+- leonid@svyatov.com
+executables:
+- create-ruby-gem
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/create-ruby-gem
+- lib/create_ruby_gem.rb
+- lib/create_ruby_gem/cli.rb
+- lib/create_ruby_gem/command_builder.rb
+- lib/create_ruby_gem/compatibility/matrix.rb
+- lib/create_ruby_gem/config/store.rb
+- lib/create_ruby_gem/detection/bundler_defaults.rb
+- lib/create_ruby_gem/detection/bundler_version.rb
+- lib/create_ruby_gem/detection/runtime.rb
+- lib/create_ruby_gem/error.rb
+- lib/create_ruby_gem/options/catalog.rb
+- lib/create_ruby_gem/options/validator.rb
+- lib/create_ruby_gem/runner.rb
+- lib/create_ruby_gem/ui/back_navigation_patch.rb
+- lib/create_ruby_gem/ui/palette.rb
+- lib/create_ruby_gem/ui/prompter.rb
+- lib/create_ruby_gem/version.rb
+- lib/create_ruby_gem/wizard.rb
+homepage: https://github.com/svyatov/create-ruby-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/svyatov/create-ruby-gem/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create-ruby-gem
+  bug_tracker_uri: https://github.com/svyatov/create-ruby-gem/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.4
+specification_version: 4
+summary: Create Ruby gems with an interactive CLI wizard that remembers your choices
+test_files: []