def test_generate_bundle_source_maps_service_explicit(self):
mapping = dist.generate_bundle_source_maps(['service'],
self.dist_dir,
method='explicit')
self.assertEqual(sorted(mapping.keys()), ['underscore'])
self.assertIn((join('underscore', 'underscore.js')),
mapping['underscore'])
def test_generate_bundle_source_maps_site_default(self):
mapping = dist.generate_bundle_source_maps(['site'], self.dist_dir)
self.assertEqual(sorted(mapping.keys()), ['jquery', 'underscore'])
self.assertTrue(mapping['jquery'].endswith(
join('fake_modules', 'jquery', 'dist', 'jquery.js')))
self.assertTrue(mapping['underscore'].endswith(
join('fake_modules', 'underscore', 'underscore.js')))
def test_generate_bundle_source_maps_site_empty(self):
# This one declares exact, should still work.
mapping = dist.generate_bundle_source_maps(['site'],
self.dist_dir,
method='empty')
self.assertEqual(sorted(mapping.keys()), ['jquery', 'underscore'])
self.assertEqual(mapping['jquery'], 'empty:')
self.assertEqual(mapping['underscore'], 'empty:')
def test_generate_bundle_source_maps_default(self):
mapping = dist.generate_bundle_source_maps(['framework'],
self.dist_dir)
self.assertEqual(sorted(mapping.keys()), [
'jquery',
'underscore',
])
self.assertIn((join('underscore', 'underscore-min.js')),
mapping['underscore'])
mapping = dist.generate_bundle_source_maps(['service'], self.dist_dir)
self.assertEqual(sorted(mapping.keys()), [
'jquery',
'underscore',
])
self.assertIn((join('underscore', 'underscore.js')),
mapping['underscore'])
self.assertIn('jquery', mapping['jquery'])
def test_generate_bundle_source_maps_service_empty(self):
mapping = dist.generate_bundle_source_maps(['service'],
self.dist_dir,
method='empty')
# Note that this ends up including all it sparents
self.assertEqual(mapping, {
'jquery': 'empty:',
'underscore': 'empty:',
})
def test_generate_bundle_source_maps_bad_dir(self):
bad_dir = utils.mkdtemp(self)
with pretty_logging(stream=StringIO()) as log:
mapping = dist.generate_bundle_source_maps(['service'], bad_dir)
self.assertEqual(sorted(mapping.keys()), [])
self.assertIn('fake_modules', log.getvalue())
def test_generate_bundle_source_maps_none(self):
mapping = dist.generate_bundle_source_maps(['site'], method='none')
self.assertEqual(sorted(mapping.keys()), [])
def create_spec(
package_names, export_target=None, working_dir=None, build_dir=None,
source_registry_method='all', source_registries=None,
source_map_method='all', bundle_map_method='all',
stub_missing_with_empty=False,
transpile_no_indent=False):
"""
Produce a spec for the compilation through the RJSToolchain.
Arguments:
package_names
The name of the Python package to source the dependencies from.
export_target
The filename for the output, can be an absolute path to a file.
Defaults to the package_name with a '.js' suffix added in the
working_dir.
working_dir
The working directory. If the package specified any extras
calmjs requirements (e.g. node_modules), they will be searched
for from here. Defaults to current working directory.
build_dir
The build directory. Defaults to a temporary directory that is
automatically removed when done.
source_registry_method
The acqusition method for the list of calmjs module registries
declared for the provided package names.
'all'
Traverse the dependency graph for the specified package to
acquire the declared calmjs module registries to use.
'explicit'
Only use the calmjs module registries declared for specified
packages.
'none'
Do not acquire sources. Useful for creating bundles of just
the bundle sources.
source_registries
If the provided packages did not specify all registries or have
declared modules in alternative but not explicitly specified
calmjs module registries, this option can be used to pass an
explicit list of calmjs module registries to use. Typical use
case is to generate tests.
source_map_method
The acquisition method for the source mapping for the given
package from the source_registries specified. Choices are
between 'all', 'explicit' or 'none'. Defaults to 'all'.
'all'
Traverse the dependency graph for the specified package to
acquire the sources declared for each of those modules.
'explicit'
Only acquire the sources for the specified package.
'none'
Do not acquire sources. Useful for creating bundles of just
the bundle sources.
bundle_map_method
The acquisition method for the bundle sources for the given
module. Choices are between 'all', 'explicit' or 'none'.
Defaults to 'all'.
'all'
Traverse the dependency graph for the specified package and
acquire the declarations.
'explicit'
Only acquire the bundle sources declared for the specified
package.
'empty'
Include all entries in a way that ensure that requirejs does
not include them. Useful for cases where these may be
provided by other bundles, or for cases where only the
declared sources are desired.
'none'
Do not specify any bundle files. This only works for
packages that have declared these as optional
Defaults to 'all'.
stub_missing_with_empty
If r.js/requirejs encounters a module that it cannot find, it
will flat out kill itself and this feature cannot be disabled
using a simple command line level flag. The only known way to
get around this is sto stub every single missing file using the
'empty:' url. Set this to True to enable the module names found
by the toolchain that do not lead to a valid location be stubbed
with this value in the configuration files generated for
consumption by RequireJS or r.js.
transpile_no_indent
Ensure that the transpile targets have no indents.
"""
working_dir = working_dir if working_dir else default_toolchain.join_cwd()
if export_target is None:
# Take the final package name for now...
if package_names:
export_target = package_names[-1] + '.js'
else:
export_target = 'calmjs.rjs.export.js'
spec = Spec(
transpile_no_indent=transpile_no_indent,
)
if source_registries is None:
source_registries = get_calmjs_module_registry_for(
package_names, method=source_registry_method)
if source_registries:
logger.info(
"automatically picked registries %r for building source map",
source_registries,
)
elif package_names:
logger.warning(
"no module registry declarations found using packages %r "
"using acquisition method '%s'",
package_names, source_registry_method,
)
else:
logger.warning('no packages specified for spec construction')
else:
logger.info(
"using manually specified registries %r for building source map",
source_registries,
)
spec[BUILD_DIR] = build_dir
spec[CALMJS_MODULE_REGISTRY_NAMES] = source_registries
spec[EXPORT_TARGET] = export_target
spec[SOURCE_PACKAGE_NAMES] = package_names
spec[STUB_MISSING_WITH_EMPTY] = stub_missing_with_empty
spec_update_source_map(spec, generate_transpile_source_maps(
package_names=package_names,
registries=source_registries,
method=source_map_method,
), 'transpile_source_map')
spec_update_source_map(spec, generate_bundle_source_maps(
package_names=package_names,
working_dir=working_dir,
method=bundle_map_method,
), 'bundle_source_map')
return spec