Merge pull request #438 from robotichead/development-0.30.0

Development 0.30.0

.gitignore

@@ -119,3 +119,6 @@ node_modules/
 /tests/browserstatck/config.py
 
 .vscode/
+
+# Ignore any documents uploaded to the private folders
+/local/private/

.prettierignore

@@ -0,0 +1,19 @@
+# Ignore artifacts:
+build
+coverage
+NearBeach
+NearBeach/**
+.circleci
+.github
+.pytest_cache
+.vscode
+browserstack
+docs
+local
+locust_tests
+node_modules
+webpack.common.js
+webpack.dev.js
+webpack.prod.js
+webpack.watch.js
+cypress.json

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+	"tabWidth": 4,
+	"useTabs": true,
+	"semi": true,
+	"vueIndentScriptAndStyle": true,
+	"singleAttributePerLine": true
+}

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+-   The use of sexualized language or imagery and unwelcome sexual attention or advances
+-   Trolling, insulting/derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or electronic address, without explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
@@ -38,7 +38,6 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
-
 ## Separation of art from artist clause
 
 Any code, wiki, or other form of submitted work will not be judged based on but not limited to age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. The content submitted will be judged by the validity of said content and not the person or persons whom created the content.

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to NearBeach 
+# Contributing to NearBeach
 
 <!---
 ##  Hacktoberfest 2021
@@ -16,31 +16,29 @@ Welcome to NearBeach, we are super glad you are here. In the following month of
 
 This seems a lot to cover within such a short time frame, but we are hoping you are willing to help us. We greatly appreciate all the help we can get no matter how small the contribution.
 --->
-If you would like to join our community, please join our [fun and exciting discord](https://discord.gg/64uhRztS6n).
 
+If you would like to join our community, please join our [fun and exciting discord](https://discord.gg/64uhRztS6n).
 
 ## Contributing to NearBeach
 
 We are always looking for new contributors. There are many different ways to contribute to NearBeach, for example;
 
-- Donating via [github sponsorships](https://github.com/sponsors/robotichead) or [our patreon](https://www.patreon.com/NearBeach)
-- Bug testing
-- Bug fixing
-- Writing Documentation
-- Writing new components or functionality for NearBeach
-- Refactoring Code, i.e. making it more efficient
-- Updating Code, i.e. updating libraries
-- Marketing NearBeach
-- Supplying feedback on NearBeach, i.e. improvements and feature requests
+-   Donating via [github sponsorships](https://github.com/sponsors/robotichead) or [our patreon](https://www.patreon.com/NearBeach)
+-   Bug testing
+-   Bug fixing
+-   Writing Documentation
+-   Writing new components or functionality for NearBeach
+-   Refactoring Code, i.e. making it more efficient
+-   Updating Code, i.e. updating libraries
+-   Marketing NearBeach
+-   Supplying feedback on NearBeach, i.e. improvements and feature requests
 
 and many many more. Join our [community on discord to see what you can do](https://discord.gg/64uhRztS6n)
 
-
 ## Code of Conduct
 
 Please read our [code of conduct here](https://github.com/robotichead/NearBeach/blob/main/CODE_OF_CONDUCT.md).
 
-
 ## NearBeach Overview
 
 NearBeach is an open source project management system, that has been built using both the frameworks; Django and VueJS.
@@ -49,59 +47,52 @@ NearBeach is an open source project management system, that has been built using
 
 Each different module/componet in NearBeach are called Objects. The following objects currently exist;
 
-- Organisations
-- Customers
-- Requirements
-- Requirement Items
-- Projects
-- Tasks
-- Request for Changes
-- Kanban Boards
+-   Organisations
+-   Customers
+-   Requirements
+-   Requirement Items
+-   Projects
+-   Tasks
+-   Request for Changes
+-   Kanban Boards
 
 Each object shall have it's own folder structure within the respected location, i.e. `/views/projects`.
 
-
 ## Setting up local dev environment
 
 Please follow the instructions in our documentation: [Setting up local dev environment](https://nearbeach.readthedocs.io/en/documentation/setup-dev-environment/easy_development_environment.html)
 
-
 ## Donating
 
 Like most projects, there are some overhead costs. Every single dollar that we get will go towards;
 
-- Cloud hosting costs
-- Software costs
-- Administration costs
-- Freelance costs (i.e. hiring help like designers)
+-   Cloud hosting costs
+-   Software costs
+-   Administration costs
+-   Freelance costs (i.e. hiring help like designers)
 
 We are being transparent with all our costs and will try and provide a yearly cost breakdown every 6 months.
 
-
 ## Bug Reporting
 
 Bug reporting is a very important role for NearBeach. During Hacktoberfest, you are more than welcome to submit issues.
 
-
 ## Deepsource Issues
 
 NearBeach currently has a number of easy tasks/issues located on our [Deepsource - https://deepsource.io/gh/robotichead/NearBeach/issues](https://deepsource.io/gh/robotichead/NearBeach/issues).
 
-
 ## CodeClimate Issues
 
 NearBeach currently has a number of easy tasks/issues located on our [CodeClimte - https://codeclimate.com/github/robotichead/NearBeach/issues](https://codeclimate.com/github/robotichead/NearBeach/issues)
 
-
 ## Pull Requests
 
-Please fork NearBeach, git your changes in and then submit a simple pull request. 
+Please fork NearBeach, git your changes in and then submit a simple pull request.
 
 When submitting a pull request, please fill out the template appropriately. We have flagged NearBeach's repository with Hacktoberfest, so any accepted pull requests WILL count towards Hacktoberfest.
 
 Not all pull requests will be accepted.
 
-
 ## Documentation
 
 Our documentation is hosted on [readthedocs](https://nearbeach.readthedocs.io). If you would like to contribute to the documentation, you will be able to find the files within `/docs`

NearBeach/__init__.py

@@ -1,2 +1,2 @@
 name = "NearBeach"
-__version__ = "0.29.8"
+__version__ = "0.30.0"

NearBeach/admin.py

@@ -2,121 +2,73 @@
 
 # Register your models here.
 from .models import (
-    AboutUser,
     Bug,
     BugClient,
-    Campus,
     ChangeTask,
     ChangeTaskBlock,
-    ContactHistory,
-    Cost,
     Customer,
-    CustomerCampus,
     Document,
     DocumentPermission,
-    EmailContent,
-    EmailContact,
     Folder,
     GroupPermission,
     Group,
     KanbanBoard,
     KanbanCard,
     KanbanColumn,
     KanbanLevel,
-    Kudos,
-    ListOfAmountType,
     ListOfBugClient,
-    ListOfCurrency,
-    ListOfContactType,
-    ListOfCountryRegion,
-    ListOfCountry,
     ListOfRequirementItemStatus,
     ListOfRequirementItemType,
     ListOfRequirementStatus,
     ListOfRequirementType,
     ListOfRFCStatus,
-    ListOfTax,
     ListOfTitle,
-    NearbeachOption,
     Notification,
     ObjectAssignment,
-    ObjectNote,
     Organisation,
     PermissionSet,
     Project,
     RequestForChange,
     RequestForChangeGroupApproval,
-    RequestForChangeStakeholder,
     Requirement,
-    RequirementCustomer,
     RequirementItem,
     Tag,
     TagAssignment,
-    TaskAction,
-    TaskCustomer,
     Task,
-    Timesheet,
-    ToDo,
     UserGroup,
-    UserWant,
-    UserWeblink,
 )
 
-admin.site.register(AboutUser)
 admin.site.register(Bug)
 admin.site.register(BugClient)
-admin.site.register(Campus)
 admin.site.register(ChangeTask)
 admin.site.register(ChangeTaskBlock)
-admin.site.register(ContactHistory)
-admin.site.register(Cost)
 admin.site.register(Customer)
-admin.site.register(CustomerCampus)
 admin.site.register(Document)
 admin.site.register(DocumentPermission)
-admin.site.register(EmailContent)
-admin.site.register(EmailContact)
 admin.site.register(Folder)
 admin.site.register(GroupPermission)
 admin.site.register(Group)
 admin.site.register(KanbanBoard)
 admin.site.register(KanbanCard)
 admin.site.register(KanbanColumn)
 admin.site.register(KanbanLevel)
-admin.site.register(Kudos)
-admin.site.register(ListOfAmountType)
 admin.site.register(ListOfBugClient)
-admin.site.register(ListOfCurrency)
-admin.site.register(ListOfContactType)
-admin.site.register(ListOfCountryRegion)
-admin.site.register(ListOfCountry)
 admin.site.register(ListOfRequirementItemStatus)
 admin.site.register(ListOfRequirementItemType)
 admin.site.register(ListOfRequirementStatus)
 admin.site.register(ListOfRequirementType)
 admin.site.register(ListOfRFCStatus)
-admin.site.register(ListOfTax)
 admin.site.register(ListOfTitle)
-admin.site.register(NearbeachOption)
 admin.site.register(Notification)
 admin.site.register(ObjectAssignment)
-admin.site.register(ObjectNote)
 admin.site.register(Organisation)
 admin.site.register(PermissionSet)
 admin.site.register(Project)
 admin.site.register(RequestForChange)
 admin.site.register(RequestForChangeGroupApproval)
-admin.site.register(RequestForChangeStakeholder)
 admin.site.register(Requirement)
-admin.site.register(RequirementCustomer)
 admin.site.register(RequirementItem)
 admin.site.register(Tag)
 admin.site.register(TagAssignment)
-admin.site.register(TaskAction)
-admin.site.register(TaskCustomer)
 admin.site.register(Task)
-admin.site.register(Timesheet)
-admin.site.register(ToDo)
 admin.site.register(UserGroup)
-admin.site.register(UserWant)
-admin.site.register(UserWeblink)

NearBeach/context_processors.py

@@ -3,10 +3,16 @@
 
 
 def django_version(request):
+    """
+    Get's the django verion and returns it - used in template rendering.
+    """
     return {
         "django_version": django.get_version(),
     }
 
 
 def nearbeach_version(request):
+    """
+    Get's the NearBeach version and returns it - used in template rendering.
+    """
     return {"nearbeach_version": NearBeach.__version__}

NearBeach/decorators/check_destination.py

@@ -17,6 +17,10 @@
 
 
 def check_destination():
+    """
+    Does a quick check to make sure the destination variable is inside the OBJECT_ARRAY
+    If not - it will return a Permission Denied. i.e. object does not exist do nothing.
+    """
     def decorator(func):
         @wraps(func)
         def inner(request, destination, *args, **kwargs):