busser-behave 0.1.3

data/vendor/behave/docs/behave.rst-template

@@ -0,0 +1,86 @@
+==============
+Using *behave*
+==============
+
+The command-line tool *behave* has a bunch of `command-line arguments`_ and is
+also configurable using `configuration files`_.
+
+Values defined in the configuration files are used as defaults which the
+command-line arguments may override.
+
+
+Command-Line Arguments
+======================
+
+You may see the same information presented below at any time using ``behave
+-h``.
+
+{cmdline}
+
+
+Tag Expression
+--------------
+
+{tag_expression}
+
+
+Configuration Files
+===================
+
+Configuration files for *behave* are called either ".behaverc",
+"behave.ini" or "setup.cfg" (your preference) and are located in one of
+three places:
+
+1. the current working directory (good for per-project settings),
+2. your home directory ($HOME), or
+3. on Windows, in the %APPDATA% directory.
+
+If you are wondering where *behave* is getting its configuration defaults
+from you can use the "-v" command-line argument and it'll tell you.
+
+Configuration files **must** start with the label "[behave]" and are
+formatted in the Windows INI style, for example:
+
+.. code-block:: ini
+
+    [behave]
+    format=plain
+    logging_clear_handlers=yes
+    logging_filter=-suds
+
+
+Configuration Parameter Types
+-----------------------------
+
+The following types are supported (and used):
+
+**text**
+    This just assigns whatever text you supply to the configuration setting.
+
+**bool**
+    This assigns a boolean value to the configuration setting.
+    The text describes the functionality when the value is true.
+    True values are "1", "yes", "true", and "on".
+    False values are "0", "no", "false", and "off".
+
+**sequence<text>**
+    These fields accept one or more values on new lines, for example a tag
+    expression might look like:
+
+    .. code-block:: ini
+
+        tags=@foo,~@bar
+            @zap
+
+    which is the equivalent of the command-line usage::
+
+        --tags @foo,~@bar --tags @zap
+
+
+
+Configuration Parameters
+-----------------------------
+
+{config}
+
+

data/vendor/behave/docs/behave_ecosystem.rst

@@ -0,0 +1,81 @@
+.. _id.appendix.behave_ecosystem:
+
+Behave Ecosystem
+==============================================================================
+
+The following tools and extensions try to simplify the work with `behave`_.
+
+.. _behave: https://github.com/behave/behave
+
+.. seealso::
+
+    * `Are there any non-developer tools for writing Gherkin files ?
+      <http://stackoverflow.com/questions/8275026/are-there-any-non-developer-tools-to-edit-gherkin-files>`_
+      (``*.feature`` files)
+
+
+IDE Plugins
+------------------------------------------------------------------------------
+
+=============== =================== ======================================================================================
+IDE             Plugin              Description
+=============== =================== ======================================================================================
+`PyCharm`_      `PyCharm BDD`_      PyCharm 4 (Professional edition) has **built-in support** for `behave`_.
+`PyCharm`_      Gherkin             PyCharm/IDEA editor support for Gherkin.
+`Eclipse`_      `Cucumber-Eclipse`_ Plugin contains editor support for Gherkin.
+`VisualStudio`_ `cuke4vs`_          VisualStudio plugin with editor support for Gherkin.
+=============== =================== ======================================================================================
+
+.. _PyCharm:        http://www.jetbrains.com/pycharm/
+.. _Eclipse:        http://eclipse.org/
+.. _VisualStudio:   http://www.visualstudio.com/
+
+.. _`PyCharm BDD`:  http://www.jetbrains.com/pycharm/whatsnew/#BDD
+.. _`PyCharm BDD details`: http://blog.jetbrains.com/pycharm/2014/09/feature-spotlight-behavior-driven-development-in-pycharm/
+.. _`Cucumber-Eclipse`: http://cucumber.github.io/cucumber-eclipse/
+.. _cuke4vs:        https://github.com/henritersteeg/cuke4vs
+
+
+
+
+Editors and Editor Plugins
+------------------------------------------------------------------------------
+
+=================== ======================= =============================================================================
+Editor              Plugin                  Description
+=================== ======================= =============================================================================
+`gedit`_            `gedit_behave`_         `gedit`_ plugin for jumping between feature and step files.
+`Gherkin editor`_   ---                     An editor for writing ``*.feature`` files.
+`Notepad++`_        `NP++ gherkin`_         Notepad++ editor syntax highlighting for Gherkin.
+`Sublime Text`_     `Cucumber (ST Bundle)`_ Gherkin editor support, table formatting.
+`Sublime Text`_     `Behave Step Finder`_   Helps to navigate to steps in behave.
+`vim`_              `vim-behave`_           `vim`_ plugin: Port of `vim-cucumber`_ to Python `behave`_.
+=================== ======================= =============================================================================
+
+.. _`Notepad++`: http://www.notepad-plus-plus.org
+.. _gedit:  https://wiki.gnome.org/Apps/Gedit
+.. _vim:    http://www.vim.org/
+.. _`Sublime Text`:    http://www.sublimetext.com
+
+.. _`Gherkin editor`: http://gherkineditor.codeplex.com
+.. _gedit_behave:   https://gitorious.org/cucutags/gedit_behave
+.. _`NP++ gherkin`: http://productive.me/develop/cucumbergherkin-syntax-highlighting-for-notepad
+.. _vim-behave:     https://gitorious.org/cucutags/vim-behave
+.. _vim-cucumber:   https://github.com/tpope/vim-cucumber
+.. _`Cucumber (ST Bundle)`:    https://packagecontrol.io/packages/Cucumber
+.. _Behave Step Finder: https://packagecontrol.io/packages/Behave%20Step%20Finder
+
+
+Tools
+------------------------------------------------------------------------------
+
+=========================== ===========================================================================
+Tool                        Description
+=========================== ===========================================================================
+`cucutags`_                 Generate `ctags`_-like information (cross-reference index)
+                            for Gherkin feature files and behave step definitions.
+=========================== ===========================================================================
+
+.. _cucutags:   https://gitorious.org/cucutags/cucutags/
+.. _ctags:      http://ctags.sourceforge.net/
+

data/vendor/behave/docs/comparison.rst

@@ -0,0 +1,85 @@
+===========================
+Comparison With Other Tools
+===========================
+
+There are other options for doing Gherkin-based BDD in Python. We've listed
+the main ones below and why we feel you're better off using behave. Obviously
+this comes from our point of view and you may disagree. That's cool. We're
+not worried whichever way you go.
+
+This page may be out of date as the projects mentioned will almost certainly
+change over time. If anything on this page is out of date, please contact us.
+
+Cucumber_
+=========
+
+You can actually use Cucumber to run test code written in Python. It uses
+"rubypython" (dead) to fire up a Python interpreter inside the Ruby process though and
+this can be somewhat brittle. Obviously we prefer to use something written in
+Python but if you've got an existing workflow based around Cucumber and you
+have code in multiple languages, Cucumber may be the one for you.
+
+.. _Cucumber: http://cukes.info/
+.. dead-project:
+
+    rubypython: http://rubypython.rubyforge.org/
+
+Lettuce_
+========
+
+:pypi:`lettuce` is similar to behave in that it's a fairly straight port of
+the basic functionality of `Cucumber`_. The main differences with behave are:
+
+* Single decorator for step definitions, ``@step``.
+* The context variable, ``world``, is simply a shared holder of attributes.
+  It never gets cleaned up during the run.
+* Hooks are declared using decorators rather than as simple functions.
+* No support for tags.
+* Step definition code files can be anywhere in the feature directory
+  hierarchy.
+
+The issues we had with Lettuce that stopped us using it were:
+
+* Lack of tags (which are supported by now, at least since v0.2.20).
+* The hooks functionality was patchy. For instance it was very hard to clean
+  up the ``world`` variable between scenario outlines. Behave clears the
+  scenario-level context between outlines automatically.
+* Lettuce's handling of stdout would occasionally cause it to crash mid-run in
+  such a way that cleanup hooks were never run.
+* Lettuce uses import hackery so .pyc files are left around and the module
+  namespace is polluted.
+
+.. _Lettuce: http://lettuce.it/
+
+Freshen_
+========
+
+:pypi:`freshen` is a plugin for :pypi:`nose` that implements a
+Gherkin-style language with Python step definitions.
+The main differences with behave are:
+
+* Operates as a plugin for nose, and is thus tied to the nose runner and its
+  output model.
+* Has some additions to its Gherkin syntax allowing it to specify specific step
+  definition modules for each feature.
+* Has separate context objects for various levels: ``glc``, ``ftc`` and
+  ``scc``. These relate to global, feature and scenario levels respectively.
+
+The issues we had with Freshen that stopped us using it were:
+
+* The integration with the nose runner made it quite hard to properly debug
+  how and why tests were failing. Quite often you'd get a rather cryptic
+  message with the actual exception having been swallowed.
+* The feature-specific step includes could lead to specific sets of step
+  definitions for each feature despite them warning against doing that.
+* The output being handled by nose meant that you couldn't do cucumber-style
+  output without the addition of more plugins.
+* The context variable names are cryptic and moving context data from one
+  level to another takes a certain amount of work finding and renaming. The
+  behave `context` variable is much more flexible.
+* Step functions must have unique names, even though they're decorated to
+  match different strings.
+* As with Lettuce, Freshen uses import hackery so .pyc files are left
+  around and the module namespace is polluted.
+* Only Before and no contextual before/after control, thus requiring use of
+  atexit for teardown operations and no fine-grained control.

data/vendor/behave/docs/conf.py

@@ -0,0 +1,293 @@
+# -*- coding: utf-8 -*-
+# =============================================================================
+# SPHINX CONFIGURATION: behave documentation build configuration file
+# =============================================================================
+
+import os.path
+import sys
+
+# -- ENSURE: Local workspace is used (for sphinx apidocs).
+# 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(".."))
+
+# -- OPTIONAL EXTENSIONS/PARTS:
+# NOTES:
+# * sphinxcontrib.youtube: Not easily installable
+#   => other package with same name in pypi
+try:
+    import sphinxcontrib.youtube
+    has_extension_sphinxcontrib_youtube = True
+except ImportError:
+    has_extension_sphinxcontrib_youtube = False
+
+# ------------------------------------------------------------------------------
+# GENERAL CONFIGGURATION
+# ------------------------------------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = "1.3"
+
+# 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.autodoc",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.extlinks",
+]
+if has_extension_sphinxcontrib_youtube:
+    extensions.append("sphinxcontrib.youtube")
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+source_encoding = "utf-8"
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = u"behave"
+authors = u"Benno Rice, Richard Jones and Jens Engel"
+copyright = u"2012-2016, %s" % authors
+
+# 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.
+from behave import __version__
+version = __version__
+# 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.
+#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 = []
+
+extlinks = {
+    "pypi": ("https://pypi.python.org/pypi/%s", ""),
+    "github": ("https://github.com/%s", "github:/"),
+    "issue":  ("https://github.com/behave/behave/issue/%s", "issue #"),
+    "youtube": ("https://www.youtube.com/watch?v=%s", "youtube:video="),
+}
+
+
+# -- SUPPORT: Documentation variation-points with sphinx.ext.ifconfig
+def setup(app):
+    # -- VARIATION-POINT: supports_video
+    # BASED-ON: installed("sphinxcontrib-youtube") and output-mode
+    # TODO: Check for output-mode, too (supported on: HTML, ...)
+    supports_video = has_extension_sphinxcontrib_youtube
+    app.add_config_value("supports_video", supports_video, "env")
+
+
+# ------------------------------------------------------------------------------
+# OPTIONS FOR: HTML OUTPUT
+# ------------------------------------------------------------------------------
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+if on_rtd:
+    html_theme = "default"
+else:
+    html_theme = "kr"
+
+# 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.
+
+# agogo options:
+# headerfont (CSS font family): Font for headings.
+# pagewidth (CSS length): Width of the page content, default 70em.
+# documentwidth (CSS length): Width of the document (without sidebar), default 50em.
+# sidebarwidth (CSS length): Width of the sidebar, default 20em.
+# bgcolor (CSS color): Background color.
+# headerbg (CSS value for “background”): background for the header area, default a grayish gradient.
+# footerbg (CSS value for “background”): background for the footer area, default a light gray gradient.
+# linkcolor (CSS color): Body link color.
+# headercolor1, headercolor2 (CSS color): colors for <h1> and <h2> headings.
+# headerlinkcolor (CSS color): Color for the backreference link in headings.
+# textalign (CSS text-align value): Text alignment for the body, default is justify.
+
+html_theme_options = {
+ #"bodyfont": '"Ubuntu", sans-serif', # (CSS font family): Font for normal text.
+  #"github_fork": "behave/behave"
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ["_themes"]
+
+# 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 = "_static/behave_logo1.png"
+
+# 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"]
+
+# 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
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "behavedoc"
+
+
+# ------------------------------------------------------------------------------
+# 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": "",
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ("index", "behave.tex", u"behave Documentation", authors, "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 (man page) OUTPUT
+# ------------------------------------------------------------------------------
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ("index", "behave", u"behave Documentation", [authors], 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 = [
+  ("index", "behave", u"behave Documentation", authors,
+   "behave", "A test runner for behave (feature tests).", "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"