tg_cli 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+notifications:
+  recipients:
+    - wael.nasreddine@gmail.com

data/Gemfile

@@ -0,0 +1,26 @@
+# Sources
+source "http://rubygems.org"
+
+# Parse tg_cli.gemspec
+gemspec
+
+####
+# For development or testing
+###
+
+# Require rbconfig to figure out the target OS
+require 'rbconfig'
+
+platforms :ruby do
+  unless ENV['TRAVIS']
+    if RbConfig::CONFIG['target_os'] =~ /darwin/i
+      gem 'rb-fsevent', :require => false
+      gem 'ruby-growl', :require => false
+      gem 'growl', :require => false
+    end
+    if RbConfig::CONFIG['target_os'] =~ /linux/i
+      gem 'rb-inotify', :require => false
+      gem 'libnotify', :require => false
+    end
+  end
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/.*\.rb$})  { "spec" }
+end

data/README.md

@@ -0,0 +1,70 @@
+# TgCli [![Build Status](http://travis-ci.org/TechnoGate/tg_cli.png)](http://travis-ci.org/TechnoGate/tg_cli) [![Still Maintained](http://stillmaintained.com/TechnoGate/tg_cli.png)](http://stillmaintained.com/TechnoGate/tg_cli)
+
+[![Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com!](http://pledgie.com/campaigns/16123.png?skin_name=chrome)](http://www.pledgie.com/campaigns/16123)
+
+## Introduction
+
+TODO
+
+## Features
+
+TODO
+
+## Getting Started
+
+### Installation
+
+```bash
+$ gem install tg_cli
+```
+
+### Usage
+
+TODO
+
+## Contributing
+
+Please feel free to fork and send pull requests, but please follow the
+following guidelines:
+
+- Prefix each commit message with the filename or the module followed by a
+  colon and a space, for example 'README: fix a typo' or 'Server/Project: Fix
+  a typo'.
+- Include tests.
+- __Do not change the version__, We will take care of that.
+
+## Contact
+
+For bugs and feature request, please use __Github issues__, for other
+requests, you may use:
+
+- [Github private message](https://github.com/inbox/new/eMxyzptlk)
+- Email: [contact@technogate.fr](mailto:contact@technogate.fr)
+
+Don't forget to follow me on [Github](https://github.com/eMxyzptlk) and
+[Twitter](https://twitter.com/eMxyzptlk) for news and updates.
+
+## License
+
+### This code is free to use under the terms of the MIT license.
+
+Copyright (c) 2011 TechnoGate <support@technogate.fr>
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tg_cli/base.rb

@@ -0,0 +1,99 @@
+require 'thor'
+require 'thor/group'
+require 'thor/actions'
+
+module TechnoGate
+  module TgCli
+    # A {Base} is the superclass for all commands which are single
+    # commands, e.g. `vagrant init`, `vagrant up`. Not commands like
+    # `vagrant box add`. For commands which have more subcommands, use
+    # a {GroupBase}.
+    #
+    # A {Base} is a subclass of `Thor::Group`, so view the documentation
+    # there on how to add arguments, descriptions etc. The important note
+    # about this is that when invoked, _all public methods_ will be called
+    # in the order they are defined. If you don't want a method called when
+    # the command is invoked, it must be made `protected` or `private`.
+    #
+    # The best way to get examples of how to create your own command is to
+    # view the various Vagrant commands, which are relatively simple, and
+    # can be found in the Vagrant source tree at `lib/vagrant/command/`.
+    #
+    # # Defining a New Command
+    #
+    # To define a new single command, create a new class which inherits
+    # from this class, then call {register} to register the command. That's
+    # it! When the command is invoked, _all public methods_ will be called.
+    # Below is an example `SayHello` class:
+    #
+    #     class SayHello < Vagrant::Command::Base
+    #       register "hello", "Says hello"
+    #
+    #       def hello
+    #         env.ui.info "Hello"
+    #       end
+    #     end
+    #
+    # In this case, the above class is invokable via `vagrant hello`. To give
+    # this a try, just copy and paste the above into a Vagrantfile somewhere.
+    # The command will be available for that project!
+    #
+    # Also note that the above example uses `env.ui` to output. It is recommended
+    # you use this instead of raw "puts" since it is configurable and provides
+    # additional functionality, such as colors and asking for user input. See
+    # the {UI} class for more information.
+    #
+    # ## Defining Command-line Options
+    #
+    # Most command line actions won't be as simple as `vagrant hello`, and will
+    # probably require parameters or switches. Luckily, Thor makes adding these
+    # easy:
+    #
+    #     class SayHello < Vagrant::Command::Base
+    #       register "hello", "Says hello"
+    #       argument :name, :type => :string
+    #
+    #       def hello
+    #         env.ui.info "Hello, #{name}"
+    #       end
+    #     end
+    #
+    # Then, the above can be invoked with `vagrant hello Mitchell` which would
+    # output "Hello, Mitchell." If instead you're looking for switches, such as
+    # "--name Mitchell", then take a look at `class_option`, an example of which
+    # can be found in the {PackageCommand}.
+    class Base < Thor::Group
+      include Thor::Actions
+
+      # Register the command with the main Vagrant CLI under the
+      # given name. The name will be used for accessing it from the CLI,
+      # so if you name it "lamp", then the command to invoke this
+      # will be `vagrant lamp`.
+      #
+      # The description is used when the help is listed, and is meant to be
+      # a brief (one sentence) description of what the command does.
+      #
+      # Some additional options may be passed in as the last parameter:
+      #
+      # * `:alias` - If given as an array or string, these will be aliases
+      #  for the same command. For example, `vagrant version` is also
+      #  `vagrant --version` and `vagrant -v`
+      #
+      # @param [String] usage
+      # @param [String] description
+      # @param [Hash] opts
+      def self.register(usage, description, opts=nil)
+        desc description
+        Main.register(self, extract_name_from_usage(usage), usage, desc, opts)
+      end
+
+      protected
+
+      # Extracts the name of the command from a usage string. Example:
+      # `init [box_name] [box_url]` becomes just `init`.
+      def self.extract_name_from_usage(usage)
+        /^([-_a-zA-Z0-9]+)(\s+(.+?))?$/.match(usage).to_a[1]
+      end
+    end
+  end
+end

data/lib/tg_cli/group_base.rb

@@ -0,0 +1,100 @@
+require 'thor'
+require 'thor/group'
+require 'thor/actions'
+
+module TechnoGate
+  module TgCli
+    # A {GroupBase} is the superclass which should be used if you're
+    # creating a CLI command which has subcommands such as `vagrant box`,
+    # which has subcommands such as `add`, `remove`, `list`. If you're
+    # creating a simple command which has no subcommands, such as `vagrant up`,
+    # then use {Base} instead.
+    #
+    # Unlike {Base}, where all public methods are executed, in a {GroupBase},
+    # each public method defines a separate task which can be invoked. The best
+    # way to get examples of how to create a {GroupBase} command is to look
+    # at the built-in commands, such as {BoxCommand}.
+    #
+    # # Defining a New Command
+    #
+    # To define a new command with subcommands, create a new class which inherits
+    # from this class, then call {register} to register the command. That's it! When
+    # the command is invoked, the method matching the subcommand is invoked. An
+    # example is shown below:
+    #
+    #     class SayCommand < Vagrant::Command::GroupBase
+    #       register "say", "Say hello or goodbye"
+    #
+    #       desc "hello", "say hello"
+    #       def hello
+    #         env.ui.info "Hello"
+    #       end
+    #
+    #       desc "goodbye", "say goodbye"
+    #       def goodbye
+    #         env.ui.info "Goodbye"
+    #       end
+    #     end
+    #
+    # In this case, the above class is invokable via `vagrant say hello` or
+    # `vagrant say goodbye`. To give it a try yourself, just copy and paste
+    # the above into a Vagrantfile somewhere, and run `vagrant` from within
+    # that directory. You should see the new command!
+    #
+    # Also notice that in the above, each task follows a `desc` call. This
+    # call is used to provide usage and description for each task, and is
+    # required.
+    #
+    # ## Defining Command-line Options
+    #
+    # ### Arguments
+    #
+    # To define arguments to your commands, such as `vagrant say hello mitchell`,
+    # then you simply define them as arguments to the method implementing the
+    # task. An example is shown below (only the method, to keep things brief):
+    #
+    #     def hello(name)
+    #       env.ui.info "Hello, #{name}"
+    #     end
+    #
+    # Then, if `vagrant say hello mitchell` was called, then the output would
+    # be "Hello, mitchell"
+    #
+    # ### Switches or Other Options
+    #
+    # TODO
+    class GroupBase < Thor
+      include Thor::Actions
+
+      # Register the command with the main Vagrant CLI under the given
+      # usage. The usage will be used for accessing it from the CLI,
+      # so if you give it a usage of `lamp [subcommand]`, then the command
+      # to invoke this will be `vagrant lamp` (with a subcommand).
+      #
+      # The description is used when a listing of the commands is given
+      # and is meant to be a brief (one sentence) description of what this
+      # command does.
+      #
+      # Some additional options may be passed in as the last parameter:
+      #
+      # * `:alias` - If given as an array or string, these will be aliases
+      #  for the same command. For example, `vagrant version` is also
+      #  `vagrant --version` and `vagrant -v`
+      #
+      # @param [String] usage
+      # @param [String] description
+      # @param [Hash] opts
+      def self.register(usage, description, opts=nil)
+        @_name = Base.extract_name_from_usage(usage)
+        Main.register(self, @_name, usage, description, opts)
+      end
+
+      protected
+
+      # Override the basename to include the subcommand name.
+      def self.basename
+        "#{super} #{@_name}"
+      end
+    end
+  end
+end

data/lib/tg_cli/main.rb

@@ -0,0 +1,57 @@
+require 'thor'
+
+module TechnoGate
+  module TgCli
+    # Entrypoint for the Vagrant CLI. This class should never be
+    # initialized directly (like a typical Thor class). Instead,
+    # use {Environment#cli} to invoke the CLI.
+    #
+    # # Defining Custom CLI Commands
+    #
+    # If you're looking to define custom CLI commands, then look at
+    # one of the two following classes:
+    #
+    # * {Command::Base} - Implementing a single command such as `vagrant up`, e.g.
+    #   one without subcommands. Also take a look at {Command::NamedBase}.
+    # * {Command::GroupBase} - Implementing a command with subcommands, such as
+    #   `vagrant box`, which has the `list`, `add`, etc. subcommands.
+    #
+    # The above linked classes contain the main documentation for each
+    # type of command.
+    class Main < Thor
+      # Registers the given class with the CLI so it can be accessed.
+      # The class must be a subclass of either {Command::Base} or {Command::GroupBase}.
+      # Don't call this method directly, instead call the {Command::Base.register}
+      # or {Command::GroupBase.register} methods.
+      #
+      # @param [Class] klass Command class
+      # @param [String] name Command name, accessed at `vagrant NAME`
+      # @param [String] usage Command usage, such as "vagrant NAME [--option]"
+      # @param [String] description Description of the command shown during the
+      #   command listing.
+      # @param [Hash] opts Other options (not gone into detail here, look at
+      #   the source instead).
+      def self.register(klass, name, usage, description, opts=nil)
+        opts ||= {}
+
+        if klass <= GroupBase
+          # A subclass of GroupBase is a subcommand, since it contains
+          # many smaller commands within it.
+          desc usage, description, opts
+          subcommand name, klass
+        elsif klass <= Base
+          # A subclass of Base is a single command, since it
+          # is invoked as a whole (as Thor::Group)
+          desc usage, description, opts
+          define_method(name) { |*args| invoke klass, args }
+        end
+
+        if opts[:alias]
+          # Alises are defined for this command, so properly alias the
+          # newly defined method/subcommand:
+          map opts[:alias] => name
+        end
+      end
+    end
+  end
+end

data/lib/tg_cli/version.rb

@@ -0,0 +1,18 @@
+module TechnoGate
+  module TgCli
+    MAJOR = 0
+    MINOR = 0
+    TINY = 1
+    PRE = ''
+
+    def self.version
+      # Init the version
+      version = [MAJOR, MINOR, TINY]
+      # Add the pre if available
+      version << PRE unless PRE.nil? || PRE !~ /\S/
+      # Return the version joined by a dot
+      version.join('.')
+    end
+  end
+end
+

data/lib/tg_cli.rb

@@ -0,0 +1,11 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  require "rubygems"
+  require "bundler/setup"
+end
+
+require "tg_cli/version"
+require "tg_cli/main"
+require "tg_cli/base"
+require "tg_cli/group_base"

data/spec/lib/tg_cli/base_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Base do
+
+  subject { Base }
+
+  context "extracting a name from a usage string" do
+    it "should extract properly" do
+      subject.send(:extract_name_from_usage, "init").should == "init"
+      subject.send(:extract_name_from_usage, "init [foo] [bar]").should == "init"
+      subject.send(:extract_name_from_usage, "init <foo> [bar]").should == "init"
+      subject.send(:extract_name_from_usage, "ssh-config").should == "ssh-config"
+    end
+  end
+end

data/spec/lib/tg_cli/group_base_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe GroupBase do
+
+  subject { GroupBase }
+end

data/spec/lib/tg_cli/main_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Main do
+  subject { Main }
+
+  context "#registering" do
+    it {should respond_to :register }
+
+    it "should register a base command as a single invokable" do
+      base = Class.new(Base)
+      name = "__test_registering_single_subcommand"
+      subject.register(base, name, name, "A description")
+      expect { subject.tasks[name] }.should_not raise_error
+    end
+
+    it "should register a group base as a subcommand" do
+      base = Class.new(GroupBase)
+      name = "_test_registering_single_group"
+      subject.register(base, name, name, "A description")
+      subject.subcommands.should include(name)
+    end
+
+    it "should alias methods if the alias option is given" do
+      base = Class.new(Base) do
+        def execute
+          true
+        end
+      end
+
+      name = "__test_registering_with_alias"
+      subject.register(base, name, name, "A description", :alias => "--ALIAS")
+      subject.start(["--ALIAS"]).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'rspec'
+require 'tg_cli'
+
+include TechnoGate
+include TgCli
+
+RSpec.configure do |config|
+  def config.escaped_path(*parts)
+    Regexp.compile(parts.join('[\\\/]'))
+  end unless config.respond_to? :escaped_path
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  # config.mock_with :rspec
+end
+
+# Include support files.
+Dir["#{File.expand_path('../', __FILE__)}/support/**/*.rb"].each { |f| require f }

data/tg_cli.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tg_cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tg_cli"
+  s.version     = TechnoGate::TgCli.version
+  s.authors     = ["Wael Nasreddine"]
+  s.email       = ["wael.nasreddine@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Helpers around Thor extracted from the Vagrant gem."
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  ####
+  # Run-time dependencies
+  ####
+
+  # Bundler
+  s.add_dependency 'bundler', '~>1.0.0'
+
+  # Thor
+  s.add_dependency 'thor', '~>0.14.6'
+  
+  ####
+  # Development dependencies
+  ####
+
+  # Guard
+  s.add_development_dependency 'guard', '~>0.8.4'
+  s.add_development_dependency 'guard-bundler', '~>0.1.3'
+  s.add_development_dependency 'guard-rspec', '~>0.4.5'
+
+  # Documentation
+  s.add_development_dependency 'yard', '~>0.7.2'
+
+  ####
+  # Development / Test dependencies
+  ####
+
+  # RSpec / Capybara
+  s.add_development_dependency 'rspec', '~>2.6.0'
+
+  # Mocha
+  s.add_development_dependency 'mocha', '~>0.10.0'
+
+  ####
+  # Debugging
+  ####
+  s.add_development_dependency 'pry', '~>0.9.6.2'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: tg_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wael Nasreddine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &16114980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *16114980
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &16502820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *16502820
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &16589840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *16589840
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &16587560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *16587560
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &16585400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :development
+  prerelease: false
+  version_requirements: *16585400
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &16672740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: *16672740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16672140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *16672140
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &16671620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *16671620
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &16670940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *16670940
+description: Helpers around Thor extracted from the Vagrant gem.
+email:
+- wael.nasreddine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/tg_cli.rb
+- lib/tg_cli/base.rb
+- lib/tg_cli/group_base.rb
+- lib/tg_cli/main.rb
+- lib/tg_cli/version.rb
+- spec/lib/tg_cli/base_spec.rb
+- spec/lib/tg_cli/group_base_spec.rb
+- spec/lib/tg_cli/main_spec.rb
+- spec/spec_helper.rb
+- tg_cli.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4598389211369895346
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4598389211369895346
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Helpers around Thor extracted from the Vagrant gem.
+test_files:
+- spec/lib/tg_cli/base_spec.rb
+- spec/lib/tg_cli/group_base_spec.rb
+- spec/lib/tg_cli/main_spec.rb
+- spec/spec_helper.rb
+has_rdoc: