Skip to content

Latest commit

 

History

History
391 lines (255 loc) · 16.1 KB

README.md

File metadata and controls

391 lines (255 loc) · 16.1 KB
Raw

cl-brewer - Homebrew formula builder for Common Lisp applications.

CL-BREWER ASDF System Details

About

Currently there is no easy way to distribute common lisp applications. One promising way is to use roswell project however it might be to complicated for the users how just want to install an application and are not really interested in having one more package manager for that.

In Mac OS X world the most popular solution is to use brew package manager and all we need is to be able to generate formula that will handle installation proccess. Since homebrew guidelines are not really fond of using third-party managers to get dependencies, we need to generate list manually and feed it to brew.

cl-brewer uses SBCL and targets command line applications written in Common Lisp. GUI applications haven't been tested and might require additional changes.

This application is based on the awesome quicklisp-homebrew-roundup but has a purpose to make a process simplier by:

  • Allowing to generate file for any system available not just quicklisp package (dependencies should be on quicklisp though)
  • Allowing to generate a complete formula, not just dependencies
  • Having a cli interface that can be used in CI services to generate formulas automatically.

At the moment several assumptions were made:

  • We can use Buildapp or Deploy make executable.
  • Formula is generated for the system available for ASDF.
  • All dependencies should be available via quicklisp.
  • System source code should live on github all releases should be tagged with vX.Y.Z scheme.
  • System should have description, version, homepage fields defined. Project at GitHub should have a tag corresponding to the current system version. GitHub build a tar.gz archive with sources of the tagged revision and this way a formula, created by cl-brewer, will be able to fetch sources, corresponding to the version.
  • Buildapp calls main function. By default main function is searched in the package with the same name as system name but can be overridden with option.
  • When using Deploy, you don't have to define an entry point. Also, Deploy is able to create formulas for applications which build some dynamic libraries.

Here is an example formula

Installation

brew tap 40ants/soft
brew install cl-brewer

Or you can install it using Roswell:

# install roswell and sbcl before
$ ros install 40ants/cl-brewer

If you want to install it to use from the REPL, then you can install this library from Quicklisp, but you want to receive updates quickly, then install it from Ultralisp.org:

(ql-dist:install-dist "http://dist.ultralisp.org/"
                      :prompt nil)
(ql:quickload :cl-brewer)

Usage

Just run:

cl-brewer <your-system-name>

This will emit <your-system-name>.rb file in current folder.

To run cl-brewer under Qlot, you'll need set SBCL_HOME variable. Otherwise sb-sys::*sbcl-homedir-pathname* variable will be reinitialized and this can cause some incompatibilities if Qlot and cl-brewer were built with different SBCL implementations.

Thus, in this case call cl-brewer like this:

qlot exec bash -c "SBCL_HOME='' cl-brewer <your-system-name>"

Building a formula for cl-brewer

To kickstart a cl-brewer and to create a formula for itself, load it in the REPL and do like that:

CL-USER> (cl-brewer:create-formula :cl-brewer)
#<BUILDAPP-FORMULA "cl-brewer" depends on 23 systems>

CL-USER> (cl-brewer:save-formula * "cl-brewer"
                                 :preload (list "quicklisp-starter"))
Downloading "https://github.com/40ants/cl-brewer/archive/v0.5.5.tar.gz" (Unknown size)
NIL

However, in most cases you can just install cl-brewer from the Homebrew. In this case, you can update cl-brewer's formula with this command:

qlot exec cl-brewer 
          --preload quicklisp-starter 
          cl-brewer

Installing From Local Formula

How to install cl-brewer (or any other project) from a local formula?

Replace url line in a formula:

url "https://github.com/40ants/cl-brewer/archive/v0.5.6.tar.gz"

with two lines like this:

url File.dirname(__FILE__), :using => :git
version "0.5.6-rc1"

Next, do this in the shell:

HOMEBREW_NO_AUTO_UPDATE=1 brew install --debug --verbose ./*.rb

it should build and install cl-brewer.

Contribute

If you are interested in using this project but your application has different requirements, please open an issue or make a pull request. Contributions are welcome!

License

All code is public domain except parts that were taken from quicklisp-homebrew-roundup which is under MIT License.

API

CL-BREWER

package cl-brewer

Classes

FORMULA

class cl-brewer:formula ()

Base class for Homebrew formula definition.

Readers

reader cl-brewer/formula:included-systems (formula) (:included-systems)

reader cl-brewer/formula:missing-systems (formula) (:missing-systems)

reader cl-brewer/formula:root-system (formula) (:root-system)

Accessors

accessor cl-brewer/formula:included-systems (formula) (:included-systems)

accessor cl-brewer/formula:missing-systems (formula) (:missing-systems)

accessor cl-brewer/formula:root-system (formula) (:root-system)

Generics

generic-function cl-brewer:create-formula system

Create object based on asdf:system with a list of all dependencies

generic-function cl-brewer:get-implicit-dependencies system-name

Some systems, like cl-unicode have implicit dependencies in their asdf methods: https://github.com/edicl/cl-unicode/blob/8073fc5634c9d4802888ac03abf11dfe383e16fa/cl-unicode.asd#L67-L70 use this method to provide information about such dependencies.

System name is a keyword and method should return a one keyword or a list of keywords with names of systems. Each returned system should be possible to find with ql-dist:find-system.

Functions

function cl-brewer:save-formula formula name &key entry-point preload

Saves Homebrew formula definition into the file with given NAME.

If ENTRY-POINT argument was given, then it might be used as entry-point, but some formula classes like cl-brewer/deploy/formula:deploy-formula might ignore this argument.

PRELOAD argument if given, should be a list of strings with ASDF system names to be preloaded before cl-brewer will build a binary.

CL-BREWER/BUILDAPP/FORMULA

package cl-brewer/buildapp/formula

Classes

BUILDAPP-FORMULA

class cl-brewer/buildapp/formula:buildapp-formula (formula)

This formula class uses Buildapp to build a binary.

CL-BREWER/DEPLOY/FORMULA

package cl-brewer/deploy/formula

Classes

DEPLOY-FORMULA

class cl-brewer/deploy/formula:deploy-formula (formula)

This formula class uses Deploy to build a binary.

The core difference from cl-brewer/buildapp/formula:buildapp-formula is that this type of formula also builds and distributes all necessary dynamic libraries.

CL-BREWER/FORMULA

package cl-brewer/formula

Generics

generic-function cl-brewer/formula:get-additional-dependencies formula

Some formulas might add dependencies needed to build a binary. For example, Deploy formula adds cl-brewer because it uses it's cl-brewer/deploy/hooks subsystem.

[generic-function] cl-brewer/formula:included-systems object

[generic-function] cl-brewer/formula:missing-systems object

[generic-function] cl-brewer/formula:root-system object

Macros

macro cl-brewer/formula:define-quesser name (asdf-system) &body body

Use this macro to define a function to guess a formula class.

The function should accept a one argument - an ASDF system and return a symbol denoting a class derived from formula class.

If guesser does not know how to create a formula for the system, then it should return a NIL value.

[generated by 40ANTS-DOC]