gitsync 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.rvmrc +1 -0
- data/Gemfile +13 -0
- data/Gemfile.lock +20 -0
- data/LICENSE.txt +20 -0
- data/Manifest +6 -0
- data/README.rdoc +19 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/bin/autosync +41 -0
- data/bin/gitsync +65 -0
- data/gitsync.gemspec +68 -0
- data/lib/gitsync.rb +0 -0
- data/lib/trollop.rb +782 -0
- data/test/helper.rb +18 -0
- data/test/test_gitsync.rb +7 -0
- metadata +119 -0
data/.rvmrc
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
rvm use --create 1.9.2@rails3
|
data/Gemfile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
source "http://rubygems.org"
|
2
|
+
# Add dependencies required to use your gem here.
|
3
|
+
# Example:
|
4
|
+
# gem "activesupport", ">= 2.3.5"
|
5
|
+
|
6
|
+
# Add dependencies to develop your gem here.
|
7
|
+
# Include everything needed to run rake, tests, features, etc.
|
8
|
+
group :development do
|
9
|
+
gem "shoulda", ">= 0"
|
10
|
+
gem "bundler", "~> 1.0.0"
|
11
|
+
gem "jeweler", "~> 1.5.2"
|
12
|
+
gem "rcov", ">= 0"
|
13
|
+
end
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
GEM
|
2
|
+
remote: http://rubygems.org/
|
3
|
+
specs:
|
4
|
+
git (1.2.5)
|
5
|
+
jeweler (1.5.2)
|
6
|
+
bundler (~> 1.0.0)
|
7
|
+
git (>= 1.2.5)
|
8
|
+
rake
|
9
|
+
rake (0.8.7)
|
10
|
+
rcov (0.9.9)
|
11
|
+
shoulda (2.11.3)
|
12
|
+
|
13
|
+
PLATFORMS
|
14
|
+
ruby
|
15
|
+
|
16
|
+
DEPENDENCIES
|
17
|
+
bundler (~> 1.0.0)
|
18
|
+
jeweler (~> 1.5.2)
|
19
|
+
rcov
|
20
|
+
shoulda
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2011 Nic Haynes
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/Manifest
ADDED
data/README.rdoc
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
= gitsync
|
2
|
+
|
3
|
+
Gitsync will watch a directory for changes then automatically commit any changed files.
|
4
|
+
|
5
|
+
== Contributing to gitsync
|
6
|
+
|
7
|
+
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
|
8
|
+
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
|
9
|
+
* Fork the project
|
10
|
+
* Start a feature/bugfix branch
|
11
|
+
* Commit and push until you are happy with your contribution
|
12
|
+
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
|
13
|
+
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
|
14
|
+
|
15
|
+
== Copyright
|
16
|
+
|
17
|
+
Copyright (c) 2011 Nic Haynes. See LICENSE.txt for
|
18
|
+
further details.
|
19
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'bundler'
|
3
|
+
begin
|
4
|
+
Bundler.setup(:default, :development)
|
5
|
+
rescue Bundler::BundlerError => e
|
6
|
+
$stderr.puts e.message
|
7
|
+
$stderr.puts "Run `bundle install` to install missing gems"
|
8
|
+
exit e.status_code
|
9
|
+
end
|
10
|
+
require 'rake'
|
11
|
+
|
12
|
+
require 'jeweler'
|
13
|
+
Jeweler::Tasks.new do |gem|
|
14
|
+
# gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
|
15
|
+
gem.name = "gitsync"
|
16
|
+
gem.homepage = "http://github.com/nicinabox/gitsync"
|
17
|
+
gem.license = "MIT"
|
18
|
+
gem.summary = %Q{Autosync watched directories in git}
|
19
|
+
gem.description = %Q{Autosync watched directories in git}
|
20
|
+
gem.email = "nic@nicinabox.com"
|
21
|
+
gem.authors = ["Nic Haynes"]
|
22
|
+
# Include your dependencies below. Runtime dependencies are required when using your gem,
|
23
|
+
# and development dependencies are only needed for development (ie running rake tasks, tests, etc)
|
24
|
+
# gem.add_runtime_dependency 'jabber4r', '> 0.1'
|
25
|
+
# gem.add_development_dependency 'rspec', '> 1.2.3'
|
26
|
+
end
|
27
|
+
Jeweler::RubygemsDotOrgTasks.new
|
28
|
+
|
29
|
+
require 'rake/testtask'
|
30
|
+
Rake::TestTask.new(:test) do |test|
|
31
|
+
test.libs << 'lib' << 'test'
|
32
|
+
test.pattern = 'test/**/test_*.rb'
|
33
|
+
test.verbose = true
|
34
|
+
end
|
35
|
+
|
36
|
+
require 'rcov/rcovtask'
|
37
|
+
Rcov::RcovTask.new do |test|
|
38
|
+
test.libs << 'test'
|
39
|
+
test.pattern = 'test/**/test_*.rb'
|
40
|
+
test.verbose = true
|
41
|
+
end
|
42
|
+
|
43
|
+
task :default => :test
|
44
|
+
|
45
|
+
require 'rake/rdoctask'
|
46
|
+
Rake::RDocTask.new do |rdoc|
|
47
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
48
|
+
|
49
|
+
rdoc.rdoc_dir = 'rdoc'
|
50
|
+
rdoc.title = "gitsync #{version}"
|
51
|
+
rdoc.rdoc_files.include('README*')
|
52
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
53
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.2.0
|
data/bin/autosync
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'trollop'
|
3
|
+
|
4
|
+
# Setup options
|
5
|
+
opts = Trollop::options do
|
6
|
+
opt :dir, "Directory to watch", :type => String, :required => true
|
7
|
+
opt :verbose, "Show verbose output", :default => false
|
8
|
+
opt :frequency, "Frequency to run", :default => 10
|
9
|
+
end
|
10
|
+
|
11
|
+
puts "Git sync started..." if opts[:verbose]
|
12
|
+
|
13
|
+
dir = opts[:dir]
|
14
|
+
|
15
|
+
while true
|
16
|
+
curr = %x(du -s #{dir} | awk '{print $1}').chomp
|
17
|
+
prev = curr
|
18
|
+
|
19
|
+
while curr == prev
|
20
|
+
#puts "No change, waiting #{opts[:frequency]} seconds" if opts[:verbose]
|
21
|
+
sleep opts[:frequency].to_i
|
22
|
+
curr = %x(du -s #{dir} | awk '{print $1}').chomp
|
23
|
+
end
|
24
|
+
|
25
|
+
sleep 1
|
26
|
+
orig = %x(du -s #{dir} | awk '{print $1}').chomp
|
27
|
+
while curr != orig
|
28
|
+
orig = %x(du -s #{dir} | awk '{print $1}').chomp
|
29
|
+
puts "File being written. Waiting..." if opts[:verbose]
|
30
|
+
sleep 4
|
31
|
+
curr = %x(du -s #{dir} | awk '{print $1}').chomp
|
32
|
+
end
|
33
|
+
|
34
|
+
puts "Adding files..." if opts[:verbose]
|
35
|
+
msg = `cd #{dir} && git status --porcelain`
|
36
|
+
%x(cd #{dir} && git add -A)
|
37
|
+
%x(cd #{dir} && git commit -qm "#{msg}")
|
38
|
+
|
39
|
+
puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} Committed" if opts[:verbose]
|
40
|
+
puts "Watching for change..." if opts[:verbose]
|
41
|
+
end
|
data/bin/gitsync
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require 'trollop'
|
3
|
+
|
4
|
+
# Setup options
|
5
|
+
opts = Trollop::options do
|
6
|
+
opt :dir, "Directory to watch", :type => String, :required => true
|
7
|
+
opt :debug, "Show debug output", :default => false
|
8
|
+
opt :interactive, "Interactive", :default => false
|
9
|
+
opt :pull, "git pull", :default => false
|
10
|
+
end
|
11
|
+
|
12
|
+
puts "Git sync started..." if opts[:debug]
|
13
|
+
|
14
|
+
dir = opts[:dir]
|
15
|
+
|
16
|
+
# Current status
|
17
|
+
go = "cd #{dir} &&"
|
18
|
+
status = %x(#{go} git status --porcelain).split("\n")
|
19
|
+
untracked = %x(#{go} git ls-files -o -X .gitignore).split("\n")
|
20
|
+
|
21
|
+
if opts[:pull]
|
22
|
+
output = %x(#{go} git pull)
|
23
|
+
puts output
|
24
|
+
exit
|
25
|
+
end
|
26
|
+
|
27
|
+
|
28
|
+
# Current working size
|
29
|
+
orig_size = %x(du -s #{dir} | awk '{print $1}').chomp
|
30
|
+
|
31
|
+
# Write protection
|
32
|
+
sleep 1
|
33
|
+
curr_size = %x(du -s #{dir} | awk '{print $1}').chomp
|
34
|
+
while curr_size != orig_size
|
35
|
+
orig = %x(du -s #{dir} | awk '{print $1}').chomp
|
36
|
+
puts "Might be writing: orig: #{orig_size}, curr: #{curr_size}" if opts[:debug]
|
37
|
+
sleep 3
|
38
|
+
curr_size = %x(du -s #{dir} | awk '{print $1}').chomp
|
39
|
+
end
|
40
|
+
|
41
|
+
# Git
|
42
|
+
unless status.empty?
|
43
|
+
# Add all files
|
44
|
+
if opts[:interactive]
|
45
|
+
print "\nAdd these files to staging?\n#{status.join("\n")}?\n[yn] "
|
46
|
+
response = $stdin.gets.chomp
|
47
|
+
exit if response == "n"
|
48
|
+
end
|
49
|
+
%x(cd #{dir} && git add -A)
|
50
|
+
|
51
|
+
# Check to see what's been staged
|
52
|
+
staged = %x(#{go} git ls-files).split("\n")
|
53
|
+
porcelain = %x(#{go} git status --porcelain).split("\n")
|
54
|
+
|
55
|
+
# Commit!
|
56
|
+
if opts[:interactive]
|
57
|
+
print "\nCommit #{s = staged.join(", ")}? [yn] "
|
58
|
+
response == $stdin.gets.chomp
|
59
|
+
exit if response == "n"
|
60
|
+
end
|
61
|
+
%x(cd #{dir} && git commit -qm "#{porcelain.join("\n")}")
|
62
|
+
puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")} #{staged.join(", ")}" if opts[:debug]
|
63
|
+
else
|
64
|
+
puts "Nothing to commit." if opts[:debug]
|
65
|
+
end
|
data/gitsync.gemspec
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{gitsync}
|
8
|
+
s.version = "0.2.0"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Nic Haynes"]
|
12
|
+
s.date = %q{2011-02-13}
|
13
|
+
s.description = %q{Autosync watched directories in git}
|
14
|
+
s.email = %q{nic@nicinabox.com}
|
15
|
+
s.executables = ["autosync", "gitsync"]
|
16
|
+
s.extra_rdoc_files = [
|
17
|
+
"LICENSE.txt",
|
18
|
+
"README.rdoc"
|
19
|
+
]
|
20
|
+
s.files = [
|
21
|
+
".rvmrc",
|
22
|
+
"Gemfile",
|
23
|
+
"Gemfile.lock",
|
24
|
+
"LICENSE.txt",
|
25
|
+
"Manifest",
|
26
|
+
"README.rdoc",
|
27
|
+
"Rakefile",
|
28
|
+
"VERSION",
|
29
|
+
"bin/autosync",
|
30
|
+
"bin/gitsync",
|
31
|
+
"gitsync.gemspec",
|
32
|
+
"lib/gitsync.rb",
|
33
|
+
"lib/trollop.rb",
|
34
|
+
"test/helper.rb",
|
35
|
+
"test/test_gitsync.rb"
|
36
|
+
]
|
37
|
+
s.homepage = %q{http://github.com/nicinabox/gitsync}
|
38
|
+
s.licenses = ["MIT"]
|
39
|
+
s.require_paths = ["lib"]
|
40
|
+
s.rubygems_version = %q{1.5.0}
|
41
|
+
s.summary = %q{Autosync watched directories in git}
|
42
|
+
s.test_files = [
|
43
|
+
"test/helper.rb",
|
44
|
+
"test/test_gitsync.rb"
|
45
|
+
]
|
46
|
+
|
47
|
+
if s.respond_to? :specification_version then
|
48
|
+
s.specification_version = 3
|
49
|
+
|
50
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
51
|
+
s.add_development_dependency(%q<shoulda>, [">= 0"])
|
52
|
+
s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
|
53
|
+
s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
|
54
|
+
s.add_development_dependency(%q<rcov>, [">= 0"])
|
55
|
+
else
|
56
|
+
s.add_dependency(%q<shoulda>, [">= 0"])
|
57
|
+
s.add_dependency(%q<bundler>, ["~> 1.0.0"])
|
58
|
+
s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
|
59
|
+
s.add_dependency(%q<rcov>, [">= 0"])
|
60
|
+
end
|
61
|
+
else
|
62
|
+
s.add_dependency(%q<shoulda>, [">= 0"])
|
63
|
+
s.add_dependency(%q<bundler>, ["~> 1.0.0"])
|
64
|
+
s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
|
65
|
+
s.add_dependency(%q<rcov>, [">= 0"])
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
data/lib/gitsync.rb
ADDED
File without changes
|
data/lib/trollop.rb
ADDED
@@ -0,0 +1,782 @@
|
|
1
|
+
## lib/trollop.rb -- trollop command-line processing library
|
2
|
+
## Author:: William Morgan (mailto: wmorgan-trollop@masanjin.net)
|
3
|
+
## Copyright:: Copyright 2007 William Morgan
|
4
|
+
## License:: the same terms as ruby itself
|
5
|
+
|
6
|
+
require 'date'
|
7
|
+
|
8
|
+
module Trollop
|
9
|
+
|
10
|
+
VERSION = "1.16.2"
|
11
|
+
|
12
|
+
## Thrown by Parser in the event of a commandline error. Not needed if
|
13
|
+
## you're using the Trollop::options entry.
|
14
|
+
class CommandlineError < StandardError; end
|
15
|
+
|
16
|
+
## Thrown by Parser if the user passes in '-h' or '--help'. Handled
|
17
|
+
## automatically by Trollop#options.
|
18
|
+
class HelpNeeded < StandardError; end
|
19
|
+
|
20
|
+
## Thrown by Parser if the user passes in '-h' or '--version'. Handled
|
21
|
+
## automatically by Trollop#options.
|
22
|
+
class VersionNeeded < StandardError; end
|
23
|
+
|
24
|
+
## Regex for floating point numbers
|
25
|
+
FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))([eE][-+]?[\d]+)?$/
|
26
|
+
|
27
|
+
## Regex for parameters
|
28
|
+
PARAM_RE = /^-(-|\.$|[^\d\.])/
|
29
|
+
|
30
|
+
## The commandline parser. In typical usage, the methods in this class
|
31
|
+
## will be handled internally by Trollop::options. In this case, only the
|
32
|
+
## #opt, #banner and #version, #depends, and #conflicts methods will
|
33
|
+
## typically be called.
|
34
|
+
##
|
35
|
+
## If you want to instantiate this class yourself (for more complicated
|
36
|
+
## argument-parsing logic), call #parse to actually produce the output hash,
|
37
|
+
## and consider calling it from within
|
38
|
+
## Trollop::with_standard_exception_handling.
|
39
|
+
class Parser
|
40
|
+
|
41
|
+
## The set of values that indicate a flag option when passed as the
|
42
|
+
## +:type+ parameter of #opt.
|
43
|
+
FLAG_TYPES = [:flag, :bool, :boolean]
|
44
|
+
|
45
|
+
## The set of values that indicate a single-parameter (normal) option when
|
46
|
+
## passed as the +:type+ parameter of #opt.
|
47
|
+
##
|
48
|
+
## A value of +io+ corresponds to a readable IO resource, including
|
49
|
+
## a filename, URI, or the strings 'stdin' or '-'.
|
50
|
+
SINGLE_ARG_TYPES = [:int, :integer, :string, :double, :float, :io, :date]
|
51
|
+
|
52
|
+
## The set of values that indicate a multiple-parameter option (i.e., that
|
53
|
+
## takes multiple space-separated values on the commandline) when passed as
|
54
|
+
## the +:type+ parameter of #opt.
|
55
|
+
MULTI_ARG_TYPES = [:ints, :integers, :strings, :doubles, :floats, :ios, :dates]
|
56
|
+
|
57
|
+
## The complete set of legal values for the +:type+ parameter of #opt.
|
58
|
+
TYPES = FLAG_TYPES + SINGLE_ARG_TYPES + MULTI_ARG_TYPES
|
59
|
+
|
60
|
+
INVALID_SHORT_ARG_REGEX = /[\d-]/ #:nodoc:
|
61
|
+
|
62
|
+
## The values from the commandline that were not interpreted by #parse.
|
63
|
+
attr_reader :leftovers
|
64
|
+
|
65
|
+
## The complete configuration hashes for each option. (Mainly useful
|
66
|
+
## for testing.)
|
67
|
+
attr_reader :specs
|
68
|
+
|
69
|
+
## Initializes the parser, and instance-evaluates any block given.
|
70
|
+
def initialize *a, &b
|
71
|
+
@version = nil
|
72
|
+
@leftovers = []
|
73
|
+
@specs = {}
|
74
|
+
@long = {}
|
75
|
+
@short = {}
|
76
|
+
@order = []
|
77
|
+
@constraints = []
|
78
|
+
@stop_words = []
|
79
|
+
@stop_on_unknown = false
|
80
|
+
|
81
|
+
#instance_eval(&b) if b # can't take arguments
|
82
|
+
cloaker(&b).bind(self).call(*a) if b
|
83
|
+
end
|
84
|
+
|
85
|
+
## Define an option. +name+ is the option name, a unique identifier
|
86
|
+
## for the option that you will use internally, which should be a
|
87
|
+
## symbol or a string. +desc+ is a string description which will be
|
88
|
+
## displayed in help messages.
|
89
|
+
##
|
90
|
+
## Takes the following optional arguments:
|
91
|
+
##
|
92
|
+
## [+:long+] Specify the long form of the argument, i.e. the form with two dashes. If unspecified, will be automatically derived based on the argument name by turning the +name+ option into a string, and replacing any _'s by -'s.
|
93
|
+
## [+:short+] Specify the short form of the argument, i.e. the form with one dash. If unspecified, will be automatically derived from +name+.
|
94
|
+
## [+:type+] Require that the argument take a parameter or parameters of type +type+. For a single parameter, the value can be a member of +SINGLE_ARG_TYPES+, or a corresponding Ruby class (e.g. +Integer+ for +:int+). For multiple-argument parameters, the value can be any member of +MULTI_ARG_TYPES+ constant. If unset, the default argument type is +:flag+, meaning that the argument does not take a parameter. The specification of +:type+ is not necessary if a +:default+ is given.
|
95
|
+
## [+:default+] Set the default value for an argument. Without a default value, the hash returned by #parse (and thus Trollop::options) will have a +nil+ value for this key unless the argument is given on the commandline. The argument type is derived automatically from the class of the default value given, so specifying a +:type+ is not necessary if a +:default+ is given. (But see below for an important caveat when +:multi+: is specified too.) If the argument is a flag, and the default is set to +true+, then if it is specified on the the commandline the value will be +false+.
|
96
|
+
## [+:required+] If set to +true+, the argument must be provided on the commandline.
|
97
|
+
## [+:multi+] If set to +true+, allows multiple occurrences of the option on the commandline. Otherwise, only a single instance of the option is allowed. (Note that this is different from taking multiple parameters. See below.)
|
98
|
+
##
|
99
|
+
## Note that there are two types of argument multiplicity: an argument
|
100
|
+
## can take multiple values, e.g. "--arg 1 2 3". An argument can also
|
101
|
+
## be allowed to occur multiple times, e.g. "--arg 1 --arg 2".
|
102
|
+
##
|
103
|
+
## Arguments that take multiple values should have a +:type+ parameter
|
104
|
+
## drawn from +MULTI_ARG_TYPES+ (e.g. +:strings+), or a +:default:+
|
105
|
+
## value of an array of the correct type (e.g. [String]). The
|
106
|
+
## value of this argument will be an array of the parameters on the
|
107
|
+
## commandline.
|
108
|
+
##
|
109
|
+
## Arguments that can occur multiple times should be marked with
|
110
|
+
## +:multi+ => +true+. The value of this argument will also be an array.
|
111
|
+
## In contrast with regular non-multi options, if not specified on
|
112
|
+
## the commandline, the default value will be [], not nil.
|
113
|
+
##
|
114
|
+
## These two attributes can be combined (e.g. +:type+ => +:strings+,
|
115
|
+
## +:multi+ => +true+), in which case the value of the argument will be
|
116
|
+
## an array of arrays.
|
117
|
+
##
|
118
|
+
## There's one ambiguous case to be aware of: when +:multi+: is true and a
|
119
|
+
## +:default+ is set to an array (of something), it's ambiguous whether this
|
120
|
+
## is a multi-value argument as well as a multi-occurrence argument.
|
121
|
+
## In thise case, Trollop assumes that it's not a multi-value argument.
|
122
|
+
## If you want a multi-value, multi-occurrence argument with a default
|
123
|
+
## value, you must specify +:type+ as well.
|
124
|
+
|
125
|
+
def opt name, desc="", opts={}
|
126
|
+
raise ArgumentError, "you already have an argument named '#{name}'" if @specs.member? name
|
127
|
+
|
128
|
+
## fill in :type
|
129
|
+
opts[:type] = # normalize
|
130
|
+
case opts[:type]
|
131
|
+
when :boolean, :bool; :flag
|
132
|
+
when :integer; :int
|
133
|
+
when :integers; :ints
|
134
|
+
when :double; :float
|
135
|
+
when :doubles; :floats
|
136
|
+
when Class
|
137
|
+
case opts[:type].name
|
138
|
+
when 'TrueClass', 'FalseClass'; :flag
|
139
|
+
when 'String'; :string
|
140
|
+
when 'Integer'; :int
|
141
|
+
when 'Float'; :float
|
142
|
+
when 'IO'; :io
|
143
|
+
when 'Date'; :date
|
144
|
+
else
|
145
|
+
raise ArgumentError, "unsupported argument type '#{opts[:type].class.name}'"
|
146
|
+
end
|
147
|
+
when nil; nil
|
148
|
+
else
|
149
|
+
raise ArgumentError, "unsupported argument type '#{opts[:type]}'" unless TYPES.include?(opts[:type])
|
150
|
+
opts[:type]
|
151
|
+
end
|
152
|
+
|
153
|
+
## for options with :multi => true, an array default doesn't imply
|
154
|
+
## a multi-valued argument. for that you have to specify a :type
|
155
|
+
## as well. (this is how we disambiguate an ambiguous situation;
|
156
|
+
## see the docs for Parser#opt for details.)
|
157
|
+
disambiguated_default =
|
158
|
+
if opts[:multi] && opts[:default].is_a?(Array) && !opts[:type]
|
159
|
+
opts[:default].first
|
160
|
+
else
|
161
|
+
opts[:default]
|
162
|
+
end
|
163
|
+
|
164
|
+
type_from_default =
|
165
|
+
case disambiguated_default
|
166
|
+
when Integer; :int
|
167
|
+
when Numeric; :float
|
168
|
+
when TrueClass, FalseClass; :flag
|
169
|
+
when String; :string
|
170
|
+
when IO; :io
|
171
|
+
when Date; :date
|
172
|
+
when Array
|
173
|
+
if opts[:default].empty?
|
174
|
+
raise ArgumentError, "multiple argument type cannot be deduced from an empty array for '#{opts[:default][0].class.name}'"
|
175
|
+
end
|
176
|
+
case opts[:default][0] # the first element determines the types
|
177
|
+
when Integer; :ints
|
178
|
+
when Numeric; :floats
|
179
|
+
when String; :strings
|
180
|
+
when IO; :ios
|
181
|
+
when Date; :dates
|
182
|
+
else
|
183
|
+
raise ArgumentError, "unsupported multiple argument type '#{opts[:default][0].class.name}'"
|
184
|
+
end
|
185
|
+
when nil; nil
|
186
|
+
else
|
187
|
+
raise ArgumentError, "unsupported argument type '#{opts[:default].class.name}'"
|
188
|
+
end
|
189
|
+
|
190
|
+
raise ArgumentError, ":type specification and default type don't match (default type is #{type_from_default})" if opts[:type] && type_from_default && opts[:type] != type_from_default
|
191
|
+
|
192
|
+
opts[:type] = opts[:type] || type_from_default || :flag
|
193
|
+
|
194
|
+
## fill in :long
|
195
|
+
opts[:long] = opts[:long] ? opts[:long].to_s : name.to_s.gsub("_", "-")
|
196
|
+
opts[:long] =
|
197
|
+
case opts[:long]
|
198
|
+
when /^--([^-].*)$/
|
199
|
+
$1
|
200
|
+
when /^[^-]/
|
201
|
+
opts[:long]
|
202
|
+
else
|
203
|
+
raise ArgumentError, "invalid long option name #{opts[:long].inspect}"
|
204
|
+
end
|
205
|
+
raise ArgumentError, "long option name #{opts[:long].inspect} is already taken; please specify a (different) :long" if @long[opts[:long]]
|
206
|
+
|
207
|
+
## fill in :short
|
208
|
+
opts[:short] = opts[:short].to_s if opts[:short] unless opts[:short] == :none
|
209
|
+
opts[:short] = case opts[:short]
|
210
|
+
when /^-(.)$/; $1
|
211
|
+
when nil, :none, /^.$/; opts[:short]
|
212
|
+
else raise ArgumentError, "invalid short option name '#{opts[:short].inspect}'"
|
213
|
+
end
|
214
|
+
|
215
|
+
if opts[:short]
|
216
|
+
raise ArgumentError, "short option name #{opts[:short].inspect} is already taken; please specify a (different) :short" if @short[opts[:short]]
|
217
|
+
raise ArgumentError, "a short option name can't be a number or a dash" if opts[:short] =~ INVALID_SHORT_ARG_REGEX
|
218
|
+
end
|
219
|
+
|
220
|
+
## fill in :default for flags
|
221
|
+
opts[:default] = false if opts[:type] == :flag && opts[:default].nil?
|
222
|
+
|
223
|
+
## autobox :default for :multi (multi-occurrence) arguments
|
224
|
+
opts[:default] = [opts[:default]] if opts[:default] && opts[:multi] && !opts[:default].is_a?(Array)
|
225
|
+
|
226
|
+
## fill in :multi
|
227
|
+
opts[:multi] ||= false
|
228
|
+
|
229
|
+
opts[:desc] ||= desc
|
230
|
+
@long[opts[:long]] = name
|
231
|
+
@short[opts[:short]] = name if opts[:short] && opts[:short] != :none
|
232
|
+
@specs[name] = opts
|
233
|
+
@order << [:opt, name]
|
234
|
+
end
|
235
|
+
|
236
|
+
## Sets the version string. If set, the user can request the version
|
237
|
+
## on the commandline. Should probably be of the form "<program name>
|
238
|
+
## <version number>".
|
239
|
+
def version s=nil; @version = s if s; @version end
|
240
|
+
|
241
|
+
## Adds text to the help display. Can be interspersed with calls to
|
242
|
+
## #opt to build a multi-section help page.
|
243
|
+
def banner s; @order << [:text, s] end
|
244
|
+
alias :text :banner
|
245
|
+
|
246
|
+
## Marks two (or more!) options as requiring each other. Only handles
|
247
|
+
## undirected (i.e., mutual) dependencies. Directed dependencies are
|
248
|
+
## better modeled with Trollop::die.
|
249
|
+
def depends *syms
|
250
|
+
syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
|
251
|
+
@constraints << [:depends, syms]
|
252
|
+
end
|
253
|
+
|
254
|
+
## Marks two (or more!) options as conflicting.
|
255
|
+
def conflicts *syms
|
256
|
+
syms.each { |sym| raise ArgumentError, "unknown option '#{sym}'" unless @specs[sym] }
|
257
|
+
@constraints << [:conflicts, syms]
|
258
|
+
end
|
259
|
+
|
260
|
+
## Defines a set of words which cause parsing to terminate when
|
261
|
+
## encountered, such that any options to the left of the word are
|
262
|
+
## parsed as usual, and options to the right of the word are left
|
263
|
+
## intact.
|
264
|
+
##
|
265
|
+
## A typical use case would be for subcommand support, where these
|
266
|
+
## would be set to the list of subcommands. A subsequent Trollop
|
267
|
+
## invocation would then be used to parse subcommand options, after
|
268
|
+
## shifting the subcommand off of ARGV.
|
269
|
+
def stop_on *words
|
270
|
+
@stop_words = [*words].flatten
|
271
|
+
end
|
272
|
+
|
273
|
+
## Similar to #stop_on, but stops on any unknown word when encountered
|
274
|
+
## (unless it is a parameter for an argument). This is useful for
|
275
|
+
## cases where you don't know the set of subcommands ahead of time,
|
276
|
+
## i.e., without first parsing the global options.
|
277
|
+
def stop_on_unknown
|
278
|
+
@stop_on_unknown = true
|
279
|
+
end
|
280
|
+
|
281
|
+
## Parses the commandline. Typically called by Trollop::options,
|
282
|
+
## but you can call it directly if you need more control.
|
283
|
+
##
|
284
|
+
## throws CommandlineError, HelpNeeded, and VersionNeeded exceptions.
|
285
|
+
def parse cmdline=ARGV
|
286
|
+
vals = {}
|
287
|
+
required = {}
|
288
|
+
|
289
|
+
opt :version, "Print version and exit" if @version unless @specs[:version] || @long["version"]
|
290
|
+
opt :help, "Show this message" unless @specs[:help] || @long["help"]
|
291
|
+
|
292
|
+
@specs.each do |sym, opts|
|
293
|
+
required[sym] = true if opts[:required]
|
294
|
+
vals[sym] = opts[:default]
|
295
|
+
vals[sym] = [] if opts[:multi] && !opts[:default] # multi arguments default to [], not nil
|
296
|
+
end
|
297
|
+
|
298
|
+
resolve_default_short_options
|
299
|
+
|
300
|
+
## resolve symbols
|
301
|
+
given_args = {}
|
302
|
+
@leftovers = each_arg cmdline do |arg, params|
|
303
|
+
sym = case arg
|
304
|
+
when /^-([^-])$/
|
305
|
+
@short[$1]
|
306
|
+
when /^--([^-]\S*)$/
|
307
|
+
@long[$1]
|
308
|
+
else
|
309
|
+
raise CommandlineError, "invalid argument syntax: '#{arg}'"
|
310
|
+
end
|
311
|
+
raise CommandlineError, "unknown argument '#{arg}'" unless sym
|
312
|
+
|
313
|
+
if given_args.include?(sym) && !@specs[sym][:multi]
|
314
|
+
raise CommandlineError, "option '#{arg}' specified multiple times"
|
315
|
+
end
|
316
|
+
|
317
|
+
given_args[sym] ||= {}
|
318
|
+
|
319
|
+
given_args[sym][:arg] = arg
|
320
|
+
given_args[sym][:params] ||= []
|
321
|
+
|
322
|
+
# The block returns the number of parameters taken.
|
323
|
+
num_params_taken = 0
|
324
|
+
|
325
|
+
unless params.nil?
|
326
|
+
if SINGLE_ARG_TYPES.include?(@specs[sym][:type])
|
327
|
+
given_args[sym][:params] << params[0, 1] # take the first parameter
|
328
|
+
num_params_taken = 1
|
329
|
+
elsif MULTI_ARG_TYPES.include?(@specs[sym][:type])
|
330
|
+
given_args[sym][:params] << params # take all the parameters
|
331
|
+
num_params_taken = params.size
|
332
|
+
end
|
333
|
+
end
|
334
|
+
|
335
|
+
num_params_taken
|
336
|
+
end
|
337
|
+
|
338
|
+
## check for version and help args
|
339
|
+
raise VersionNeeded if given_args.include? :version
|
340
|
+
raise HelpNeeded if given_args.include? :help
|
341
|
+
|
342
|
+
## check constraint satisfaction
|
343
|
+
@constraints.each do |type, syms|
|
344
|
+
constraint_sym = syms.find { |sym| given_args[sym] }
|
345
|
+
next unless constraint_sym
|
346
|
+
|
347
|
+
case type
|
348
|
+
when :depends
|
349
|
+
syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} requires --#{@specs[sym][:long]}" unless given_args.include? sym }
|
350
|
+
when :conflicts
|
351
|
+
syms.each { |sym| raise CommandlineError, "--#{@specs[constraint_sym][:long]} conflicts with --#{@specs[sym][:long]}" if given_args.include?(sym) && (sym != constraint_sym) }
|
352
|
+
end
|
353
|
+
end
|
354
|
+
|
355
|
+
required.each do |sym, val|
|
356
|
+
raise CommandlineError, "option --#{@specs[sym][:long]} must be specified" unless given_args.include? sym
|
357
|
+
end
|
358
|
+
|
359
|
+
## parse parameters
|
360
|
+
given_args.each do |sym, given_data|
|
361
|
+
arg = given_data[:arg]
|
362
|
+
params = given_data[:params]
|
363
|
+
|
364
|
+
opts = @specs[sym]
|
365
|
+
raise CommandlineError, "option '#{arg}' needs a parameter" if params.empty? && opts[:type] != :flag
|
366
|
+
|
367
|
+
vals["#{sym}_given".intern] = true # mark argument as specified on the commandline
|
368
|
+
|
369
|
+
case opts[:type]
|
370
|
+
when :flag
|
371
|
+
vals[sym] = !opts[:default]
|
372
|
+
when :int, :ints
|
373
|
+
vals[sym] = params.map { |pg| pg.map { |p| parse_integer_parameter p, arg } }
|
374
|
+
when :float, :floats
|
375
|
+
vals[sym] = params.map { |pg| pg.map { |p| parse_float_parameter p, arg } }
|
376
|
+
when :string, :strings
|
377
|
+
vals[sym] = params.map { |pg| pg.map { |p| p.to_s } }
|
378
|
+
when :io, :ios
|
379
|
+
vals[sym] = params.map { |pg| pg.map { |p| parse_io_parameter p, arg } }
|
380
|
+
when :date, :dates
|
381
|
+
vals[sym] = params.map { |pg| pg.map { |p| parse_date_parameter p, arg } }
|
382
|
+
end
|
383
|
+
|
384
|
+
if SINGLE_ARG_TYPES.include?(opts[:type])
|
385
|
+
unless opts[:multi] # single parameter
|
386
|
+
vals[sym] = vals[sym][0][0]
|
387
|
+
else # multiple options, each with a single parameter
|
388
|
+
vals[sym] = vals[sym].map { |p| p[0] }
|
389
|
+
end
|
390
|
+
elsif MULTI_ARG_TYPES.include?(opts[:type]) && !opts[:multi]
|
391
|
+
vals[sym] = vals[sym][0] # single option, with multiple parameters
|
392
|
+
end
|
393
|
+
# else: multiple options, with multiple parameters
|
394
|
+
end
|
395
|
+
|
396
|
+
## modify input in place with only those
|
397
|
+
## arguments we didn't process
|
398
|
+
cmdline.clear
|
399
|
+
@leftovers.each { |l| cmdline << l }
|
400
|
+
|
401
|
+
## allow openstruct-style accessors
|
402
|
+
class << vals
|
403
|
+
def method_missing(m, *args)
|
404
|
+
self[m] || self[m.to_s]
|
405
|
+
end
|
406
|
+
end
|
407
|
+
vals
|
408
|
+
end
|
409
|
+
|
410
|
+
def parse_date_parameter param, arg #:nodoc:
|
411
|
+
begin
|
412
|
+
begin
|
413
|
+
time = Chronic.parse(param)
|
414
|
+
rescue NameError
|
415
|
+
# chronic is not available
|
416
|
+
end
|
417
|
+
time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
|
418
|
+
rescue ArgumentError => e
|
419
|
+
raise CommandlineError, "option '#{arg}' needs a date"
|
420
|
+
end
|
421
|
+
end
|
422
|
+
|
423
|
+
## Print the help message to +stream+.
|
424
|
+
def educate stream=$stdout
|
425
|
+
width # just calculate it now; otherwise we have to be careful not to
|
426
|
+
# call this unless the cursor's at the beginning of a line.
|
427
|
+
|
428
|
+
left = {}
|
429
|
+
@specs.each do |name, spec|
|
430
|
+
left[name] = "--#{spec[:long]}" +
|
431
|
+
(spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
|
432
|
+
case spec[:type]
|
433
|
+
when :flag; ""
|
434
|
+
when :int; " <i>"
|
435
|
+
when :ints; " <i+>"
|
436
|
+
when :string; " <s>"
|
437
|
+
when :strings; " <s+>"
|
438
|
+
when :float; " <f>"
|
439
|
+
when :floats; " <f+>"
|
440
|
+
when :io; " <filename/uri>"
|
441
|
+
when :ios; " <filename/uri+>"
|
442
|
+
when :date; " <date>"
|
443
|
+
when :dates; " <date+>"
|
444
|
+
end
|
445
|
+
end
|
446
|
+
|
447
|
+
leftcol_width = left.values.map { |s| s.length }.max || 0
|
448
|
+
rightcol_start = leftcol_width + 6 # spaces
|
449
|
+
|
450
|
+
unless @order.size > 0 && @order.first.first == :text
|
451
|
+
stream.puts "#@version\n" if @version
|
452
|
+
stream.puts "Options:"
|
453
|
+
end
|
454
|
+
|
455
|
+
@order.each do |what, opt|
|
456
|
+
if what == :text
|
457
|
+
stream.puts wrap(opt)
|
458
|
+
next
|
459
|
+
end
|
460
|
+
|
461
|
+
spec = @specs[opt]
|
462
|
+
stream.printf " %#{leftcol_width}s: ", left[opt]
|
463
|
+
desc = spec[:desc] + begin
|
464
|
+
default_s = case spec[:default]
|
465
|
+
when $stdout; "<stdout>"
|
466
|
+
when $stdin; "<stdin>"
|
467
|
+
when $stderr; "<stderr>"
|
468
|
+
when Array
|
469
|
+
spec[:default].join(", ")
|
470
|
+
else
|
471
|
+
spec[:default].to_s
|
472
|
+
end
|
473
|
+
|
474
|
+
if spec[:default]
|
475
|
+
if spec[:desc] =~ /\.$/
|
476
|
+
" (Default: #{default_s})"
|
477
|
+
else
|
478
|
+
" (default: #{default_s})"
|
479
|
+
end
|
480
|
+
else
|
481
|
+
""
|
482
|
+
end
|
483
|
+
end
|
484
|
+
stream.puts wrap(desc, :width => width - rightcol_start - 1, :prefix => rightcol_start)
|
485
|
+
end
|
486
|
+
end
|
487
|
+
|
488
|
+
def width #:nodoc:
|
489
|
+
@width ||= if $stdout.tty?
|
490
|
+
begin
|
491
|
+
require 'curses'
|
492
|
+
Curses::init_screen
|
493
|
+
x = Curses::cols
|
494
|
+
Curses::close_screen
|
495
|
+
x
|
496
|
+
rescue Exception
|
497
|
+
80
|
498
|
+
end
|
499
|
+
else
|
500
|
+
80
|
501
|
+
end
|
502
|
+
end
|
503
|
+
|
504
|
+
def wrap str, opts={} # :nodoc:
|
505
|
+
if str == ""
|
506
|
+
[""]
|
507
|
+
else
|
508
|
+
str.split("\n").map { |s| wrap_line s, opts }.flatten
|
509
|
+
end
|
510
|
+
end
|
511
|
+
|
512
|
+
## The per-parser version of Trollop::die (see that for documentation).
|
513
|
+
def die arg, msg
|
514
|
+
if msg
|
515
|
+
$stderr.puts "Error: argument --#{@specs[arg][:long]} #{msg}."
|
516
|
+
else
|
517
|
+
$stderr.puts "Error: #{arg}."
|
518
|
+
end
|
519
|
+
$stderr.puts "Try --help for help."
|
520
|
+
exit(-1)
|
521
|
+
end
|
522
|
+
|
523
|
+
private
|
524
|
+
|
525
|
+
## yield successive arg, parameter pairs
|
526
|
+
def each_arg args
|
527
|
+
remains = []
|
528
|
+
i = 0
|
529
|
+
|
530
|
+
until i >= args.length
|
531
|
+
if @stop_words.member? args[i]
|
532
|
+
remains += args[i .. -1]
|
533
|
+
return remains
|
534
|
+
end
|
535
|
+
case args[i]
|
536
|
+
when /^--$/ # arg terminator
|
537
|
+
remains += args[(i + 1) .. -1]
|
538
|
+
return remains
|
539
|
+
when /^--(\S+?)=(.*)$/ # long argument with equals
|
540
|
+
yield "--#{$1}", [$2]
|
541
|
+
i += 1
|
542
|
+
when /^--(\S+)$/ # long argument
|
543
|
+
params = collect_argument_parameters(args, i + 1)
|
544
|
+
unless params.empty?
|
545
|
+
num_params_taken = yield args[i], params
|
546
|
+
unless num_params_taken
|
547
|
+
if @stop_on_unknown
|
548
|
+
remains += args[i + 1 .. -1]
|
549
|
+
return remains
|
550
|
+
else
|
551
|
+
remains += params
|
552
|
+
end
|
553
|
+
end
|
554
|
+
i += 1 + num_params_taken
|
555
|
+
else # long argument no parameter
|
556
|
+
yield args[i], nil
|
557
|
+
i += 1
|
558
|
+
end
|
559
|
+
when /^-(\S+)$/ # one or more short arguments
|
560
|
+
shortargs = $1.split(//)
|
561
|
+
shortargs.each_with_index do |a, j|
|
562
|
+
if j == (shortargs.length - 1)
|
563
|
+
params = collect_argument_parameters(args, i + 1)
|
564
|
+
unless params.empty?
|
565
|
+
num_params_taken = yield "-#{a}", params
|
566
|
+
unless num_params_taken
|
567
|
+
if @stop_on_unknown
|
568
|
+
remains += args[i + 1 .. -1]
|
569
|
+
return remains
|
570
|
+
else
|
571
|
+
remains += params
|
572
|
+
end
|
573
|
+
end
|
574
|
+
i += 1 + num_params_taken
|
575
|
+
else # argument no parameter
|
576
|
+
yield "-#{a}", nil
|
577
|
+
i += 1
|
578
|
+
end
|
579
|
+
else
|
580
|
+
yield "-#{a}", nil
|
581
|
+
end
|
582
|
+
end
|
583
|
+
else
|
584
|
+
if @stop_on_unknown
|
585
|
+
remains += args[i .. -1]
|
586
|
+
return remains
|
587
|
+
else
|
588
|
+
remains << args[i]
|
589
|
+
i += 1
|
590
|
+
end
|
591
|
+
end
|
592
|
+
end
|
593
|
+
|
594
|
+
remains
|
595
|
+
end
|
596
|
+
|
597
|
+
def parse_integer_parameter param, arg
|
598
|
+
raise CommandlineError, "option '#{arg}' needs an integer" unless param =~ /^\d+$/
|
599
|
+
param.to_i
|
600
|
+
end
|
601
|
+
|
602
|
+
def parse_float_parameter param, arg
|
603
|
+
raise CommandlineError, "option '#{arg}' needs a floating-point number" unless param =~ FLOAT_RE
|
604
|
+
param.to_f
|
605
|
+
end
|
606
|
+
|
607
|
+
def parse_io_parameter param, arg
|
608
|
+
case param
|
609
|
+
when /^(stdin|-)$/i; $stdin
|
610
|
+
else
|
611
|
+
require 'open-uri'
|
612
|
+
begin
|
613
|
+
open param
|
614
|
+
rescue SystemCallError => e
|
615
|
+
raise CommandlineError, "file or url for option '#{arg}' cannot be opened: #{e.message}"
|
616
|
+
end
|
617
|
+
end
|
618
|
+
end
|
619
|
+
|
620
|
+
def collect_argument_parameters args, start_at
|
621
|
+
params = []
|
622
|
+
pos = start_at
|
623
|
+
while args[pos] && args[pos] !~ PARAM_RE && !@stop_words.member?(args[pos]) do
|
624
|
+
params << args[pos]
|
625
|
+
pos += 1
|
626
|
+
end
|
627
|
+
params
|
628
|
+
end
|
629
|
+
|
630
|
+
def resolve_default_short_options
|
631
|
+
@order.each do |type, name|
|
632
|
+
next unless type == :opt
|
633
|
+
opts = @specs[name]
|
634
|
+
next if opts[:short]
|
635
|
+
|
636
|
+
c = opts[:long].split(//).find { |d| d !~ INVALID_SHORT_ARG_REGEX && !@short.member?(d) }
|
637
|
+
if c # found a character to use
|
638
|
+
opts[:short] = c
|
639
|
+
@short[c] = name
|
640
|
+
end
|
641
|
+
end
|
642
|
+
end
|
643
|
+
|
644
|
+
def wrap_line str, opts={}
|
645
|
+
prefix = opts[:prefix] || 0
|
646
|
+
width = opts[:width] || (self.width - 1)
|
647
|
+
start = 0
|
648
|
+
ret = []
|
649
|
+
until start > str.length
|
650
|
+
nextt =
|
651
|
+
if start + width >= str.length
|
652
|
+
str.length
|
653
|
+
else
|
654
|
+
x = str.rindex(/\s/, start + width)
|
655
|
+
x = str.index(/\s/, start) if x && x < start
|
656
|
+
x || str.length
|
657
|
+
end
|
658
|
+
ret << (ret.empty? ? "" : " " * prefix) + str[start ... nextt]
|
659
|
+
start = nextt + 1
|
660
|
+
end
|
661
|
+
ret
|
662
|
+
end
|
663
|
+
|
664
|
+
## instance_eval but with ability to handle block arguments
|
665
|
+
## thanks to why: http://redhanded.hobix.com/inspect/aBlockCostume.html
|
666
|
+
def cloaker &b
|
667
|
+
(class << self; self; end).class_eval do
|
668
|
+
define_method :cloaker_, &b
|
669
|
+
meth = instance_method :cloaker_
|
670
|
+
remove_method :cloaker_
|
671
|
+
meth
|
672
|
+
end
|
673
|
+
end
|
674
|
+
end
|
675
|
+
|
676
|
+
## The easy, syntactic-sugary entry method into Trollop. Creates a Parser,
|
677
|
+
## passes the block to it, then parses +args+ with it, handling any errors or
|
678
|
+
## requests for help or version information appropriately (and then exiting).
|
679
|
+
## Modifies +args+ in place. Returns a hash of option values.
|
680
|
+
##
|
681
|
+
## The block passed in should contain zero or more calls to +opt+
|
682
|
+
## (Parser#opt), zero or more calls to +text+ (Parser#text), and
|
683
|
+
## probably a call to +version+ (Parser#version).
|
684
|
+
##
|
685
|
+
## The returned block contains a value for every option specified with
|
686
|
+
## +opt+. The value will be the value given on the commandline, or the
|
687
|
+
## default value if the option was not specified on the commandline. For
|
688
|
+
## every option specified on the commandline, a key "<option
|
689
|
+
## name>_given" will also be set in the hash.
|
690
|
+
##
|
691
|
+
## Example:
|
692
|
+
##
|
693
|
+
## require 'trollop'
|
694
|
+
## opts = Trollop::options do
|
695
|
+
## opt :monkey, "Use monkey mode" # a flag --monkey, defaulting to false
|
696
|
+
## opt :goat, "Use goat mode", :default => true # a flag --goat, defaulting to true
|
697
|
+
## opt :num_limbs, "Number of limbs", :default => 4 # an integer --num-limbs <i>, defaulting to 4
|
698
|
+
## opt :num_thumbs, "Number of thumbs", :type => :int # an integer --num-thumbs <i>, defaulting to nil
|
699
|
+
## end
|
700
|
+
##
|
701
|
+
## ## if called with no arguments
|
702
|
+
## p opts # => { :monkey => false, :goat => true, :num_limbs => 4, :num_thumbs => nil }
|
703
|
+
##
|
704
|
+
## ## if called with --monkey
|
705
|
+
## p opts # => {:monkey_given=>true, :monkey=>true, :goat=>true, :num_limbs=>4, :help=>false, :num_thumbs=>nil}
|
706
|
+
##
|
707
|
+
## See more examples at http://trollop.rubyforge.org.
|
708
|
+
def options args=ARGV, *a, &b
|
709
|
+
@last_parser = Parser.new(*a, &b)
|
710
|
+
with_standard_exception_handling(@last_parser) { @last_parser.parse args }
|
711
|
+
end
|
712
|
+
|
713
|
+
## If Trollop::options doesn't do quite what you want, you can create a Parser
|
714
|
+
## object and call Parser#parse on it. That method will throw CommandlineError,
|
715
|
+
## HelpNeeded and VersionNeeded exceptions when necessary; if you want to
|
716
|
+
## have these handled for you in the standard manner (e.g. show the help
|
717
|
+
## and then exit upon an HelpNeeded exception), call your code from within
|
718
|
+
## a block passed to this method.
|
719
|
+
##
|
720
|
+
## Note that this method will call System#exit after handling an exception!
|
721
|
+
##
|
722
|
+
## Usage example:
|
723
|
+
##
|
724
|
+
## require 'trollop'
|
725
|
+
## p = Trollop::Parser.new do
|
726
|
+
## opt :monkey, "Use monkey mode" # a flag --monkey, defaulting to false
|
727
|
+
## opt :goat, "Use goat mode", :default => true # a flag --goat, defaulting to true
|
728
|
+
## end
|
729
|
+
##
|
730
|
+
## opts = Trollop::with_standard_exception_handling p do
|
731
|
+
## o = p.parse ARGV
|
732
|
+
## raise Trollop::HelpNeeded if ARGV.empty? # show help screen
|
733
|
+
## o
|
734
|
+
## end
|
735
|
+
##
|
736
|
+
## Requires passing in the parser object.
|
737
|
+
|
738
|
+
def with_standard_exception_handling parser
|
739
|
+
begin
|
740
|
+
yield
|
741
|
+
rescue CommandlineError => e
|
742
|
+
$stderr.puts "Error: #{e.message}."
|
743
|
+
$stderr.puts "Try --help for help."
|
744
|
+
exit(-1)
|
745
|
+
rescue HelpNeeded
|
746
|
+
parser.educate
|
747
|
+
exit
|
748
|
+
rescue VersionNeeded
|
749
|
+
puts parser.version
|
750
|
+
exit
|
751
|
+
end
|
752
|
+
end
|
753
|
+
|
754
|
+
## Informs the user that their usage of 'arg' was wrong, as detailed by
|
755
|
+
## 'msg', and dies. Example:
|
756
|
+
##
|
757
|
+
## options do
|
758
|
+
## opt :volume, :default => 0.0
|
759
|
+
## end
|
760
|
+
##
|
761
|
+
## die :volume, "too loud" if opts[:volume] > 10.0
|
762
|
+
## die :volume, "too soft" if opts[:volume] < 0.1
|
763
|
+
##
|
764
|
+
## In the one-argument case, simply print that message, a notice
|
765
|
+
## about -h, and die. Example:
|
766
|
+
##
|
767
|
+
## options do
|
768
|
+
## opt :whatever # ...
|
769
|
+
## end
|
770
|
+
##
|
771
|
+
## Trollop::die "need at least one filename" if ARGV.empty?
|
772
|
+
def die arg, msg=nil
|
773
|
+
if @last_parser
|
774
|
+
@last_parser.die arg, msg
|
775
|
+
else
|
776
|
+
raise ArgumentError, "Trollop::die can only be called after Trollop::options"
|
777
|
+
end
|
778
|
+
end
|
779
|
+
|
780
|
+
module_function :options, :die, :with_standard_exception_handling
|
781
|
+
|
782
|
+
end # module
|
data/test/helper.rb
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'bundler'
|
3
|
+
begin
|
4
|
+
Bundler.setup(:default, :development)
|
5
|
+
rescue Bundler::BundlerError => e
|
6
|
+
$stderr.puts e.message
|
7
|
+
$stderr.puts "Run `bundle install` to install missing gems"
|
8
|
+
exit e.status_code
|
9
|
+
end
|
10
|
+
require 'test/unit'
|
11
|
+
require 'shoulda'
|
12
|
+
|
13
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
14
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
15
|
+
require 'gitsync'
|
16
|
+
|
17
|
+
class Test::Unit::TestCase
|
18
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: gitsync
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
prerelease:
|
5
|
+
version: 0.2.0
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Nic Haynes
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
|
13
|
+
date: 2011-02-13 00:00:00 -06:00
|
14
|
+
default_executable:
|
15
|
+
dependencies:
|
16
|
+
- !ruby/object:Gem::Dependency
|
17
|
+
name: shoulda
|
18
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
19
|
+
none: false
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: "0"
|
24
|
+
type: :development
|
25
|
+
prerelease: false
|
26
|
+
version_requirements: *id001
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: &id002 !ruby/object:Gem::Requirement
|
30
|
+
none: false
|
31
|
+
requirements:
|
32
|
+
- - ~>
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: 1.0.0
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: *id002
|
38
|
+
- !ruby/object:Gem::Dependency
|
39
|
+
name: jeweler
|
40
|
+
requirement: &id003 !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ~>
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: 1.5.2
|
46
|
+
type: :development
|
47
|
+
prerelease: false
|
48
|
+
version_requirements: *id003
|
49
|
+
- !ruby/object:Gem::Dependency
|
50
|
+
name: rcov
|
51
|
+
requirement: &id004 !ruby/object:Gem::Requirement
|
52
|
+
none: false
|
53
|
+
requirements:
|
54
|
+
- - ">="
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: "0"
|
57
|
+
type: :development
|
58
|
+
prerelease: false
|
59
|
+
version_requirements: *id004
|
60
|
+
description: Autosync watched directories in git
|
61
|
+
email: nic@nicinabox.com
|
62
|
+
executables:
|
63
|
+
- autosync
|
64
|
+
- gitsync
|
65
|
+
extensions: []
|
66
|
+
|
67
|
+
extra_rdoc_files:
|
68
|
+
- LICENSE.txt
|
69
|
+
- README.rdoc
|
70
|
+
files:
|
71
|
+
- .rvmrc
|
72
|
+
- Gemfile
|
73
|
+
- Gemfile.lock
|
74
|
+
- LICENSE.txt
|
75
|
+
- Manifest
|
76
|
+
- README.rdoc
|
77
|
+
- Rakefile
|
78
|
+
- VERSION
|
79
|
+
- bin/autosync
|
80
|
+
- bin/gitsync
|
81
|
+
- gitsync.gemspec
|
82
|
+
- lib/gitsync.rb
|
83
|
+
- lib/trollop.rb
|
84
|
+
- test/helper.rb
|
85
|
+
- test/test_gitsync.rb
|
86
|
+
has_rdoc: true
|
87
|
+
homepage: http://github.com/nicinabox/gitsync
|
88
|
+
licenses:
|
89
|
+
- MIT
|
90
|
+
post_install_message:
|
91
|
+
rdoc_options: []
|
92
|
+
|
93
|
+
require_paths:
|
94
|
+
- lib
|
95
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
96
|
+
none: false
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
hash: 303322601375303751
|
101
|
+
segments:
|
102
|
+
- 0
|
103
|
+
version: "0"
|
104
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
105
|
+
none: false
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: "0"
|
110
|
+
requirements: []
|
111
|
+
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 1.5.0
|
114
|
+
signing_key:
|
115
|
+
specification_version: 3
|
116
|
+
summary: Autosync watched directories in git
|
117
|
+
test_files:
|
118
|
+
- test/helper.rb
|
119
|
+
- test/test_gitsync.rb
|