pkgforge 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41ffe55f7c506d38a4be46bfbcb89b7b7ec49f79
-  data.tar.gz: 6146d7d7d1a8c88165deb5bc079a85c026a81570
+SHA256:
+  metadata.gz: e6295bc0fa6b21641b31a86cb8a7b72e98788c7acb0d98bdf77453818dbf3d97
+  data.tar.gz: 2dc25196c7e6d0be42a004b538b8b3738fda5443152fffc302145aa993c4b6b7
 SHA512:
-  metadata.gz: 4046b67e1b623ddd4662d199aa615fd4514fddf28beee96663b5485ab3e7284bf792b186b10f5eb8aa13d34ace973f1b7f5b002e5ae9ae9eb65683501cba1bb5
-  data.tar.gz: 7360342df27396a35cf130d30303c92ff7cbff37f01eea9f51b0155dc57270825bbf2fc060e6be1fa501af96a40fa3b91b381c0f78a5bf637b0c93d7e315f0d2
+  metadata.gz: d139be8290e21e10e98504d91db078abe3d1a235df6eeb21eee23ad8ea88837362cf4a8ab0a0cb3850836bd964691c75f3989d2d0595aa171679af9136b9c6fc
+  data.tar.gz: 92a91e3cfc2ae61e94da4c5a91ea235b0e0872ef2e6ff61640c2c291516ff928f0484b1eea90606470efc216139e77c7e4d4f3512e6f2ae79aeb0306c33bd0fc

data/.circle-ruby

@@ -1,3 +1,4 @@
-2.4.2
-2.3.5
-2.2.8
+2.5.1
+2.4.4
+2.3.7
+2.2.10

data/.prospectus

@@ -1,25 +1,11 @@
-Prospectus.extra_dep('file', 'prospectus_circleci')
-
 my_slug = 'akerl/pkgforge'
 
+Prospectus.extra_dep('file', 'prospectus_circleci')
+Prospectus.extra_dep('file', 'prospectus_gems')
+
 item do
   noop
 
-  deps do
-    item do
-      name 'gems'
-
-      expected do
-        static
-        set 'green'
-      end
-
-      actual do
-        gemnasium
-        slug my_slug
-      end
-    end
-  end
-
+  extend ProspectusGems::Gemspec.new
   extend ProspectusCircleci::Build.new(my_slug)
 end

data/.rubocop.yml

@@ -1,7 +1,4 @@
 inherit_gem:
   goodcop: .rubocop.yml
-AllCops:
-  Include:
-  - 'bin/*'
 Lint/Void:
   Enabled: false

data/README.md

@@ -12,6 +12,268 @@ DSL engine for building Arch packages
 
 ## Usage
 
+### Running pkgforge
+
+If you already have a .pkgforge file you want to run, the `pkgforge` tool has 3 subcommands:
+
+```
+❯ pkgforge
+pkgforge 0.20.0 -- DSL engine for building Arch packages
+
+Usage:
+
+  pkgforge <subcommand> [options]
+
+Options:
+        -h, --help         Show this message
+        -v, --version      Print the name and version
+        -t, --trace        Show the full backtrace when an error occurs
+
+Subcommands:
+  build                 Build the package
+  release               Release the package
+  info                  Print package info
+```
+
+Each subcommand has help text that can be invoked w/ the `-h` flag detailing available options. Specific options of note:
+
+* `-d DIR` -- Change to this directory before starting
+* `-s` -- Don't clean up anything afterwards. Very useful for troubleshooting
+* `-t` -- Enable tracebacks, so you can debug pkgforge internal errors
+
+#### Standard flow
+
+Generally, you'll want to run `pkgforge build` to confirm building works, and then `pkgforge release` to upload the package to GitHub. Releasing will use the tag on the current revision as the GitHub release name.
+
+To avoid building the package twice (since build and release don't default to sharing state), you can use the `--statefile /path/to/file` option. This will cause the two commands to share state, so building builds an artifact and release updates that same artifact.
+
+### Writing .pkgforge files
+
+The pkgforge spec has a couple of required elements and then several optional ones. The file is parsed as Ruby, so Ruby syntax applies for strings and similar, and additionally for advanced use cases you can write arbitrary Ruby at any point.
+
+Before we start, here's an example complete .pkgforge for `git`:
+
+```
+name 'git'
+org 'amylum'
+
+licenses 'COPYING'
+
+deps(
+  zlib: {
+    version: '1.2.11-1',
+    checksum: '5596e2d39ef98e2323ac415f50afa71a433ed65c23e8d1f2723f711f5ffb4f32'
+  },
+  openssl: {
+    version: '1.1.0g-1',
+    checksum: 'f70d94ca94f05be4a14438cf29ed4695d9731d023a4b72d30126d826720bc48b'
+  },
+  curl: {
+    version: '7.57.0-1',
+    checksum: 'ea8db25223edddd2668d4f25f8a030469aa90306b1204cc1cecf64d468cb2949'
+  }
+)
+
+cflags
+harden
+
+build do
+  run(['make', 'all', 'install',
+    'CC=musl-gcc',
+    "DESTDIR=#{releasedir}",
+    "CURL_LIBCURL=#{@forge.dep(:curl)}/usr/lib/libcurl.a #{@forge.dep(:openssl)}/usr/lib/libssl.a #{@forge.dep(:openssl)}/usr/lib/libcrypto.a",
+    "CFLAGS=#{@forge.cflags.join(' ')}",
+    "LDFLAGS=#{@forge.cflags.join(' ')}",
+    'NO_TCLTK=1',
+    'NO_PYTHON=1',
+    'NO_EXPAT=1',
+    'NO_GETTEXT=1',
+    'NO_REGEX=1',
+    'prefix=/usr',
+    'gitexecdir=/usr/lib/git-core'
+  ])
+end
+
+test do
+  run 'git --version'
+end
+```
+
+#### name (required)
+
+The name of the package, provided as a string
+
+#### org (required)
+
+The GitHub organization to upload the package to (this plus the name become the GitHub repo slug, as in `https://github.com/ORG/NAME`)
+
+#### license (optional)
+
+This defines where to find the license file. The default is to look for a file called 'LICENSE' in the source directory. This can be provided as a string or an array of strings (for multiple license files). If the given license does not exist, that is a fatal error during build.
+
+#### source (optional)
+
+The source block describes how to load the source of the upstream package. The default is "git" with a path of "./upstream". The available options:
+
+##### git
+
+Loads the source from a local git submodule. Accepts a single argument, "path", which defines the path to the submodule, relative to the repo base dir:
+
+```
+source(
+  type: 'git',
+  path: 'my_sub_dir'
+)
+```
+
+##### tar
+
+Loads the source from a remote tarball. Requires a "url" argument and a "checksum":
+
+```
+source(
+  type: 'tar',
+  url: 'https://invisible-mirror.net/archives/ncurses/current/ncurses-6.0-20171223.tgz',
+  checksum: 'd0e2261c84f3fc56c13ebbc297a4b19fd6c9634fabd2143f88781b405ffe7698'
+)
+```
+
+#### empty
+
+This sets up a blank source dir. Useful if you'll be generating all the contents, as in [this example](https://github.com/amylum/iana-etc/blob/master/.pkgforge)
+
+```
+source(type: 'empty')
+```
+
+#### deps (optional)
+
+The deps parameter is an hash of dep objects, each of which contains a version and checksum. Deps are expected themselves to be pkgforge-built GitHub release artifacts and exist in the same org as this package. They are described by a version number and checksum.
+
+```
+deps(
+  zlib: {
+    version: '1.2.11-1',
+    checksum: '5596e2d39ef98e2323ac415f50afa71a433ed65c23e8d1f2723f711f5ffb4f32'
+  },
+  openssl: {
+    version: '1.1.0g-1',
+    checksum: 'f70d94ca94f05be4a14438cf29ed4695d9731d023a4b72d30126d826720bc48b'
+  },
+  curl: {
+    version: '7.57.0-1',
+    checksum: 'ea8db25223edddd2668d4f25f8a030469aa90306b1204cc1cecf64d468cb2949'
+  }
+)
+```
+
+#### configure_flags (optional)
+
+This lets you set flags that will be used if you run `configure` while building. They are specified as a hash, where the keys are the configure flag names without leading "--". A value of "nil" adds the flag without a value.
+
+```
+configure_flags(
+  prefix: '/usr',
+  'with-termlib': 'tinfo',
+  'with-ticlib': 'tic',
+  'with-shared': nil,
+  'with-normal': nil,
+  'without-cxx': nil,
+  'without-cxx-binding': nil,
+  'enable-widec': nil
+)
+```
+
+#### cflags (optional)
+
+When called with no value, this auto-adds `-L /path/to/dep/lib -I /path/to/dep/include` to the CFLAGS variable used for build commands for every dep specified in the .pkgforge file. When called with a an array of strings, it adds those strings to the CFLAGS variable. It can be called multiple times.
+
+```
+cflags
+cflags ['-Wa,--noexecstack']
+```
+
+#### libs (optional)
+
+When called with no value, auto-adds `-lNAME` for every dep listed in the .pkgforge file to the LIBS variable that will be used for build commands. When called with an array of strings, adds those values to LIBS variable. Do not prefix with "-l" when calling with strings.
+
+```
+libs %w(gpg-error assuan)
+```
+
+#### remove_linker_archives (optional)
+
+If called, this removes all .la files from deps. This exists because sometimes those files interfere with building.
+
+#### remove_pkgconfig_files (optional)
+
+If called, this removes all .pc files from deps. This exists because sometimes those files interfere with building.
+
+#### harden (optional)
+
+This adds a stock set of hardening options to CFLAGS. The list was originally sourced from [this blog](https://blog.mayflower.de/5800-Hardening-Compiler-Flags-for-NixOS.html), and can be seen [here](https://github.com/akerl/pkgforge/blob/master/lib/pkgforge/components/cflags.rb#L40). Passing an array of strings as arguments disables the listed options from the ALL_HARDEN_OPTS hash.
+
+#### patch (optional)
+
+This patches the source with the given patch files. Files must be stored in the `./patches` dir in the repo, and listed by name without the `./patches` prefix. This command can be used multiple times, and patches will be run in the order they are listed.
+
+```
+patch 'musl.patch'
+patch 'elf.patch'
+patch 'if_arp.patch'
+```
+
+#### package (optional)
+
+This describes how to package the resulting build artifact. The default is to use "tarball"
+
+##### tarball
+
+This bundles the whole release dir into a .tar.gz file
+
+##### file
+
+This uploads individual files as listed. The "source" is where inside the release dir to find the file, the "name" is the name to give the artifact.
+
+```
+package(
+  type: 'file',
+  artifacts: [
+    {
+      source: 'bin/speculate_darwin',
+      name: 'speculate_darwin'
+    },
+    {
+      source: 'bin/speculate_linux',
+      name: 'speculate_linux'
+    }
+  ]
+)
+```
+
+#### test (required)
+
+The test block describes how to check that the build works. It is run after building, from the context of the newly created release's directory. Available helper commands:
+
+* `run` -- Runs a command with the environment adjusted to use only this package's libs and the libs of your named deps.
+
+#### build (required)
+
+The build command describes how to actually turn the source into a package. It has a number of helper commands:
+
+* `run` -- runs a command from the build directory. Takes a string or array of strings
+* `configure` -- runs `./configure` with any given configure_flags, CFLAGS, and LIBs, as well as with the CC set to musl-gcc. If you have other env vars to set, pass them as a hash
+* `make` -- runs `make` with the CFLAGS / LIBS / CC set similarly to ./configure. Again, if you have extra env vars, pass them as a hash.
+* `install` -- runs `make DESTDIR=#{releasedir} install` with the same CFLAGS / LIBS / CC as make. Again, env vars can be passed as a hash.
+* `rm` -- Remove a file from the release dir. Useful for cleaning up extra files. Accepts a string or array of strings
+* `cp` -- Copies a file from the build dir to the release dir. Pass just the source path to copy to the same dest path, or pass source and dest to copy to a new path.
+
+There are also a handful of variables / helper functions for looking up info:
+
+* `releasedir` -- resolves to the release dir's absolute path
+* `dep(PACKAGE)` -- resolves to that dep's absolute path
+* `default_env` -- the CC, CFLAGS, and LIBS vars used by the helper commands.
+
 ## Installation
 
     gem install pkgforge

data/bin/pkgforge

@@ -90,3 +90,4 @@ Mercenary.program(:pkgforge) do |p|
     exit 1
   end
 end
+# rubocop:enable Metrics/BlockLength

data/lib/pkgforge/components/deps.rb

@@ -36,7 +36,7 @@ module PkgForge
       deps.each do |dep_name, dep_hash|
         file = tmpfile(dep_name)
         dir = tmpdir(dep_name)
-        download_file(dep_name, file, dep_hash[:version])
+        download_file(dep_name, dep_hash, file)
         verify_file(file, dep_hash[:checksum])
         extract_file(file, dir)
       end
@@ -44,9 +44,13 @@ module PkgForge
     end
 
     Contract Symbol, String, String => nil
-    def download_file(dep_name, file, dep_version)
-      url = "https://github.com/#{org}/#{dep_name}/releases/download/#{dep_version}/#{dep_name}.tar.gz" # rubocop:disable Metrics/LineLength
-      open(file, 'wb') { |fh| fh << open(url, 'rb').read }
+    def download_file(dep_name, dep_hash, file)
+      dep_hash[:org] ||= org
+      dep_hash[:site] ||= 'https://github.com'
+      url = "#{dep_hash[:site]}/#{dep_hash[:org]}/#{dep_name}/releases/download/#{dep_hash[:version]}/#{dep_name}.tar.gz" # rubocop:disable Metrics/LineLength
+      File.open(file, 'wb') do |fh|
+        fh << open(url, 'rb').read # rubocop:disable Security/Open
+      end
       nil
     end
 

data/lib/pkgforge/components/source.rb

@@ -31,7 +31,9 @@ module PkgForge
     def tar_prepare_source
       dest_file = tmpfile(:source_tar)
       File.open(dest_file, 'wb') do |fh|
-        open(source[:url], 'rb') { |request| fh.write request.read }
+        open(source[:url], 'rb') do |request| # rubocop:disable Security/Open
+          fh.write request.read
+        end
         verify_file(dest_file, source[:checksum])
       end
       run "tar -xf #{dest_file} --strip-components=1"

data/lib/pkgforge/version.rb

@@ -1,5 +1,5 @@
 ##
 # Declare version number
 module PkgForge
-  VERSION = '0.20.0'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/pkgforge.gemspec

@@ -1,5 +1,5 @@
 require 'English'
-$LOAD_PATH.unshift File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'pkgforge/version'
 
 Gem::Specification.new do |s|
@@ -18,14 +18,14 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['pkgforge']
 
-  s.add_dependency 'mercenary', '~> 0.3.4'
   s.add_dependency 'contracts', '~> 0.16.0'
   s.add_dependency 'cymbal', '~> 1.0.0'
+  s.add_dependency 'mercenary', '~> 0.3.4'
 
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.add_development_dependency 'goodcop', '~> 0.1.0'
-  s.add_development_dependency 'rake', '~> 12.1.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.6.0'
-  s.add_development_dependency 'fuubar', '~> 2.2.0'
+  s.add_development_dependency 'fuubar', '~> 2.3.0'
+  s.add_development_dependency 'goodcop', '~> 0.5.0'
+  s.add_development_dependency 'rake', '~> 12.3.0'
+  s.add_development_dependency 'rspec', '~> 3.7.0'
+  s.add_development_dependency 'rubocop', '~> 0.57.1'
 end

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: pkgforge
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-17 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: contracts
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: contracts
+  name: cymbal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: cymbal
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: goodcop
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.57.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.57.1
 description: DSL engine for building Arch packages
 email: me@lesaker.org
 executables:
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: DSL engine for building Arch packages