mozconfig 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: deab982bf7a16337ecc968051e64f58060e57c87347fbc7ac7110a4e4dcbeaa3
+  data.tar.gz: 982729e6bca482b2731d7e6eb465d786855319639804d49b3ec89f1136cc2144
+SHA512:
+  metadata.gz: 262fffdff7424b2d03d7f48d474c8a9cc2f2438e4bbd32705547a818eb31780872dd7b8db4a1fad0a68dc82c078218aa72b0ae63c24a0ce68b09f4ed577c8fb6
+  data.tar.gz: 757347cdfb31b1f6f923b8d20280134bdbff40465282e1dae17afbd5073abdac97900c4dc472659fa64d719f7ac956c364a9355ba5323cda37bfcb0d823664c8

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Don't push Gemfile.lock on a RubyGem
+Gemfile.lock
+
+# Might want one of these around for debugging purposes
+/mozconfig

data/.rubocop.yml

@@ -0,0 +1,91 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  AllowInHeredoc: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Security/Eval:
+  Exclude:
+    - lib/cli.rb
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RequireOrder:
+  Enabled: true
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright © 2023 Vinny Diehl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# `mozconfig` Switcher
+
+A simple TUI utility to switch between different
+[`mozconfig`](https://firefox-source-docs.mozilla.org/build/buildsystem/mozconfigs.html)s
+in the Mozilla source code.
+
+## Installation
+
+```sh
+gem install mozconfig
+```
+
+## Usage
+
+Your `mozconfig` should be formatted like this, for example:
+
+```py
+mk_add_options AUTOCLOBBER=1
+
+# Firefox
+ac_add_options --with-branding=browser/branding/nightly
+ac_add_options --with-ccache=sccache
+
+# Firefox (artifact build)
+# ac_add_options --with-branding=browser/branding/nightly
+# ac_add_options --enable-artifact-builds
+
+# Thunderbird
+# mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/obj-mail-@CONFIG_GUESS@
+# ac_add_options --enable-project=comm/mail
+# ac_add_options --with-branding=comm/mail/branding/nightly
+# ac_add_options --with-ccache=sccache
+
+# Thunderbird (artifact build)
+# mk_add_options MOZ_OBJDIR=@TOPSRCDIR@/obj-mail-@CONFIG_GUESS@
+# ac_add_options --enable-project=comm/mail
+# ac_add_options --with-branding=comm/mail/branding/nightly
+# ac_add_options --enable-artifact-builds
+```
+
+The options are separated into "paragraphs", each one a separate configuration.
+This tool will comment out all of the inactive configurations. The comment
+above each paragraph will be the name displayed in the TUI. Any paragraph
+without a comment above it will remain active in all configurations.

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+task dist: :build
+task default: :build

data/VERSION

@@ -0,0 +1 @@
+0.1

data/bin/mozconfig

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "mozconfig"
+
+MozConfig::TUI.new.run

data/lib/core_ext/string.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class String
+  # Checks if a line is commented out or not.
+  def commented?
+    start_with?("#")
+  end
+
+  # Comments a line if it is not already commented out.
+  def comment
+    commented? ? self : "# #{self}"
+  end
+
+  # Uncomments a line if it is commented out.
+  def uncomment
+    gsub(/^#\s*/, "")
+  end
+
+  # Removes whitespace from the beginning of the String.
+  def strip_beginning
+    gsub(/^\s*/, "")
+  end
+end

data/lib/mozconfig.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "optimist"
+require "tty-prompt"
+
+require "core_ext/string"
+
+VERSION = File.read(File.expand_path("../VERSION", __dir__)).strip.freeze
+
+module MozConfig
+  class TUI
+    def initialize
+      check_options
+
+      unless File.exist?("mozconfig")
+        $stderr.puts "Error: mozconfig not found."
+        exit 1
+      end
+
+      # Fix whitespace-only lines and split by paragraph, then each paragraph
+      # into lines
+      @mozconfig = File.read("mozconfig")
+        .gsub(/^\s+$/, "")
+        .split(/\n{2,}/)
+        .map { |p| p.lines.map(&:strip_beginning) }
+
+      # Only paragraphs that begin with a comment are recognized as configs;
+      # anything else will remain active globally.
+      configs, @globals = @mozconfig.partition { |p| p.first.commented? }
+      # Form configs into a hash with the names as keys
+      @configs = configs.to_h { |cfg| [cfg.first.uncomment.strip, cfg[1..]] }
+      # Globals won't be manipulated further so we can rejoin them
+      @globals.map!(&:join)
+    end
+
+    def run
+      selection = TTY::Prompt.new.select("Pick a configuration", @configs)
+
+      output = "#{@globals.join("\n\n")}\n\n"
+
+      output << @configs.map do |name, options|
+        action = options == selection ? :uncomment : :comment
+        "#{name.comment}\n#{options.map(&action).join}"
+      end.join("\n\n")
+
+      File.write("mozconfig", output)
+    end
+
+    private
+
+    # Parses command-line options.
+    def check_options
+      @opts = Optimist.options do
+        version "mozconfig Picker #{VERSION}"
+        banner version
+        banner "https://github.com/vinnydiehl/mozconfig"
+        banner "\nOptions:"
+        opt :version, "display version number"
+        opt :help, "display this message"
+        educate_on_error
+      end
+    end
+  end
+end

data/mozconfig.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |gem|
+  gem.name = "mozconfig"
+  gem.version = File.read(File.expand_path("VERSION", __dir__)).strip
+
+  gem.author = "Vinny Diehl"
+  gem.email = "vinny.diehl@gmail.com"
+  gem.homepage = "https://github.com/vinnydiehl/mozconfig"
+  gem.metadata["rubygems_mfa_required"] = "true"
+
+  gem.license = "MIT"
+
+  gem.summary = "TUI mozconfig switcher"
+  gem.description = "Switch between mozconfigs quickly and easily."
+
+  gem.bindir = "bin"
+  gem.executables = %w[mozconfig]
+  gem.files = `git ls-files -z`.split "\x0"
+
+  gem.add_dependency "optimist", "~> 3.1"
+  gem.add_dependency "tty-prompt", "~> 0.23"
+
+  gem.add_development_dependency "rubocop", "~> 1.54"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: mozconfig
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vinny Diehl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+description: Switch between mozconfigs quickly and easily.
+email: vinny.diehl@gmail.com
+executables:
+- mozconfig
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- bin/mozconfig
+- lib/core_ext/string.rb
+- lib/mozconfig.rb
+- mozconfig.gemspec
+homepage: https://github.com/vinnydiehl/mozconfig
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: TUI mozconfig switcher
+test_files: []