fpm-cookery 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a665d466e70afc2e4c508512b2ba36cceac7337
-  data.tar.gz: 48dab70d5d15219594323fa6191054322d988eae
+  metadata.gz: e13450b36139981c3b9700c05e8a1cdd307a7d15
+  data.tar.gz: 36cbf763dd3217ee377eba4e6301d3f74d3825d6
 SHA512:
-  metadata.gz: 46abd44a9cb99b4bec920d415310421e34354502c9826d05feee09d3adde552c2b9c10acb2b1b6017a57294eb8672ee5f73764dfec3c7cf0778c37c179b4340c
-  data.tar.gz: 2421b226b5b365a9ea1a0046c3a714f8826c24f07d21f89bbebc27739e8720358d5ed3d335f76b5f61b544a39d87b16d83ca2614869abea974b9b777cbf6f24d
+  metadata.gz: 431ea4562cea0993d46c3b05b6f841d933d5263831106b9080c11dee93c735cecb3851ed23b7a6c52f74ca1454e129b94b94d3034cdbe40c342d64976d33e832
+  data.tar.gz: e5f23c74e1358f45f0bcfb7e35caddfe8c5ac85eb81dfff5bff7016c0ba1c1082e5c1cf64246aea80e6496616f72cfe0ad49e438d1a1668a6718b2d38086b010

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.29.0 (2015-07-25)
+* Start documentation at https://fpm-cookery.readthedocs.org/.
+  The documentation is now included in the source code (`docs/` directory) and
+  is written in sphinx/rst.
+* Add lifecycle hooks to the recipe class. (#113)
+  __WARNING__: This is an experimental feature and the hook names might change!
+* Add `extraced_source` attribute to the recipe class. (#112)
+
 # v0.28.0 (2015-07-10)
 * Add :extract option to git source handler.
   Using ":extract => :clone" with a :git source handler will clone the

data/README.md

@@ -20,6 +20,12 @@ quite some time
 
 It is using __fpm__ to create the actual packages.
 
+## Documentation
+
+Please find the documentation page here: https://fpm-cookery.readthedocs.org/
+
+Hosting and building of the documentation is provided by the great [Read the Docs project](https://readthedocs.org/)!
+
 ## Why?
 
 Building operating system packages for Debian/Ubuntu and RedHat using the

data/docs/.gitignore

@@ -0,0 +1 @@
+/_build

data/docs/Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/fpm-cookery.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/fpm-cookery.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/fpm-cookery"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/fpm-cookery"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

data/docs/conf.py

@@ -0,0 +1,295 @@
+# -*- coding: utf-8 -*-
+#
+# fpm-cookery documentation build configuration file, created by
+# sphinx-quickstart on Sat Jul 25 11:02:45 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import shlex
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# otherwise, readthedocs.org uses their theme by default, so no need to specify it
+
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.ifconfig',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'fpm-cookery'
+copyright = u'2015, Bernd Ahlers'
+author = u'Bernd Ahlers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = open("../lib/fpm/cookery/version.rb").read().split("'")[1]
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'fpm-cookerydoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  (master_doc, 'fpm-cookery.tex', u'fpm-cookery Documentation',
+   u'Bernd Ahlers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'fpm-cookery', u'fpm-cookery Documentation',
+     [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  (master_doc, 'fpm-cookery', u'fpm-cookery Documentation',
+   author, 'fpm-cookery', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

data/docs/index.rst

@@ -0,0 +1,37 @@
+.. fpm-cookery documentation master file, created by
+   sphinx-quickstart on Sat Jul 25 11:02:45 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the fpm-cookery documentation!
+=========================================
+
+**Current version:** |version|
+
+fpm-cookery provides an infrastructure to automatically build software based on recipes. It's heavily inspired and borrows code from the great `homebrew <https://github.com/mxcl/homebrew>`_ and `brew2deb <https://github.com/tmm1/brew2deb>`_ projects.
+
+Features
+^^^^^^^^
+
+* Source archive download and caching.
+* Recipes to describe and execute the software build. (e.g. configure, make, make install)
+* Sandboxed builds.
+* Package creation via `fpm <https://github.com/jordansissel/fpm>`_.
+* Standalone recipe trees/books/you name it. No need to put the recipes into the fpm-cookery source tree.
+
+Documentation Contents
+^^^^^^^^^^^^^^^^^^^^^^
+
+.. toctree::
+   :maxdepth: 2
+
+   pages/getting-started
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

data/docs/pages/getting-started.rst

@@ -0,0 +1,184 @@
+Getting Started
+===============
+
+This page helps you to get started with the fpm-cookery tool and guides you
+through the installation and the creation of a simple recipe to build your
+first package.
+
+You will create a package for the `tmux <http://tmux.sourceforge.net/>`_ program.
+
+Prerequisites
+-------------
+
+The following instructions have been tested with an Ubuntu 12.04 Linux system.
+It might work on other versions or other Linux systems but that cannot be
+guaranteed. Please use something like `Vagrant <http://www.vagrantup.com/>`_ to
+create an Ubuntu 12.04 VM if you do not have one at hand.
+
+Installation
+------------
+
+Rubygems
+^^^^^^^^
+
+fpm-cookery is written in Ruby. Before we can actually install the rubygem, you
+have to install a Ruby interpreter and some build tools.
+Execute the following to install the required packages::
+
+  $ sudo apt-get install ruby1.9.1 ruby1.9.1-dev build-essential curl
+
+Ruby 1.9 includes the ``gem`` program to install rubygems::
+
+  $ sudo gem install fpm-cookery
+
+This installs the fpm-cookery rubygem and its dependencies. At the end you
+should see something like "Successfully installed fpm-cookery-|version|".
+
+Your fpm-cookery installation is ready to build some packages now!
+
+OS Package
+^^^^^^^^^^
+
+We are planning to provide a packaged version for different operating systems.
+Please use the Rubygems installation method above in the meantime.
+
+The Recipe
+----------
+
+The recipe is a Ruby file that contains a simple class which acts as a DSL
+to set the attributes of a package (like name and version) and to describe
+the build and installation process of a package.
+
+You might want to create some folders to organize your recipes::
+
+  $ mkdir recipes
+  $ mkdir recipes/tmux
+  $ cd recipes/tmux
+  $ touch recipe.rb
+
+The last command creates an empty recipe file. See the following snippet for
+the complete recipe to build a tmux package. We will go through each step
+afterwards. Use your text editor to add the code to the ``recipe.rb`` file.
+
+.. code-block:: ruby
+
+  class Tmux < FPM::Cookery::Recipe
+    description 'terminal multiplexer'
+
+    name     'tmux'
+    version  '1.9a'
+    homepage 'http://tmux.sourceforce.net/'
+    source   'http://freefr.dl.sourceforge.net/project/tmux/tmux/tmux-1.9/tmux-1.9a.tar.gz'
+
+    build_depends 'libevent-dev', 'libncurses5-dev'
+    depends       'libevent-2.0-5'
+
+    def build
+      configure :prefix => prefix
+      make
+    end
+
+    def install
+      make :install, 'DESTDIR' => destdir
+    end
+  end
+
+Example Workflow
+----------------
+
+The following commands require the ``recipe.rb`` recipe file created above.
+
+.. code-block:: none
+
+  $ fpm-cook
+  ===> Starting package creation for tmux-1.9a (ubuntu, deb)
+  ===>
+  ===> Verifying build_depends and depends with Puppet
+  ===> Verifying package: libevent-dev
+  ===> Verifying package: libevent-2.0-5
+  ===> Missing/wrong version packages: libevent-dev
+  ERROR: Not running as root; please run 'sudo fpm-cook install-deps' to install dependencies.
+
+.. code-block:: none
+
+  $ sudo fpm-cook install-deps
+  ===> Verifying build_depends and depends with Puppet
+  ===> Verifying package: libevent-dev
+  ===> Verifying package: libevent-2.0-5
+  ===> Missing/wrong version packages: libevent-dev
+  ===> Running as root; installing missing/wrong version build_depends and depends with Puppet
+  ===> Installing package: libevent-dev
+  ===> ensure changed 'purged' to 'present'
+  ===> All dependencies installed!
+
+.. code-block:: none
+
+  $ fpm-cook
+  ===> Starting package creation for tmux-1.9a (ubuntu, deb)
+  ===>
+  ===> Verifying build_depends and depends with Puppet
+  ===> Verifying package: libevent-dev
+  ===> Verifying package: libncurses5-dev
+  ===> Verifying package: libevent-2.0-5
+  ===> All build_depends and depends packages installed
+  ===> Fetching source:
+  ######################################################################## 100.0%
+  ===> Building in /home/vagrant/recipes/tmux/tmp-build/tmux-1.9a
+  checking for a BSD-compatible install... /usr/bin/install -c
+  checking whether build environment is sane... yes
+
+  [lots of output removed]
+
+  make[1]: Nothing to be done for `install-data-am'.
+  make[1]: Leaving directory `/home/vagrant/recipes/tmux/tmp-build/tmux-1.9a'
+  ===> [FPM] Converting dir to deb {}
+  ===> [FPM] No deb_installed_size set, calculating now. {}
+  ===> [FPM] Reading template {"path":"/var/lib/gems/1.9.1/gems/fpm-1.0.2/templates/deb.erb"}
+  ===> [FPM] Creating {"path":"/tmp/package-deb-build20140308-7998-1v6uqm5/control.tar.gz","from":"/tmp/package-deb-build20140308-7998-1v6uqm5/control"}
+  ===> [FPM] Created deb package {"path":"tmux_1.9a-1_amd64.deb"}
+  ===> Created package: /home/vagrant/recipes/tmux/pkg/tmux_1.9a-1_amd64.deb
+
+.. code-block:: none
+
+  .
+  |-- cache
+  |   `-- tmux-1.9a.tar.gz
+  |-- pkg
+  |   `-- tmux_1.9a-1_amd64.deb
+  |-- recipe.rb
+  |-- tmp-build
+  |   `-- tmux-1.9a
+  `-- tmp-dest
+      `-- usr
+
+.. code-block:: none
+
+  $ dpkg -c pkg/tmux_1.9a-1_amd64.deb
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./usr/
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./usr/share/
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./usr/share/man/
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./usr/share/man/man1/
+  -rw-r--r-- 0/0           93888 2014-03-08 01:26 ./usr/share/man/man1/tmux.1
+  drwxrwxr-x 0/0               0 2014-03-08 01:26 ./usr/bin/
+  -rwxr-xr-x 0/0          491016 2014-03-08 01:26 ./usr/bin/tmux
+
+.. code-block:: none
+
+  $ dpkg -I pkg/tmux_1.9a-1_amd64.deb
+   new debian package, version 2.0.
+   size 235488 bytes: control archive= 437 bytes.
+       260 bytes,    12 lines      control
+       105 bytes,     2 lines      md5sums
+   Package: tmux
+   Version: 1.9a-1
+   License: unknown
+   Vendor:
+   Architecture: amd64
+   Maintainer: <vagrant@ubuntu1204>
+   Installed-Size: 571
+   Depends: libevent-2.0-5
+   Section: optional
+   Priority: extra
+   Homepage: http://tmux.sourceforce.net/
+   Description: terminal multiplexer

data/lib/fpm/cookery/lifecycle_hooks.rb

@@ -0,0 +1,18 @@
+require 'fpm/cookery/log'
+
+module FPM
+  module Cookery
+    module LifecycleHooks
+      def run_lifecycle_hook(hook_name)
+        Log.debug("Run lifecycle hook: #{hook_name}")
+        self.__send__(hook_name)
+      end
+
+      def before_dependency_installation
+      end
+
+      def after_dependency_installation
+      end
+    end
+  end
+end

data/lib/fpm/cookery/packager.rb

@@ -44,7 +44,9 @@ module FPM
       end
 
       def install_deps
+        recipe.run_lifecycle_hook(:before_dependency_installation)
         DependencyInspector.verify!(recipe.depends, recipe.build_depends)
+        recipe.run_lifecycle_hook(:after_dependency_installation)
         Log.info("All dependencies installed!")
       end
 
@@ -59,7 +61,9 @@ module FPM
 
         # RecipeInspector.verify!(recipe)
         if config.fetch(:dependency_check, true)
+          recipe.run_lifecycle_hook(:before_dependency_installation)
           DependencyInspector.verify!(recipe.depends, recipe.build_depends)
+          recipe.run_lifecycle_hook(:after_dependency_installation)
         end
 
         recipe.installing = false
@@ -101,6 +105,11 @@ module FPM
           Dir.chdir(recipe.builddir) do
             extracted_source = source.extract
 
+            if recipe.extracted_source
+              Log.debug "Using custom extracted source dir: #{recipe.builddir(recipe.extracted_source)}"
+              extracted_source = recipe.extracted_source
+            end
+
             Dir.chdir(extracted_source) do
               #Source::Patches.new(recipe.patches).apply!
 

data/lib/fpm/cookery/recipe.rb

@@ -6,6 +6,7 @@ require 'fpm/cookery/source_handler'
 require 'fpm/cookery/utils'
 require 'fpm/cookery/path_helper'
 require 'fpm/cookery/environment'
+require 'fpm/cookery/lifecycle_hooks'
 require 'fpm/cookery/package/cpan'
 require 'fpm/cookery/package/dir'
 require 'fpm/cookery/package/gem'
@@ -19,6 +20,7 @@ module FPM
       include FileUtils
       include FPM::Cookery::Utils
       include FPM::Cookery::PathHelper
+      include FPM::Cookery::LifecycleHooks
 
       def self.attr_rw(*attrs)
         attrs.each do |attr|
@@ -166,12 +168,21 @@ module FPM
           @spec = spec
         end
         alias_method :url, :source
+
+        def extracted_source(path = nil)
+          return @extracted_source if path.nil?
+          @extracted_source = path
+        end
       end
 
       def source
         self.class.source
       end
 
+      def extracted_source
+        self.class.extracted_source
+      end
+
       attr_reader :source_handler
 
       extend Forwardable

data/lib/fpm/cookery/version.rb

@@ -1,5 +1,5 @@
 module FPM
   module Cookery
-    VERSION = '0.28.0'
+    VERSION = '0.29.0'
   end
 end

data/spec/recipe_spec.rb

@@ -199,6 +199,12 @@ describe "Recipe" do
     end
   end
 
+  describe "#extracted_source" do
+    it "can be set" do
+      check_attribute(:extracted_source, 'test-1.0.0')
+    end
+  end
+
   def self.spec_recipe_attribute_list(name, list)
     class_eval %Q{
       describe "##{name}" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fpm-cookery
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Bernd Ahlers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-10 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,6 +124,11 @@ files:
 - README.md
 - Rakefile
 - bin/fpm-cook
+- docs/.gitignore
+- docs/Makefile
+- docs/conf.py
+- docs/index.rst
+- docs/pages/getting-started.rst
 - fpm-cookery.gemspec
 - lib/fpm/cookery/book.rb
 - lib/fpm/cookery/book_hook.rb
@@ -134,6 +139,7 @@ files:
 - lib/fpm/cookery/environment.rb
 - lib/fpm/cookery/exceptions.rb
 - lib/fpm/cookery/facts.rb
+- lib/fpm/cookery/lifecycle_hooks.rb
 - lib/fpm/cookery/log.rb
 - lib/fpm/cookery/log/color.rb
 - lib/fpm/cookery/log/output/console.rb