archlinux 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b2ec1f095b419f4c323bee8fa6f9f1f7215ab0e4b785c3922de9db10e5a0413
-  data.tar.gz: 84fe5ee8d792c03b5a62bac375114c82dcb2d1448dfe55f2a1de33a77f90a8df
+  metadata.gz: 9a503802bfcc8eecbd6b5605d96f6cf9de4ded00319ec74c9a091d56840fd86b
+  data.tar.gz: 31a14e3c70aed70bad24a5a716fb3088093866ea2db7c7e46b87ca3c101aad24
 SHA512:
-  metadata.gz: c12e913857365c3390faa570f1ffee57a577628d831efb9d974c83ecf4f5b6784c4fb901b2ed09e63d5c5a1bbc025e7b636add7a7801c31e4f2c0b01c8bf68b0
-  data.tar.gz: c74297e0f98dd6c9518420e1d28d2193c5a56f97749ae596a1c6be398ea3f1bfc630e814d5fd889315ce39fcac2030024157902bb954a7ffa212bfd827535fa3
+  metadata.gz: af974b69974f277bf426b912c7619ba7fc6d87ea4fc7dfa86b5858c6abe9b2a6b862d8d32359344d566c2d4a59fd92a74be14ef3fa4bb1cbe955887c07321e80
+  data.tar.gz: 712fc0f6b8035b038facd41ea33df1185be0819d77f0b11caf91cc08440d3432d1765e1eb652aa83865037d6e8d1f0d464475222dcf77264d6acd5493bfe91e2

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 100
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/README.md

@@ -116,4 +116,10 @@ It will do the following:
 
 ## Declarations:
 
-Functions the user will run to declare the state of the system like packages to be present, files, services, user, group...etc
+Functions the user will run to declare the state of the system like packages to
+be present, files, services, user, group...etc
+
+## Utilities:
+
+Methods for logging and small predicates, technically any ruby method is a
+utility. calling it executes the code directly instead of declaring a state.

data/archlinux.gemspec

@@ -4,6 +4,8 @@ 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.1'
-  s.licenses     = ["GPL-3.0-or-later"]
+  s.version     = '0.2.0'
+  s.licenses = ["GPL-3.0-or-later"]
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.required_ruby_version = '>=3.0'
 end

data/lib/archlinux.rb

@@ -1,5 +1,5 @@
 def require_relative_dir(dir)
-  Dir["#{File.dirname(__FILE__)}/#{dir}/**/*.rb"].sort.each { |f| require f }
+  Dir["#{File.dirname(__FILE__)}/#{dir}/**/*.rb"].each { |f| require f }
 end
 
 require_relative 'core'

data/lib/core.rb

@@ -3,35 +3,35 @@
 # of this class
 class State
   def apply(block)
-    instance_eval &block
+    instance_eval(&block)
   end
 
   # Run block on prepare step. id identifies the block uniqueness in the steps.
   # registering a block with same id multiple times replaces old block by new
   # one. if id is nil the block location in source code is used as an id
-  def on_prepare(id=nil, &block)
-    id ||=  caller_locations(1,1).first.to_s
+  def on_prepare(id = nil, &block)
+    id ||= caller_locations(1, 1).first.to_s
     @prepare_steps ||= {}
     @prepare_steps[id] = block
   end
 
   # Same as {#on_prepare} but for install step
-  def on_install(id=nil, &block)
-    id ||=  caller_locations(1,1).first.to_s
+  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
-  def on_configure(id=nil, &block)
-    id ||=  caller_locations(1,1).first.to_s
+  def on_configure(id = nil, &block)
+    id ||= caller_locations(1, 1).first.to_s
     @configure_steps ||= {}
     @configure_steps[id] = block
   end
 
   # Same as {.on_prepare} but for configure step
-  def on_finalize(id=nil, &block)
-    id ||=  caller_locations(1,1).first.to_s
+  def on_finalize(id = nil, &block)
+    id ||= caller_locations(1, 1).first.to_s
     @finalize_steps ||= {}
     @finalize_steps[id] = block
   end
@@ -51,7 +51,7 @@ def run_step(name, step)
   return unless step&.any?
 
   log "=> #{name}"
-  step.each { |_, s| apply(s) }
+  step.each_value { |s| apply(s) }
 end
 
 # @group Core:

data/lib/declarations/file.rb

@@ -21,7 +21,7 @@ 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}
+  @replace << { file: file, pattern: pattern, replacement: replacement }
 
   on_configure do
     @replace.each do |params|
@@ -35,18 +35,32 @@ end
 # link file to destination
 def symlink(target, link_name)
   @symlink ||= Set.new
-  @symlink << {target: target, link_name: link_name}
+  @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]
+
+      if File.directory?(target)
+        log "Can't link directories", target: target, link_name: link_name
+        exit
+      end
+
+      # Check if file exists and is a symlink
+      if File.exist?(link_name) && File.symlink?(link_name)
+        links_to = File.readlink(link_name)
+        next if links_to == target # skip creating link if it's already exists
+
+        # Remove the link if it links to something else
+        File.unlink link_name
+      end
+
       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)
+      FileUtils.mkdir_p(dest_dir)
 
       # link with force
       FileUtils.ln_s(target, link_name, force: true)
@@ -74,7 +88,10 @@ def file(path, content)
 
   on_configure do
     @files.each do |path, content|
+      FileUtils.mkdir_p File.dirname(path)
       File.write(path, content)
+    rescue Errno::ENOENT => e
+      log "Error: Can't write file", file: path, error: e
     end
   end
 end

data/lib/declarations/git.rb

@@ -5,7 +5,7 @@ require 'set'
 # 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}
+  @git_clone << { from: from, to: to }
 
   on_install do
     @git_clone.each do |item|

data/lib/declarations/pacman.rb

@@ -19,29 +19,28 @@ def package(*names)
 
   # 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
+    # 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
+    all = @packages + group_packages # full list of packages that should exist on the system
 
     # actual list on the system
     installed = Set.new(`pacman -Q --quiet --explicit --unrequired --native`.lines.map(&:strip))
 
     unneeded = installed - all
-    next if unneeded.empty?
+    if unneeded.any?
+      log "Removing packages", packages: unneeded
+      sudo("pacman -Rsu #{unneeded.join(" ")}")
+    end
 
-    log "Removing packages", packages: unneeded
-    sudo("pacman -Rs #{unneeded.join(" ")}")
+    # 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
   end
 end
 
@@ -52,23 +51,30 @@ def aur(*names)
   @aurs += names.map(&:to_s)
 
   on_install do
-    names = @aurs || []
-    log "Install AUR packages", packages: names
+    log "Install AUR packages", packages: @aurs
     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)
+      @aurs.each do |package|
+        unless Dir.exist?(package)
+          system("git clone --depth 1 --shallow-submodules https://aur.archlinux.org/#{package}.git")
+        end
         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
+          package_info = `pacman -Qi #{package}`.strip.lines.to_h { |l| l.strip.split(/\s*:\s*/, 2) }
           installed = package_info["Version"].to_s.split("-")[0] == pkgver
 
           system("makepkg --syncdeps --install --noconfirm --needed") unless installed
         end
       end
     end
+
+    foreign = Set.new(`pacman -Qm`.lines.map { |l| l.split(/\s+/, 2).first })
+    unneeded = foreign - @aurs
+    next if unneeded.empty?
+
+    log "Foreign packages to remove", packages: unneeded
+    sudo("pacman -Rsu #{unneeded.join(" ")}")
   end
 end

data/lib/declarations/systemd.rb

@@ -4,7 +4,7 @@ require 'set'
 
 # set timezone and NTP settings during prepare step
 def timedate(timezone: 'UTC', ntp: true)
-  @timedate = {timezone: timezone, ntp: ntp}
+  @timedate = { timezone: timezone, ntp: ntp }
 
   on_configure do
     log "Set timedate", @timedate
@@ -20,21 +20,28 @@ def service(*names)
   @services += names.map(&:to_s)
 
   on_finalize do
-    log "Enable services", services: @services
     user_flags = root? ? "" : "--user"
 
-    system "systemctl enable #{user_flags} #{@services.join(" ")}"
+    services = `systemctl list-unit-files #{user_flags} --state=enabled --type=service --no-legend --no-pager`
+    enabled = services.lines
+    enabled.map! { |l| l.strip.split(/\s+/) }
+    enabled.each { |l| l[0].delete_suffix!(".service") }
+
+    to_enable = @services - enabled.map(&:first)
+
+    if to_enable.any?
+      log "Enable services", services: to_enable
+      system "systemctl enable #{user_flags} #{to_enable.join(" ")}"
+    end
 
     # 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
+    enabled_manually = enabled.select! { |l| l[2] == 'disabled' }.map(&:first)
 
+    to_disable = enabled_manually - @services.to_a
     next if to_disable.empty?
 
     log "Services to disable", packages: to_disable
-    # system "systemctl disable #{user_flags} #{to_disable.join(" ")}"
+    system "systemctl disable #{user_flags} #{to_disable.join(" ")}"
   end
 end
 
@@ -46,7 +53,7 @@ def timer(*names)
 
   on_finalize do
     log "Enable timers", timers: @timers
-    timers = @timers.map{ |t| "#{t}.timer" }.join(" ")
+    timers = @timers.map { |t| "#{t}.timer" }.join(" ")
     if root?
       sudo "systemctl enable #{timers}"
     else

data/lib/declarations/user.rb

@@ -5,14 +5,15 @@ require 'etc'
 
 # 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)
+def user(name, groups: [], autologin: nil, &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][:autologin] = autologin unless autologin.nil?
+  @user[name][:state] ||= State.new
   @user[name][:state].apply(block) if block_given?
 
   on_configure do
@@ -21,6 +22,15 @@ def user(name, groups: [], &block)
       sudo "useradd #{name}" unless exists
       sudo "usermod --groups #{groups.join(",")} #{name}" if groups.any?
 
+      if conf[:autologin]
+        FileUtils.mkdir_p '/etc/systemd/system/getty@tty1.service.d'
+        file '/etc/systemd/system/getty@tty1.service.d/autologin.conf', <<~FILE
+          [Service]
+          ExecStart=
+          ExecStart=-/sbin/agetty -o '-p -f -- \\u' --noclear --autologin #{name} %I $TERM
+        FILE
+      end
+
       fork do
         currentuser = Etc.getpwnam(name)
         Process::GID.change_privilege(currentuser.gid)

data/lib/utils.rb

@@ -1,11 +1,11 @@
 require 'etc'
 
-# @group Utilities: Methods for logging and small predicates
+# @group Utilities
 
 # Prints a message to the STDOUT
 # @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={})
+def log(msg, args = {})
   puts msg
 
   return unless args.any?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archlinux
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Emad Elsaid
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - README.md
 - archlinux.gemspec
 - lib/applications/ufw.rb
@@ -30,7 +31,8 @@ files:
 homepage: https://github.com/emad-elsaid/archlinux
 licenses:
 - GPL-3.0-or-later
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -39,7 +41,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="