clone_git_file 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32fb5dd7523cde6334e4ec6f5373555f8423ecd0
-  data.tar.gz: 51fd364c11b7bd60c9ade03fc98d07421428bebd
+  metadata.gz: a6a43dd0a36bfccd6e5c32722a835ecc6ceeac55
+  data.tar.gz: d1fd69615798975cc626c7a135e25d802d75a437
 SHA512:
-  metadata.gz: 7be4d9be3dba8d5a90617b70c5dbb1cb0c86d85b7b7dcb92ff530a153ded7d9413a2e5aa7cf80b9205330fa1ad856e4b0437853f5e31ec78273bd2a559c3dba8
-  data.tar.gz: 4c665b58515d5de912aee26fb0899c841541e9ec15410a8cd8d474d84fade71f3e2dfeb31e860ab1e7febe1db122f3088248bd8417d2467421291c3c08719369
+  metadata.gz: 0ab9272637734ae7ae03b0ab59bf19914308af732378ab0f30f6f47ba2b959840121627af3da9d53b050b60d5fd6d6a94eb14f5558957e04013351bea58f2872
+  data.tar.gz: 93cbe3fa002925024e92131bdafbf18feae483e1587fbcedf15d72bbb2b64b0b04dacca4141d0dd393564a413db941b70036c548492b35c2d42ea5d342116fd3

data/README.md

@@ -18,28 +18,37 @@ This gem allows you to replace these commands:
 
 with:
 
-`cgf https://github.com/author/repo/file.rb` (assuming you setup the alias below)
+`ogf https://github.com/author/repo/file.rb` (if you choose to setup an alias)
 
 #### Long version
 
-This gem will clone the repository containing a file, then open that file in
-your chosen editor. If the repository already exists in the specified directory,
-any uncommitted changes will be lost (`git reset HEAD --hard` will be run). The
-repository will be pulled after resetting, to get the latest changes.
+This gem will clone the repository containing a file, optionally opening that
+file in your chosen editor. If the repository already exists in the specified
+directory, any uncommitted changes will be lost (`git reset HEAD --hard` will
+be run). The repository will be pulled after resetting, to get the latest
+changes.
 
 The editor that will be used is specified using the `EDITOR` environment
 variable, which allows you to easily override your editor only for this command.
 
 # Usage
 
-At a minimum, you need to specify a target directory:
+At a minimum, you need to specify a target directory and url:
 
 ```bash
 TARGET_DIRECTORY=~/dev clone_git_file https://github.com/brandoncc/clone_git_file/blob/master/README.md
 ```
 
-That will clone this repository to `~/dev/clone_git_file` then open `README.md`
-from the `master` branch.
+That will clone this repository to `~/dev/clone_git_file`, then switch to the
+`master` branch. A message will then be shown giving you that location.
+
+There are command switches available as follows:
+
+| Switch | Description |
+| --- | --- |
+| -o, <nobr>--open</nobr> | Open the file in the specified editor after cloning |
+| -t, <nobr>--terminal</nobr> | Output the command which would be used to open the file in your editor, as text in the terminal. This is useful for piping into other commands. Since Ruby `system` method executions are run in a child process, this is useful for opening the file in your editor in the current shell (more details in the bonus section). This is equivalent to `-ot`. |
+| -s, <nobr>--silent</nobr> | Suppress messages from the cloning process. If you want to pipe the output of `-t` into a command, you should also use this. |
 
 If you want to override your default editor, just add `EDITOR=myeditor` to the
 beginning. For example:
@@ -50,14 +59,21 @@ EDITOR=mvim TARGET_DIRECTORY=~/dev clone_git_file https://github.com/brandoncc/c
 
 ### Bonus
 
-* You can also supply the repo url or a repo directory url, and that directory will be opened by your editor
-* Setup an alias to make using the gem easy. For example, here is mine (zsh):
+* You can also supply the repo url or a repo subdirectory url, and that directory will be opened by your editor.
+* Setup an alias to make using the gem easy. For example, here are mine (zsh):
 
     ```bash
     alias cgf="TARGET_DIRECTORY=~/dev EDITOR=mvim clone_git_file $1"
+    alias ogf="TARGET_DIRECTORY=~/dev EDITOR=mvim clone_git_file -ts $1"
     ```
+    
+    `cgf` clones, then prints a message with the location of the cloned file/directory.
+    
+    `ogf` prints the commands to open the file/directory in my editor. I then use `source <(...)` to pipe the printed command to `source` which runs it in my current shell. This fixes some weird things that happen when opening the editor in a child process, and also allows the current directory of my current shell to be changed (instead of the child process shell which will be lost when you close the editor).
+    
+    Unfortunately `$1` doesn't get passed into the nested command, so the `source <()` usage can't be in the alias (still looking for a solution to this if anybody has one), so I used TextExpander to setup a snippet which handles that part, with the final command I run being `source <(ogf https://github.com/brandoncc/clone_git_file/blob/master/README.md)`.
 
 # Limitations
 
-Github is the only service that is current compatible. I would like to add more
-services in the future.
+* Github is the only service that is currently compatible. I would like to add more services in the future.
+* `-s, --silent` is only available on operating systems which can direct output to `/dev/null`, which means it is unavailable on Windows.

data/exe/clone_git_file

@@ -1,12 +1,67 @@
 #!/usr/bin/env ruby
 
 require 'clone_git_file'
+require 'optparse'
+require 'rbconfig'
 
-file = ARGV[0]
-abort("You forgot the file!") unless file
-abort("You haven't specified a target directory") unless ENV["TARGET_DIRECTORY"]
-abort("No editor set, please specify the EDITOR environment variable") unless ENV["EDITOR"]
-abort("Sorry, github is the only service currently compatible") unless file.match(/github\.com/)
+options = {}
 
-cloner = CloneGitFile::Cloner.new(file)
+OptionParser.new do |opts|
+  opts.banner = "\nA utility for easily cloning from git services\n"
+
+  opts.on("-o", "--open", "Open in editor after cloning") do
+    options[:open_in_editor] = true
+  end
+
+  opts.on("-s", "--silent", "Suppress messages from cloning process") do
+    options[:silent] = true
+  end
+
+  opts.on("-t", "--terminal", "Output editor run command to the terminal",
+          "instead of executing it (same as -ot)") do
+    options[:output_run_command_to_terminal] = true
+  end
+
+  opts.on("-h", "--help", "Displays help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+def verify_url_was_provided(url)
+  abort("You must specify a url to clone") unless url
+end
+
+def verify_target_directory_was_provided
+  abort("You haven't specified a target directory") unless ENV["TARGET_DIRECTORY"]
+end
+
+def verify_url_is_github(url)
+  abort("Sorry, github is the only service currently compatible") unless url.match(/github\.com/)
+end
+
+def verify_editor_is_set_when_necessary(options)
+  if options[:open_in_editor] || options[:output_run_command_to_terminal]
+    unless ENV["EDITOR"]
+      abort("No editor set, please specify the EDITOR environment variable")
+    end
+  end
+end
+
+def verify_silent_is_available
+  abort("Silent mode is not available on Windows") if windows?
+end
+
+def windows?
+  RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+end
+
+url = ARGV[0]
+verify_url_was_provided(url)
+verify_target_directory_was_provided
+verify_url_is_github(url)
+verify_editor_is_set_when_necessary(options)
+verify_silent_is_available if options[:silent]
+
+cloner = CloneGitFile::Cloner.new(url, options)
 cloner.open_file

data/lib/clone_git_file.rb

@@ -3,8 +3,9 @@ require "clone_git_file/github_repo_parser"
 
 module CloneGitFile
   class Cloner
-    def initialize(file)
+    def initialize(file, options = {})
       @file = file
+      @options = options
     end
 
     def open_file
@@ -14,7 +15,12 @@ module CloneGitFile
         clone_repo
       end
 
-      launch_editor
+      if @options[:open_in_editor] ||
+          @options[:output_run_command_to_terminal]
+        launch_editor
+      else
+        print_clone_location
+      end
     end
 
     private
@@ -28,7 +34,22 @@ module CloneGitFile
     end
 
     def launch_editor
-      system("#{ENV["EDITOR"]} #{local_repo_path}/#{parsed_data.file_relative_path}")
+      commands = ""
+      file_path = "#{local_repo_path}/#{parsed_data.file_relative_path}"
+
+      # change into the directory so that relative file loads will work
+      commands << "cd #{File.dirname(file_path)}"
+      commands << "\n#{ENV["EDITOR"]} #{file_path}"
+
+      if @options[:output_run_command_to_terminal]
+        puts(commands)
+      else
+        system(commands)
+      end
+    end
+
+    def print_clone_location
+      puts "Cloned to: #{local_repo_path}/#{parsed_data.file_relative_path}"
     end
 
     def clone_repo
@@ -40,6 +61,8 @@ module CloneGitFile
         commands << "\ngit checkout #{parsed_data.branch_name}"
       end
 
+      commands = make_commands_silent(commands) if @options[:silent]
+
       system(commands)
     end
 
@@ -50,8 +73,15 @@ module CloneGitFile
       commands << "\ngit reset HEAD --hard"
       commands << "\ngit pull"
       commands << "\ngit checkout #{parsed_data.branch_name}" if parsed_data.branch_name
+      commands = make_commands_silent(commands) if @options[:silent]
 
       system(commands)
     end
+
+    def make_commands_silent(commands)
+      cmds = commands.split("\n")
+
+      cmds.map { |c| "#{c} &> /dev/null" }.join("\n")
+    end
   end
 end

data/lib/clone_git_file/version.rb

@@ -1,3 +1,3 @@
 module CloneGitFile
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clone_git_file
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Brandon Conway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler