shell_explain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 789021ab7ef1c9774f14cd4086d8717203c928f5
+  data.tar.gz: dcfa98c2c4041a27f848f6e6a2507d28061815bb
+SHA512:
+  metadata.gz: 06143aef944b496f2e64d680c810492c2dfd0e5d1ee9fafb9e8d196e342529318d386f08a175d072cd4cd33cb5c18d387aa7be14fa586de0c4bd074cceecb0f8
+  data.tar.gz: a848e24f79783397b1f4152820de93601dc7b34ef7f1994c751b0bb927eecc6294d9a2d37d722ad161086a379605506a87f9981e0930dfa8b2d611d3e8234ec4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 blackanger
+
+MIT License
+
+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,45 @@
+# ShellExplain
+
+  **Explain shell input from your command line.**
+
+  Thanks http://explainshell.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shell_explain'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shell_explain
+
+## Usage
+
+```sh
+$ explain "true && { echo success; } || { echo failed; }"
+$ explain "find . -type f -print0"
+$ explain "ssh -i keyfile -f -N -L 1234:www.google.com:80 host"
+$ explain "lsof -c python -u user"
+$ explain "mysql -u root -p -h 192.168.1.2"
+$ explain "iptables -A INPUT -i eth0 -s ip-to-block -j DROP"
+$ explain "git log --graph --abbrev-commit --pretty=oneline origin..mybranch"
+```
+
+## Screenshots
+
+![alt tag](https://github.com/ZhangHanDong/shell_explain/public/img/explain_shell1.png)
+![alt tag](https://github.com/ZhangHanDong/shell_explain/public/img/explain_shell2.png)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/explain

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+require 'shell_explain'
+require 'ansi/core'
+require 'ansi/progressbar'
+
+# example:
+# $ explain "cut -d ' ' -f 1 /var/log/apache2/access_logs | uniq -c | sort -n"
+
+# get cmd
+@cmd = ARGV[0]
+
+#progress bar
+pbar = ANSI::Progressbar.new("Test Bar", 100)
+
+def run(pbar)
+  puts "get explain data".ansi(:green)
+  pbar.inc
+  doc = ShellExplain::Site.get_data(@cmd)
+  #commands format: {command: help-num}
+  @commands = ShellExplain::Site.get_command(doc)
+  @explains = ShellExplain::Site.get_explain(doc)
+
+  combination = @commands.values.zip(@explains)
+
+  @results = combination.inject({}) do|h, node|
+    h[node[0]] = node[1] unless h.has_key?(node[0])
+    h
+  end
+
+  pbar.finish
+end
+
+pbar.transfer_mode
+run(pbar)
+puts ("+"*20)+"Explain Shell"+("+"*20)
+
+# input results
+# puts "--results: #{@results.inspect}"
+
+puts "invalid command".ansi(:red) if @results.empty?
+@results.each do |re|
+
+	cmd_name = @commands.each_pair do|pair|
+    puts pair[0].ansi(:red) if pair.include?(re[0])
+	end
+
+	puts re[1].ansi(:yellow)
+	puts ("+"*50).ansi(:green)
+end
+
+

data/lib/shell_explain/version.rb

@@ -0,0 +1,3 @@
+module ShellExplain
+  VERSION = "0.0.1"
+end

data/lib/shell_explain.rb

@@ -0,0 +1,34 @@
+require "shell_explain/version"
+require 'net/http'
+require 'nokogiri'
+require 'cgi'
+
+module ShellExplain
+  class Site
+
+    class << self
+     def get_data(cmd)
+     	 explain_shell_url = "http://explainshell.com/explain?cmd="
+    	 uri = URI("#{explain_shell_url}#{CGI.escape(cmd)}")
+    	 html = Net::HTTP.get_response(uri).body
+    	 Nokogiri::HTML(html)
+     end
+
+     #{command: help-num}
+     def get_command(doc)
+       doc.xpath("//span[@helpref]").inject({}) do|cmds, node|
+         cmds[node.text] = node.attributes["helpref"].value
+         cmds
+       end
+     end
+
+     def get_explain(doc)
+       data = doc.xpath("//table[@id='help']//pre").inject([]) do|exps, node|
+         exps << node.children.text
+       end
+       data
+      end
+    end
+
+  end
+end

data/shell_explain.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shell_explain/version'
+
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = "shell_explain"
+  spec.version       = ShellExplain::VERSION
+  spec.authors       = ["blackanger"]
+  spec.email         = ["blackanger.z@gmail.com"]
+  spec.description   = %q{explainshell.com input from terminal}
+  spec.summary       = %q{explainshell.com for terminal}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ansi"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: shell_explain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- blackanger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: explainshell.com input from terminal
+email:
+- blackanger.z@gmail.com
+executables:
+- explain
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/explain
+- lib/shell_explain.rb
+- lib/shell_explain/version.rb
+- public/.DS_Store
+- public/img/.DS_Store
+- public/img/explain_shell1.png
+- public/img/explain_shell2.png
+- shell_explain.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.0.6
+signing_key: 
+specification_version: 4
+summary: explainshell.com for terminal
+test_files: []