qrpm 0.2.0 → 0.3.0

data/lib/qrpm/rpm.rb

@@ -2,64 +2,102 @@ require 'erb'
 require 'fileutils'
 
 module Qrpm
+  # Knows the following RPM fields:
+  #
+  #   name        Package name (mandatory)
+  #   version     Version (mandatory)
+  #   release     Release
+  #   summary     Short one-line description of package (mandatory)
+  #   description Description
+  #   packager    Name of the packager (defaults to the name of the user or 
+  #               $USER@$HOSTNAME if not found)
+  #   license     License (defaults to GPL)
+  #   require     Array of required packages
+  #   make        Controls the build process:
+  #                 null    Search the top-level directory for configure or
+  #                         make files and runs them. Skip building if not 
+  #                         found. This is the default
+  #                 true    Expect the top-level directory to contain 
+  #                         configure or make files and runs them. It is an 
+  #                         error if the Makefile is missing
+  #                 (array of commands)
+  #                         Runs the commands to build the project
+  #
+  # Each field has a dynamically generated accessor method that can be
+  # referenced in the template file
   class Rpm
-    # Defines the following member methods:
-    #
-    #   name        Package name
-    #   version     Version
-    #   release     Release
-    #   license     License (defaults to GPL)
-    #   summary     Short one-line description of package
-    #   description Description
-    #   packager    Name of the packager (defaults to the name of the current
-    #               user or the value of the $USER environment variable if not
-    #               found)
-    #   require     Array of required packages
-    #   make        Controls the build process:
-    #                 null    Search the top-level directory for configure or
-    #                         make files and runs them. Skip building if not 
-    #                         found. This is the default
-    #                 true    Expect the top-level directory to contain 
-    #                         configure make files and runs them. It is an 
-    #                         error if the Makefile is missing
-    #                 (array of commands)
-    #                         Runs the commands to build the project
-    #
-    FIELDS = %w(name version release group license summary description packager requires make)
-    MANDATORY_FIELDS = %w(name summary version)
-    TEMPLATE = "#{::File.dirname(__FILE__)}/template.erb"
+    MANDATORY_FIELDS = %w(name version summary)
+
+    # Maps from field name to array of allowed types for that field
+    FIELDS = MANDATORY_FIELDS.map { |f| [f, [String]] }.to_h.merge({
+      "release" => [String],
+      "description" => [String],
+      "packager" => [String],
+      "license" => [String],
+      "group" => [String],
+      "include" => [Array, String],
+      "require" => [Array, String],
+      "make" => [Array, String]
+    })
 
     RPM_DIRS = %w(SOURCES BUILD RPMS SPECS SRPMS tmp)
 
-    # Field accessor methods
-    FIELDS.each { |f| eval "def #{f}() @fields[\"#{f}\"] end" }
+    # Field accessor methods. FIXME Value should have been resolved
+    FIELDS.each { |f,ts| 
+      if ts.include? Array
+        eval <<-EOS
+          def #{f}() 
+            case v = @fields["#{f}"]
+              when ValueNode
+                v.value
+              when ArrayNode
+                v.values.map(&:value)
+              else
+                raise ArgumentError, "Can this even happen?"
+            end
+          end
+        EOS
+      else
+        eval "def #{f}() @fields[\"#{f}\"]&.value end"
+      end
+    }
 
     attr_reader :fields
     attr_reader :nodes
 
+    # The source directory
+    attr_reader :srcdir
+
     # The content of the SPEC file
     attr_reader :spec
 
     def files() @files ||= nodes.select(&:file?) end
-    def links() @lines ||= nodes.select(&:link?) end
-
-    def verbose?() @verbose end
-
-    def initialize(fields, nodes, template: TEMPLATE, verbose: false)
+    def links() @links ||= nodes.select(&:link?) end
+    def reflinks() @reflinks ||= nodes.select(&:reflink?) end
+    def symlinks() @symlinks ||= nodes.select(&:symlink?) end
+
+    def initialize(srcdir, fields, nodes, template: QRPM_ERB_FILE)
+      constrain srcdir, String
+      constrain fields, String => Node
+      constrain nodes, [FileNode]
       @fields, @nodes = fields, nodes
+      @srcdir = srcdir
       @template = template
-      @verbose = verbose
-      @verb = verbose ? "" : "&>/dev/null"
     end
 
-    def has_configure?() ::File.exist? "configure" end
-    def has_make?() ::File.exist? "make" end
+    def has_configure?() ::File.exist? "#{srcdir}/configure" end
+    def has_make?() ::File.exist? "#{srcdir}/Makefile" end
 
-    def build(target: :rpm, file: nil, verbose: false, destdir: ".")
+    def build(target: :rpm, file: nil, verbose: false, destdir: ".", builddir: nil)
       verb = verbose ? "" : "&>/dev/null"
-      Dir.mktmpdir { |rootdir|
-        FileUtils.rm_rf(rootdir)
-        FileUtils.mkdir_p(rootdir)
+      begin
+        if builddir
+          rootdir = builddir
+          FileUtils.rm_rf(rootdir)
+          FileUtils.mkdir_p(rootdir)
+        else
+          rootdir = Dir.mktmpdir
+        end
 
         spec_file = file || "#{name}.spec"
         tar_file = "#{name}.tar.gz"
@@ -69,47 +107,51 @@ module Qrpm
         # Create directories
         RPM_DIRS.each { |dir| FileUtils.mkdir_p "#{rootdir}/#{dir}" }
 
-        # Directory for tarball creation. This lives inside the RPM directory
-        # structure and is removed before we start rpmbuild
-        tarroot = "#{rootdir}/tmp/#{name}"
-        FileUtils.mkdir(tarroot)
-
-        # Copy files
-        FileUtils.cp_r(".", tarroot, preserve: true)
-        
-        # Roll tarball and put it in the SOURCES directory
-        system "tar zcf #{tar_path} -C #{rootdir}/tmp #{name} #{verb}" or raise "Can't roll tarball"
-
-        # Remove temporary tar dir
-        FileUtils.rm_rf tarroot
-
-        # Create spec file
+        # Roll tarball
+        #
+        # It is a bad idea to use git-archive to roll a tarball because we may
+        # have configuration files/scripts that are not included in the git
+        # repository. If needed then see
+        # https://gist.github.com/arteymix/03702e3eb05c2c161a86b49d4626d21f
+        #
+        # Alternatively use the --add-file option? Then we need to know if
+        # files are in the git repo or not
+        system "tar zcf #{tar_path} --transform=s%^\./%#{name}/% ." # FIXME FIXME
+
+        # Create spec file. Initial blanks are removed from each line in the file
         renderer = ERB.new(IO.read(@template).sub(/^__END__\n.*/m, ""), trim_mode: "-")
-        @spec = renderer.result(binding)
+        @spec = renderer.result(binding).gsub(/^[[:blank:]]*/, "")
 
         # Emit spec or build RPM
         if target == :spec
-          IO.write("#{destdir}/#{spec_file}", @spec)
+          destfiles = ["#{destdir}/#{spec_file}"]
+          IO.write(destfiles.first, @spec)
         else
           IO.write(spec_path, @spec)
           system "rpmbuild -v -ba --define \"_topdir #{rootdir}\" #{rootdir}/SPECS/#{name}.spec #{verb}" or
               raise "Failed building RPM file. Re-run with -v option to see errors"
           if target == :srpm
-            system "cp #{rootdir}/SRPMS/* #{destdir}" or raise "Failed copying SRPM file"
+            destfiles = Dir["#{rootdir}/SRPMS/*"]
+            !destfiles.empty? or raise Error, "No SRPM file found"
           elsif target == :rpm
-            system "cp #{rootdir}/RPMS/*/#{name}-[0-9]* #{destdir}" or raise "Failed copying RPM file"
+            destfiles = Dir["#{rootdir}/RPMS/*/#{name}-[0-9]*"]
+            !destfiles.empty? or raise Error, "No RPM file found"
           else
             raise ArgumentError, "Not a valid value for :target - #{target.inspect}"
           end
+          system "cp #{destfiles.join " "} #{destdir}" or raise "Failed copying SRPM file"
         end
-      }
+        return destfiles
+      ensure
+        FileUtils.remove_entry_secure rootdir if !builddir
+      end
     end
 
     def dump
       puts self.class
       indent {
         puts "fields"
-        indent { fields.each { |k,v| puts "#{k}: #{v.inspect}" } }
+        indent { fields.sort_by(&:first).each { |k,v| puts "#{k}: #{v.value}" } }
         puts "nodes"
         indent { nodes.map(&:dump) }
       }

data/lib/qrpm/template.erb

@@ -1,4 +1,3 @@
-
 Name: <%= name %>
 Summary: <%= summary %>
 Version: <%= version %>
@@ -6,13 +5,12 @@ Release: <%= release %>
 License: <%= license %>
 Packager: <%= packager %>
 <% if group -%>
-Group: <%= group %>
+  Group: <%= group %>
 <% end -%>
-<% for pck in requires || [] -%>
-Requires: <%= pck %>
+<% for pck in require || [] -%>
+  Requires: <%= pck %>
 <% end -%>
 Source: %{name}.tar.gz
-BuildRoot: <%= rootdir %>/tmp/%{name}-%{version}
 
 %description
 <%= description %>
@@ -21,55 +19,56 @@ BuildRoot: <%= rootdir %>/tmp/%{name}-%{version}
 %setup -n <%= name %>
 
 %build
+cd <%= srcdir %>
 <% if make.nil? -%>
-<% if has_configure? -%>
-./configure
-<% end -%>
-<% if has_make? -%>
-make
-<% end -%>
+  <% if has_configure? -%>
+    ./configure
+  <% end -%>
+  <% if has_make? -%>
+    make
+  <% end -%>
 <% elsif make == false -%>
 <% elsif make == true -%>
-<% if has_configure? -%>
-./configure
-<% end -%>
-make
+  <% if has_configure? -%>
+    ./configure
+  <% end -%>
+  make
 <% elsif make.is_a? Array -%>
-<% for cmd in make -%>
-<%= cmd %>
-<% end -%>
+  <% for cmd in make -%>
+    <%= cmd.value  %>
+  <% end -%>
 <% end -%>
 
 %install
 <% if !nodes.empty? -%>
 mkdir -p <%= nodes.map { |f| "%{buildroot}#{f.directory}" }.uniq.join(" ") %>
 <% for file in files -%>
-cp <%= file.file %> %{buildroot}<%= file.path %>
+cp <%= file.srcpath %> %{buildroot}<%= file.dstpath %>
 <% end -%>
 <% for link in links -%>
-touch %{buildroot}<%= link.path %>
+touch %{buildroot}<%= link.dstpath %>
 <% end -%>
 <% end -%>
 
 %files
 <% for file in files -%>
-<%= file.path %>
+<%= file.dstpath %>
 <% end -%>
 <% for link in links -%>
-%ghost <%= link.path %>
+%ghost <%= link.dstpath %>
 <% end -%>
 
 %clean
-%if "%{clean}" != ""
-  rm -rf %{_topdir}/BUILD/%{name}
-  [ $(basename %{buildroot}) == "%{name}-%{version}-%{release}.%{_target_cpu}" ] && rm -rf %{buildroot}
-%endif
+true # no-op
 
 %post
 <% for file in files.select(&:perm) -%>
-chmod <%= file.perm %> <%= file.path %>
+chmod <%= file.perm %> <%= file.dstpath %>
+<% end -%>
+<% for file in reflinks -%>
+ln -sf <%= link.reflink %> <%= link.dstpath %>
 <% end -%>
-<% for file in links -%>
-ln -sf <%= link.link %> <%= link.path %>
+<% for file in symlinks -%>
+ln -sf <%= link.symlink %> <%= link.dstpath %>
 <% end -%>
 

data/lib/qrpm/template.yml

@@ -45,7 +45,7 @@ make: null      # make can be undefined or null (use make if present), false
 #
 # It is used like this
 #   
-#   /opt/my_files
+#   /opt/my_files:
 #     - name: data
 #       file: src/my_data
 #       perm: 600
@@ -53,18 +53,17 @@ make: null      # make can be undefined or null (use make if present), false
 # This will copy src/my_data to a 'data' file in the /opt/my_files directory
 # with permissions 0600
 #
-# Links can only be specified using attributes
+# Link files are specified using the :link attribute that is a path on the
+# target system:
 #
-#   name: Destination file name. Default is the last path component in :link
-#   link: Path to the file that will be pointed to by the link
+#   /opt/my_files:
+#     - name: linked_data
+#       link: /opt/my_files/data
 #
-# To create a symbolic link in /var/lib/ from my_app to /opt/my_files/data:
+# Default name for link files is the basename of of :link
 #
-#   libdir:
-#     - name: my_app
-#       link: /opt/my_files/data
 #
-# The following standard directories are defined:
+# The following standard directories are defined: FIXME Outdated
 #
 #   etcdir            /etc            Configuration files
 #   bindir            /usr/bin        Executables
@@ -72,16 +71,20 @@ make: null      # make can be undefined or null (use make if present), false
 #   libdir            /usr/lib        Libraries (both binary and clear text)
 #   libexecdir        /usr/libexec    Executable subprograms (not meant to be 
 #                                     called indepentently)
-#   sharedir          /usr/share      Constant data files. FIXME: Always a subdir
+#   sharedir          /usr/share      Constant data files
 #   vardir            /var/lib        Variable data files
 #   spooldir          /var/spool      Spool files
 #   rundir            /var/run        Run files
 #   lockdir           /var/lock       Lock files
 #   cachedir          /var/cache      Cache directory
-#   tmpdir            /tmp            Temporary directory (deleted when the '
-#                                     machine starts)
+#   tmpdir            /tmp            Temporary directory (deleted between restarts)
+#   vartmpdir         /var/tmp        TODO
 #   logdir            /var/log        Log directory
 #
+#   pckdir            <package-name>  Name of package directory. It is always the
+#                                     name of the directory in /usr/share
+#
+#
 # Each standard directory can also be prefixed a 'pck'. That will create a
 # subdirectory with the package's name in the base standard directory. Eg.
 # 'pcketcdir' will create the directory '/etc/<name>'

data/lib/qrpm/utils.rb

@@ -0,0 +1,10 @@
+module Qrpm
+  # Get full name of user, defaults to username '@' hostname
+  def self.fullname
+    s = Etc.getpwnam(ENV['USER'])&.gecos
+    if s.nil? || s == ""
+      s = "#{ENV['USER']}@#{ENV['HOSTNAME']}"
+    end
+    s
+  end
+end

data/lib/qrpm/version.rb

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

data/lib/qrpm.rb

@@ -1,16 +1,122 @@
 # frozen_string_literal: true
 
+require 'etc'
+
+require 'indented_io'
+require "constrain"
+require "forward_to"
+
+include Constrain
+include ForwardTo
+
 require_relative "qrpm/version"
 require_relative "qrpm/node.rb"
+require_relative "qrpm/fragment.rb"
+require_relative "qrpm/lexer.rb"
+require_relative "qrpm/compiler.rb"
+require_relative "qrpm/qrpm.rb"
 require_relative "qrpm/rpm.rb"
-require_relative "qrpm/parser.rb"
+require_relative "qrpm/utils.rb"
 
 module Qrpm
   class Error < RuntimeError; end
+  class CompileError < StandardError; end
+  class AbstractMethodError < StandardError; end
+  def abstract_method = raise AbstractMethodError.new "Abstract method called"
 
   QRPM_CONFIG_FILE = "qrpm.yml"
 
   QRPM_SHARE_DIR = "#{::File.dirname(__FILE__)}/../lib/qrpm"
   QRPM_CONFIG_FILE_TEMPLATE = "#{QRPM_SHARE_DIR}/template.yml"
   QRPM_ERB_FILE = "#{QRPM_SHARE_DIR}/template.erb"
+
+  # Should be defined and non-empty
+  MANDATORY_FIELDS = Rpm::MANDATORY_FIELDS
+
+  # Maps from field name to array of allowed types for that field
+  FIELDS = Rpm::FIELDS.map { |k,ts|
+    nts = ts.map { |t|
+      if t == String
+        ValueNode
+      elsif t == Array
+        ArrayNode
+      else
+        raise ArgumentError, "Illegal type: #{t.inspect}"
+      end
+    }
+    [k, nts]
+  }.to_h
+
+  STANDARD_DIRS = %w(
+    etcdir bindir sbindir libdir libexecdir sharedir docdir vardir spooldir
+    rundir lockdir cachedir logdir tmpdir
+  )
+
+  ROOT_DIRS = {
+    rootdir: "/",
+    rootconfdir: "$rootdir/etc",
+    rootexecdir: "$rootdir/usr",
+    rootlibdir: "$rootdir/usr",
+    rootconstdir: "$rootdir/usr/share",
+    rootdocdir: "$rootconstdir",
+    rootdatadir: "$rootdir/var"
+  }
+
+  SYSTEM_DIRS = {
+    sysetcdir: "$rootconfdir",
+    sysbindir: "$rootexecdir/bin",
+    syssbindir: "$rootexecdir/sbin",
+    syslibdir: "$rootlibdir/lib64",
+    syslibexecdir: "$rootexecdir/libexec",
+    syssharedir: "$rootconstdir/$pckdir", # Always a subdir of /usr/share
+    sysdocdir: "$syssharedir",
+    sysvardir: "$rootdatadir/lib",
+    sysspooldir: "$rootdatadir/spool",
+    sysrundir: "$rootdatadir/run",
+    syslockdir: "$rootdatadir/lock",
+    syscachedir: "$rootdatadir/cache",
+    syslogdir: "$rootdatadir/log",
+    systmpdir: "/tmp" # Always /tmp because of security
+  }
+
+  # There are no package-specific versions of bindir and sbindir
+  PACKAGE_DIRS = {
+    pcketcdir: "$sysetcdir/$pckdir",
+    pckbindir: "$sysbindir", # No subdir
+    pcksbindir: "$syssbindir", # No subdir
+    pcklibdir: "$syslibdir/$pckdir",
+    pcklibexecdir: "$syslibexecdir/$pckdir",
+    pcksharedir: "$syssharedir/$pckdir",
+    pckdocdir: "$sysdocdir/$pckdir",
+    pckvardir: "$sysvardir/$pckdir",
+    pckspooldir: "$sysspooldir/$pckdir",
+    pckrundir: "$sysrundir/$pckdir",
+    pcklockdir: "$syslockdir/$pckdir",
+    pckcachedir: "$syscachedir/$pckdir",
+    pcklogdir: "$syslogdir/$pckdir",
+    pcktmpdir: "$systmpdir/$pckdir"
+  }
+
+  INSTALL_DIRS = ROOT_DIRS.merge SYSTEM_DIRS.merge PACKAGE_DIRS
+
+  DEFAULTS = {
+    "name" => "$(basename $PWD)",
+    "summary" => "The $name RPM package",
+    "version" => "$(cd ${{srcdir}} && git tag -l 2>/dev/null | tail -1 | tr -dc '.0-9' || echo 0.0.0)",
+    "description" => "$summary",
+    "release" => "1",
+    "license" => "GPL",
+    "packager" => ::Qrpm.fullname,
+    "currdir" => ".", # The directory from where the qrpm was run. Initialized by the client program
+    "qrpmdir" => ".", # The directory containing the qrpm file. Initialized by the client program
+    "srcdir" => ".",
+    "pckdir" => "$name",
+    "make" => nil
+  }
+
+  IDENT_RE = /(?:[\w_][\w\d_]*)/
+  PATH_RE = /(?:[\w_][\w\d_.]*)/
+
+  FILE_KEYS = %w(name file symlink reflink perm)
 end
+

data/qrpm.gemspec

@@ -11,8 +11,6 @@ Gem::Specification.new do |spec|
   spec.summary       = "Gem qrpm"
   spec.description   = "Gem qrpm"
   spec.homepage      = "http://www.nowhere.com/"
-  spec.required_ruby_version = ">= 2.4.0"
-
 
   spec.metadata["homepage_uri"] = spec.homepage
 
@@ -27,8 +25,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "shellopts", "~> 2.0.0"
+  spec.add_dependency "shellopts", "~> 2.1.1"
   spec.add_dependency "indented_io"
+  spec.add_dependency "constrain"
+  spec.add_dependency "forward_to"
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qrpm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Claus Rasmussen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shellopts
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.1
 - !ruby/object:Gem::Dependency
   name: indented_io
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: constrain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: forward_to
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem qrpm
 email:
 - claus.l.rasmussen@gmail.com
@@ -49,27 +77,39 @@ files:
 - ".rspec"
 - ".ruby-version"
 - Gemfile
+- NOTES
 - README.md
 - Rakefile
+- TODO
 - bin/console
 - bin/setup
 - clean
 - cmd
+- doc/pg.yml
+- doc/qrpm2.rb
+- doc/qrpm2.yml
 - example.yml
 - example/bin/a_file
 - example/bin/another_file
+- example/configure
+- example/make
+- example/my_package_name-1.2.3-4.x86_64.rpm
+- example/my_package_name.spec
 - example/qrpm.yml
 - example/share/some_data
 - example/share/some_other_data
 - exe/qrpm
 - lib/qrpm.rb
+- lib/qrpm/compiler.rb
+- lib/qrpm/fragment.rb
+- lib/qrpm/lexer.rb
 - lib/qrpm/node.rb
-- lib/qrpm/parser.rb
 - lib/qrpm/qrpm.rb
 - lib/qrpm/render.rb
 - lib/qrpm/rpm.rb
 - lib/qrpm/template.erb
 - lib/qrpm/template.yml
+- lib/qrpm/utils.rb
 - lib/qrpm/version.rb
 - packager.sh
 - packager.yml
@@ -79,7 +119,7 @@ homepage: http://www.nowhere.com/
 licenses: []
 metadata:
   homepage_uri: http://www.nowhere.com/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.18
+signing_key:
 specification_version: 4
 summary: Gem qrpm
 test_files: []