https://github.com/flavorjones/mini_portile

mini_portile and mini_portile2 - Simple autoconf and cmake builder for developers
https://github.com/flavorjones/mini_portile

Keywords from Contributors

rubygems activerecord activejob mvc ruby-gem rspec rubocop rack static-code-analysis code-formatter

Last synced: about 7 hours ago
JSON representation

Repository metadata

mini_portile and mini_portile2 - Simple autoconf and cmake builder for developers

Host: GitHub
URL: https://github.com/flavorjones/mini_portile
Owner: flavorjones
License: mit
Created: 2011-03-08T00:50:26.000Z (almost 15 years ago)
Default Branch: main
Last Pushed: 2025-09-14T20:04:18.000Z (3 months ago)
Last Synced: 2025-10-19T02:53:39.966Z (about 2 months ago)
Language: Ruby
Homepage:
Size: 1.65 MB
Stars: 119
Watchers: 6
Forks: 55
Open Issues: 13
Releases: 22
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Security: SECURITY.md

MiniPortile

This documents versions 2 and up, for which the require file was
renamed to mini_portile2. For mini_portile versions 0.6.x and
previous, please visit
the v0.6.x branch.

Documentation: http://www.rubydoc.info/github/flavorjones/mini_portile
Source Code: https://github.com/flavorjones/mini_portile
Bug Reports: https://github.com/flavorjones/mini_portile/issues

This project is a minimalistic implementation of a port/recipe system
for developers.

Because "Works on my machine" is unacceptable for a library maintainer.

Not Another Package Management System

mini_portile2 is not a general package management system. It is not
aimed to replace apt, macports or homebrew.

It's intended primarily to make sure that you, as the developer of a
library, can reproduce a user's dependencies and environment by
specifying a specific version of an underlying dependency that you'd
like to use.

So, if a user says, "This bug happens on my system that uses libiconv
1.13.1", mini_portile2 should make it easy for you to download,
compile and link against libiconv 1.13.1; and run your test suite
against it.

This scenario might be simplified with something like this:

rake compile LIBICONV_VERSION=1.13.1

(For your homework, you can make libiconv version be taken from the
appropriate ENV variables.)

Sounds easy, but where's the catch?

At this time mini_portile2 only supports autoconf- or
configure-based projects. (That is, it assumes the library you
want to build contains a configure script, which all the
autoconf-based libraries do.)

As of v2.2.0, there is experimental support for CMake-based
projects. We welcome your feedback on this, particularly for Windows
platforms.

How to use (for autoconf projects)

Now that you know the catch, and you're still reading this, here is a
quick example:

gem "mini_portile2", "~> 2.0.0" # NECESSARY if used in extconf.rb. see below.
require "mini_portile2"
recipe = MiniPortile.new("libiconv", "1.13.1")
recipe.files = ["http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz"]
recipe.cook
recipe.activate

The gem version constraint makes sure that your extconf.rb is
protected against possible backwards-incompatible changes to
mini_portile2. This constraint is REQUIRED if you're using
mini_portile2 within a gem installation process (e.g., extconf.rb),
because Bundler doesn't enforce gem version constraints at
install-time (only at run-time.

#cook will download, extract, patch, configure and compile the
library into a namespaced structure.

#activate ensures GCC will find this library and prefer it over a
system-wide installation.

Some keyword arguments can be passed to the constructor to configure the commands used:

`cc_command` and `cxx_command`

The C compiler command that is used is configurable, and in order of preference will use:

the CC environment variable (if present)
the :cc_command keyword argument passed in to the constructor
RbConfig::CONFIG["CC"]
"gcc"

The C++ compiler is similarly configuratble, and in order of preference will use:

the CXX environment variable (if present)
the :cxx_command keyword argument passed in to the constructor
RbConfig::CONFIG["CXX"]
"g++"

You can pass your compiler commands to the MiniPortile constructor:

MiniPortile.new("libiconv", "1.13.1", cc_command: "clang", cxx_command: "clang++")

(For backwards compatibility, the constructor also supports a keyword argument :gcc_command for the C compiler.)

`make_command`

The configuration/make command that is used is configurable, and in order of preference will use:

the MAKE environment variable (if present)
the make_command value passed in to the constructor
the make environment variable (if present)
"make"

You can pass it in like so:

MiniPortile.new("libiconv", "1.13.1", make_command: "nmake")

`open_timeout`, `read_timeout`

By default, when downloading source archives, MiniPortile will use a timeout value of 10
seconds. This can be overridden by passing a different value (in seconds):

MiniPortile.new("libiconv", "1.13.1", open_timeout: 99, read_timeout: 2)

How to use (for cmake projects)

Same as above, but instead of MiniPortile.new, call MiniPortileCMake.new.

`make_command`

This is configurable as above, except for Windows systems where it's hardcoded to "nmake".

`cmake_command`

The cmake command used is configurable, and in order of preference will use:

the CMAKE environment variable (if present)
the :cmake_command keyword argument passed into the constructor
"cmake" (the default)

You can pass it in like so:

MiniPortileCMake.new("libfoobar", "1.3.5", cmake_command: "cmake3")

`cmake_build_type`

The cmake build type is configurable as of v2.8.5, and in order of preference will use:

the CMAKE_BUILD_TYPE environment variable (if present)
the :cmake_build_type keyword argument passed into the constructor
"Release" (the default)

You can pass it in like so:

MiniPortileCMake.new("libfoobar", "1.3.5", cmake_build_type: "Debug")

Local source directories

Instead of downloading a remote file, you can also point mini_portile2 at a local source
directory. In particular, this may be useful for testing or debugging:

gem "mini_portile2", "~> 2.0.0" # NECESSARY if used in extconf.rb. see below.
require "mini_portile2"
recipe = MiniPortile.new("libiconv", "1.13.1")
recipe.source_directory = "/path/to/local/source/for/library-1.2.3"

Directory Structure Conventions

mini_portile2 follows the principle of convention over configuration and
established a folder structure where is going to place files and perform work.

Take the above example, and let's draw some picture:

mylib
  |-- ports
  |   |-- archives
  |   |   `-- libiconv-1.13.1.tar.gz
  |   `-- <platform>
  |       `-- libiconv
  |           `-- 1.13.1
  |               |-- bin
  |               |-- include
  |               `-- lib
  `-- tmp
      `-- <platform>
          `-- ports

In above structure, <platform> refers to the architecture that
represents the operating system you're using (e.g. i686-linux,
i386-mingw32, etc).

Inside the platform folder, mini_portile2 will store the artifacts
that result from the compilation process. The library is versioned so
you can keep multiple versions around on disk without clobbering
anything.

archives is where downloaded source files are cached. It is
recommended you avoid trashing that folder to avoid downloading the
same file multiple times (save bandwidth, save the world).

tmp is where compilation is performed and can be safely discarded.

Use the recipe's #path to obtain the full path to the installation
directory:

recipe.cook
recipe.path # => /home/luis/projects/myapp/ports/i686-linux/libiconv/1.13.1

How can I combine this with my compilation task?

In the simplest case, your rake compile task will depend on
mini_portile2 compilation and most important, activation.

Example:

task :libiconv do
  recipe = MiniPortile.new("libiconv", "1.13.1")
  recipe.files << {
    url: "http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.13.1.tar.gz"],
    sha256: "55a36168306089009d054ccdd9d013041bfc3ab26be7033d107821f1c4949a49"
  }
  checkpoint = ".#{recipe.name}-#{recipe.version}.installed"

  unless File.exist?(checkpoint)
    recipe.cook
    touch checkpoint
  end

  recipe.activate
end

task :compile => [:libiconv] do
  # ... your library's compilation task ...
end

The above example will:

download and verify integrity the sources only once
compile the library only once (using a timestamp file)
ensure compiled library is activated
make the compile task depend upon compiled library activation

As an exercise for the reader, you could specify the libiconv version
in an environment variable or a configuration file.

Download verification

MiniPortile supports HTTPS, HTTP, FTP and FILE sources for download.
The integrity of the downloaded file can be verified per hash value or PGP signature.
This is particular important for untrusted sources (non-HTTPS).

Hash digest verification

MiniPortile can verify the integrity of the downloaded file per SHA256, SHA1 or MD5 hash digest.

  recipe.files << {
    url: "http://your.host/file.tar.bz2",
    sha256: "<32 byte hex value>",
  }

PGP signature verification

MiniPortile can also verify the integrity of the downloaded file per PGP signature.

  public_key = <<-EOT
    -----BEGIN PGP PUBLIC KEY BLOCK-----
    Version: GnuPG v1

    mQENBE7SKu8BCADQo6x4ZQfAcPlJMLmL8zBEBUS6GyKMMMDtrTh3Yaq481HB54oR
    [...]
    -----END PGP PUBLIC KEY BLOCK-----
  EOT

  recipe.files << {
    url: "http://your.host/file.tar.bz2",
    gpg: {
      key: public_key,
      signature_url: "http://your.host/file.tar.bz2.sig"
    }
  }

Please note, that the gpg executable is required to verify the signature.
It is therefore recommended to use the hash verification method instead of PGP, when used in extconf.rb while gem install.

Native and/or Cross Compilation

The above example covers the normal use case: compiling dependencies
natively.

MiniPortile also covers another use case, which is the
cross-compilation of the dependencies to be used as part of a binary
gem compilation.

It is the perfect complementary tool for
rake-compiler and
its cross rake task.

Depending on your usage of rake-compiler, you will need to use
host to match the installed cross-compiler toolchain.

Please refer to the examples directory for simplified and practical usage.

Supported Scenarios

As mentioned before, MiniPortile requires a GCC compiler
toolchain. This has been tested against Ubuntu, OSX and even Windows
(RubyInstaller with DevKit)

Support

The bug tracker is available here:

https://github.com/flavorjones/mini_portile/issues

Consider subscribing to Tidelift which provides license assurances and timely security notifications for your open source dependencies, including Loofah. Tidelift subscriptions also help the Loofah maintainers fund our automated testing which in turn allows us to ship releases, bugfixes, and security updates more often.

Security

See SECURITY.md for vulnerability reporting details.

License

This library is licensed under MIT license. Please see LICENSE.txt for details.

Owner metadata

Name: Mike Dalessio
Login: flavorjones
Email:
Kind: user
Description: Part-time OSS contributor, maintaining Nokogiri, Loofah, Rails::Html::Sanitizer, Mechanize, Sqlite3, and more in the Ruby ecosystem.
Website: http://mike.daless.io/
Location: New York City / New Jersey
Twitter: flavorjones
Company:
Icon url: https://avatars.githubusercontent.com/u/8207?u=b696c885624fac0e15405b8713a770e888f26a96&v=4
Repositories: 166
Last ynced at: 2024-10-29T17:10:21.650Z
Profile URL: https://github.com/flavorjones

GitHub Events

Total

Release event: 1
Watch event: 5
Delete event: 5
Issue comment event: 10
Push event: 17
Pull request event: 16
Fork event: 6
Create event: 7

Last Year

Release event: 1
Watch event: 4
Delete event: 3
Issue comment event: 10
Push event: 12
Pull request event: 12
Fork event: 5
Create event: 4

Committers metadata

Last synced: 17 days ago

Total Commits: 395
Total Committers: 29
Avg Commits per committer: 13.621
Development Distribution Score (DDS): 0.456

Commits in past year: 8
Committers in past year: 4
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.375

Name	Email	Commits
Mike Dalessio	m**o@g**m	215
Luis Lavena	l**a@g**m	81
Lars Kanis	l**s@g**e	43
John Shahid	j**d@g**m	12
Toshio Maki	k**2@g**m	6
JT Archie	j**e@g**m	5
Ken Collins	k**n@m**t	4
Stan Hu	s**u@g**m	4
Paul Mucur	m**e@m**e	3
Akira Matsuda	r**e@d**p	2
Postmodern	p**3@g**m	2
Pivotal	c**g@p**o	1
jtimberman	j**a@o**m	1
marvin2k	m**b@m**e	1
Akinori MUSHA	k**u@i**g	1
Atul Bhosale	a**e@g**m	1
Ben Dean	b**n@o**m	1
Cezary Baginski	c**y@c**t	1
Earlopain	1****n	1
Jan Krutisch	j**n@k**e	1
Kasumi Hanazuki	k**i@r**t	1
Kentaro Hayashi	h**i@c**m	1
Kohei Suzuki	e**t@g**m	1
Mark Young	m**g@a**o	1
Nathan Nobbe	q**n@g**m	1
Peter Goldstein	p**n@g**m	1
Watson	w**8@g**m	1
kamoh	b**s@g**m	1
kou1okada	k****a	1

Committer domains:

Issue and Pull Request metadata

Last synced: 20 days ago

Total issues: 47
Total pull requests: 109
Average time to close issues: 5 months
Average time to close pull requests: about 1 month
Total issue authors: 25
Total pull request authors: 33
Average comments per issue: 3.17
Average comments per pull request: 1.81
Merged pull request: 80
Bot issues: 0
Bot pull requests: 0

Past year issues: 2
Past year pull requests: 19
Past year average time to close issues: 8 days
Past year average time to close pull requests: 1 day
Past year issue authors: 2
Past year pull request authors: 6
Past year average comments per issue: 0.5
Past year average comments per pull request: 0.58
Past year merged pull request: 12
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/flavorjones/mini_portile

Top Issue Authors

flavorjones (20)
mudge (2)
stanhu (2)
saurabhghumnar (2)
agelwarg (1)
guikubivan (1)
gjtorikian (1)
glandium (1)
dsisnero (1)
taogone (1)
larskanis (1)
squeedee (1)
balasankarc (1)
cpanderson (1)
firefart (1)

Top Pull Request Authors

flavorjones (48)
larskanis (13)
mudge (4)
jtarchie (4)
jvshahid (3)
amatsuda (2)
kenhys (2)
pinotree (2)
andrew (2)
mark-young-atg (2)
kirikak2 (2)
Earlopain (2)
stanhu (2)
postmodern (2)
Atul9 (1)

Top Issue Labels

needs more information (3)
feature (2)
help-wanted (2)
will-close (1)
bug (1)

Top Pull Request Labels

feature (1)

Package metadata

Total packages: 24
Total downloads:
- rubygems: 1,271,782,624 total
Total docker downloads: 2,513,283,686
Total dependent packages: 90 (may contain duplicates)
Total dependent repositories: 928,198 (may contain duplicates)
Total versions: 159
Total maintainers: 4

gem.coop: mini_portile2

Simple autoconf and cmake builder for developers. It provides a standard way to compile against dependency libraries without requiring system-wide installation. It also simplifies vendoring and cross-compilation by providing a consistent build interface.

Homepage: https://github.com/flavorjones/mini_portile
Documentation: http://www.rubydoc.info/gems/mini_portile2/
Licenses: MIT
Latest release: 2.8.9 (published 7 months ago)
Last Synced: 2025-12-11T09:28:51.724Z (about 18 hours ago)
Versions: 29
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 570,523,954 Total
Docker Downloads: 1,214,071,690
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.012%
- Downloads: 0.036%
Maintainers (3)

gem.coop: mini_portile

Simplistic port-like solution for developers. It provides a standard and simplified way to compile against dependency libraries without messing up your system.

Homepage: http://github.com/flavorjones/mini_portile
Documentation: http://www.rubydoc.info/gems/mini_portile/
Licenses: MIT
Latest release: 0.6.2 (published almost 11 years ago)
Last Synced: 2025-12-10T13:33:42.870Z (1 day ago)
Versions: 18
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 65,371,683 Total
Docker Downloads: 42,570,153
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.262%
- Downloads: 0.417%
- Docker downloads count: 0.632%
Maintainers (2)
- flavorjones
- luislavena

rubygems.org: mini_portile2

Homepage: https://github.com/flavorjones/mini_portile
Documentation: http://www.rubydoc.info/gems/mini_portile2/
Licenses: MIT
Latest release: 2.8.9 (published 7 months ago)
Last Synced: 2025-12-11T08:18:21.633Z (about 19 hours ago)
Versions: 30
Dependent Packages: 48
Dependent Repositories: 732,623
Downloads: 570,514,003 Total
Docker Downloads: 1,214,071,690
Rankings:
- Dependent repos count: 0.018%
- Downloads: 0.026%
- Docker downloads count: 0.112%
- Dependent packages count: 0.559%
- Average: 1.613%
- Forks count: 3.767%
- Stargazers count: 5.195%
Maintainers (3)

rubygems.org: mini_portile

Simplistic port-like solution for developers. It provides a standard and simplified way to compile against dependency libraries without messing up your system.

Homepage: http://github.com/flavorjones/mini_portile
Documentation: http://www.rubydoc.info/gems/mini_portile/
Licenses: MIT
Latest release: 0.6.2 (published almost 11 years ago)
Last Synced: 2025-12-11T20:00:46.521Z (about 8 hours ago)
Versions: 18
Dependent Packages: 33
Dependent Repositories: 195,574
Downloads: 65,372,984 Total
Docker Downloads: 42,570,153
Rankings:
- Dependent repos count: 0.096%
- Downloads: 0.313%
- Dependent packages count: 0.728%
- Docker downloads count: 1.172%
- Average: 1.89%
- Forks count: 3.812%
- Stargazers count: 5.218%
Maintainers (2)
- flavorjones
- luislavena