stig

A CLI tool for searching GitHub from the terminal.


stig

/

src

/

main.cc

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
#include "ob/parg.hh"
using Parg = OB::Parg;

#include "ob/string.hh"
namespace String = OB::String;

#include "stig/stig.hh"
namespace Stig = OB::Stig;

#include <string>
#include <iostream>

int program_options(Parg& pg);

int program_options(Parg& pg)
{
  pg.name("stig").version("0.1.6 (05.01.2019)");
  pg.description("A CLI tool for searching Git repositories on GitHub.");
  pg.usage("[flags] [options] [--] [arguments]");
  pg.usage("[-q|--query str] [-p|--page int] [-n|--number int] [-s|--sort stars|forks|updated|best] [-o|--order asc|desc] [-f|--filter key:value[ key:value]...] [--token str] [--host str] [-c|--color on|off|auto]");
  pg.usage("[-r|--readme user/repo[/ref]]");
  pg.usage("[-v|--version]");
  pg.usage("[-h|--help]");
  pg.info("Examples", {
    "stig --query 'stig' --number 20 --page 1",
    "stig --query 'stig' --filter 'language:cpp'",
    "stig --query 'stig' | less",
    "stig --query '' --sort 'stars' --filter 'language:js'",
    "stig --query 'http server' --filter 'language:cpp stars:>10'",
    "stig --readme 'octobanana/stig'",
    "stig --readme 'octobanana/stig/master'",
    "stig --readme 'octobanana/stig' | less",
    "stig --help",
    "stig --version",
  });
  pg.info("Exit Codes", {"0 -> normal", "1 -> error"});
  pg.info("Repository", {
    "https://github.com/octobanana/stig.git",
  });
  pg.info("Homepage", {
    "https://octobanana.com/software/stig",
  });
  pg.author("Brett Robinson (octobanana) <octobanana.dev@gmail.com>");

  // general flags
  pg.set("help,h", "print the help output");
  pg.set("version,v", "print the program version");

  // general options
  pg.set("token", "", "str", "used to validate against GitHub, enables a greater number of requests before being rate-limited");
  pg.set("host", "api.github.com", "str", "perform GitHub API v3 requests against a custom host");

  // query options
  pg.set("query,q", "", "str", "the query string");
  pg.set("page,p", "1", "int", "the page number to get");
  pg.set("number,n", "10", "int", "the number of results to show per page");
  pg.set("sort,s", "best", "stars|forks|updated|best", "how to sort the search results, default is best match");
  pg.set("order,o", "desc", "asc|desc", "the order to sort the search results, default is desc");
  pg.set("filter,f", "", "key:value[ key:value]...", "filter results with space seperated key:value pairs");
  pg.set("color,c", "auto", "on|off|auto", "used to determine the output color preference, default is auto");

  // readme options
  pg.set("readme,r", "", "user/repo[/ref]", "print a repos README.md to stdout");

  // pg.set_pos();
  // pg.set_stdin();

  int status {pg.parse()};

  if (status > 0 && pg.get_stdin().empty())
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "expected arguments" << "\n";

    return -1;
  }

  if (status < 0)
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << pg.error() << "\n";

    if (pg.similar().size() > 0)
    {
      std::cerr << "Did you mean: ";
      for (auto const& e : pg.similar())
      {
        std::cerr << e << " ";
      }
      std::cerr << "\n";
    }
    else
    {
      std::cerr << "No suggestions found.\n";
    }

    return -1;
  }

  if (pg.get<bool>("help"))
  {
    std::cerr << pg.help();

    return 1;
  }

  if (pg.get<bool>("version"))
  {
    std::cerr << pg.name() << " v" << pg.version() << "\n";

    return 1;
  }

  if (! pg.find("query") && ! pg.find("readme"))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "expected either '--query' or '--readme'" << "\n";

    return -1;
  }

  if (pg.find("query") && pg.find("readme"))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "choose either '--query' or '--readme'" << "\n";

    return -1;
  }

  if (pg.find("page") && pg.get<std::size_t>("page") < 1)
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--page' must be greater than zero" << "\n";

    return -1;
  }

  if (pg.find("number") && (pg.get<std::size_t>("number") < 1 || pg.get<std::size_t>("number") > 100))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--number' must be between 1 and 100" << "\n";

    return -1;
  }

  if (pg.find("order") && ! pg.find("sort"))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--order' must be paired with '--sort'" << "\n";

    return -1;
  }

  if (pg.find("sort") && ! String::assert_rx(pg.get("sort"), std::regex("^stars|forks|updated|best$")))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--sort' contains an invalid value, try 'stars', 'forks', or 'updated'" << "\n";

    return -1;
  }

  if (pg.find("order") && ! String::assert_rx(pg.get("order"), std::regex("^asc|desc$")))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--order' contains an invalid value, try 'asc' or 'desc'" << "\n";

    return -1;
  }

  if (pg.find("color") && ! String::assert_rx(pg.get("color"), std::regex("^on|off|auto$")))
  {
    std::cerr << pg.help() << "\n";
    std::cerr << "Error: " << "option '--color' contains an invalid value, try 'on', 'off', or 'auto'" << "\n";

    return -1;
  }

  return 0;
}

int main(int argc, char *argv[])
{
  Parg pg {argc, argv};
  int pstatus {program_options(pg)};
  if (pstatus > 0) return 0;
  if (pstatus < 0) return 1;

  try
  {
    // query
    if (pg.find("query"))
    {
      auto query = pg.get("query");
      auto const filter = pg.get("filter");

      if (! filter.empty())
      {
        auto const filters = String::split(filter, " ");

        for (auto const& kv : filters)
        {
          auto k_v = String::split(kv, ":");

          if (k_v.size() != 2)
          {
            throw std::runtime_error(
              "filter '" + kv + "' is invalid" +
              "\nexpected 'key:value[ key:value]...'" +
              "\nview the help output with '-h'"
            );
          }

          query += " " + k_v.at(0) + ":" + k_v.at(1);
        }
      }

      if (query.empty())
      {
        throw std::runtime_error(
          "query string is empty"
          "\nview the help output with '-h'"
        );
      }

      auto sort = pg.get("sort");

      if (sort == "best")
      {
        sort = "";
      }

      auto const host = pg.get("host");
      auto const order = pg.get("order");
      auto const page = pg.get<std::size_t>("page");
      auto const per_page = pg.get<std::size_t>("number");
      auto const token = pg.get("token");
      auto const color = pg.get("color");

      Stig::search(host, query, sort, order, page, per_page, token, color);
    }

    // readme
    else if (pg.find("readme"))
    {
      auto const path = pg.get("readme");

      struct match
      {
        enum
        {
          path,
          repo,
          ref
        };
      };

      auto const valid_repo = String::match(path,
        std::regex("^([^\\/]+?\\/[^\\/]+)(?:/([^\\/]+?))?$"));

      if (! valid_repo)
      {
        throw std::runtime_error(
          "repo path is invalid"
          "\nview the help output with '-h'"
        );
      }

      auto const host = pg.get("host");
      auto const repo = valid_repo.value().at(match::repo);
      auto const ref = valid_repo.value().at(match::ref);

      Stig::readme(host, repo, ref);
    }
  }
  catch(std::exception const& e)
  {
    std::cerr << "Error: " << e.what() << "\n";
  }
  catch(...)
  {
    std::cerr << "Error: an unexpected error occurred\n";
  }

  return 0;
}
Back to Top