ecl 1.2.1 → 3.0.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8c4127b7ce838a2a736346aab64dcaf82357641
-  data.tar.gz: b90734a950059c756fc3c84fe16a16e4c6c05bb6
+SHA256:
+  metadata.gz: 26b729fe35fb071861abc7905ad29bb47b7ef3cbf0c41154f88dcb79bfdb7206
+  data.tar.gz: 00416e67138a83c0ab4775da8d64ca9ddfb361d9a1ef5ad38783799985ff1d45
 SHA512:
-  metadata.gz: 43e1dcf11d56c776bd9b5b9da208eb1b35fd7253ef2b5b00e9467e53be2d320ee44b5304d49f69333746efbdbbd0b5089baf40b2b93e83776f8f4ce1b7066198
-  data.tar.gz: 364e71b80c302d94b79965e84771483be25081dce64c5621df9e95e32a8478f5a09e7f628828b61d4406663a474a33d913f6dd6c315d6afa9afc19bdbf2996b5
+  metadata.gz: 303f74e1a7d1b664c7e60fab94c1632fb22ab392e2efd3b6feed74b63b85707ee79c51916742cbee7637a451c981edb44f8e17de6866672a5a827ea6deb33fe1
+  data.tar.gz: 1712067f06e506d7f89a927bdef263a9c65a7035916d239c0e834e9d2de0fc081e44989eca1cdd1a9c2404c7cce3d62262ed594fe33475ca98f1b8683582e4ce

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in eclair.gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    ecl (3.0.0.pre.alpha1)
+      aws-sdk-ec2 (~> 1.18)
+      curses (~> 1.0)
+      json (~> 2.1)
+      oj (~> 3.3)
+      pry (~> 0.10)
+      ruby-string-match-scorer (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.0.3)
+    aws-partitions (1.167.0)
+    aws-sdk-core (3.53.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.87.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    coderay (1.1.2)
+    curses (1.3.1)
+    jmespath (1.4.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    oj (3.7.12)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    ruby-string-match-scorer (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  ecl!
+  rake (~> 12.3)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,114 +1,137 @@
-# Eclair
+eclair [![RubyGems total downloads]][RubyGems]
+========
+![A video showing how Eclair works]
 
 Simple ssh helper for Amazon EC2
 
-## Requirements
-    
-    tmux
-    ~/.aws/credentials (created by AWS CLI)
+Requirements
+--------
+- tmux > 2.0
+- Properly configured `~/.aws/credentials`
 
-## Installation
+Installation
+--------
+```console
+$ gem install ecl
+```
 
-    $ gem install ecl
+### Install from Source
+If you want to use the latest functionalities, install Eclair from the source.
+```bash
+# Headers of ncursesw is required to build Eclair in GNU/Linux
+sudo apt-get install libncursesw5-dev   # Debian, Ubuntu, etc
+sudo yum install libncursesw5-devel     # CentOS, etc
 
-## Usage
-
-    $ ecl
+# Build latest eclair gem
+gem build eclair.gemspec
 
-First execution will create ~/.eclrc file. Edit this file and run again.
+# Install eclair into your system
+gem install ecl-3.0.0.pre.alpha1.gem
+```
 
-## Configurations
+## Usage
+```console
+$ ecl
+```
+First execution will create `~/.ecl/config.rb` file. Edit this file and run again.
 
+Configurations
+--------
 ### aws_region
-
 AWS region to connect.
-
-	config.aws_region = "ap-northeast-1"
+```ruby
+config.aws_region = "ap-northeast-1"
+```
 
 ### columns
-
 Max number of columns displayed in eclair.
-
-	$ config.columns = 4
-
-### ssh_username 
-
-Function to find username from image.  
-Returns username of given image.  
-Uses image data from [EC2::Client#describe_images](https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_images-instance_method) API call
-
-	config.ssh_username = lambda do |image|
-	  case image.name
-	  when /ubuntu/
-	    "ubuntu"
-	  else
-	    "ec2-user"
-	  end
-	end
+```ruby
+config.columns = 4
+```
+
+### ssh_username
+Function to find username from image. Returns username of given image. Uses
+image data from [EC2::Client#describe_images] API call.
+
+```ruby
+config.ssh_username = lambda do |image|
+  case image.name
+  when /ubuntu/
+    "ubuntu"
+  else
+    "ec2-user"
+  end
+end
+```
 
 ### group_by
-
-Function to find group name from instance.  
-Returns group name from instance data.
-Uses instance data from [EC2::Client#describe_instances](https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_instances-instance_method) API call.
-
-Example)  
-Group by security groups.  
-
-	config.group_by = lambda do |instance|
-	  if instance.security_groups.first
-	    instance.security_groups.first.group_name
-	  else
-	    "no_group"
-	  end
-	end
-
-Group by instance name.
-
-	config.group_by = lambda do |instance|
-	  nametag = instance.tags.find{|t| t.key == "Name"}
-	  return "Noname" unless nametag
-	  case nametag.value
-	  when /^production/
-	    "production servers"
-	  when /^test/
-	    "test servers"
-	  end
-	end
-
-Do not group instances.
-	
-	config.group_by = nil
-
+Function to find group name from instance. Returns group name from instance
+data. Uses instance data from [EC2::Client#describe_instances] API call.
+
+You can group instances by security groups with this config:
+```ruby
+config.group_by = lambda do |instance|
+  if instance.security_groups.first
+    instance.security_groups.first.group_name
+  else
+    "no_group"
+  end
+end
+```
+
+Grouping by instance name is also possible:
+```ruby
+config.group_by = lambda do |instance|
+  case instance.name
+  when /^production/
+    "production servers"
+  when /^test/
+    "test servers"
+  end
+end
+```
+
+You can disable grouping by assigning nil:
+```ruby
+config.group_by = nil
+```
 
 ### ssh_ports
-Port numbers to try ssh.  
-
-	config.ssh_ports = [1234, 22]
-
+Port numbers to try ssh.
+```ruby
+config.ssh_ports = [1234, 22]
+```
 
 ### ssh_options
 Extra options passed to ssh.
-
-	config.ssh_options = "-o ConnectTimeout=1 -o StrictHostKeyChecking=no"
+```ruby
+config.ssh_options = "-o ConnectTimeout=1 -o StrictHostKeyChecking=no"
+```
 
 ### ssh_hostname
-Hostname to use in ssh.  
-Choose from :public_dns_name, :public_ip_address, :private_dns_name, :private_ip_address
-	
-	config.ssh_hostname = :public_ip_address
-
+Hostname to use in ssh. Choose from `:public_dns_name`, `:public_ip_address`,
+`:private_dns_name`, `:private_ip_address`
+```ruby
+config.ssh_hostname = :public_ip_address
+```
 
 ### ssh_keys
-Hash of EC2 keypair name => key_path in local.  
-If your key has been already registered in ssh-agent, you don't have to configure this.
-
-	config.ssh_keys = {
-	  "keypair1" => "/path/to/key1",
-	  "keypair2" => "/path/to/key2",
-	}
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+Hash of EC2 keypair name => key_path in local. If your key has been already
+registered in ssh-agent, you don't have to configure this.
+```ruby
+config.ssh_keys = {
+  "keypair1" => "/path/to/key1",
+  "keypair2" => "/path/to/key2",
+}
+```
+
+License
+--------
+The gem is available as open source under the terms of the [MIT License].
+
+[RubyGems]: https://rubygems.org/gems/ecl
+[RubyGems total downloads]: https://badgen.net/rubygems/dt/ecl
+[A video showing how Eclair works]: out.gif
+[EC2::Client#describe_images]: https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_images-instance_method
+[EC2::Client#describe_instances]: https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_instances-instance_method
+[MIT License]: http://opensource.org/licenses/MIT

data/Rakefile

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"

data/eclair.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -19,11 +20,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
 
-  spec.add_runtime_dependency "aws-sdk", "~> 2"
+  spec.add_runtime_dependency "aws-sdk-ec2", "~> 1.18"
   spec.add_runtime_dependency "curses", "~> 1.0"
-  spec.add_runtime_dependency "pry", "~> 0.10"
   spec.add_runtime_dependency "ruby-string-match-scorer", "~> 0.1"
+  spec.add_runtime_dependency "pry", "~> 0.10"
+  spec.add_runtime_dependency "json", "~> 2.1"
+  spec.add_runtime_dependency "oj", "~> 3.3"
 end

data/exe/ecl

@@ -1,6 +1,64 @@
 #!/usr/bin/env ruby
-require 'eclair'
+# frozen_string_literal: true
 
-Eclair::Console.init
-# Eclair::Grid.assign
-# Eclair::Prompt.run!
+require "eclair"
+require "eclair/grid"
+
+Eclair.init_config
+Curses.init_screen
+Curses.stdscr.timeout = 100
+Curses.stdscr.keypad = true
+Curses.start_color
+Curses.use_default_colors
+Curses.crmode
+Curses.noecho
+Curses.ESCDELAY = 25
+trap("INT") { exit }
+
+if ARGV.empty?
+  grid = Eclair::Grid.new
+else
+  grid = Eclair::Grid.new(ARGV[0])
+end
+
+loop do
+  case grid.mode
+  when :nav, :sel
+    Curses.curs_set(0)
+    case k = Curses.stdscr.getch
+    when Curses::KEY_RESIZE
+      grid.resize
+    when Curses::KEY_LEFT, Curses::KEY_RIGHT, Curses::KEY_UP, Curses::KEY_DOWN, ?h, ?j, ?k, ?l
+      grid.move(k)
+    when " "
+      grid.space
+    when 10 # enter
+      grid.action
+    when "/"
+      grid.start_search
+      grid.clear_search
+    when "!"
+      Curses.close_screen
+      require 'pry'
+      binding.pry
+      exit
+    when ?q
+      exit
+    when 27 # escape
+      grid.clear_search
+    end
+  when :search
+    Curses.curs_set(1)
+    case k = Curses.stdscr.getch
+    when Curses::KEY_RESIZE
+      grid.resize
+    when 10 # enter
+      grid.end_search
+    when 27 # escape
+      grid.clear_search
+      grid.end_search
+    else
+      grid.append_search(k)
+    end
+  end
+end

data/lib/eclair.rb

@@ -1,22 +1,25 @@
+# frozen_string_literal: true
 module Eclair
 end
 
-require "curses"
-require "aws-sdk"
-require "string_scorer"
-require "pry"
-
-require "eclair/helpers/benchmark_helper"
-require "eclair/helpers/common_helper"
-require "eclair/helpers/aws_helper"
-require "eclair/config"
-require "eclair/version"
-require "eclair/less_viewer"
-require "eclair/grid"
-require "eclair/column"
-require "eclair/cell"
-require "eclair/group"
-require "eclair/instance"
-require "eclair/console"
-require "eclair/color"
+require "eclair/providers/ec2"
 
+# require "curses"
+# require "zlib"
+# require "aws-sdk"
+# require "string_scorer"
+# require "pry"
+# require "eclair/item"
+# require "eclair/helpers/benchmark_helper"
+# require "eclair/helpers/common_helper"
+# require "eclair/helpers/aws_helper"
+# require "eclair/config"
+# require "eclair/version"
+# require "eclair/less_viewer"
+# require "eclair/grid"
+# require "eclair/column"
+# require "eclair/cell"
+# require "eclair/group"
+# require "eclair/instance"
+# require "eclair/console"
+# require "eclair/color"

data/lib/eclair/color.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+require 'curses'
+
 module Eclair
   module Color
     extend self