ssh-bookmarks 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4736d62216080452a0274bf8f2ec7a98e0314c9b
-  data.tar.gz: b6877f8e213b81e3e3eaa8985c6a918a6e428b36
+  metadata.gz: b2b6347767933e2244838045d66836f2b9bd3c1a
+  data.tar.gz: 461ea2d7afa7ab57e96a57e694770d8a2be53081
 SHA512:
-  metadata.gz: 5aafbe2827263b199117ee256c0872d6f9911f8c47e97aaa3e4551c378af6bebef4b0f9fb79df519fda5de5440b81fcbb84b5d9369c36fab99227a3b8eeca6aa
-  data.tar.gz: 2b91f4dcbf6147e0a630dd55fce252acc38b44faf5a856eed6f22a3ea191817235485aeb4f7cbe01ce63b4ee989a826f2ea0502e80d02240e1a4eb681b252d27
+  metadata.gz: 26ff52abd3f1eddbd17f5d660c7268d90fd86fb70481d3d9b2e22c7ee3cc7c58a6b2b57812b36ff742ec840112c73031dd3dca03f967377a83aec7d267fccad1
+  data.tar.gz: 5ffe2782c0b75c7a127590233cfca80767f1f8939791e5541e7c3a4ed5476b6a493cd3627d25d2251b63b7908519f71b4fb9194cffb05b1995f777f3013f17e2

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/.travis.yml

@@ -14,5 +14,7 @@ gemfile:
 branches:
     only:
         - master
-
-
+before_install:
+      - gem update --system
+install: "bundle install"
+script: "bundle exec rake spec:unit spec:acceptance features"

data/.yardopts

@@ -0,0 +1 @@
+--private

data/Guardfile

@@ -1,37 +1,31 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'spring', rspec_cli: '--color' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :reek do
   watch(%r{.+\.rb$})
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { 'features' }
-  watch(%r{^features/.+\/step_definitions/(.+)_steps\.rb$}) do |m|
-    Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
-  end
 end
 
-guard :rspec, cmd: 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { 'spec' }
+guard 'yard' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.c})
 end
 
 guard :cucumber do
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { 'features' }
-  watch(%r{^features/.+\/step_definitions/(.+)_steps\.rb$}) do |m|
+  watch(%r{^test/features/.+\.feature$})
+  watch(%r{^test/features/support/.+$})          { 'features' }
+  watch(%r{^test/features/.+\/step_definitions/(.+)_steps\.rb$}) do |m|
     Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
   end
 end
 
-guard :rubocop do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-end
-
-guard :reek do
-  watch(%r{.+\.rb$})
+guard :rspec, cmd: 'bundle exec rspec', cmd_additional_args: '--format progress --color spec', spec_paths: ['test/spec'] do
+  watch(%r{^test/spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/spec/lib/#{m[1]}_spec.rb" }
+  watch('test/spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,13 +1,26 @@
+[![Code Climate](https://codeclimate.com/github/AndreyAntipov/ssh-bookmarks-cli/badges/gpa.svg)](https://codeclimate.com/github/AndreyAntipov/ssh-bookmarks-cli)
+[![Dependency Status](https://gemnasium.com/AndreyAntipov/ssh-bookmarks-cli.svg)](https://gemnasium.com/AndreyAntipov/ssh-bookmarks-cli)
+[![Gem Version](https://badge.fury.io/rb/ssh-bookmarks.svg)](http://badge.fury.io/rb/ssh-bookmarks)
+[![Coverage Status](https://img.shields.io/coveralls/AndreyAntipov/ssh-bookmarks-cli.svg)](https://coveralls.io/r/AndreyAntipov/ssh-bookmarks-cli)
 
-A dead simple cli ssh server list.
 
-## ssh-bookmarks <sub>0.1</sub>
+## ssh-bookmarks
+
+A dead simple cli ssh server list.
 
 
 ## Installation
 
     $ gem install ssh-bookmarks
 
+## Updating
+
+    $ gem update ssh-bookmarks
+
+## Uninstalling
+
+    $ gem uninstall ssh-bookmarks
+
 ## Usage
 
     $ ssh-bookmarks
@@ -32,7 +45,7 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/ssh_bookmarks/fork )
+1. Fork it ( https://github.com/AndreyAntipov/ssh-bookmarks/fork )
 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`)

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new do |t|
+  #task.rspec_opts = Dir.glob("[0-9][0-9][0-9]_*").collect { |x| "-I#{x}" }
+  #task.rspec_opts << '-r ./rspec_config --color -f d'
+  t.pattern = '**/*_spec.rb'
+  t.rspec_opts = ['--default-path', 'test/spec']
+end
+
+task test: :spec

data/bin/ssh-bookmarks

@@ -1,89 +1,19 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
+# resolve dependencies
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
 # dead simple ssh connection manager
 class Application
   require 'highline/import'
-
-  # core methods
-  class Foundation
-    # SSH methods
-    module SSH
-      def self.connect(server)
-        exec "ssh #{server}"
-      end
-    end
-
-    # preparation and setting the configuration file
-    class Config
-      PATH = "#{ENV['HOME']}/.ssh/config"
-      OPTIONS = %w(hidden)
-
-      # parse configuration file
-      def initialize
-        # load ssh config
-        new = File.readlines(PATH).map(&:split)
-        @data = construct new
-      rescue => err
-        abort "Error: config is invalid.\nReason: #{err}"
-      end
-
-      def construct(raw)
-        container = []
-        raw.each_with_index do |block, index|
-          next if block.empty? || comment?(block)
-          if block[0] == 'Host'
-            container << {}
-            container.last.merge!(options: options(raw, index))
-          end
-          container.last.merge!(block[0].downcase.to_sym => block[1]) if defined? container
-        end
-        container
-      end
-
-      # parse inline options passed in comments of specific block
-      def options(raw, index)
-        @prev_index = 0 unless defined? @prev_index
-        options = {}
-        index += 1 if index > 0
-        # catch options between range
-        raw[@prev_index..index].each do |opt|
-          if comment?(opt) && option?(opt)
-            options.merge!(opt[1].downcase.to_sym => true)
-          end
-        end
-        @prev_index = index
-        options
-      end
-
-      def option?(block)
-        OPTIONS.include?(block[1])
-      end
-
-      # block is comment?
-      def comment?(block)
-        true if block[0] == '#'
-      end
-
-      # determine if config exist
-      def exist?
-        # ssh configuration file
-        if File.exist?(PATH)
-          return true
-        else
-          abort "Error: no configuration file is found.\nExpected path: #{path}"
-        end
-      end
-
-      attr_reader :data
-      private :exist?, :comment?, :option?, :construct, :options
-    end
-  end
+  require 'ssh/bookmarks'
 
   # CLI interface for SSH manager
-  class Interface < Foundation
+  class Interface
     def initialize
-      config = Config.new
+      config = SSH::Bookmarks::Config.new
       show_menu config.data, 'host'
 
       # ignore errors when use ctrl-c or ctrl-d
@@ -91,6 +21,9 @@ class Application
       puts "\nexiting..."
     end
 
+    # show menu
+    # @param list [Array] all paramerers from config
+    # @param title [String] determine which parameter will be used for title
     def show_menu(list, title)
       t = title.to_sym
       proposal = 'Please choose the server which you would like to connect?'

data/lib/ssh/bookmarks.rb

@@ -0,0 +1,89 @@
+require 'ssh/bookmarks/version'
+
+module SSH
+  # Initialize ssh connection
+  # @param server [String] name of server
+  def self.connect(server)
+    exec "ssh #{server}"
+  end
+
+  module Bookmarks
+    # This class handle the configuration file
+    class Config
+      # Constant which stored path of ssh config file
+      PATH = "#{ENV['HOME']}/.ssh/config"
+      # Constant which stored of array custom options of ssh config
+      OPTIONS = %w(hidden)
+
+      # load and initialize parsing configuration file
+      def initialize
+        new = File.readlines(PATH).map(&:split)
+        @data = construct new
+      rescue => err
+        abort "Error: config is invalid.\nReason: #{err}"
+      end
+
+      # Parse and build configuration
+      # @param raw [Array] original data ssh config file
+      # @return [Hash] container of parsed config
+      def construct(raw)
+        container = []
+        raw.each_with_index do |block, index|
+          next if block.empty? || comment?(block)
+          if block[0] == 'Host'
+            container << {}
+            container.last.merge!(options: options(raw, index))
+          end
+          container.last.merge!(block[0].downcase.to_sym => block[1]) if defined? container
+        end
+        container
+      end
+
+      # Parse options placed in comments which allowed in OPTIONS constant
+      # @param raw [Array] original data of ssh config file
+      # @param index [Integer] index which used for definition of membership of comments
+      # @return [Array] list of options for specific group which is found in specific range
+      def options(raw, index)
+        @prev_index = 0 unless defined? @prev_index
+        options = {}
+        index += 1 if index > 0
+        # catch options between range
+        raw[@prev_index..index].each do |opt|
+          if comment?(opt) && option?(opt)
+            options.merge!(opt[1].downcase.to_sym => true)
+          end
+        end
+        @prev_index = index
+        options
+      end
+
+      # Determine whether the block in the list of allowed
+      # @param block [String] the testable string 
+      # @return [Boolean] returns the current state of block 
+      def option?(block)
+        OPTIONS.include?(block[1])
+      end
+
+      # Determine whether the block is comment?
+      # @param block [String] the testable string
+      # @return [Boolean] return current state of block
+      def comment?(block)
+        block[0] == '#' ? true : false
+      end
+
+      # Determine whether the config is exist
+      # @return [Boolean] return true if config exist or abort the process
+      def exist?
+        # ssh configuration file
+        if File.exist?(PATH)
+          return true
+        else
+          abort "Error: no configuration file is found.\nExpected path: #{path}"
+        end
+      end
+
+      attr_reader :data
+      private :exist?, :comment?, :option?, :construct, :options
+    end
+  end
+end

data/lib/ssh/bookmarks/version.rb

@@ -0,0 +1,5 @@
+module SSH
+  module Bookmarks
+    VERSION = '0.0.4'
+  end
+end

data/ssh-bookmarks.gemspec

@@ -1,54 +1,58 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ssh-bookmarks/version'
+require 'ssh/bookmarks/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ssh-bookmarks"
-  spec.version       = SshBookmarks::VERSION
+  spec.version       = SSH::Bookmarks::VERSION
   spec.authors       = ["Andrey Antipov"]
   spec.email         = ["andrey@antipov.me"]
   spec.summary       = %q{A dead simple cli ssh server list.}
-  #spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = "https://github.com/AndreyAntipov/ssh-bookmarks"
+  spec.homepage      = 'https://github.com/AndreyAntipov/ssh-bookmarks'
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  
-  # cli interface dependency
-  spec.add_runtime_dependency "highline"
 
-  # dependencies
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  # docs
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "inch"
+    # cli interface dependency
+  spec.add_runtime_dependency 'highline'
+
+    # docs
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'inch'
 
   # preloader
-  spec.add_development_dependency "spring"
+  # TODO: replace spring to something else
+  # spec.add_development_dependency 'spring'
 
   # irb
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "hirb"
-  
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'hirb'
+
   # tests
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-expectations"
-  spec.add_development_dependency "fuubar"
-  
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-expectations'
+  spec.add_development_dependency 'fuubar'
+
   # automation
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rubocop"
-  spec.add_development_dependency "guard-cucumber"
-  spec.add_development_dependency "guard-spring"
-  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-inch'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'guard-yard'
+  spec.add_development_dependency 'guard-reek'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-cucumber'
+  spec.add_development_dependency 'guard-bundler'
 
 end

data/test/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'ssh/bookmarks' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/test/spec/ssh/bookmarks_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../spec_helper'
+
+describe SSH::Bookmarks::Config do
+    it "should return the config file" do
+      config = SSH::Bookmarks::Config.new
+      config.data.should be_kind_of(Array)
+    end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ssh-bookmarks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrey Antipov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: highline
-  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
@@ -53,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-inch
+  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: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -235,7 +263,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-cucumber
+  name: guard-yard
+  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: guard-reek
+  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: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -249,7 +305,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-spring
+  name: guard-cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -286,20 +342,21 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/ssh-bookmarks
+- config/application.rb
 - config/spring.rb
-- lib/ssh-bookmarks.rb
-- lib/ssh-bookmarks/version.rb
+- lib/ssh/bookmarks.rb
+- lib/ssh/bookmarks/version.rb
 - ssh-bookmarks.gemspec
-- test/.keep
-- test/features/.keep
-- test/rspec/.keep
-- test/test_ssh-bookmarks.rb
+- test/features/config.feature
+- test/spec/spec_helper.rb
+- test/spec/ssh/bookmarks_spec.rb
 homepage: https://github.com/AndreyAntipov/ssh-bookmarks
 licenses:
 - MIT
@@ -325,8 +382,7 @@ signing_key:
 specification_version: 4
 summary: A dead simple cli ssh server list.
 test_files:
-- test/.keep
-- test/features/.keep
-- test/rspec/.keep
-- test/test_ssh-bookmarks.rb
+- test/features/config.feature
+- test/spec/spec_helper.rb
+- test/spec/ssh/bookmarks_spec.rb
 has_rdoc: 

data/lib/ssh-bookmarks.rb

@@ -1,5 +0,0 @@
-require "ssh_bookmarks/version"
-
-module SshBookmarks
-  # Your code goes here...
-end

data/lib/ssh-bookmarks/version.rb

@@ -1,3 +0,0 @@
-module SshBookmarks
-  VERSION = "0.0.3"
-end