Add copy file command.

Author: skuroda

AdvancedNewFile.sublime-settings

@@ -143,5 +143,11 @@
     // cannot be resolved from the current active view. If an index outside of the range
     // of existing folders is used, it will default to 0 (the top level folder). If no
     // folders exist as part of the project the home directory will be used.
-    "relative_fallback_index": 0
+    "relative_fallback_index": 0,
+
+    // Setting to control if the extension will be automatically applied to renamed files.
+    "append_extension_on_copy": true,
+
+    // Same as `rename_default`, but applied to copy command.
+    "copy_default": ""
 }

Default.sublime-commands

@@ -2,5 +2,6 @@
   { "caption": "ANF: New File", "command": "advanced_new_file_new" },
   { "caption": "ANF: Rename File", "command": "advanced_new_file_move"},
   { "caption": "ANF: Delete File", "command": "advanced_new_file_delete"},
-  { "caption": "ANF: Delete Current File", "command": "advanced_new_file_delete", "args": {"current": true}}
+  { "caption": "ANF: Delete Current File", "command": "advanced_new_file_delete", "args": {"current": true}},
+  { "caption": "ANF: Copy Current File", "command": "advanced_new_file_copy" }
 ]

README.md

@@ -160,7 +160,7 @@ Setting to control if VCS management is used when moving and removing files.
 
 An object containing information to use for templates when creating new files. The key values for this object should be a file extension. Files without extensions such as "Makefile" or ".bash_profile" use the full file name as the key. The value may either be a string of the content to be inserted or a list of paths. If a list of paths is specified, the name of the file will be displayed during selection. The paths must either be absolute, from the home directory of the user (`~/`), or relative to the Packages directory. These relative files should have the form "Packages/User/mytest.sublime-snippet". If a string is used, or the list contains a single entry, it will be automatically inserted into any newly created files.
 
-`posix_input`:
+`shell_input`:
 
 Setting this value to true will allow you to escape characters as you normally would when using a shell. For example, given the input string "foo\ bar", false would result in a file named " bar" in the foo directory. With the value set to true, a file named "foo bar" would be created. In addition, setting this value to true will allow for curly brace expansion. Currently, only comma separated entries are supported.
 
@@ -172,6 +172,15 @@ Setting to control if the extension will be automatically applied to renamed fil
 
 An integer value representing a folder index to be used when a relative path cannot be resolved from the current active view. If an index outside of the range  of existing folders is used, it will default to 0 (the top level folder). If no  folders exist as part of the project the home directory will be used.
 
+`append_extension_on_copy`:
+
+Setting to control if the extension will be automatically applied to copied files.
+
+`copy_default`:
+
+Same as `rename_default`, applied to copy command.
+
+
 ### Project Specific Settings
 All of the above settings can also be specified as part of the project specific settings. These values override any previous values set by higher level settings, with aliases being an exception. Alias settings will be merged with higher level configurations for alias. In addition, if the same alias exist for both default/user settings and project settings, the project setting will take precedence.
 

advanced_new_file/anf_util.py

@@ -30,6 +30,8 @@
 SHELL_INPUT_SETTING = "shell_input"
 APPEND_EXTENSION_ON_MOVE_SETTING = "append_extension_on_move"
 RELATIVE_FALLBACK_INDEX_SETTING = "relative_fallback_index"
+APPEND_EXTENSION_ON_COPY_SETTING = "append_extension_on_copy"
+COPY_DEFAULT_SETTING = "copy_default"
 
 SETTINGS = [
     ALIAS_SETTING,
@@ -59,7 +61,9 @@
     FILE_TEMPLATES_SETTING,
     SHELL_INPUT_SETTING,
     APPEND_EXTENSION_ON_MOVE_SETTING,
-    RELATIVE_FALLBACK_INDEX_SETTING
+    RELATIVE_FALLBACK_INDEX_SETTING,
+    APPEND_EXTENSION_ON_COPY_SETTING,
+    COPY_DEFAULT_SETTING
 ]
 
 NIX_ROOT_REGEX = r"^/"

advanced_new_file/commands/__init__.py

@@ -2,6 +2,7 @@
 from .new_file_command import AdvancedNewFileNew, AdvancedNewFileNewAtCommand, AdvancedNewFileNewEventListener
 from .delete_file_command import AdvancedNewFileDelete
 from .move_file_command import AdvancedNewFileMove, AdvancedNewFileMoveAtCommand
+from .copy_file_command import AdvancedNewFileCopy, AdvancedNewFileCopyAtCommand
 
 __all__ = [
     "AnfReplaceCommand",
@@ -11,5 +12,7 @@
     "AdvancedNewFileNewEventListener",
     "AdvancedNewFileMove",
     "AdvancedNewFileMoveAtCommand",
-    "AdvancedNewFileDelete"
+    "AdvancedNewFileDelete",
+    "AdvancedNewFileCopy",
+    "AdvancedNewFileCopyAtCommand"
 ]

advanced_new_file/commands/command_base.py

@@ -231,8 +231,9 @@ def input_panel_caption(self):
         return ""
 
     def show_filename_input(self, initial):
+        caption = self.input_panel_caption()
         self.input_panel_view = self.window.show_input_panel(
-            self.input_panel_caption(), initial,
+            caption, initial,
             self.on_done, self.__update_filename_input, self.clear
         )
 

advanced_new_file/commands/copy_file_command.py

@@ -0,0 +1,97 @@
+import os
+import re
+import shutil
+import sublime_plugin
+
+from .duplicate_file_base import DuplicateFileBase
+from ..anf_util import *
+
+class AdvancedNewFileCopy(DuplicateFileBase):
+    def __init__(self, window):
+        super(AdvancedNewFileCopy, self).__init__(window)
+
+    def get_default_setting(self):
+        return COPY_DEFAULT_SETTING
+
+    def input_panel_caption(self):
+        caption = 'Enter a new path to copy file'
+        if self.is_python:
+            caption = '%s (creates __init__.py in new dirs)' % caption
+        return caption
+
+    def entered_file_action(self, path):
+        attempt_copy = True
+        path = self.try_append_extension(path)
+
+        directory = os.path.dirname(path)
+        if not os.path.exists(directory):
+            try:
+                self.create_folder(directory)
+            except OSError as e:
+                attempt_copy = False
+                sublime.error_message("Cannot create '" + path + "'." +
+                                      " See console for details")
+                print("Exception: %s '%s'" % (e.strerror, e.filename))
+
+        if attempt_copy:
+            if self._copy_file(path):
+                self.open_file(path)
+
+    def _copy_file(self, path):
+        if os.path.isdir(path) or re.search(r"(/|\\)$", path):
+            # use original name if a directory path has been passed in.
+            path = os.path.join(path, self.original_name)
+
+        window = self.window
+        copied = True
+        if self.get_argument_name():
+            self.copy_from_argument(path)
+        elif self.view is not None:
+            self.copy_from_view(self.view, path)
+        else:
+            copied = False
+            sublime.error_message("Unable to copy file. No source file to move")
+
+        return copied
+
+    def copy_from_view(self, source_view, target):
+        source = source_view.file_name()
+        if source is None:
+            self.copy_file_from_buffer(source_view, target)
+        else:
+            self.copy_file_from_disk(source, target)
+
+    def copy_file_from_buffer(self, source_view, target):
+        content = self.view.substr(sublime.Region(0, self.view.size()))
+        with open(target, "w") as file_obj:
+            file_obj.write(content)
+
+    def copy_file_from_disk(self, source, target):
+        self._copy_file_action(source, target)
+
+    def copy_from_argument(self, target):
+        source_name = self.get_argument_name()
+        file_view = self._find_open_file(source_name)
+
+        self._copy_file_action(source_name, target)
+
+
+    def _copy_file_action(self, source, target):
+        shutil.copy(source, target)
+
+    def get_status_prefix(self):
+        return "Copying file to"
+
+    def get_append_extension_setting(self):
+        return APPEND_EXTENSION_ON_COPY_SETTING
+
+
+class AdvancedNewFileCopyAtCommand(sublime_plugin.WindowCommand):
+    def run(self, files):
+        if len(files) != 1:
+            return
+        self.window.run_command("advanced_new_file_copy",
+                                {"rename_file": files[0]})
+
+    def is_visible(self, files):
+        return len(files) == 1

advanced_new_file/commands/duplicate_file_base.py

@@ -0,0 +1,80 @@
+import os
+import re
+import sublime_plugin
+
+from .command_base import AdvancedNewFileBase
+from ..anf_util import *
+
+class DuplicateFileBase(AdvancedNewFileBase, sublime_plugin.WindowCommand):
+
+    def __init__(self, window):
+        super(DuplicateFileBase, self).__init__(window)
+
+    def run(self, is_python=False, initial_path=None, rename_file=None):
+        self.is_python = is_python
+        self.run_setup()
+        self.argument_name = rename_file
+
+        path = self.settings.get(self.get_default_setting(), "")
+        current_file = self.view.file_name()
+        if current_file:
+            directory, current_file_name = os.path.split(current_file)
+            path = path.replace("<filepath>", current_file)
+            path = path.replace("<filedirectory>", directory + os.sep)
+        else:
+            current_file_name = ""
+
+        path = path.replace("<filename>", current_file_name)
+        self.duplicate_setup()
+        self.show_filename_input(
+            path if len(path) > 0 else self.generate_initial_path())
+
+    def get_argument_name(self):
+        return self.argument_name
+
+    def duplicate_setup(self):
+        view = self.window.active_view()
+        self.original_name = None
+        if view is not None:
+            view_file_name = view.file_name()
+            if view_file_name:
+                self.original_name = os.path.basename(view_file_name)
+
+        if self.original_name is None:
+            self.original_name = ""
+
+    def update_status_message(self, creation_path):
+        status_prefix = self.get_status_prefix()
+        if self.is_copy_original_name(creation_path):
+            creation_path = os.path.join(creation_path, self.original_name)
+        else:
+            creation_path = self.try_append_extension(creation_path)
+        if self.view is not None:
+            self.view.set_status("AdvancedNewFile", "%s %s " %
+                                 (status_prefix, creation_path))
+        else:
+            sublime.status_message("%s %s" %
+                                   (status_prefix, creation_path))
+
+    def is_copy_original_name(self, path):
+        return (os.path.isdir(path) or
+               os.path.basename(path) == "")
+
+    def try_append_extension(self, path):
+        append_setting = self.get_append_extension_setting()
+        print(append_setting)
+        print(self.settings.get(append_setting))
+        if self.settings.get(append_setting, False):
+            if not self.is_copy_original_name(path):
+                _, new_path_extension = os.path.splitext(path)
+                if new_path_extension == "":
+                    argument_name = self.get_argument_name()
+                    if argument_name is None:
+                        _, extension = os.path.splitext(self.view.file_name())
+                    else:
+                        _, extension = os.path.splitext(argument_name)
+                    path += extension
+        return path
+
+
+

advanced_new_file/commands/move_file_command.py

@@ -3,46 +3,20 @@
 import shutil
 import sublime_plugin
 
-from ..vcs.git.git_command_base import GitCommandBase
-from .command_base import AdvancedNewFileBase
+from .duplicate_file_base import DuplicateFileBase
 from ..anf_util import *
+from ..vcs.git.git_command_base import GitCommandBase
 
 
-class AdvancedNewFileMove(AdvancedNewFileBase, sublime_plugin.WindowCommand,
-                          GitCommandBase):
+class AdvancedNewFileMove(DuplicateFileBase, GitCommandBase):
     def __init__(self, window):
         super(AdvancedNewFileMove, self).__init__(window)
 
-    def run(self, is_python=False, initial_path=None, rename_file=None):
-        self.is_python = is_python
-        self.run_setup()
-        self.rename_filename = rename_file
-
-        path = self.settings.get(RENAME_DEFAULT_SETTING)
-        current_file = self.view.file_name()
-        if current_file:
-            directory, current_file_name = os.path.split(current_file)
-            path = path.replace("<filepath>", current_file)
-            path = path.replace("<filedirectory>", directory + os.sep)
-        else:
-            current_file_name = ""
-
-        path = path.replace("<filename>", current_file_name)
-        self.show_filename_input(
-            path if len(path) > 0 else self.generate_initial_path())
+    def get_default_setting(self):
+        return RENAME_DEFAULT_SETTING
 
     def input_panel_caption(self):
         caption = 'Enter a new path for current file'
-        view = self.window.active_view()
-        self.original_name = None
-        if view is not None:
-            view_file_name = view.file_name()
-            if view_file_name:
-                self.original_name = os.path.basename(view_file_name)
-
-        if self.original_name is None:
-            self.original_name = ""
-
         if self.is_python:
             caption = '%s (creates __init__.py in new dirs)' % caption
         return caption
@@ -72,36 +46,24 @@ def entered_file_action(self, path):
         if attempt_open:
             self._rename_file(path)
 
-    def is_copy_original_name(self, path):
-        return (os.path.isdir(path) or
-               os.path.basename(path) == "")
-
-    def try_append_extension(self, path):
-        if self.settings.get(APPEND_EXTENSION_ON_MOVE_SETTING, False):
-            if not self.is_copy_original_name(path):
-                _, new_path_extension = os.path.splitext(path)
-                if new_path_extension == "":
-                    if self.rename_filename is None:
-                        _, extension = os.path.splitext(self.view.file_name())
-                    else:
-                        _, extension = os.path.splitext(self.rename_filename)
-                    path += extension
-        return path
+    def get_append_extension_setting(self):
+        return APPEND_EXTENSION_ON_MOVE_SETTING
 
     def _rename_file(self, file_path):
         if os.path.isdir(file_path) or re.search(r"(/|\\)$", file_path):
             # use original name if a directory path has been passed in.
             file_path = os.path.join(file_path, self.original_name)
 
         window = self.window
-        if self.rename_filename:
-            file_view = self._find_open_file(self.rename_filename)
+        rename_filename = self.get_argument_name()
+        if rename_filename:
+            file_view = self._find_open_file(rename_filename)
             if file_view is not None:
                 self.view.run_command("save")
                 window.focus_view(file_view)
                 window.run_command("close")
 
-            self._move_action(self.rename_filename, file_path)
+            self._move_action(rename_filename, file_path)
 
             if file_view is not None:
                 self.open_file(file_path)
@@ -131,16 +93,8 @@ def _move_action(self, from_file, to_file):
         else:
             shutil.move(from_file, to_file)
 
-    def update_status_message(self, creation_path):
-        if self.is_copy_original_name(creation_path):
-            creation_path = os.path.join(creation_path, self.original_name)
-        else:
-            creation_path = self.try_append_extension(creation_path)
-        if self.view is not None:
-            self.view.set_status("AdvancedNewFile", "Moving file to %s " %
-                                 creation_path)
-        else:
-            sublime.status_message("Moving file to %s" % creation_path)
+    def get_status_prefix(self):
+        return "Moving file to"
 
 
 class AdvancedNewFileMoveAtCommand(sublime_plugin.WindowCommand):