embulk 0.3.2 → 0.4.0

data/embulk-docs/push-gh-pages.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+set -e
+[ "$TRAVIS_PULL_REQUEST" != "false" ] && exit 0
+
+revision="$(git rev-parse HEAD)"
+remote="$(git config remote.origin.url | sed "s+^git:+http://+")"
+./gradlew site
+
+rm -rf gh_pages
+git clone . gh_pages
+cd gh_pages
+
+git remote add travis_push "$remote"
+git fetch travis_push
+
+git checkout -b gh-pages travis_push/gh-pages
+rm -rf docs
+cp -a ../embulk-docs/build/html docs
+git add docs
+
+git config user.name "$GIT_USER_NAME"
+git config user.email "$GIT_USER_EMAIL"
+git commit -m "Updated document $revision" || exit 0
+
+git config credential.helper "store --file=.git_credential_helper"
+echo "https://$GITHUB_TOKEN:@github.com" > "$HOME/.git_credential_helper"
+trap "rm -rf $HOME/.git_credential_helper" EXIT
+git push travis_push gh-pages

data/embulk-docs/src/conf.py

@@ -0,0 +1,260 @@
+# -*- coding: utf-8 -*-
+#
+# Embulk documentation build configuration file, created by
+# sphinx-quickstart on Fri Feb 13 14:52:36 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
+
+# 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',
+]
+
+# 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'Embulk'
+copyright = u'2015, Embulk Project'
+
+# 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.4'
+# The full version, including alpha/beta/rc tags.
+release = '0.4'
+
+# 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 = []
+
+# 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
+
+
+# -- 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 = 'haiku'
+
+# 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
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Embulkdoc'
+
+
+# -- 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, or own class]).
+latex_documents = [
+  ('index', 'Embulk.tex', u'Embulk Documentation',
+   u'Embulk Project', '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', 'embulk', u'Embulk Documentation',
+     [u'Embulk Project'], 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', 'Embulk', u'Embulk Documentation',
+   u'Embulk Project', 'Embulk', '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/embulk-docs/src/index.rst

@@ -0,0 +1,19 @@
+.. Embulk documentation master file, created by
+   sphinx-quickstart on Fri Feb 13 14:52:36 2015.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Embulk documentation
+==================================
+
+https://github.com/embulk/embulk
+
+.. toctree::
+   :maxdepth: 2
+
+   release
+
+* `JavaDoc <javadoc/index.html>`_
+
+* `RDoc <rdoc/_index.html>`_
+

data/embulk-docs/src/release.rst

@@ -0,0 +1,14 @@
+Release Notes
+==================================
+
+.. toctree::
+    :maxdepth: 1
+
+    release/release-0.1.0
+    release/release-0.2.0
+    release/release-0.2.1
+    release/release-0.3.0
+    release/release-0.3.1
+    release/release-0.3.2
+    release/release-0.4.0
+

data/embulk-docs/src/release/release-0.1.0.rst

@@ -0,0 +1,8 @@
+Release 0.1.0
+==================================
+
+The first release.
+
+Release Date
+---------------
+2015-01-26

data/embulk-docs/src/release/release-0.2.0.rst

@@ -0,0 +1,16 @@
+Release 0.2.0
+==================================
+
+Plugin API
+------------------
+
+* Changed JRuby InputPlugin API to use #run instead of .run
+
+CLI
+------------------
+
+* Fixed ``example`` subcommand to quote file path for Windows environment
+
+Release Date
+------------------
+2015-01-26

data/embulk-docs/src/release/release-0.2.1.rst

@@ -0,0 +1,19 @@
+Release 0.2.1
+==================================
+
+Plugin Utility
+------------------
+
+* Fixed ``spi.util.LineEncoder#finish`` to flush all remaining buffer (reported by @aibou)
+* ``Embulk::PageBuilder#add`` accepts nil value
+
+General Changes
+------------------
+
+* Fixed NextConfig to be merged to in: or out: rather than the top-level
+  (reported by enukane) [#41]
+* ./bin/embulk shows warns to run `rake` if ./classpath doesn't exist
+
+Release Date
+------------------
+2015-01-29

data/embulk-docs/src/release/release-0.3.0.rst

@@ -0,0 +1,34 @@
+Release 0.3.0
+==================================
+
+Resume Feature
+------------------
+
+* Added resume functionality.
+
+Filter Feature
+------------------
+
+* Added new filter plugin type.
+
+Plugin SPI
+------------------
+
+* ``spi.InputPlugin`` and ``spi.OutputPlugin`` need to implement ``resume`` and ``cleanup`` methods.
+* Added ``spi.FilterInputPlugin`` Java API.
+* Added ``Embulk::FilterInputPlugin`` JRuby API.
+
+CLI
+------------------
+
+* ``run`` subcommand supports ``-r, --resume-state PATH`` option.
+
+General Changes
+------------------
+
+* Added gradle-versions-plugin to build.gradle (@seratch++)
+* Fixed broken dependencies at build.gradle (@thagikura++)
+
+Release Date
+------------------
+2015-02-03

data/embulk-docs/src/release/release-0.3.1.rst

@@ -0,0 +1,11 @@
+Release 0.3.1
+==================================
+
+CLI
+------------------
+
+* Added ``-C, --classpath option`` to add java classpath
+
+Release Date
+------------------
+2015-02-04

data/embulk-docs/src/release/release-0.3.2.rst

@@ -0,0 +1,15 @@
+Release 0.3.2
+==================================
+
+General Changes
+------------------
+
+* Fixed a problem where ruby input plugins can't use timestamp type (reported
+  by @shun0102)
+* ``Embulk::Page`` includes Enumerable to include map, each_with_index, and other
+   a lot of convenient methods (@niku++)
+* Fixed ``spi.time.TimestampType::DEFAULT_FORMAT`` to use ':' as the separator of times
+
+Release Date
+------------------
+2015-02-04

data/embulk-docs/src/release/release-0.4.0.rst

@@ -0,0 +1,74 @@
+Release 0.4.0
+==================================
+
+Plugin Template Generator
+------------------
+
+A new CLI subcommand ``new`` generate a plugin template.
+
+For example, ``new ruby-output <name>`` generates a template of output plugin written in Ruby::
+
+    $ embulk new ruby-output foo
+    Creating embulk-output-foo/
+      Creating embulk-output-foo/README.md
+      Creating embulk-output-foo/LICENSE.txt
+      Creating embulk-output-foo/.gitignore
+      Creating embulk-output-foo/Rakefile
+      Creating embulk-output-foo/Gemfile
+      Creating embulk-output-foo/embulk-output-foo.gemspec
+      Creating embulk-output-foo/lib/embulk/output/foo.rb
+
+The template generate supports most of plugin types. ruby-file-input and output, ruby-parser and formatter, ruby-decoder and encoder are not available yet because plugin SPI is not implemented yet.
+
+
+Java Plugin Loader
+------------------
+
+Now, we can write plugins in Java.
+
+The plugin loader creates a dedicated classloader for each plugin so that plugins can depend on different versions of libraries. To develop a Java plugin, you can use use ``new java-<category> <name>`` command which generates a template. The generated directory has ``build.gradle`` file so that you can run ``./gradlew gem`` command to build a gem package.
+
+
+Plugin SPI
+------------------
+
+* **IMPORTANT**: Changed plugin path name from ``lib/embulk/<caetgory>_<name>.rb`` to ``lib/embulk/<category>/<name>.rb``.
+* Added ``@ConfigInject`` annotation to set resources injected by Guice to a Task.
+* Removed support for ``@JacksonInject`` annotation on a Task. ``@ConfigInject`` is the drop-in replacement.
+* Changed class name ``spi.NextConfig`` to ``spi.ConfigDiff``.
+
+
+
+Built-in plugins
+------------------
+
+* ``csv`` parser plugin and its guess plugin assume "true", "yes", "Y" and "on" as a boolean true value.
+
+* ``file`` input plugin changed parameters.
+
+  * Added ``path_prefix`` parameter (string, required).
+  * Added ``last_path`` parameter (string, optional) which skips files older than or same with the specified file path.
+  * Removed ``paths`` parameter.
+
+* ``file`` output plugin changed parameters.
+
+  * Added ``sequence_format`` parameter.
+  * Removed ``directory`` parameters.
+  * Removed ``file_name`` parameters.
+  * The actual file name is ``${path_prefix}${sequence_format % [processorIndex, sequenceNumber}${ext_name}``.
+
+* Removed ``s3`` file input plugin. It is now embulk-input-s3 gem.
+
+
+General Changes
+------------------
+
+* PluginManager reports the cause of exceptions when it failed to load a plugin.
+* Removed pom.xml.
+* Set locale = 'en_US' when gradle builds javadoc.
+* Added documentation scripts using Sphinx, YARD and JavaDoc.
+
+
+Release Date
+------------------
+2015-02-15