gito 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0838fb4e8600ad656c53a678d75dc794cdde1a0a'
-  data.tar.gz: ecc81ababf24d6af18ce5fc0d18ca3e60ba77055
+  metadata.gz: 4416faef1ce8a1f742961c8166aa3748191d61cd
+  data.tar.gz: ed9a120d580ae5f28dd6ba95ad9786755146eadd
 SHA512:
-  metadata.gz: 75fcd0dddecbd0c88da9928f35aa549106266bfaf0f2ac2b8fafee109b38a993fb471612376d395ce23b26234d8dd628436a4040cbaa9ffd5188fc6298e9442f
-  data.tar.gz: 1af9cca5a67adaf239394620ce43f2f1227c96a8f3c1ca378d2f5286268ffb6257fc6086944b348ab2d003620bdbe9e6137fcba436b722cc5cbef1126cf1adf7
+  metadata.gz: 52da36d58def0e2b8bf201966118a247ff1904bf896354a75923850f3fe853d5b48a9dc579da6f49b9dd6aa3e69076483acc3985b2825c227ae996fb43747c88
+  data.tar.gz: 69966fb5f99e3c5aac8a00de16a30b42f1ed5149dcef2256f8712b48c1d7b7d9205d13a0eafb5debedebbe9802901bad658f67795e4080a9f0dd659fbf326422

data/README.md

@@ -4,20 +4,19 @@
 [![Code Climate](https://codeclimate.com/github/cesarferreira/gito/badges/gpa.svg)](https://codeclimate.com/github/cesarferreira/gito)
 [![Inline docs](http://inch-ci.org/github/cesarferreira/gito.svg?branch=master)](http://inch-ci.org/github/cesarferreira/gito)
 
-git helper tool to **clone**/**open**/**install**/**edit** a git project with a one-liner.
+git helper tool to **clone**/**open**/**auto-install**/**edit** a git project with a one-liner.
 
------------
 
 <p align="center">
-  > <strong>gito</strong> <i>cesarferreira/dryrun</i>
+<img src="extras/recordit2.gif" width="100%" />
 </p>
 
 <p align="center">
-<img src="extras/screenshot.png" width="100%" />
+  > <strong>gito</strong> <i>cesarferreira/dryrun -e</i>
 </p>
 
 ## Why?
-A lot of times I find myself wanting to try some code from github and in order to do so I have to copy the git URL, go to the terminal, git clone, find out the folder name, go to the folder and based on the type of project I need to `bundle install`, `./gradlew assemble`, `npm install`... Not anymore!
+A lot of times I find myself wanting to try some code from github and in order to do so I have to copy the git URL, go to the terminal, git clone, find out the folder name, go to the folder and based on the type of project I need to `bundle install`, `./gradlew assemble`, `npm install`, `pip install .`, `mix deps.get`, `make install`, you name it. And after that opening it in my text editor of choice... Not anymore!
 
 
 ## Usage
@@ -27,9 +26,10 @@ $ gito -h
 Usage: gito GIT_URL [OPTIONS]
 
 Options
+    -s, --set-editor EDITOR          Set a custom editor to open the project (e.g. "atom", "subl", "vim", etc.
     -e, --edit                       Open the project on an editor
     -o, --open                       Open the project on Finder
-    -d, --dryrun                     Doesn't install the dependencies
+    -d, --dryrun                     Does not install the dependencies
     -h, --help                       Displays help
     -v, --version                    Displays the version
 ```
@@ -42,10 +42,13 @@ gito cesarferreira/dryrun
 # git clone, install, open and edit the project
 gito cesarferreira/dryrun --edit --open
 
-# git clone, install, open and edit the project
+# set the editor to be 'subl' from now on
+gito cesarferreira/dryrun -s subl
+
+# git clone, install, open and edit the project from github
 gito https://github.com/cesarferreira/dryrun -e -o
 
-# git clone, install,
+# git clone, install from another git source
 gito https://bitbucket.org/username/project
 ```
 
@@ -53,12 +56,26 @@ gito https://bitbucket.org/username/project
 
     $ gem install gito
 
-## Internally what happens?
+## Supported type detections/auto-intalls
+So far it auto-installs these types:
+- Ruby
+- Gradle
+- node.js
+- C
+- Elixir
+- Python
 
-Sample:
+Create a pull request by editing [detector.json](detector.json) file if you want more types to be added.
+
+## Internally what happens?
 
+When you run this:
 ```bash
-# clone it
+gito cesarferreira/dryrun --edit --open
+```
+This will happen:
+```bash
+# clone
 git clone http://github.com/cesarferreira/dryrun
 
 # change directory
@@ -77,6 +94,9 @@ project_type_detector
 bundle install
 ```
 
+## todo
+- `-t` to clone into a temp directory
+
 ## Contributing
 I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
   1. If its a feature, bugfix, or anything please only change code to what you specify.

data/detector.json

@@ -0,0 +1,32 @@
+[
+  {
+    "file_requirement": "Gemfile",
+    "installation_command": "bundle install",
+    "type": "ruby"
+  },
+  {
+    "file_requirement": "build.gradle",
+    "installation_command": "./gradlew assemble",
+    "type": "gradle"
+  },
+  {
+    "file_requirement": "package.json",
+    "installation_command": "yarn",
+    "type": "node"
+  },
+  {
+    "file_requirement": "Makefile",
+    "installation_command": "make",
+    "type": "c"
+  },
+  {
+    "file_requirement": "mix.exs",
+    "installation_command": "mix deps.get",
+    "type": "elixir"
+  },
+  {
+    "file_requirement": "setup.py",
+    "installation_command": "pip install .",
+    "type": "python"
+  }
+]

data/detector.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+file = File.read('detector.json')
+types = JSON.parse(file)
+chosen = nil
+types.each do |item|
+	if File.exist? (item['file_requirement'])
+		chosen = item
+		break
+	end
+end
+
+unless chosen.nil?
+	puts "Found: " + chosen['type']
+	puts "how to install: " + chosen['installation']
+end

data/gito.gemspec

@@ -8,7 +8,7 @@ spec = Gem::Specification.new do |s|
   s.homepage        = 'https://github.com/cesarferreira/gito'
   s.license         = 'MIT'
   s.platform        = Gem::Platform::RUBY
-  s.summary         = 'git helper tool to clone/open/install/edit a git project with a one-liner'
+  s.summary         = 'git helper tool to clone/open/auto-install/edit a git project with a one-liner'
   s.files           = `git ls-files`.split("
 ")
   s.require_paths << 'lib'
@@ -22,4 +22,5 @@ spec = Gem::Specification.new do |s|
 
   s.add_dependency 'bundler', '~> 1.7'
   s.add_dependency 'colorize', '~> 0.7'
+  s.add_dependency 'safe_yaml', '~> 1.0.4'
 end

data/lib/gito.rb

@@ -3,6 +3,7 @@ require 'tmpdir'
 require 'fileutils'
 require 'gito/version'
 require 'gito/project'
+require 'gito/config_manager'
 require 'openssl'
 require 'open3'
 require 'optparse'
@@ -17,6 +18,8 @@ class MainApp
     @should_edit = false
     @should_open = false
     @dryrun = false
+    @editor = nil
+    @setting_up = false
 
     # Parse Options
     create_options_parser(arguments)
@@ -28,7 +31,12 @@ class MainApp
       opts.separator ''
       opts.separator 'Options'
 
-      opts.on('-e', '--edit', 'Open the project on an editor') do |edit|
+      opts.on('-s EDITOR', '--set-editor EDITOR', 'Set a custom editor to open the project (e.g. "atom", "subl", "vim", etc.') do |editor|
+        @editor = editor.nil? ? nil : editor
+        @setting_up = true
+      end
+
+      opts.on('-e', '--edit', 'Open the project on an editor') do |editor|
         @should_edit = true
       end
 
@@ -54,24 +62,46 @@ class MainApp
     end
   end
 
+  def update_configuration
+    config_manager = ConfigManager.new
+    app_config = config_manager.get
+
+    if @editor.nil?
+      @editor = app_config[:editor]
+    else
+      config_manager.write_editor @editor
+    end
+  end
+
   def call
 
+    if @setting_up
+      if @editor.nil?
+          puts 'New new editor can\'t be empty'.red
+        else
+          update_configuration
+          puts 'Updated the editor to: ' + @editor.yellow
+      end
+    exit 1
+    end
+
     if @url.nil?
       puts 'You need to insert a valid GIT URL/folder'
       exit 1
     end
 
+    # handle the configuration
+    update_configuration
+
     project = Project.new(@url)
 
     # Clone the repository
     project.clone
 
-    # Detect project type
-    project.detect_project_type
-
     # Open in editor
     if @should_edit
-      project.open_editor
+      # binding.pry
+      project.open_editor @editor
     end
 
     # Open in Finder

data/lib/gito/config_manager.rb

@@ -0,0 +1,36 @@
+require 'safe_yaml'
+
+class ConfigManager
+
+	def initialize
+		SafeYAML::OPTIONS[:default_mode] = :safe
+		SafeYAML::OPTIONS[:deserialize_symbols] = true
+
+		@conf_path = "#{Dir.home}/.gito.yml"
+		@default_config = {"editor": "atom"}
+	end
+
+	def write_editor(new_editor)
+		current_config = get
+		current_config[:editor] = new_editor
+		write(current_config)
+	end
+
+	def write(config)
+		new_config = config.to_yaml
+		File.open(@conf_path, 'w') { |file| file.write(new_config)}
+	end
+
+	def get
+		if File.exists? (@conf_path)
+			file = File.open(@conf_path, "rb")
+			contents = file.read
+			config = YAML.load(contents, :safe => true)
+		else
+			write @default_config
+			config = @default_config
+		end
+
+		config
+	end
+end

data/lib/gito/project.rb

@@ -1,6 +1,7 @@
 require 'tmpdir'
 require 'fileutils'
 require 'uri'
+require 'json'
 require_relative './app_utils'
 require 'pry'
 
@@ -9,7 +10,7 @@ class Project
     @base_url = sanitize_url(url)
     @destination_dir = nil
     @destination = destination
-    @project_type = :unknown
+    @detector_json_path = '../detector.json'
   end
 
   def sanitize_url(url)
@@ -46,43 +47,32 @@ class Project
   end
 
   def change_directory
-    # TODO aparently this doesn't work because ruby forks the terminal process and cant' communicate with his father
+    # TODO aparently this doesn't work because ruby forks the terminal process and can't communicate with his parent
 
     # temp_script_name = './temp.sh'
     # AppUtils::execute 'echo "cd '+@destination+'" > ' + temp_script_name
     # AppUtils::execute '. '+temp_script_name
     # AppUtils::execute 'rm -rf ' + temp_script_name
 
-    puts "\nPlease change directory into the project"
+    puts "-------------------------------------------"
+    puts "Please change directory"
     puts "cd #{destination.yellow}"
+    puts "-------------------------------------------"
   end
 
-  def detect_project_type
-    Dir.chdir @destination_dir
-
-    @project_type = :unknown
+  def install_dependencies
+    file = File.read(@detector_json_path)
+    types = JSON.parse(file)
+    chosen = nil
 
-    if File.exists?('build.gradle')
-      @project_type = :gradle
-    elsif File.exists?('package.json')
-      @project_type = :node
-    elsif File.exists?('Gemfile')
-      @project_type = :ruby
-    end
+    Dir.chdir(@destination_dir)
 
-    puts "Detected #{@project_type}...".yellow
-    @project_type
-  end
-
-  def install_dependencies
-    case @project_type
-      when :gradle
-        go_inside_and_run('./gradlew assemble')
-      when :node
-        go_inside_and_run('npm install')
-      when :ruby
-        go_inside_and_run('bundle install')
+    types.each do |item|
+      if File.exists? (item['file_requirement'])
+        puts "#{item['type']} detected...".yellow
+        go_inside_and_run item['installation_command']
       end
+    end
   end
 
   def cloneable_url
@@ -115,9 +105,9 @@ class Project
     @destination_dir
   end
 
-  def open_editor
+  def open_editor(app)
     puts "Opening editor...".yellow
-    go_inside_and_run 'atom .'
+    go_inside_and_run "#{app} ."
   end
 
   def open_folder

data/lib/gito/version.rb

@@ -1,3 +1,3 @@
 module Gito
-  VERSION = '0.2.4'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gito
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1
 platform: ruby
 authors:
 - cesar ferreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 description: 
 email:
 - cesar.manuel.ferreira@gmail.com
@@ -95,10 +109,15 @@ files:
 - README.md
 - Rakefile
 - bin/gito
+- detector.json
+- detector.rb
+- extras/recordit.gif
+- extras/recordit2.gif
 - extras/screenshot.png
 - gito.gemspec
 - lib/gito.rb
 - lib/gito/app_utils.rb
+- lib/gito/config_manager.rb
 - lib/gito/project.rb
 - lib/gito/version.rb
 homepage: https://github.com/cesarferreira/gito
@@ -125,5 +144,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: git helper tool to clone/open/install/edit a git project with a one-liner
+summary: git helper tool to clone/open/auto-install/edit a git project with a one-liner
 test_files: []