Started to implement ProtoCommentFixer class

Author: LeviBorodenko

README.md

@@ -7,8 +7,9 @@ A tool to turn your clean python code into a hideous mess.
 
 A longer description of your project goes here...
 
+## How to run
 
-## Note
+### Developtment
+
+run `python setup.py develop` to get started on developing
 
-This project has been set up using PyScaffold 3.2.2. For details and usage
-information on PyScaffold see https://pyscaffold.org/.

setup.cfg

@@ -8,9 +8,9 @@ description = A tool to turn your clean python code into a hideous mess.
 author = Levi Borodenko
 author-email = Levi.borodenko@gmail.com
 license = mit
-long-description = file: README.rst
+long-description = file: README.md
 long-description-content-type = text/x-rst; charset=UTF-8
-url = https://github.com/pyscaffold/pyscaffold/
+# url = https://github.com/pyscaffold/pyscaffold/
 project-urls =
     Documentation = https://pyscaffold.org/
 # Change if running only on Windows, Mac or Linux (comma-separated)

setup.py

@@ -3,9 +3,6 @@
     Setup file for lancer.
     Use setup.cfg to configure your project.
 
-    This file was generated with PyScaffold 3.2.2.
-    PyScaffold helps you to put up the scaffold of your new Python project.
-    Learn more under: https://pyscaffold.org/
 """
 import sys
 

src/lancer/data/lyrics.txt

@@ -0,0 +1,87 @@
+DJ Tim Johnson, I want everybody to stop what they're doin' (Mr. 305)
+Now if you know you're with somebody
+You're gonna take the hotel room tonight, Make some noise (woo)
+Meet me at the hotel room, Meet me at the hotel room
+Meet me at the hotel room, Meet me at the hotel room
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room.
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+She like that freaky stuff, Two in the "O" and one in the eye
+That kinky stuff, you nasty, But I like your type
+And like T.I., it's whatever you like, Bring your girls, just whatever the night
+Your man just left, I'm the plumber tonight,
+I'll check yo' pipes, oh you the healthy type, Well, here goes some egg whites.
+Now gimme that sweet, That nasty, that Gucci stuff
+Let me tell you what we gon' do, Two plus two, I'm gon' undress you.
+Then we're gonna go three and three, You gon' undress me.
+Then we're gonna go four and four, We gon' freak some more, but first
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+After party in hotel lobby, Then we off to the room like vroom
+Put them fingers in yo' mouth, or open up yo' blouse, And pull that g-string down south
+Ooh, okay shawty, one's company, Two's a crowd and three's a party
+Your girl ain't with it, I got somebody, In my nature, she's naughty.
+Now gimme that sweet, That nasty, that Gucci stuff
+Let me tell you what we gon' do, Two plus two, I'm gon' undress you.
+Then we're gonna go three and three, You gon' undress me.
+Then we're gonna go four and four, We gon' freak some more, but first
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room
+Forget about your boyfriend And meet me at the hotel room
+You can bring your girlfriends And meet me at the hotel room
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+We at the hotel, motel, Holiday Inn, We at the hotel, motel, Holiday Inn.
+Mujeres!... ey-oh-ey-oh-ey... Yenny... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Yaminel... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Roslyn... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Zuleyma... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Cristina... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Catolina... oye, que bola?
+Mujeres!... ey-oh-ey-oh-ey... Sophia... oye, que bola?
+Mujeres!... ay-oh-ay-oh-ay... Estefany... oye, que bola? Dale
+I don't play football but I've touched down everywhere
+(everywhere) everywhere
+I don't play baseball but I've hit a home run everywhere, everywhere
+I've been to countries and cities I can't pronounce
+And the places on the globe I didn't know existed
+In Romania she pulled me to the centre
+she said Pit you can have me and my sister
+In Lebanon yeah the women are bomb
+And in Greece you've guessed it the women are sweet
+Spinned all around the world but I ain't gon' lie
+there's nothing like Miami's heat
+Welcome to Miami where them boys used to touch tourists on a daily basis
+Duck charges therefore hardly caught cases
+This is a city full of culture and different races
+Where all the mami's come fully equipped at young ages
+With the hurricanes cause even the biggest hurricane couldn't phase us
+We got a dome for the Heat that put y'all to sleep
+and we carry hits from night till morning
+Like Marino strong armin' the game
+but I'm not retiring till I got a championship ring
+poppin champagne simple and plain
+check the map and look where we at
+the bottom, simple as that
+I'm bringing it back to the fore-front
+like Luke in the 2 Live Crew days
+he's the one that's got these mami's going two waysGod bless Uncle Al but knowin him MIA was probably engraved
+on the tombstone that stands over his grave to this day!
+HEY
+So if your visitin our city and your sittin pretty on duce tres
+or duce fours watch where you park your whip
+cause they will leave it sittin' on bricks awfully quick
+GET-GET-GET-GET-GET FREAKY
+Mr. Worldwide
+Hey baby, givin' it your all when you're dancin' on me
+I wanna see if you give me some more
+Hey baby, you can be my girl, I can be your man
+And we can pump this jam however you want
+Hey baby, pump it from the side, bend it upside down
+Or we can pump it from the back to the front

src/lancer/prototype.py

@@ -0,0 +1,56 @@
+from lancer.skeleton import setup_logging
+import logging
+from pathlib import Path
+from tokenize import tokenize, untokenize, COMMENT
+from random import randint
+
+__author__ = "Levi Borodenko"
+__copyright__ = "Levi Borodenko"
+__license__ = "mit"
+
+# setting up logger instance
+_logger = logging.getLogger(__name__)
+
+# setting up logger format and default log level
+setup_logging(logging.DEBUG)
+
+
+class ProtoCommentFixer(object):
+    """docstring for ProtoCommentFixer"""
+
+    def __init__(self, file: Path = Path("./")):
+        super(ProtoCommentFixer, self).__init__()
+
+        # File to be fixed
+        self.FILE_PATH = Path(file)
+
+        # Path to lyric file
+        self.LYRIC_FILE = Path("./data/lyrics.txt")
+
+        # Number of lyrics
+        self.NUM_LYRICS = sum(1 for line in open(self.LYRIC_FILE))
+
+        # check if file is a python file
+        if self.FILE_PATH.suffix != ".py":
+            raise ValueError("File needs to be .py")
+
+    def get_lyric(self) -> str:
+        """Returns a random song lyric.
+
+        [description]
+        """
+
+        # Open lyrics file and grab a random line
+        with open(self.LYRIC_FILE) as f:
+
+            random_index = randint(0, self.NUM_LYRICS)
+
+            lyrics = f.readlines()
+
+            # .rstrip to remove trailing whitespace
+            return lyrics[random_index].rstrip()
+
+
+if __name__ == '__main__':
+    a = ProtoCommentFixer("test.py")
+    print(a.get_lyric())

src/lancer/skeleton.py

@@ -39,8 +39,8 @@ def fib(n):
     """
     assert n > 0
     a, b = 1, 1
-    for i in range(n-1):
-        a, b = b, a+b
+    for i in range(n - 1):
+        a, b = b, a + b
     return a
 
 

tests/test_prototype.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+import pytest
+from lancer.prototype import ProtoCommentFixer as CommentFixer
+from pathlib import Path
+
+__author__ = "Levi Borodenko"
+__copyright__ = "Levi Borodenko"
+__license__ = "mit"
+
+
+class TestCommentFixer(object):
+    """docstring for TestCommentFixer"""
+
+    # test file
+    COMMENTS_FILE = "./test_scripts/comments.py"
+
+    # test instance
+    fixer = CommentFixer(COMMENTS_FILE)
+
+    def test_init(self):
+        """Testing basic attributes.
+        """
+        assert isinstance(self.fixer.FILE_PATH, Path)
+        assert self.fixer.FILE_PATH.name == "comments.py"
+
+        with pytest.raises(ValueError):
+            CommentFixer("Not_a_python_file.txt")
+
+        with pytest.raises(FileNotFoundError):
+            CommentFixer("./nosuchfile.py")
+
+    def test_get_lyric(self):
+        """Test random lyric generation.
+        """
+
+        lyric = self.fixer.get_lyric()
+
+        assert isinstance(lyric, str)
+        assert len(lyric) > 2
+
+        another_lyric = self.fixer.get_lyric()
+
+        assert lyric != another_lyric
+
+        assert self.fixer.NUM_LYRICS > 100

tests/test_scripts/comments.py

@@ -0,0 +1,23 @@
+from pathlib import Path
+
+
+def some_function(some_arg: Path= "lol"):
+    """[summary]
+
+    [description]
+
+    Keyword Arguments:
+        some_arg {int} -- [description] (default: {"lol"})
+    """
+    a = "b"
+
+    # comment 1
+    return a
+
+# comment 2
+
+
+if __name__ == '__main__':
+
+    # comment 3
+    some_function()