Skip to content

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also .

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also .
  • 16 commits
  • 16 files changed
  • 0 commit comments
  • 2 contributors
View
1 .gitignore
@@ -3,3 +3,4 @@
.coverage
.tox/
dist/
+docs/_build/
View
1 AUTHORS
@@ -1 +1,2 @@
Mike Yumatov
+Dima Kukushkin
View
10 README.rst
@@ -8,8 +8,12 @@ inspired by Ruby's Sprockets_. It includes support for writing scripts, styles
and client templates using CoffeeScript_, Handlebars_, Stylus_, Less_, SASS_
and SCSS_. New compilers can be also easily added.
-There is also an app for Django called django-gears_ that integrates Gears
-into Django project. You can read more on the project page.
+There is also:
+
+- django-gears_, an app for Django that integrates Gears with Django project;
+- Flask-Gears_, an extension that integrates Gears with Flask application;
+- gears-cli_, a command-line utility that compiles assets. It also can watch
+ assets for changes and automaticaly re-compile them.
Features
--------
@@ -113,3 +117,5 @@ Feel free to fork, send pull requests or report bugs and issues on github.
.. _SCSS: http://sass-lang.com/
.. _django-gears: https://github.com/trilan/django-gears
+.. _flask-gears: https://github.com/trilan/flask-gears
+.. _gears-cli: https://github.com/trilan/gears-cli
View
153 docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# 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 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 " 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 " 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 " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in 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/Gears.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Gears.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Gears"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Gears"
+ @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."
+
+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."
View
59 docs/about.rst
@@ -0,0 +1,59 @@
+About
+=====
+
+The Problem
+-----------
+
+The amount of code on the client side significantly grows in the modern
+web-applications. JavaScript and CSS files size increases, and it becomes more
+difficult to navigate through them. Static files must be broken down into
+modules. But the more static files you connect to the HTML page, the more HTTP
+requests must be done to load this page, which increases the load time.
+
+CSS and JavaScript files must be combined in production to reduce the number
+of subsequent HTTP requests to load the page. This is what Gears does for you.
+
+Motivation and Design Decisions
+-------------------------------
+
+But this problem is not new, and there are many awesome Python libraries here
+to solve it. So why another one? I've tried almost every existent library, and
+none of them fits my needs (and taste). Some of them are only for Django,
+some require you to specify asset dependencies in Python (or YAML, or JSON,
+or HTML).
+
+So, when I decided to create Gears, I pursued two goals:
+
+- this library should be framework-agnostic and cover as much as possible
+ contexts;
+- asset dependencies should be described in the usual way, much like this is
+ done in the modern languages (e.g., in Python).
+
+Let's look at both.
+
+Usage Contexts
+^^^^^^^^^^^^^^
+
+I have to work with static in different contexts:
+
+- in Django projects;
+- in reusable Django apps;
+- in Flask apps;
+- in static sites.
+
+And I want to use only one library for all this contexts (I don't want to deal
+with many different libraries).
+
+Asset Dependencies
+^^^^^^^^^^^^^^^^^^
+
+Yes, there are already Python libraries, that cover all this contexts. But I
+don't like their approach to describing dependencies between assets. It should
+be more like how we import modules in Python, Ruby, Java, etc. Dependencies
+for the asset should be described in this asset, not in the other place.
+Imagine for a moment that all imports in Python project would have to be
+described in JSON file in the root of this project. It would be terrible.
+
+I like how this problem is solved in Ruby's Sprockets library. Dependencies
+between assets must be described in header comments with special syntax. It was
+decided to use this approach and syntax in Gears.
View
43 docs/api.rst
@@ -0,0 +1,43 @@
+.. _api:
+
+API
+===
+
+.. module:: gears.asset_attributes
+
+Asset Attributes
+----------------
+
+.. autoclass:: AssetAttributes
+ :members:
+ :inherited-members:
+
+.. module:: gears.asset_handler
+
+Asset Handlers
+--------------
+
+.. autoclass:: BaseAssetHandler
+ :members:
+ :inherited-members:
+
+ .. automethod:: __call__(asset)
+
+.. autoclass:: ExecMixin
+ :members:
+
+.. module:: gears.processors.base
+
+Processors
+^^^^^^^^^^
+
+.. autoclass:: BaseProcessor
+ :members:
+
+.. module:: gears.compilers.base
+
+Compilers
+^^^^^^^^^
+
+.. autoclass:: BaseCompiler
+ :members:
View
246 docs/conf.py
@@ -0,0 +1,246 @@
+# -*- coding: utf-8 -*-
+#
+# Gears documentation build configuration file, created by
+# sphinx-quickstart on Sat Feb 25 20:20:25 2012.
+#
+# 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, os
+
+# 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.autodoc', 'sphinx.ext.intersphinx']
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Gears'
+copyright = u'2012, Mike Yumatov'
+
+# 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 = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2.dev'
+
+# 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 = []
+
+
+# -- 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 = 'default'
+
+# 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']
+
+# 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 = 'Gearsdoc'
+
+
+# -- 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', 'Gears.tex', u'Gears Documentation',
+ u'Mike Yumatov', '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 = [
+ ('index', 'gears', u'Gears Documentation',
+ [u'Mike Yumatov'], 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', 'Gears', u'Gears Documentation',
+ u'Mike Yumatov', 'Gears', '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'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
View
42 docs/index.rst
@@ -0,0 +1,42 @@
+Gears
+=====
+
+Gears is a library to compile, concatenate and minify JavaScript and CSS
+assets, highly inspired by Ruby's Sprockets_. It includes support for writing
+scripts, styles and client templates using CoffeeScript_, Handlebars_, Stylus_,
+Less_, SASS_ and SCSS_. New compilers can be also easily added.
+
+There is also:
+
+- django-gears_, an app for Django that integrates Gears with Django project;
+- Flask-Gears_, an extension that integrates Gears with Flask application;
+- gears-cli_, a command-line utility that compiles assets. It also can watch
+ assets for changes and automaticaly re-compile them.
+
+Source Code
+-----------
+
+Gears code is hosted on GitHub: https://github.com/trilan/gears.
+
+Contents
+--------
+
+.. toctree::
+ :maxdepth: 2
+
+ about
+ installation
+ api
+
+
+.. _Sprockets: http://getsprockets.org
+.. _CoffeeScript: http://jashkenas.github.com/coffee-script/
+.. _Handlebars: http://www.handlebarsjs.com/
+.. _Stylus: http://learnboost.github.com/stylus/
+.. _Less: http://lesscss.org/
+.. _SASS: http://sass-lang.com/
+.. _SCSS: http://sass-lang.com/
+
+.. _django-gears: https://github.com/trilan/django-gears
+.. _flask-gears: https://github.com/trilan/flask-gears
+.. _gears-cli: https://github.com/trilan/gears-cli
View
28 docs/installation.rst
@@ -0,0 +1,28 @@
+Installation
+============
+
+You can install Gears with pip_::
+
+ $ pip install Gears
+
+It is strongly recommended to install Gears within activated virtualenv_.
+
+If you want to use one of available extensions (django-gears_, Flask-Gears_ or
+gears-cli_), please refer to its documentation instead.
+
+Installing the Development Version
+----------------------------------
+
+If you want to work with the latest version of Gears, install it from the
+public repository (Git_ is required)::
+
+ $ pip install -e git+https://github.com/trilan/gears@develop#egg=Gears
+
+
+.. _pip: http://www.pip-installer.org/
+.. _virtualenv: http://virtualenv.org/
+.. _Git: http://git-scm.com/
+
+.. _django-gears: https://github.com/trilan/django-gears
+.. _flask-gears: https://github.com/trilan/flask-gears
+.. _gears-cli: https://github.com/trilan/gears-cli
View
190 docs/make.bat
@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :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. 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. text to make text files
+ echo. man to make manual pages
+ echo. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Gears.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Gears.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
View
2 setup.py
@@ -8,7 +8,7 @@ def read(filename):
setup(
name='Gears',
- version='0.1.1',
+ version='0.2.dev',
license='ISC',
description='Compiles and concatenates JavaScript and CSS assets.',
long_description=read('README.rst'),
View
22 tests/fixtures/directives_processor/requirements/bundle.js
@@ -0,0 +1,22 @@
+(function () {
+ console.log('external lib');
+}).call(this);
+
+(function () {
+ var App = this.App = {
+ Models: {},
+ Views: {}
+ };
+}).call(this);
+
+console.log('simple_lib.js');
+
+console.log('useful_lib.js');
+
+(function () {
+ console.log('application models');
+}).call(this);
+
+(function () {
+ console.log('application views');
+}).call(this);
View
1 tests/fixtures/directives_processor/requirements/js/libs/simple_lib.js
@@ -0,0 +1 @@
+console.log('simple_lib.js');
View
1 tests/fixtures/directives_processor/requirements/js/libs/useful_lib.js
@@ -0,0 +1 @@
+console.log('useful_lib.js');
View
1 tests/fixtures/directives_processor/requirements/source.js
@@ -1,5 +1,6 @@
//= require js/external
//= require_self
+//= require_directory js/libs
//= require js/models
//= require js/views
View
29 tests/test_directives_processor.py
@@ -35,23 +35,42 @@ def get_environment(self, fixture):
def get_asset(self, fixture):
return Asset(*self.get_environment(fixture).find('source.js'))
- def get_output_source(self, fixture):
+ def get_source(self, fixture, filename):
fixture_path = self.get_fixture_path(fixture)
- with open(os.path.join(fixture_path, 'output.js')) as f:
+ with open(os.path.join(fixture_path, filename)) as f:
return f.read()
def test_fills_asset_requirements(self):
asset = self.get_asset('requirements')
DirectivesProcessor.as_handler()(asset)
self.check_paths(asset.requirements.before, ['js/external.js'])
- self.check_paths(asset.requirements.after, ['js/models.js', 'js/views.js'])
+ self.check_paths(asset.requirements.after, [
+ 'js/libs/simple_lib.js',
+ 'js/libs/useful_lib.js',
+ 'js/models.js',
+ 'js/views.js',
+ ])
def test_modifies_processed_source(self):
asset = self.get_asset('requirements')
DirectivesProcessor.as_handler()(asset)
- self.assertEqual(asset.processed_source, self.get_output_source('requirements'))
+ self.assertEqual(
+ asset.processed_source,
+ self.get_source('requirements', 'output.js'),
+ )
+
+ def test_modifies_bundled_source(self):
+ asset = self.get_asset('requirements')
+ DirectivesProcessor.as_handler()(asset)
+ self.assertEqual(
+ asset.bundled_source,
+ self.get_source('requirements', 'bundle.js'),
+ )
def test_requires_asset_only_once(self):
asset = self.get_asset('require_multiple_times')
DirectivesProcessor.as_handler()(asset)
- self.check_paths(list(asset.requirements), 'external.js models.js views.js source.js'.split())
+ self.check_paths(
+ list(asset.requirements),
+ 'external.js models.js views.js source.js'.split(),
+ )

No commit comments for this range

Something went wrong with that request. Please try again.