Merge pull request #60 from ento/fix-indirect-deps

Fix indirect deps, remove automatic installation of Elm

Author: ento

.travis.yml

@@ -14,39 +14,32 @@ env:
   global:
     - PIP_CACHE_DIR=$HOME/.cache/pip
     - PIPENV_CACHE_DIR=$HOME/.cache/pipenv
+    - PIPENV_KEEP_OUTDATED=1
 
 language: python
 
 python:
-  - 3.5
-  - 3.6
-  - nightly
 
 matrix:
   include:
-  - env: WITH_YARN=yes
-    python: "3.5"
-  - env: CHECK_INSTALL=yes
-    python: "3.5"
+  - python: "3.5"
+    env: CHECK_INSTALL=yes
+  - python: "3.5"
+  - python: "3.6"
+  - python: "3.7"
+    dist: xenial
+  - python: nightly
 
 before_install:
   - pip --version
   - pip install codecov
   - pip install -U pip setuptools
-  - |
-    if [[ $WITH_YARN == 'yes' ]]; then
-      # Repo for newer Node.js versions
-      curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
-      # Repo for Yarn
-      curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
-      echo "deb http://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
-      sudo apt-get update -qq && sudo apt-get install -y -qq yarn
-    fi
 
 install:
   - pip install 'pipenv>=2018.10.9' tox-travis
   - pipenv --version
   - pipenv install --dev
+  - git checkout Pipfile.lock # workaround until https://github.com/pypa/pipenv/pull/3304 is released
 
 before_script:
   - git lfs version

MANIFEST.in

@@ -4,6 +4,7 @@ include src/elm_doc/assets/assets.tar.gz
 exclude .gitmodules
 exclude dependencies.yml
 exclude Pipfile*
+exclude *.nix
 exclude vendor
 recursive-exclude vendor *
 exclude workspace

Pipfile

@@ -23,4 +23,4 @@ wheel = "*"
 keyring = "*"
 
 [requires]
-python_version = "3.6"
+python_version = "3.7"

README.md

@@ -15,7 +15,8 @@ You will need to enable the `--pre` flag if you're installing the latest version
 
 Simplest invocation:
 
-    $ elm-doc . --output docs --fake-license 'SPDX license name'
+    $ elm-doc . --output docs --fake-license 'SPDX license name' \
+        --elm-path path/to/usually/node_modules/.bin/elm
 
 The license name is required because elm-doc uses the official Elm binary to
 validate and generate docs; the official Elm binary only generates
@@ -41,16 +42,10 @@ and `--fake-version`.
 elm-doc creates a build directory named `.elm-doc` at the root of the project.
 You may want to ignore it in your SCM config, or you can change its path with `--build-dir`.
 
-You can further point `--elm-path` at your existing installation of `elm` binary
-to avoid the overhead of installing Elm:
-
-    $ elm-doc . --output docs \
-        --elm-path ui/node_modules/.bin/elm
-
 `--validate` can check if you have all the necessary documentation in place:
 
     $ elm-doc . \
-        --elm-path ui/node_modules/.bin/elm \
+        --elm-path ./node_modules/.bin/elm \
         --validate
 
 `elm-doc` assumes you're working on an app, not a package; it will try to generate
@@ -59,13 +54,13 @@ documentation for all modules found in the application source directories.
 You can `--exclude-modules` by using [fnmatch](https://docs.python.org/3/library/fnmatch.html)
 patterns:
 
-    $ elm-doc . --output docs \
-        --elm-path ui/node_modules/.bin/elm \
+    $ elm-doc . --output docs --fake-license 'SPDX license name' \
+        --elm-path ./node_modules/.bin/elm \
         --exclude-modules '*.Private.*,Blacklist.*'
 
 or `--exclude-source-directories` entirely:
 
-    $ elm-doc . --output docs \
+    $ elm-doc . --output docs --fake-license 'SPDX license name' \
         --elm-path ui/node_modules/.bin/elm \
         --exclude-source-directories generated
 
@@ -78,7 +73,7 @@ You can also specify which files and directories to _include_ in the list of mod
 Note that the `--exclude` flag takes no effect if you explicitly specify which
 files to include, unless you add the `--force-exclusion` flag:
 
-    $ elm-doc . --output docs \
+    $ elm-doc . --output docs --fake-license 'SPDX license name' \
         --elm-path ui/node_modules/.bin/elm \
         --exclude-modules '*.Private.*,Blacklist.*' \
         --force-exclusion \
@@ -104,9 +99,9 @@ This is the rough build process:
   - Populate `--fake-*` fields, including the license: these are required for a package project but not included in an application project's elm.json
   - Add dependencies that are listed as popular packages in the sidebar, making HTTP requests to look up the latest versions
   - This means the actual build / validation process will have its own elm-stuff directory
-- Copy source files into the build directory's `src` directory using [dirsync](https://bitbucket.org/tkhyn/dirsync/)
+- Copy source files into the build directory's `src` directory using rsync
   - An application project supports multiple source directories, while a package project supports only `src`
-- For each file that were copied, rewrite port delcarations to be normal functions
+- For each file that was copied, rewrite port delcarations to be normal functions
   - This is needed because ports are not allowed in package projects
 - Run `elm make` with the `--doc` flag on
 - If validating docs, exit here

dodo.py

@@ -15,7 +15,7 @@
 
 sys.path.insert(0, str(Path(__file__).parent / 'src'))
 
-from elm_doc import elm_platform, elm_project, tasks
+from elm_doc import elm_project, tasks
 from tests import conftest
 
 
@@ -48,7 +48,7 @@ def _create_elm_core_fixture(elm_version: str, tarball: str):
     shutil.rmtree(str(workspace_path / elm_project.STUFF_DIRECTORY), ignore_errors=True)
     with TemporaryDirectory() as tmpdir:
         root_path = Path(tmpdir)
-        elm_path = elm_platform.install(root_path, elm_version)
+        elm_path = conftest.install_elm(root_path, elm_version)
         elm_home_path = root_path / '.elm'
         try:
             subprocess.check_output(
@@ -182,7 +182,7 @@ def _create_package_elm_lang_org_elm_js(output_path: Path):
     elm_version = _read_elm_version(repo_path / 'elm.json')
     with TemporaryDirectory() as tmpdir:
         root_path = Path(tmpdir)
-        elm_path = elm_platform.install(root_path, elm_version)
+        elm_path = conftest.install_elm(root_path, elm_version)
         try:
             subprocess.check_output(
                 [
@@ -219,14 +219,14 @@ def task_install_workspace_elm():
 
 def _install_elm(project_path: Path):
     elm_version = _read_elm_version(project_path / 'elm.json')
-    elm_platform.install(project_path, elm_version)
+    conftest.install_elm(project_path, elm_version)
 
 
 for creator_name, creator_func in tasks.build_task_creators(
         workspace_path,
         config,
+        elm_path,
         output_path,
-        elm_path=elm_path,
         mount_point='/docs',
 ).items():
     globals()[creator_name] = creator_func

setup.py

@@ -49,6 +49,7 @@
         'Programming Language :: Python',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3 :: Only',
         'Topic :: Software Development :: Documentation',
     ]

shell.nix

@@ -0,0 +1,13 @@
+let
+  pkgs = import <nixpkgs> {};
+in
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    nodejs
+    pipenv
+    rsync
+  ];
+  shellHook = ''
+    export SOURCE_DATE_EPOCH=315532800
+  '';
+}

src/elm_doc/cli.py

@@ -83,6 +83,7 @@ def write(self, *args, **kwargs):
 
 
 @click.command(context_settings=dict(
+    help_option_names=['-h', '--help'],
     ignore_unknown_options=True,
 ))
 @click.option('--output', '-o',
@@ -187,9 +188,9 @@ def main(
     task_creators = build_task_creators(
         _resolve_path(project_path),
         project_config,
+        _resolve_path(elm_path) if elm_path else None,
         _resolve_path(output) if output is not None else None,
         build_path=_resolve_path(build_dir) if build_dir is not None else None,
-        elm_path=_resolve_path(elm_path) if elm_path is not None else None,
         mount_point=mount_at,
         validate=validate)
 

src/elm_doc/decorators.py

@@ -1,10 +1,5 @@
 import os
-import subprocess
 from pathlib import Path
-import json
-
-from elm_doc import node_modules
-from elm_doc.decorators import capture_subprocess_error_as_task_error
 
 
 # See: https://github.com/elm/compiler/blob/0.19.0/builder/src/Elm/PerUserCache.hs#L44
@@ -14,48 +9,3 @@
 # On Windows, this is something like 'C:/Users/<user>/AppData/Roaming/<app>'.
 # elm-doc currently don't support Windows, so this is fine for now.
 ELM_HOME = Path(os.environ['ELM_HOME']) if 'ELM_HOME' in os.environ else (Path.home() / '.elm')
-
-
-def install(to: Path, elm_version: str) -> Path:
-    npm_package = {
-        'dependencies': {
-            'elm': get_npm_version_range(elm_version)
-        }
-    }
-    with open(str(to / 'package.json'), 'w') as f:
-        json.dump(npm_package, f)
-    node_modules.install(cwd=str(to))
-    return to / 'node_modules' / '.bin' / 'elm'
-
-
-@capture_subprocess_error_as_task_error
-def get_node_modules_elm_path(project_root: Path):
-    script = 'console.log(require.resolve("elm"))'
-    # e.g. path/to/node_modules/elm/index.js
-    elm_index_path = subprocess.check_output(
-        ['node', '-e', script],
-        cwd=str(project_root),
-    )
-    # e.g. path/to/node_modules/.bin/elm
-    return Path(elm_index_path.decode('utf-8').strip()).parent.parent / '.bin' / 'elm'
-
-
-def get_npm_version_range(elm_version: str) -> str:
-    if _is_exact(elm_version):
-        return elm_version
-    min_version, gt_op, _, lt_op, max_version = elm_version.split(' ')
-    return '{gt_op}{min_version} {lt_op}{max_version}'.format(
-        min_version=min_version,
-        gt_op=_flip_inequality_op(gt_op),
-        lt_op=lt_op,
-        max_version=max_version,
-    )
-
-
-def _is_exact(elm_version: str) -> bool:
-    return ' ' not in elm_version
-
-
-def _flip_inequality_op(op: str) -> str:
-    # assume there's only one < or >
-    return op.replace('>', '<').replace('<', '>')