archlinux 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f95fc88d318bc67d0abe5281c5eb940ed50e024f9f064f3af4c3d6a72edbcc87
-  data.tar.gz: 55e6b4029e5920f2e659f4cf4c0e532cc1216f7570bb9064836284027697d397
+  metadata.gz: 0b2ec1f095b419f4c323bee8fa6f9f1f7215ab0e4b785c3922de9db10e5a0413
+  data.tar.gz: 84fe5ee8d792c03b5a62bac375114c82dcb2d1448dfe55f2a1de33a77f90a8df
 SHA512:
-  metadata.gz: cf9d3e93c200ec678bcb960dddb13c16fa534387104e22a02f64d0a66f1bd740c92bcf1fd318cbe4cd7c8864bece2ca709b5acdee667cb196ce9a106f9453542
-  data.tar.gz: d7b4b04d3412daf906d20fb94c7f4d9451dc4007dae41b3c23c3d22c857a92e0a5b2e7c4e63f709a8a32f41e255ec532c795d1328e75c5fe749c88a42c51cbe3
+  metadata.gz: c12e913857365c3390faa570f1ffee57a577628d831efb9d974c83ecf4f5b6784c4fb901b2ed09e63d5c5a1bbc025e7b636add7a7801c31e4f2c0b01c8bf68b0
+  data.tar.gz: c74297e0f98dd6c9518420e1d28d2193c5a56f97749ae596a1c6be398ea3f1bfc630e814d5fd889315ce39fcac2030024157902bb954a7ffa212bfd827535fa3

data/README.md

@@ -1,5 +1,7 @@
 # Archlinux
 
+[![Gem Version](https://badge.fury.io/rb/archlinux.svg)](https://badge.fury.io/rb/archlinux)
+
 > [!WARNING]
 > this can break your system, don't use it on your running system
 
@@ -108,3 +110,10 @@ It will do the following:
 - Make sure services and timers are running
 - Do other configurations like locale, X11 keyboard settings, hostname
 - Ensure users are created and in specified groups
+
+
+# Concepts
+
+## Declarations:
+
+Functions the user will run to declare the state of the system like packages to be present, files, services, user, group...etc

data/archlinux.gemspec

@@ -4,6 +4,6 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.lines.map(&:chomp)
   s.name        = 'archlinux'
   s.summary     = "Archlinux DSL to manage whole system state"
-  s.version     = '0.0.0'
+  s.version     = '0.0.1'
   s.licenses     = ["GPL-3.0-or-later"]
 end

data/lib/applications/ufw.rb

@@ -0,0 +1,16 @@
+require 'set'
+
+# @group Declarations:
+
+# setup add ufw enable it and allow ports during configure step
+def ufw(*allow)
+  @ufw ||= Set.new
+  @ufw += allow.map(&:to_s)
+
+  package :ufw
+  service :ufw
+
+  on_configure do
+    sudo "ufw allow #{@ufw.join(' ')}"
+  end
+end

data/lib/archlinux.rb

@@ -1,5 +1,10 @@
+def require_relative_dir(dir)
+  Dir["#{File.dirname(__FILE__)}/#{dir}/**/*.rb"].sort.each { |f| require f }
+end
+
 require_relative 'core'
 require_relative 'utils'
-require_relative 'declarations'
+require_relative_dir 'declarations'
+require_relative_dir 'applications'
 
 Signal.trap("INT") { exit } # Suppress stack trace on Ctrl-C

data/lib/core.rb

@@ -1,9 +1,6 @@
-# ==============================================================
-# CORE:
 # State of the system It should hold all the information we need to build the
 # system, packages, files, changes...etc. everything will run inside an instance
 # of this class
-# ==============================================================
 class State
   def apply(block)
     instance_eval &block
@@ -18,21 +15,21 @@ class State
     @prepare_steps[id] = block
   end
 
-  # Same as on_prepare but for install step
+  # Same as {#on_prepare} but for install step
   def on_install(id=nil, &block)
     id ||=  caller_locations(1,1).first.to_s
     @install_steps ||= {}
     @install_steps[id] = block
   end
 
-  # Same as on_prepare but for configure step
+  # Same as {.on_prepare} but for configure step
   def on_configure(id=nil, &block)
     id ||=  caller_locations(1,1).first.to_s
     @configure_steps ||= {}
     @configure_steps[id] = block
   end
 
-  # Same as on_finalize but for configure step
+  # Same as {.on_prepare} but for configure step
   def on_finalize(id=nil, &block)
     id ||=  caller_locations(1,1).first.to_s
     @finalize_steps ||= {}
@@ -41,29 +38,25 @@ class State
 
   # Run all registered code blocks in the following order: Prepare, Install, Configure, Finalize
   def run_steps
-    if @prepare_steps&.any?
-      log "=> Prepare"
-      @prepare_steps.each { |_, step| apply(step) }
-    end
+    run_step("Prepare", @prepare_steps)
+    run_step("Install", @install_steps)
+    run_step("Configure", @configure_steps)
+    run_step("Finalize", @finalize_steps)
+  end
+end
 
-    if @install_steps&.any?
-      log "=> Install"
-      @install_steps.each { |_, step| apply(step) }
-    end
+private
 
-    if @configure_steps&.any?
-      log "=> Configure"
-      @configure_steps.each { |_, step| apply(step) }
-    end
+def run_step(name, step)
+  return unless step&.any?
 
-    if @finalize_steps&.any?
-      log "=> Finalize"
-      @finalize_steps.each { |_, step| apply(step) }
-    end
-  end
+  log "=> #{name}"
+  step.each { |_, s| apply(s) }
 end
 
-# passed block will run in the context of a State instance and then a builder
+# @group Core:
+
+# passed block will run in the context of a {State} instance and then a builder
 # will build this state
 def linux(&block)
   s = State.new

data/lib/declarations/file.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+
+# @group Declarations:
+
+# Copy src inside dest during configure step, if src/. will copy src content to dest
+def copy(src, dest)
+  @copy ||= []
+  @copy << { src: src, dest: dest }
+
+  on_configure do
+    next unless @copy
+    next if @copy.empty?
+
+    @copy.each do |item|
+      log "Copying", item
+      FileUtils.cp_r item[:src], item[:dest]
+    end
+  end
+end
+
+# Replace a regex pattern with replacement string in a file during configure step
+def replace(file, pattern, replacement)
+  @replace ||= []
+  @replace << {file: file, pattern: pattern, replacement: replacement}
+
+  on_configure do
+    @replace.each do |params|
+      input = File.read(params[:file])
+      output = input.gsub(params[:pattern], params[:replacement])
+      File.write(params[:file], output)
+    end
+  end
+end
+
+# link file to destination
+def symlink(target, link_name)
+  @symlink ||= Set.new
+  @symlink << {target: target, link_name: link_name}
+
+  on_configure do
+
+    @symlink.each do |params|
+      target = File.expand_path params[:target]
+      link_name = File.expand_path params[:link_name]
+      log "Linking", target: target, link_name: link_name
+
+      # make the parent if it doesn't exist
+      dest_dir = File.dirname(link_name)
+      FileUtils.mkdir_p(dest_dir) unless File.exist?(dest_dir)
+
+      # link with force
+      FileUtils.ln_s(target, link_name, force: true)
+    end
+  end
+end
+
+# on prepare make sure the directory exists
+def mkdir(*path)
+  path.flatten!
+  @mkdir ||= Set.new
+  @mkdir += path
+
+  on_prepare do
+    @mkdir.each do |path|
+      FileUtils.mkdir_p File.expand_path(path)
+    end
+  end
+end
+
+# Write a file during configure step
+def file(path, content)
+  @files ||= {}
+  @files[path] = content
+
+  on_configure do
+    @files.each do |path, content|
+      File.write(path, content)
+    end
+  end
+end

data/lib/declarations/git.rb

@@ -0,0 +1,22 @@
+require 'set'
+
+# @group Declarations:
+
+# on prepare make sure a git repository is cloned to directory
+def git_clone(from:, to: nil)
+  @git_clone ||= Set.new
+  @git_clone << {from: from, to: to}
+
+  on_install do
+    @git_clone.each do |item|
+      from = item[:from]
+      to = item[:to]
+      system "git clone #{from} #{to}" unless File.exist?(File.expand_path(to))
+    end
+  end
+end
+
+# git clone for github repositories
+def github_clone(from:, to: nil)
+  git_clone(from: "https://github.com/#{from}", to: to)
+end

data/lib/declarations/pacman.rb

@@ -0,0 +1,74 @@
+require 'set'
+require 'fileutils'
+
+# @group Utilities
+
+# Utility function, returns true of package is installed
+def package?(name)
+  system("pacman -Qi #{name} &> /dev/null")
+end
+
+# @group Declarations:
+
+# Install a package on install step and remove packages not registered with this
+# function
+def package(*names)
+  names.flatten!
+  @packages ||= Set.new
+  @packages += names.map(&:to_s)
+
+  # install step to install packages required and remove not required
+  on_install do
+    # install missing packages
+    need_install = @packages.reject { |p| package? p }
+    need_install_args = need_install.join(" ")
+    if need_install.any?
+      log "Installing packages", packages: need_install
+      sudo "pacman --noconfirm --needed -S #{need_install_args}"
+    end
+
+    # expand groups to packages
+    packages_args = @packages.join(" ")
+    group_packages = Set.new(`pacman --quiet -Sg #{packages_args}`.lines.map(&:strip))
+
+    # full list of packages that should exist on the system
+    all = @packages + group_packages
+
+    # actual list on the system
+    installed = Set.new(`pacman -Q --quiet --explicit --unrequired --native`.lines.map(&:strip))
+
+    unneeded = installed - all
+    next if unneeded.empty?
+
+    log "Removing packages", packages: unneeded
+    sudo("pacman -Rs #{unneeded.join(" ")}")
+  end
+end
+
+# aur command to install packages from aur on install step
+def aur(*names)
+  names.flatten!
+  @aurs ||= Set.new
+  @aurs += names.map(&:to_s)
+
+  on_install do
+    names = @aurs || []
+    log "Install AUR packages", packages: names
+    cache = "./cache/aur"
+    FileUtils.mkdir_p cache
+    Dir.chdir cache do
+      names.each do |package|
+        system("git clone --depth 1 --shallow-submodules https://aur.archlinux.org/#{package}.git") unless Dir.exist?(package)
+        Dir.chdir package do
+
+          pkgbuild = File.readlines('PKGBUILD')
+          pkgver = pkgbuild.find { |l| l.start_with?('pkgver=') }.split('=')[1].strip.chomp('"')
+          package_info = `pacman -Qi #{package}`.strip.lines.map{|l| l.strip.split(/\s*:\s*/, 2) }.to_h
+          installed = package_info["Version"].to_s.split("-")[0] == pkgver
+
+          system("makepkg --syncdeps --install --noconfirm --needed") unless installed
+        end
+      end
+    end
+  end
+end

data/lib/declarations/systemd.rb

@@ -0,0 +1,100 @@
+require 'set'
+
+# @group Declarations:
+
+# set timezone and NTP settings during prepare step
+def timedate(timezone: 'UTC', ntp: true)
+  @timedate = {timezone: timezone, ntp: ntp}
+
+  on_configure do
+    log "Set timedate", @timedate
+    sudo "timedatectl set-timezone #{@timedate[:timezone]}"
+    sudo "timedatectl set-ntp #{@timedate[:ntp]}"
+  end
+end
+
+# enable system service if root or user service if not during finalize step
+def service(*names)
+  names.flatten!
+  @services ||= Set.new
+  @services += names.map(&:to_s)
+
+  on_finalize do
+    log "Enable services", services: @services
+    user_flags = root? ? "" : "--user"
+
+    system "systemctl enable #{user_flags} #{@services.join(" ")}"
+
+    # Disable services that were enabled manually and not in the list we have
+    services = `systemctl list-unit-files #{user_flags} --state=enabled --type=service --no-legend --no-pager`
+    enabled_manually = services.lines.map{|l| l.strip.split(/\s+/) }.select{|l| (l[1] == 'enabled') && (l[2] == 'disabled')}
+    names_without_extension = enabled_manually.map{|l| l.first.delete_suffix(".service") }
+    to_disable = names_without_extension - @services.to_a
+
+    next if to_disable.empty?
+
+    log "Services to disable", packages: to_disable
+    # system "systemctl disable #{user_flags} #{to_disable.join(" ")}"
+  end
+end
+
+# enable system timer if root or user timer if not during finalize step
+def timer(*names)
+  names.flatten!
+  @timers ||= Set.new
+  @timers += names.map(&:to_s)
+
+  on_finalize do
+    log "Enable timers", timers: @timers
+    timers = @timers.map{ |t| "#{t}.timer" }.join(" ")
+    if root?
+      sudo "systemctl enable #{timers}"
+    else
+      system "systemctl enable --user #{timers}"
+    end
+    # disable all other timers
+  end
+end
+
+# set keyboard settings during prepare step
+def keyboard(keymap: nil, layout: nil, model: nil, variant: nil, options: nil)
+  @keyboard ||= {}
+  values = {
+    keymap: keymap,
+    layout: layout,
+    model: model,
+    variant: variant,
+    options: options
+  }.compact
+  @keyboard.merge!(values)
+
+  on_prepare do
+    next unless @keyboard[:keymap]
+
+    sudo "localectl set-keymap #{@keyboard[:keymap]}"
+
+    m = @keyboard.to_h.slice(:layout, :model, :variant, :options)
+    sudo "localectl set-x11-keymap \"#{m[:layout]}\" \"#{m[:model]}\" \"#{m[:variant]}\" \"#{m[:options]}\""
+  end
+end
+
+# Sets locale using localectl
+def locale(value)
+  @locale = value
+
+  on_prepare do
+    sudo "localectl set-locale #{@locale}"
+  end
+end
+
+# Sets the machine hostname
+def hostname(name)
+  @hostname = name
+
+  file '/etc/hostname', "#{@hostname}\n"
+
+  on_configure do
+    log "Setting hostname", hostname: @hostname
+    sudo "hostnamectl set-hostname #{@hostname}"
+  end
+end

data/lib/declarations/user.rb

@@ -0,0 +1,38 @@
+require 'set'
+require 'etc'
+
+# @group Declarations:
+
+# create a user and assign a set of group. if block is passes the block will run
+# in as this user. block will run during the configure step
+def user(name, groups: [], &block)
+  name = name.to_s
+
+  @user ||= {}
+  @user[name] ||= {}
+  @user[name][:groups] ||= []
+  @user[name][:groups] += groups.map(&:to_s)
+  @user[name][:state] = State.new
+  @user[name][:state].apply(block) if block_given?
+
+  on_configure do
+    @user.each do |name, conf|
+      exists = Etc.getpwnam name rescue nil
+      sudo "useradd #{name}" unless exists
+      sudo "usermod --groups #{groups.join(",")} #{name}" if groups.any?
+
+      fork do
+        currentuser = Etc.getpwnam(name)
+        Process::GID.change_privilege(currentuser.gid)
+        Process::UID.change_privilege(currentuser.uid)
+        ENV['XDG_RUNTIME_DIR'] = "/run/user/#{currentuser.uid}"
+        ENV['HOME'] = currentuser.dir
+        ENV['USER'] = currentuser.name
+        ENV['LOGNAME'] = currentuser.name
+        conf[:state].run_steps
+      end
+
+      Process.wait
+    end
+  end
+end

data/lib/utils.rb

@@ -1,10 +1,10 @@
 require 'etc'
 
+# @group Utilities: Methods for logging and small predicates
+
 # Prints a message to the STDOUT
-#
-# @param [String] msg a log message to print
-#
-# @param [Hash<String, Object>] args prints each key and value in separate lines after message
+# @param msg [String] a log message to print
+# @param args [Hash<String, Object>] prints each key and value in separate lines after message
 def log(msg, args={})
   puts msg
 
@@ -22,10 +22,13 @@ def log(msg, args={})
   end
 end
 
+# Checks if current user is the root
+# @return [Boolean] true if current user is root and false otherwise
 def root?
   Process.uid == Etc.getpwnam('root').uid
 end
 
+# Runs the command with sudo if current user is not root
 def sudo(command)
   root? ? system(command) : system("sudo #{command}")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archlinux
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-18 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -18,9 +18,14 @@ extra_rdoc_files: []
 files:
 - README.md
 - archlinux.gemspec
+- lib/applications/ufw.rb
 - lib/archlinux.rb
 - lib/core.rb
-- lib/declarations.rb
+- lib/declarations/file.rb
+- lib/declarations/git.rb
+- lib/declarations/pacman.rb
+- lib/declarations/systemd.rb
+- lib/declarations/user.rb
 - lib/utils.rb
 homepage: https://github.com/emad-elsaid/archlinux
 licenses:

data/lib/declarations.rb

@@ -1,243 +0,0 @@
-require 'set'
-require 'fileutils'
-
-# ==============================================================
-# DECLARATIONS:
-# Functions the user will run to declare the state of the system
-# like packages to be present, files, services, user, group...etc
-# ==============================================================
-
-# Install a package on install step and remove packages not registered with this
-# function
-def package(*names)
-  names.flatten!
-  @packages ||= Set.new
-  @packages += names.map(&:to_s)
-
-  # install step to install packages required and remove not required
-  on_install do
-    # install packages list as is
-    names = @packages.join(" ")
-    log "Installing packages", packages: @packages
-    sudo "pacman --noconfirm --needed -S #{names}" unless @packages.empty?
-
-    # expand groups to packages
-    group_packages = Set.new(`pacman --quiet -Sg #{names}`.lines.map(&:strip))
-
-    # full list of packages that should exist on the system
-    all = @packages + group_packages
-
-    # actual list on the system
-    installed = Set.new(`pacman -Q --quiet --explicit --unrequired --native`.lines.map(&:strip))
-
-    unneeded = installed - all
-    next if unneeded.empty?
-
-    log "Removing packages", packages: unneeded
-    sudo("pacman -Rs #{unneeded.join(" ")}")
-  end
-
-end
-
-# aur command to install packages from aur on install step
-def aur(*names)
-  names.flatten!
-  @aurs ||= Set.new
-  @aurs += names.map(&:to_s)
-
-  on_install do
-    names = @aurs || []
-    log "Install AUR packages", packages: names
-    cache = "./cache/aur"
-    FileUtils.mkdir_p cache
-    Dir.chdir cache do
-      names.each do |package|
-        system("git clone --depth 1 --shallow-submodules https://aur.archlinux.org/#{package}.git") unless Dir.exists?(package)
-        Dir.chdir package do
-          system("makepkg --syncdeps --install --noconfirm --needed")
-        end
-      end
-    end
-  end
-end
-
-# set timezone and NTP settings during prepare step
-def timedate(timezone: 'UTC', ntp: true)
-  @timedate = {timezone: timezone, ntp: ntp}
-
-  on_configure do
-    log "Set timedate", @timedate
-    sudo "timedatectl set-timezone #{@timedate[:timezone]}"
-    sudo "timedatectl set-ntp #{@timedate[:ntp]}"
-  end
-end
-
-# enable system service if root or user service if not during finalize step
-def service(*names)
-  names.flatten!
-  @services ||= Set.new
-  @services += names.map(&:to_s)
-
-  on_finalize do
-    log "Enable services", services: @services
-    user_flags = root? ? "" : "--user"
-
-    system "systemctl enable #{user_flags} #{@services.join(" ")}"
-
-    # Disable services that were enabled manually and not in the list we have
-    services = `systemctl list-unit-files #{user_flags} --state=enabled --type=service --no-legend --no-pager`
-    enabled_manually = services.lines.map{|l| l.strip.split(/\s+/) }.select{|l| (l[1] == 'enabled') && (l[2] == 'disabled')}
-    names_without_extension = enabled_manually.map{|l| l.first.delete_suffix(".service") }
-    to_disable = names_without_extension - @services.to_a
-
-    next if to_disable.empty?
-
-    log "Services to disable", packages: to_disable
-    # system "systemctl disable #{user_flags} #{to_disable.join(" ")}"
-  end
-end
-
-# enable system timer if root or user timer if not during finalize step
-def timer(*names)
-  names.flatten!
-  @timers ||= Set.new
-  @timers += names.map(&:to_s)
-
-  on_finalize do
-    log "Enable timers", timers: @timers
-    timers = @timers.map{ |t| "#{t}.timer" }.join(" ")
-    if root?
-      sudo "systemctl enable #{timers}"
-    else
-      system "systemctl enable --user #{timers}"
-    end
-    # disable all other timers
-  end
-end
-
-# set keyboard settings during prepare step
-def keyboard(keymap: nil, layout: nil, model: nil, variant: nil, options: nil)
-  @keyboard ||= {}
-  values = {
-    keymap: keymap,
-    layout: layout,
-    model: model,
-    variant: variant,
-    options: options
-  }.compact
-  @keyboard.merge!(values)
-
-  on_prepare do
-    next unless @keyboard[:keymap]
-
-    sudo "localectl set-keymap #{@keyboard[:keymap]}"
-
-    m = @keyboard.to_h.slice(:layout, :model, :variant, :options)
-    sudo "localectl set-x11-keymap \"#{m[:layout]}\" \"#{m[:model]}\" \"#{m[:variant]}\" \"#{m[:options]}\""
-  end
-end
-
-def locale(value)
-  @locale = value
-
-  on_prepare do
-    sudo "localectl set-locale #{@locale}"
-  end
-end
-
-# create a user and assign a set of group. if block is passes the block will run
-# in as this user. block will run during the configure step
-def user(name, groups: [], &block)
-  name = name.to_s
-
-  @user ||= {}
-  @user[name] ||= {}
-  @user[name][:groups] ||= []
-  @user[name][:groups] += groups.map(&:to_s)
-  @user[name][:state] = State.new
-  @user[name][:state].apply(block) if block_given?
-
-  on_configure do
-    @user.each do |name, conf|
-      exists = Etc.getpwnam name rescue nil
-      sudo "useradd #{name}" if exists
-      sudo "usermod --groups #{groups.join(",")} #{name}" if groups.any?
-
-      fork do
-        currentuser = Etc.getpwnam(name)
-        Process::GID.change_privilege(currentuser.gid)
-        Process::UID.change_privilege(currentuser.uid)
-        ENV['XDG_RUNTIME_DIR'] = "/run/user/#{currentuser.uid}"
-        conf[:state].run_steps
-      end
-
-      Process.wait
-    end
-  end
-end
-
-# Copy src inside dest during configure step, if src/. will copy src content to dest
-def copy(src, dest)
-  @copy ||= []
-  @copy << { src: src, dest: dest }
-
-  on_configure do
-    next unless @copy
-    next if @copy.empty?
-
-    @copy.each do |item|
-      log "Copying", item
-      FileUtils.cp_r item[:src], item[:dest]
-    end
-  end
-end
-
-# Replace a regex pattern with replacement string in a file during configure step
-def replace(file, pattern, replacement)
-  @replace ||= []
-  @replace << {file: file, pattern: pattern, replacement: replacement}
-
-  on_configure do
-    @replace.each do |params|
-      input = File.read(params[:file])
-      output = input.gsub(params[:pattern], params[:replacement])
-      File.write(params[:file], output)
-    end
-  end
-end
-
-# setup add ufw enable it and allow ports during configure step
-def firewall(*allow)
-  @firewall ||= Set.new
-  @firewall += allow.map(&:to_s)
-
-  package :ufw
-  service :ufw
-
-  on_configure do
-    sudo "ufw allow #{@firewall.join(' ')}"
-  end
-end
-
-# Write a file during configure step
-def file(path, content)
-  @files ||= {}
-  @files[path] = content
-
-  on_configure do
-    @files.each do |path, content|
-      File.write(path, content)
-    end
-  end
-end
-
-def hostname(name)
-  @hostname = name
-
-  file '/etc/hostname', "#{@hostname}\n"
-
-  on_configure do
-    log "Setting hostname", hostname: @hostname
-    sudo "hostnamectl set-hostname #{@hostname}"
-  end
-end