feat: change output to echo via pager

* Add --sort-by flag to threads sub-command

* Add some sanity test commands to tox

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,8 +1 @@
-
-*Description of changes:*
-
-*Checklist:*
-
-- [ ] Write unit tests
-- [ ] `make pr` passes
-- [ ] Write documentation
+###### Motivation for this change

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,27 @@
+name: "Code scanning - action"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 4 * * 1'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 2
+
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -88,3 +88,5 @@ venv.bak/
 .mypy_cache/
 .dmypy.json
 dmypy.json
+
+tmp/

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v2.5.0
     hooks:
     -   id: check-added-large-files
     -   id: check-ast

.travis.yml

@@ -1,11 +1,10 @@
 language: python
-dist: xenial
+dist: bionic
 sudo: false
 cache: false
 stages:
   - name: deploy
-    # require the branch name to be master (note for PRs this is the base branch name)
-    if: branch = master AND NOT type IN (pull_request)
+    if: repo = davegallant/rfd AND tag IS present
 
 before_install:
   - pip install -U pip
@@ -19,15 +18,14 @@ script:
 jobs:
   include:
     - python: "2.7"
-
     - python: "3.5"
-
     - python: "3.6"
-
     - python: "3.7"
+    - python: "3.8"
+    - python: "3.9-dev"
 
     - stage: deploy
-      python: "3.7"
+      python: "3.8"
       deploy:
         on:
           repo: davegallant/rfd

Makefile

@@ -1,35 +1,66 @@
 
 SRC := rfd
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
 
-.PHONY: build
+
+ifeq ($(origin .RECIPEPREFIX), undefined)
+  $(error This Make does not support .RECIPEPREFIX. Please use GNU Make 4.0 or later)
+endif
+.RECIPEPREFIX = >
+
+## build: Build a tar.gz of the python package
 build:
-	rm -rf dist/
-	python setup.py sdist
+> rm -rf dist/
+> python setup.py sdist
+.PHONY: build
 
-.PHONY: push_test
-push_test:
-	twine upload -r testpypi dist/*.tar.gz
-
-.PHONY: push_prod
-push_prod:
-	twine upload dist/*.tar.gz
-
-.PHONY: precommit
-precommit: ## Run pre-commit
-	pre-commit run \
+## precommit: Run all pre-commit hooks
+precommit:
+> pre-commit run \
  --all-files \
  --show-diff-on-failure
+.PHONY: precommit
 
-.PHONY: lint
+## lint: Run static analysis on the code
 lint:
-	pylint $(SRC)
+> pylint $(SRC)
+.PHONY: lint
 
+## test: Run all unit tests
+test: tmp/.tests-passed.sentinel
 .PHONY: test
-test:
-	pytest -v
 
-.PHONY: pr
+## examples: Run basic commands
+examples: tmp/.tests-passed.sentinel
+> rfd --version
+> rfd threads >/dev/null
+> rfd threads --sort-by score >/dev/null
+> rfd search 'pizza' >/dev/null
+> rfd search '(coffee|starbucks)' >/dev/null
+.PHONY: examples
+
+# Tests - re-ran if any file under src has been changed since tmp/.tests-passed.sentinel was last touched
+tmp/.tests-passed.sentinel: $(shell find ${SRC} -type f)
+> mkdir -p $(@D)
+> pytest -v
+> touch $@
+
+## pr: Run pre-commit, lint and test
 pr: precommit lint test
+.PHONY: pr
 
+ci: lint test examples
 .PHONY: ci
-ci: lint test
+
+## help: Print this help message
+help:
+> @echo "Usage:"
+> @echo
+> @sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' |  sed -e 's/^/ /' | sort
+> @echo
+.PHONY: help

README.md

@@ -4,10 +4,12 @@ Hot deals on the command line.
 
 [![Build Status](https://travis-ci.org/davegallant/rfd.svg?branch=master)](https://travis-ci.org/davegallant/rfd)
 [![PyPI version](https://badge.fury.io/py/rfd.svg)](https://badge.fury.io/py/rfd)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/davegallant/rfd.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/davegallant/rfd/alerts/)
+[![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/davegallant/rfd.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/davegallant/rfd/context:python)
 
-## Installation
+![screenshot](https://user-images.githubusercontent.com/4519234/85969861-e10a4100-b996-11ea-9a31-6203322c60ee.png)
+
+## Install
 
 ```bash
 pip install rfd
@@ -15,30 +17,65 @@ pip install rfd
 
 ## Usage
 
-![rfd_demo_gif](https://user-images.githubusercontent.com/4519234/64501455-64836600-d28f-11e9-8381-3fbfda910230.gif)
+```shell
+Usage: rfd [OPTIONS] COMMAND [ARGS]...
 
+  CLI for https://forums.redflagdeals.com
 
-### threads
-```bash
-rfd threads [--forum-id 9] [--limit 10]
+Options:
+  -v, --version
+  --help         Show this message and exit.
+
+Commands:
+  posts    Display all posts in a thread.
+  search   Search deals based on a regular expression.
+  threads  Displays threads in the forum. Defaults to hot deals.
 ```
 
-### search
-```bash
-rfd search pizza [--num-pages 100]
+## Examples
+
+### View Hot Deals
+
+```console
+$ rfd threads
 ```
 
-## Tab Completion
+### View and Sort Hot Deals
+
+```console
+$ rfd threads --sort-by score
+```
+
+```console
+$ rfd threads --sort-by views --limit 40
+```
+
+### Simple Search
+
+```console
+$ rfd search 'pizza'
+```
+
+### RegEx Search
+
+Regular expressions can be used for search.
+
+```console
+$ rfd search '(coffee|starbucks)' --pages 10 --sort-by views
+```
+
+## Shell Completion
+
+Completion can be enabled if using `bash` or `zsh`.
 
 ### bash
 
-```bash
-echo 'eval "$(_RFD_COMPLETE=source rfd)"' >> ~/.profile
+```console
+$ echo 'eval "$(_RFD_COMPLETE=source rfd)"' >> ~/.profile
 ```
 
 ### zsh
 
-
-```zsh
-echo 'eval "$(_RFD_COMPLETE=source_zsh rfd)"' >> ~/.zshrc
+```console
+$ echo 'eval "$(_RFD_COMPLETE=source_zsh rfd)"' >> ~/.zshrc
 ```

requirements.txt

@@ -1,4 +1,5 @@
-beautifulsoup4>=4.6.0
+beautifulsoup4<=4.8.2
 click>=7.0
-colorama>=0.3.9
-requests>=2.18.0
+colorama>=0.4.3
+requests>=2.22.0
+soupsieve<=2.0

requirements_dev.txt

@@ -1,5 +1,5 @@
-pre-commit==1.18.3
+pre-commit==1.21.0
 pylint
 pytest>=4.6.6
-rope==0.14.0
+rope==0.16.0
 tox-travis==0.12

rfd/VERSION

@@ -1 +1 @@
-0.3.3
+0.5.0

rfd/__init__.py

@@ -6,3 +6,5 @@ __title__ = "RFD CLI"
 __author__ = "Dave Gallant"
 __license__ = "Apache 2.0"
 __copyright__ = "(c) 2018 Dave Gallant"
+
+API_BASE_URL = "https://forums.redflagdeals.com"

rfd/api.py

@@ -6,11 +6,10 @@ except ImportError:
     JSONDecodeError = ValueError
 import logging
 import requests
-from .constants import API_BASE_URL
-from .format import strip_html, is_valid_url
-from .models import Post
+from . import API_BASE_URL
+from .posts import Post
 from .scores import calculate_score
-from .utils import is_int
+from .utils import is_int, strip_html, is_valid_url
 
 
 def extract_post_id(url):

rfd/cli.py

@@ -7,8 +7,7 @@ import sys
 import click
 from colorama import init, Fore, Style
 from .api import get_threads, get_posts
-from .search import search_threads
-from .parsing import parse_threads
+from .threads import parse_threads, search_threads, sort_threads
 from .__version__ import version as current_version
 
 init()
@@ -20,7 +19,7 @@ logging.getLogger().addHandler(logging.StreamHandler())
 
 
 def get_version():
-    return "rfd " + current_version
+    return "rfd v" + current_version
 
 
 def get_terminal_width():
@@ -36,34 +35,65 @@ def get_vote_color(score):
     return Fore.BLUE + " [" + str(score) + "] "
 
 
+def print_version(ctx, value):
+    if not value or ctx.resilient_parsing:
+        return
+    click.echo(get_version(), nl=False)
+    ctx.exit()
+
+
+def generate_thread_output(_threads):
+    for count, thread in enumerate(_threads, 1):
+        output = ""
+        dealer = thread.dealer_name
+        if dealer and dealer is not None:
+            dealer = "[" + dealer + "] "
+        else:
+            dealer = ""
+        output += (
+            " "
+            + str(count)
+            + "."
+            + get_vote_color(thread.score)
+            + Fore.RESET
+            + "%s%s" % (dealer, thread.title)
+            + Fore.LIGHTYELLOW_EX
+            + " (%d views)" % thread.views
+            + Fore.RESET
+        )
+        output += Fore.BLUE + " {}".format(thread.url)
+        output += Style.RESET_ALL
+        output += "\n\n"
+        yield output
+
+
 @click.group(invoke_without_command=True)
-@click.option("--version/--no-version", default=False)
+@click.option(
+    "-v",
+    "--version",
+    is_flag=True,
+    callback=print_version,
+    expose_value=False,
+    is_eager=True,
+)
 @click.pass_context
-def cli(ctx, version):
+def cli(ctx):
     """CLI for https://forums.redflagdeals.com"""
-    if version:
-        click.echo(get_version())
-    elif not ctx.invoked_subcommand:
+    if not ctx.invoked_subcommand:
         click.echo(ctx.get_help())
 
 
-@cli.command("version")
-def display_version():
-    click.echo(get_version())
-
-
-@cli.command(short_help="Displays posts in a specific thread.")
+@cli.command(short_help="Display all posts in a thread.")
 @click.argument("post_id")
 def posts(post_id):
-    """Displays posts in a specific thread.
+    """Iterate all pages and display all posts in a thread.
 
     post_id can be a full url or post id only
 
     Example:
 
     \b
-    url: https://forums.redflagdeals.com/koodo-targeted-public-mobile-12-120-koodo-5gb-40-no-referrals-2173603
-    post_id: 2173603
+    rfd posts https://forums.redflagdeals.com/koodo-targeted-public-mobile-12-120-koodo-5gb-40-no-referrals-2173603
     """
 
     try:
@@ -87,11 +117,12 @@ def posts(post_id):
         sys.exit(1)
 
 
-@cli.command(short_help="Displays threads in the specified forum.")
-@click.option("--limit", default=10, help="Number of topics.")
+@cli.command(short_help="Displays threads in the forum. Defaults to hot deals.")
 @click.option("--forum-id", default=9, help="The forum id number")
-def threads(limit, forum_id):
-    """Displays threads in the specified forum id. Defaults to 9.
+@click.option("--limit", default=10, help="Number of threads.")
+@click.option("--sort-by", default=None, help="Sort threads by")
+def threads(limit, forum_id, sort_by):
+    """Display threads in the specified forum id. Defaults to 9 (hot deals).
 
     Popular forum ids:
 
@@ -107,28 +138,21 @@ def threads(limit, forum_id):
     74 \t shopping discussion
     88 \t cell phones
     """
-    _threads = parse_threads(get_threads(forum_id, limit), limit)
-    for count, thread in enumerate(_threads, 1):
-        click.echo(
-            " "
-            + str(count)
-            + "."
-            + get_vote_color(thread.score)
-            + Fore.RESET
-            + "[%s] %s" % (thread.dealer_name, thread.title)
+    _threads = sort_threads(
+        parse_threads(get_threads(forum_id, limit), limit), sort_by=sort_by
     )
-        click.echo(Fore.BLUE + " {}".format(thread.url))
-        click.echo(Style.RESET_ALL)
+    click.echo_via_pager(generate_thread_output(_threads))
 
 
-@cli.command(short_help="Displays threads in the specified forum.")
-@click.option("--num-pages", default=5, help="Number of pages to search.")
+@cli.command(short_help="Search deals based on a regular expression.")
+@click.option("--pages", default=5, help="Number of pages to search.")
 @click.option(
     "--forum-id", default=9, help="The forum id number. Defaults to 9 (hot deals)."
 )
-@click.argument("keyword")
-def search(num_pages, forum_id, keyword):
-    """Searches for deals based on a keyword in the specified forum id.
+@click.option("--sort-by", default=None, help="Sort threads by")
+@click.argument("regex")
+def search(pages, forum_id, sort_by, regex):
+    """Search deals based on regex.
 
     Popular forum ids:
 
@@ -145,18 +169,12 @@ def search(num_pages, forum_id, keyword):
     88 \t cell phones
     """
 
-    count = 0
-    for page in range(1, num_pages):
+    matched_threads = []
+
+    for page in range(1, pages):
         _threads = parse_threads(get_threads(forum_id, 100, page=page), limit=100)
-        for thread in search_threads(threads=_threads, keyword=keyword):
-            count += 1
-            click.echo(
-                " "
-                + str(count)
-                + "."
-                + get_vote_color(thread.score)
-                + Fore.RESET
-                + "[%s] %s" % (thread.dealer_name, thread.title)
+        for thread in search_threads(threads=_threads, regex=regex):
+            matched_threads.append(thread)
+    click.echo_via_pager(
+        generate_thread_output(sort_threads(matched_threads, sort_by=sort_by))
     )
-            click.echo(Fore.BLUE + " {}".format(thread.url))
-            click.echo(Style.RESET_ALL)

rfd/constants.py

@@ -1 +0,0 @@
-API_BASE_URL = "https://forums.redflagdeals.com"

rfd/format.py

@@ -1,16 +0,0 @@
-"""Formatting utils"""
-
-try:
-    from urllib.parse import urlparse  # python 3
-except ImportError:
-    from urlparse import urlparse  # python 2
-from bs4 import BeautifulSoup
-
-
-def strip_html(text):
-    return BeautifulSoup(text, "html.parser").get_text()
-
-
-def is_valid_url(url):
-    result = urlparse(url)
-    return all([result.scheme, result.netloc, result.path])

rfd/models.py

@@ -1,17 +0,0 @@
-# pylint: disable=old-style-class
-class Thread:
-    def __init__(self, title, dealer_name, score, url):
-        self.dealer_name = dealer_name
-        self.score = score
-        self.title = title
-        self.url = url
-
-    def __repr__(self):
-        return "Thread(%s)" % self.title
-
-
-class Post:
-    def __init__(self, body, score, user):
-        self.body = body
-        self.score = score
-        self.user = user

rfd/parsing.py

@@ -1,34 +0,0 @@
-from .constants import API_BASE_URL
-from .scores import calculate_score
-from .models import Thread
-
-
-def build_web_path(slug):
-    return "{}{}".format(API_BASE_URL, slug)
-
-
-def parse_threads(threads, limit):
-    """parse topics list api response into digestible list.
-
-    Arguments:
-        threads {dict} -- topics response from rfd api
-        limit {int} -- limit number of threads returned
-
-    Returns:
-        list(dict) -- digestible list of threads
-    """
-    parsed_threads = []
-    if threads is None:
-        return []
-    for count, topic in enumerate(threads.get("topics"), start=1):
-        if count > limit:
-            break
-        parsed_threads.append(
-            Thread(
-                title=topic.get("title"),
-                dealer_name=topic["offer"].get("dealer_name"),
-                score=calculate_score(topic),
-                url=build_web_path(topic.get("web_path")),
-            )
-        )
-    return parsed_threads

rfd/posts.py

@@ -0,0 +1,8 @@
+# pylint: disable=old-style-class
+
+
+class Post:
+    def __init__(self, body, score, user):
+        self.body = body
+        self.score = score
+        self.user = user

rfd/search.py

@@ -1,13 +0,0 @@
-def search_threads(threads, keyword=None):
-    """Match deal title and dealer names with keyword specified."""
-
-    if keyword is None:
-        return
-
-    keyword = str(keyword)
-
-    for deal in threads:
-        if keyword.lower() in deal.title.lower() or (
-            deal.dealer_name and keyword.lower() in deal.dealer_name.lower()
-        ):
-            yield deal

rfd/threads.py

@@ -0,0 +1,76 @@
+import re
+from . import API_BASE_URL
+from .scores import calculate_score
+
+# pylint: disable=old-style-class
+class Thread:
+    def __init__(self, title, dealer_name, score, url, views):
+        self.dealer_name = dealer_name
+        self.score = score
+        self.title = title
+        self.url = url
+        self.views = views
+
+    def __repr__(self):
+        return "Thread(%s)" % self.title
+
+
+def build_web_path(slug):
+    return "{}{}".format(API_BASE_URL, slug)
+
+
+def get_dealer(topic):
+    dealer = None
+    if topic.get("offer"):
+        dealer = topic.get("offer").get("dealer_name")
+    return dealer
+
+
+def parse_threads(threads, limit):
+    """Parse topics list api response into digestible list.
+
+    Arguments:
+        threads {dict} -- topics response from rfd api
+        limit {int} -- limit number of threads returned
+
+    Returns:
+        list(dict) -- digestible list of threads
+    """
+    parsed_threads = []
+    if threads is None:
+        return []
+    for count, topic in enumerate(threads.get("topics"), start=1):
+        if count > limit:
+            break
+        parsed_threads.append(
+            Thread(
+                title=topic.get("title"),
+                dealer_name=get_dealer(topic),
+                score=calculate_score(topic),
+                url=build_web_path(topic.get("web_path")),
+                views=topic.get("total_views"),
+            )
+        )
+    return parsed_threads
+
+
+def sort_threads(threads, sort_by):
+    """Sort threads by an attribute"""
+    if sort_by is None:
+        return threads
+    assert sort_by in ["views", "score", "title"]
+    threads = sorted(threads, key=lambda x: getattr(x, sort_by), reverse=True)
+    return threads
+
+
+def search_threads(threads, regex):
+    """Match deal title and dealer names with regex specified."""
+
+    regexp = re.compile(str(regex).lower())
+
+    for deal in threads:
+
+        if regexp.search(deal.title.lower()) or (
+            deal.dealer_name and regexp.search(deal.dealer_name.lower())
+        ):
+            yield deal

rfd/utils.py

@@ -1,4 +1,18 @@
 """This module provides utility functions that are used within rfd"""
+try:
+    from urllib.parse import urlparse  # python 2
+except ImportError:
+    from urlparse import urlparse  # python 1
+from bs4 import BeautifulSoup
+
+
+def strip_html(text):
+    return BeautifulSoup(text, "html.parser").get_text()
+
+
+def is_valid_url(url):
+    result = urlparse(url)
+    return all([result.scheme, result.netloc, result.path])
 
 
 def is_int(number):

tests/test_api.py

@@ -1,5 +1,5 @@
 from rfd.api import extract_post_id
-from rfd.parsing import build_web_path, parse_threads
+from rfd.threads import build_web_path, parse_threads
 
 
 def test_build_web_path():