clone_git_file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 637cbb2eda84c98bd8fb050abdf134fbcba36c68
+  data.tar.gz: f4b0ea2a891550970426d6b28569de407255a512
+SHA512:
+  metadata.gz: 833662a9821dc6aee03abf872253ebd69a13631e33082bf3c6f001ef6ddb804a04615a99439050acdebdab93052998205beb5afae3703f0ad535e71fd29ce936
+  data.tar.gz: 9d349fae49b89876909032c5f55fe0655bd0aca96f5c06b9a0b0123363d609f095c81de5f23cbf7637717cc9d1f82415c8cfc1f9312dc8e6cbc674ba81976a10

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clone_git_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brandon Conway
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Description
+
+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.
+
+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:
+
+```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.
+
+If you want to override your default editor, just add `EDITOR=myeditor` to the
+beginning. For example:
+
+```bash
+EDITOR=mvim TARGET_DIRECTORY=~/dev clone_git_file https://github.com/brandoncc/clone_git_file/blob/master/README.md
+```
+
+### Bonus
+
+You can also supply the repo url or a repo directory url, and that directory will be opened by your editor
+
+# Limitations
+
+Github is the only service that is current compatible. I would like to add more
+services in the future.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clone_git_file"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clone_git_file.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clone_git_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clone_git_file"
+  spec.version       = CloneGitFile::VERSION
+  spec.authors       = ["Brandon Conway"]
+  spec.email         = ["brandoncc@gmail.com"]
+
+  spec.summary       = "A small tool which allows you to easily clone and open a file from git services"
+  spec.homepage      = "https://github.com/brandoncc/clone_git_file"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = ["clone_git_file"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-spec-context"
+end

data/exe/clone_git_file

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'clone_git_file'
+
+file = ARGV[0]
+abort("You forgot the file!") unless file
+abort("You haven't specified a target directory") unless ENV["TARGET_DIRECTORY"]
+abort("Target directory doesn't exist") unless Dir.exists?(File.expand_path(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/)
+
+cloner = CloneGitFile::Cloner.new(file)
+cloner.open_file

data/lib/clone_git_file/github_repo_parser.rb

@@ -0,0 +1,65 @@
+require 'ostruct'
+
+module CloneGitFile
+  class GithubRepoParser
+    def initialize(file)
+      @file = file
+    end
+
+    def parse
+      abort("Error: That url is not valid") unless valid_url?
+      data                    = OpenStruct.new
+      data.repo_url           = parse_repo_url
+      data.repo_name          = parse_repo_name
+      data.github_username    = parse_github_username
+      data.file_relative_path = parse_file_relative_path
+      data.branch_name        = parse_branch_name
+      data
+    end
+
+    def valid_url?
+      !!@file.match(%r{.+github\.com/[^/]+/[^/]+})
+    end
+
+    private
+
+    def parse_github_username
+      @file.match(%r{.+github\.com/([^/]+)})[1]
+    end
+
+    def parse_repo_url
+      @file.match(%r{.+github\.com/[^/]+/[^/]+})[0]
+    end
+
+    def parse_repo_name
+      @file.match(%r{.+github\.com/[^/]+/([^/]+)})[1]
+    end
+
+    def parse_file_relative_path
+      path = @file.match(%r{#{Regexp.escape(parse_repo_url)}/(.+)$})[1]
+      path.sub!(%r{^(?:blob|tree)/[^/]+}, '') if has_branch?
+      path.sub!(%r{^/}, '')
+      path
+    rescue NoMethodError
+      ''
+    end
+
+    def has_branch?
+      is_branch? || is_tree?
+    end
+
+    def parse_branch_name
+      return nil unless has_branch?
+
+      @file.match(%r{#{Regexp.escape(parse_repo_url)}/(?:blob|tree)/([^/]+)})[1]
+    end
+
+    def is_branch?
+      @file.match(%r{#{Regexp.escape(parse_repo_url)}/blob/[^/]+/.+})
+    end
+
+    def is_tree?
+      @file.match(%r{#{Regexp.escape(parse_repo_url)}/tree/[^/]+$})
+    end
+  end
+end

data/lib/clone_git_file/version.rb

@@ -0,0 +1,3 @@
+module CloneGitFile
+  VERSION = "0.1.0"
+end

data/lib/clone_git_file.rb

@@ -0,0 +1,57 @@
+require "clone_git_file/version"
+require "clone_git_file/github_repo_parser"
+
+module CloneGitFile
+  class Cloner
+    def initialize(file)
+      @file = file
+    end
+
+    def open_file
+      if Dir.exists?(File.expand_path(local_repo_path))
+        update_repo
+      else
+        clone_repo
+      end
+
+      launch_editor
+    end
+
+    private
+
+    def parsed_data
+      @parsed_data ||= GithubRepoParser.new(@file).parse
+    end
+
+    def local_repo_path
+      @local_repo_path ||= "#{ENV["TARGET_DIRECTORY"]}/#{parsed_data.github_username}/#{parsed_data.repo_name}"
+    end
+
+    def launch_editor
+      system("#{ENV["EDITOR"]} #{local_repo_path}/#{parsed_data.file_relative_path}")
+    end
+
+    def clone_repo
+      commands = ""
+      commands << "git clone #{parsed_data.repo_url} #{local_repo_path}"
+
+      if parsed_data.branch_name
+        commands << "\ncd #{local_repo_path}"
+        commands << "\ngit checkout #{parsed_data.branch_name}"
+      end
+
+      system(commands)
+    end
+
+    def update_repo
+      commands = ""
+
+      commands << "cd #{local_repo_path}"
+      commands << "\ngit reset HEAD --hard"
+      commands << "\ngit pull"
+      commands << "\ngit checkout #{parsed_data.branch_name}" if parsed_data.branch_name
+
+      system(commands)
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: clone_git_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Conway
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brandoncc@gmail.com
+executables:
+- clone_git_file
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clone_git_file.gemspec
+- exe/clone_git_file
+- lib/clone_git_file.rb
+- lib/clone_git_file/github_repo_parser.rb
+- lib/clone_git_file/version.rb
+homepage: https://github.com/brandoncc/clone_git_file
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A small tool which allows you to easily clone and open a file from git services
+test_files: []