"""Contains a Directory class to represent real directories"""

import os
import pathlib
import shutil
import pwd

from ..base import _BaseFileAndDirectoryInterface
from ..exceptions import InvalidDirectoryValueError
from .. import utils, config


class Directory(_BaseFileAndDirectoryInterface):
    """A class that groups together the (meta)data and behavior of 
    directories"""
    def __init__(self, path):
        """
        Construct the object

        Parameters:
        path -- (str) where the directory is (or will be) located at. An 
                exception is raised if the path refers to a file, and also if an
                empty string is given.

        """
        if not path:
            # No point in continuing since the methods of this class assume
            # that a path will be given upon instantiation.
            raise InvalidDirectoryValueError("No directory path was given")
        
        # Raise an exception if the path refers to a file
        path_exists = os.path.exists(path)
        path_is_a_file = os.path.isfile(path)
        if path_exists and path_is_a_file:
            raise NotADirectoryError("The path refers to a file") 
        
        self._path = utils.normalize_path(os.path.abspath(path))         
        return
    
    # Special Methods
    def __repr__(self):
        """Get the official string representation"""
        repr_ = (
            "{class_name}(\"{path}\")"
            .format(class_name=Directory.__name__, path=self.path)
        )
        return repr_

    def __str__(self):
        """Get the informal string representation"""
        return self.path
    
    # Properties
    @property
    def name(self):
        """
        Get the name of the directory
        
        Return Value:
        (str)

        """        
        return pathlib.Path(self.path).name
    
    @property
    def path(self):
        """
        Get the absolute path (or location) of the directory
        
        Return Value:
        (str)
        
        """
        return self._path  
    
    @path.setter
    def path(self, new_path):
        """
        Set the path of the directory
        
        Parameters:
        new_path -- (str) the new path to assign. This can be an absolute or a
                    relative path.
        
        """
        # Raise an exception if the path refers to a file
        path_exists = os.path.exists(new_path)
        path_is_a_file = os.path.isfile(new_path)
        if path_exists and path_is_a_file:
            raise NotADirectoryError("The path refers to a file")
        
        self._path = utils.normalize_path(os.path.abspath(new_path))         
        return    
    
    @property
    def exists(self):
        pass
    
    @property
    def created_on(self):
        pass    
    
    @property
    def size(self):
        pass    
    
    @property
    def parent(self):
        """
        Get the parent directory of the directory

        Return Value:
        (str)

        """
        return str(pathlib.Path(self.path).parent)   
    
    @property
    def owner(self):
        """
        Get the details of the user that owns the directory

        Supported Operating Systems:
        Unix-like

        Return Value:
        user -- (dict) contains the details of the user that owns the directory.
                Specifically, it contains the user's username, user_id, 
                group_id, and home directory. The keys are username, user_id,
                group_id, and directory.

        """
        if config._OPERATING_SYSTEM == "windows":
            raise NotImplementedError(
                "Directory.owner is not supported on Windows"
            ) 
    
        # Get the owner's details from the user account and password database
        pwd_user = pwd.getpwnam(pathlib.Path(self.path).owner())
    
        user = {}
        user["username"] = pwd_user.pw_name
        user["user_id"] = pwd_user.pw_uid
        user["group_id"] = pwd_user.pw_gid
        user["directory"] = pwd_user.pw_dir
    
        return user
    
    @property
    def group(self):
        pass   
    
    @property
    def is_dir(self):
        """
        Whether the object's path refers to a directory or not
        
        Normally, this method shouldn't need to be used since checks are made
        on a given path when a Directory object is created and also if its value
        changes later. However, this method becomes useful in any situation when
        one isn't sure a path will always refer to a directory. For example, 
        when a file replaces a directory (with the same path) on the file 
        system, all after a Directory object is created.
        
        """
        return os.path.isdir(self.path)    
    
    # Regular Methods
    def get_parent(self, levels=1):
        """
        Get the parent directory of the directory
    
        Parameters:
        levels -- (int) how many levels to look upwards for a parent directory.
                  For example, 1 represents the immediate directory that
                  contains the directory referred to by the instance object. 
                  For clarity, 0 is treated the same as 1 in this method.
    
        Return Value:
        (str)
    
        """
        if levels < 0:
            raise InvalidDirectoryValueError("levels should be 0 or more")
    
        elif levels == 0:
            # 0 and 1 should be treated the same for clarity
            levels = 1
    
        p = pathlib.Path(self.path)        
        for i in range(levels):
            parent = str(p.parent)
            p = pathlib.Path(parent)
    
        return parent         
    
    def create(self):
        pass         
    
    def get_permissions(self):
        pass  
    
    def change_permissions(self):
        pass      
    
    def chmod(self):
        pass 
    
    def change_owner(self):
        pass       
    
    def change_group(self):
        pass             
    
    def copy(self):
        pass
    
    def move(self):
        pass
    
    def rename(self):
        pass 
    
    def remove(self, empty_only=True):
        """
        Remove the directory
        
        Parameters:
        empty_only -- (bool) If True, then the directory is only removed if it
                      is empty. If False, then the directory and any files 
                      and sub-directories are deleted. 
        
        """
        if empty_only:
            os.rmdir(self.path)
        else:
            # Delete the directory and anything in it
            shutil.rmtree(self.path)
        
        return
@@ -106,16 +106,27 @@
 port pwd
+%0Aimport grp
 %0A%0Afrom .
@@ -4142,20 +4142,876 @@
         
-pass
+%22%22%22%0A        Get the details of the group that owns the directory%0A%0A        Supported Operating Systems:%0A        Unix-like%0A%0A        Return Value:%0A        group -- (dict) contains the details for the group that owns the %0A                 directory. Specifically, it contains the group's id, name, and%0A                 its members. Its keys are id, name, and members.%0A%0A        %22%22%22%0A        if config._OPERATING_SYSTEM == %22windows%22:%0A            raise NotImplementedError(%0A                %22Directory.group is not supported on Windows%22%0A            )       %0A    %0A        # Get the group's details from the group database%0A        grp_group = grp.getgrnam(pathlib.Path(self.path).group())%0A    %0A        group = %7B%7D%0A        group%5B%22name%22%5D = grp_group.gr_name%0A        group%5B%22id%22%5D = grp_group.gr_gid%0A        group%5B%22members%22%5D = grp_group.gr_mem%0A    %0A        return group        
    %0A    

Add logic for Directory.group -- which displays the details of a directory's group