Merge pull request #13 from InnoFang/dev

✨ 💥 New feature to support counting remote repositories

Author: InnoFang

.github/workflows/code-counter-CI.yml

@@ -8,13 +8,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, 3.10.0]
+        python-version: [3.7, 3.8, 3.9, 3.10.0]
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Test with pytest
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Run unittest
       run: python -m unittest discover -s tests -p "test_*.py"

code_counter/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.1.0"

code_counter/__main__.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# coding:utf8
+# -*- coding: utf-8  -*-
 
 import time
 from code_counter.core.counter import CodeCounter
@@ -8,25 +8,35 @@
 
 
 def main():
-    args = CodeCounterArgs()
+    cocnt_args = CodeCounterArgs()
 
     config = Config()
-    if args.has_config_args():
-        config.invoke(args.config())
+    if cocnt_args.has_config_args():
+        config.invoke(cocnt_args.config())
         return
 
     code_counter = CodeCounter()
 
-    search_args = args.search()
-    code_counter.setSearchArgs(search_args)
+    if cocnt_args.has_search_args():
+        args = cocnt_args.search()
+    elif cocnt_args.has_remote_args():
+        args = cocnt_args.remote()
+        if cocnt_args.is_gitee_repo() and not config.access_tokens.gitee:
+            config.request_gitee_access_token()
+        elif cocnt_args.is_github_repo() and not config.access_tokens.github:
+            config.request_github_access_token()
+    else:
+        raise Exception('wrong command')
+
+    code_counter.setArgs(args)
 
     time_start = time.time()
     code_counter.search()
     time_end = time.time()
 
     print('\n\tTotally cost {} s.'.format(time_end - time_start))
 
-    if search_args.graph:
+    if args.graph:
         code_counter.visualize()
 
 

code_counter/conf/config.json

@@ -1,55 +1,59 @@
 {
     "suffix": [
+        "go",
+        "lua",
         "java",
         "swift",
+        "cu",
+        "h",
+        "pde",
         "dart",
+        "cs",
         "rb",
-        "cc",
-        "go",
+        "cuh",
         "php",
-        "sh",
-        "lua",
-        "m",
-        "cu",
-        "c",
-        "vb",
+        "lisp",
+        "cpp",
+        "rust",
+        "R",
         "clj",
+        "jl",
+        "py",
         "js",
-        "cuh",
+        "vb",
         "hpp",
-        "R",
-        "cs",
-        "kt",
-        "ts",
+        "sh",
+        "cc",
+        "m",
         "scala",
-        "rust",
-        "py",
-        "cpp",
+        "kt",
         "rs",
-        "h",
-        "jl",
-        "pde",
-        "lisp"
+        "c",
+        "ts"
     ],
     "comment": [
-        "//",
-        ":",
-        "*",
-        "*/",
+        "/*",
         ";",
-        "#",
         "\"\"\"\"",
-        "/*"
+        "*/",
+        ":",
+        "//",
+        "#",
+        "*"
     ],
     "ignore": [
-        "venv",
+        ".idea",
         "dist",
         "target",
-        "build",
-        ".idea",
-        "node_modules",
-        ".vscode",
         ".git",
-        "out"
-    ]
+        "venv",
+        ".vscode",
+        "node_modules",
+        "out",
+        "build"
+    ],
+    "access_tokens": {
+        "github": "",
+        "gitee": ""
+    }
 }

code_counter/conf/config.py

@@ -5,10 +5,12 @@
 import pkg_resources
 
 
-class SetEncoder(json.JSONEncoder):
+class ConfigEncoder(json.JSONEncoder):
     def default(self, obj):
         if isinstance(obj, set):
             return list(obj)
+        elif isinstance(obj, Config.AccessTokens):
+            return obj.__dict__
         return json.JSONEncoder.default(self, obj)
 
 
@@ -22,13 +24,21 @@ def __call__(cls, *args, **kwargs):
 
 
 class Config(metaclass=SingletonMeta):
+    class AccessTokens:
+        def __init__(self, github='', gitee=''):
+            self.github = github
+            self.gitee = gitee
+
     def __init__(self):
         conf = self.__load()
 
         self.suffix = set(conf['suffix'])
         self.comment = set(conf['comment'])
         self.ignore = set(conf['ignore'])
 
+        self.access_tokens = self.AccessTokens(github=conf['access_tokens']['github'],
+                                               gitee=conf['access_tokens']['gitee'])
+
     def invoke(self, args):
         if args.restore:
             self.restore()
@@ -43,7 +53,7 @@ def invoke(self, args):
             self.show()
 
     def show(self):
-        print(json.dumps(self.__dict__, indent=4, cls=SetEncoder))
+        print(json.dumps(self.__dict__, indent=4, cls=ConfigEncoder))
 
     def __confirm(self, tips):
         check = input(tips)
@@ -97,7 +107,43 @@ def __load(self):
     def __update(self):
         filename = pkg_resources.resource_filename(__name__, 'config.json')
         with open(filename, 'w') as config:
-            json.dump(self.__dict__, config, indent=4, cls=SetEncoder)
+            json.dump(self.__dict__, config, indent=4, cls=ConfigEncoder)
+
+    def request_github_access_token(self):
+        if not self.access_tokens.github:
+            print("\nThe Github access token is empty. In this case, your usage times will be limited by Github. "
+                  "You can change this situation by setting access token. ")
+        print("\nRequest a Github access token from https://github.com/settings/tokens/new .")
+        print("`code-counter` require access to the public repositories .")
+        print("Choose the `public_repo` in `Select scopes`, and click the `Generate token` to generate a token, "
+              "then copy the access token and paste it here.")
+
+        access_token = input('\nthe Github access token: ')
+        access_token = access_token.strip()
+        if access_token:
+            self.access_tokens.github = access_token
+            self.__update()
+        else:
+            print('\nNo access token set!')
+        print('======================\n')
+
+    def request_gitee_access_token(self):
+        if not self.access_tokens.gitee:
+            print("\nThe Gitee access token is empty. In this case, your usage times will be limited by Gitee. "
+                  "You can change this situation by setting access token. ")
+        print("\nRequest a Gitee access token from https://gitee.com/profile/personal_access_tokens/new .")
+        print("`code-counter` require access to the public repositories.")
+        print("Only need to choose the `projects`, and click the `submit` to generate a token, "
+              "then copy the access token and paste it here.")
+
+        access_token = input('\nthe Gitee access token: ')
+        access_token = access_token.strip()
+        if access_token:
+            self.access_tokens.gitee = access_token
+            self.__update()
+        else:
+            print('\nNo access token set!')
+        print('======================\n')
 
     def restore(self):
         self.suffix = {"c", "cc", "clj", "cpp", "cs", "cu", "cuh", "dart", "go", "h", "hpp", "java", "jl", "js", "kt",

code_counter/core/args.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
-# coding:utf8
+# -*- coding: utf-8  -*-
 
+import re
 import sys
 import argparse
 from code_counter import __version__
@@ -10,9 +11,32 @@ def split_args(args):
     return list(args.split(','))
 
 
+def remote_repo_parse(repo):
+    # check HTTPS link first
+    res = re.search(r"^https://(github|gitee).com/([^/]+)/([^\.]+)\.git$", repo, re.I)
+    # if got none, then check SSH link
+    if not res:
+        res = re.search(r"^git@(github|gitee).com:([^/]+)/([^\.]+)\.git$", repo, re.I)
+    if not res:
+        print('Remote repository link parse error! please enter a right HTTPS or SSH link:')
+        print('\tcocnt remote', repo)
+        exit(1)
+    if res.group(1).lower() == 'github':
+        # Github API
+        return 'https://api.github.com/repos/{}/{}/contents/'.format(res.group(2), res.group(3))
+    elif res.group(1).lower() == 'gitee':
+        # Gitee API
+        return 'https://gitee.com/api/v5/repos/{}/{}/contents/'.format(res.group(2), res.group(3))
+    else:
+        print('Remote repository link parse error! please enter a right HTTPS or SSH link:')
+        print('\tcocnt remote', repo)
+        exit(1)
+
+
 class CodeCounterArgs:
     __SEARCH__ = 'search'
     __CONFIG__ = 'config'
+    __REMOTE__ = 'remote'
 
     def __init__(self):
         parser = argparse.ArgumentParser(
@@ -21,7 +45,8 @@ def __init__(self):
                         "that can help you easily count code and display detailed results.",
             usage="""cocnt <command> [<args>]
 These are common Code-Counter commands used in various situations:
-    search     Search code in the given path(s)
+    search     Search and count code lines for the given path(s)
+    remote     Search and count the remote repository
     config     Configure Code-Counter
 """)
         parser.add_argument('--version', action='version',
@@ -38,16 +63,36 @@ def __init__(self):
     def has_search_args(self):
         return self.__SEARCH__ in self.__args
 
+    def has_remote_args(self):
+        return self.__REMOTE__ in self.__args
+
     def has_config_args(self):
         return self.__CONFIG__ in self.__args
 
+    def is_github_repo(self):
+        if not self.has_remote_args():
+            return False
+        return self.__args[self.__REMOTE__].input_path.startswith('https://api.github.com/repos/')
+
+    def is_gitee_repo(self):
+        if not self.has_remote_args():
+            return False
+        return self.__args[self.__REMOTE__].input_path.startswith('https://gitee.com/api/v5/repos/')
+
     def search(self):
         if not self.has_search_args():
             return None
         if self.__args[self.__SEARCH__] == argparse.Namespace():
             self.__args[self.__SEARCH__] = self.__search()
         return self.__args[self.__SEARCH__]
 
+    def remote(self):
+        if not self.has_remote_args():
+            return None
+        if self.__args[self.__REMOTE__] == argparse.Namespace():
+            self.__args[self.__REMOTE__] = self.__remote()
+        return self.__args[self.__REMOTE__]
+
     def config(self):
         if not self.has_config_args():
             return None
@@ -57,10 +102,10 @@ def config(self):
 
     def __search(self):
         parser = argparse.ArgumentParser(
-            description="Search code in the given path(s)",
+            description="Search and count code lines for the given path(s)",
             usage="cocnt search input_path [-h] [-v] [-g] "
                   "[-o OUTPUT_PATH] [--suffix SUFFIX] [--comment COMMENT] [--ignore IGNORE]")
-        parser.add_argument('input_path', type=split_args,
+        parser.add_argument('input_path', metavar="paths", type=split_args,
                             help="counting the code lines according to the given path(s)")
         parser.add_argument('-v', '--verbose', dest="verbose", action='store_true',
                             help="show verbose information")
@@ -76,6 +121,27 @@ def __search(self):
                             help="ignore some directories or files that you don't want to count")
         return parser.parse_args(sys.argv[2:])
 
+    def __remote(self):
+        parser = argparse.ArgumentParser(
+            description="Search and count the remote repository with a given Github or Gitee HTTP link",
+            usage="cocnt remote <repository> [-h] [-v] [-g] "
+                  "[-o OUTPUT_PATH] [--suffix SUFFIX] [--comment COMMENT] [--ignore IGNORE]")
+        parser.add_argument('input_path', metavar="repository", type=remote_repo_parse,
+                            help="search and count a remote repository")
+        parser.add_argument('-v', '--verbose', dest="verbose", action='store_true',
+                            help="show verbose information")
+        parser.add_argument('-g', '--graph', dest='graph', action='store_true',
+                            help="choose to whether to visualize the result")
+        parser.add_argument('-o', '--output', dest='output_path',
+                            help="specify an output path if you want to store the result")
+        parser.add_argument('--suffix', dest='suffix', type=split_args,
+                            help="what code files do you want to count")
+        parser.add_argument('--comment', dest='comment', type=split_args,
+                            help="the comment symbol, which can be judged whether the current line is a comment")
+        parser.add_argument('--ignore', dest='ignore', type=split_args,
+                            help="ignore some directories or files that you don't want to count")
+        return parser.parse_args(sys.argv[2:])
+
     def __config(self):
         parser = argparse.ArgumentParser(
             prog="code-counter",