commandlineflunky 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.8.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Edmund Highcock
+
+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,4 @@
+commandlineflunky
+=================
+
+A library for quickly creating a command line program.

data/README.rdoc

@@ -0,0 +1,19 @@
+= commandlineflunky
+
+Description goes here.
+
+== Contributing to commandlineflunky
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* 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.
+
+== Copyright
+
+Copyright (c) 2012 Edmund Highcock. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "commandlineflunky"
+  gem.homepage = "http://github.com/edmundhighcock/commandlineflunky"
+  gem.license = "GPLv3"
+  gem.summary = %Q{A library for quickly creating a command line program.}
+  gem.description = %Q{A library for quickly creating a command line program. Quickly create commands, options and a built in manual.}
+  gem.email = "edmundhighcock@sourceforge.net"
+  gem.authors = ["Edmund Highcock"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+  ##test.libs << 'test'
+  ##test.pattern = 'test/**/test_*.rb'
+  ##test.verbose = true
+  ##test.rcov_opts << '--exclude "gems/*"'
+##end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "commandlineflunky #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/commandlineflunky.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "commandlineflunky"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Edmund Highcock"]
+  s.date = "2012-12-10"
+  s.description = "A library for quickly creating a command line program. Quickly create commands, options and a built in manual."
+  s.email = "edmundhighcock@sourceforge.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "commandlineflunky.gemspec",
+    "lib/commandlineflunky.rb",
+    "test/helper.rb",
+    "test/test_commandlineflunky.rb"
+  ]
+  s.homepage = "http://github.com/edmundhighcock/commandlineflunky"
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A library for quickly creating a command line program."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+  end
+end
+

data/lib/commandlineflunky.rb

@@ -0,0 +1,246 @@
+
+if RUBY_VERSION.to_f < 1.9
+	raise "Ruby version 1.9 or greater required (current version is #{RUBY_VERSION})"
+end
+module CommandLineFlunky
+# 	$stderr.puts STARTUP_MESSAGE unless $has_put_startup_message
+
+	COMMAND_FOLDER = Dir.pwd
+  SCRIPT_FOLDER = File.dirname(File.expand_path(SCRIPT_FILE)) #i.e. where the script using command line flunky is
+	SYS = (ENV['COMMAND_LINE_FLUNKY_SYSTEM'] or "genericlinux")
+	@@sys = SYS
+	def gets #No reading from the command line thank you very much!
+		$stdin.gets
+	end
+	def self.gets
+		$stdin.gets
+	end
+end
+CommandLineFlunky::GLOBAL_BINDING = binding
+
+# $stderr.print 'Loading libraries...' unless $has_put_startup_message
+require 'getoptlong'
+# $stderr.puts unless $has_put_startup_message
+$has_put_startup_message = true
+
+# Log.log_file = nil
+
+
+module CommandLineFlunky
+# 	CLF = COMMAND_LINE_FLAGS = []
+
+	# This lists all the commands available on the command line. The first two items in each array indicate the long and short form of the command, and the third indicates the number of arguments the command takes. They are all implemented as Code Runner class methods (the method is named after the long form). The short form of the command is available as a global method in Code Runner interactive mode.
+
+ 	COMMANDS.push ['interactive_mode', 'im', 0]
+	
+	# A lookup hash which gives the appropriate short command option (copt) key for a given long command flag
+	
+	CLF_TO_SHORT_COPTS = COMMAND_LINE_FLAGS.inject({}) do |hash, arr|
+		unless arr.size == 2 
+			long, short, req = arr 
+			letter = short[1,1]
+			hash[long] = letter.to_sym 
+		end
+		hash
+	end 
+	
+	# specifying flag sets a bool to be true
+
+# 	CLF_BOOLS = [:H, :U, :u, :A, :a, :T, :N, :q, :z, :d] 
+# 		CLF_BOOLS = [:s, :r, :D, :H, :U, :u, :L, :l, :A, :a, :T, :N,:V, :q, :z, :d] # 
+
+	CLF_INVERSE_BOOLS = [] # specifying flag sets a bool to be false
+           
+	# a look up hash that converts the long form of the command options to the short form (NB command options e.g. use_large_cache have a different form from command line flags e.g. --use-large-cache)
+	
+	LONG_TO_SHORT = COMMAND_LINE_FLAGS.inject({}) do |hash, arr|
+		unless arr.size == 2 #No short version
+			long, short, req = arr 
+			letter = short[1,1]
+			hash[long[2, long.size].gsub(/\-/, '_').to_sym] = letter.to_sym 
+		end
+		hash
+	end
+	
+	#Converts a command line flag opt with value arg to a command option which is stored in copts
+
+	def self.process_command_line_option(opt, arg, copts)
+		if CLF_BOOLS.include? CLF_TO_SHORT_COPTS[opt]
+			copts[CLF_TO_SHORT_COPTS[opt]] = true
+		elsif CLF_INVERSE_BOOLS.include? CLF_TO_SHORT_COPTS[opt]
+			copts[CLF_TO_SHORT_COPTS[opt]] = false
+		elsif CLF_TO_SHORT_COPTS[opt] # Applies to most options
+			copts[CLF_TO_SHORT_COPTS[opt]] = arg
+		else 
+			copts[opt[2, opt.size].gsub(/\-/, '_').to_sym] = arg
+		end	
+		copts
+	end
+
+	# Default command options; they are usually determined by the command line flags, but can be set independently
+	
+	DEFAULT_COMMAND_OPTIONS = {} 
+
+	def self.set_default_command_options_from_command_line
+		opts = GetoptLong.new(*COMMAND_LINE_FLAGS)
+		opts.each do |opt, arg|
+		      process_command_line_option(opt, arg, DEFAULT_COMMAND_OPTIONS)
+		end
+		raise "\n\nCannot use large cache ('-U' or '-u' ) if submitting runs" if DEFAULT_COMMAND_OPTIONS[:U] and (DEFAULT_COMMAND_OPTIONS[:s] or DEFAULT_COMMAND_OPTIONS[:P])
+	end
+end
+
+module CommandLineFlunky
+
+	def self.read_default_command_options(copts)
+		DEFAULT_COMMAND_OPTIONS.each do |key, value|
+			copts[key] ||= value
+		end
+	end
+# 	def self.process_command_options(copts)
+# 		read_default_command_options(copts)
+# 		copts.each do |key, value|
+# 			copts[LONG_TO_SHORT[key]] = value if LONG_TO_SHORT[key]
+# 		end
+# 
+# 		
+# 		if copts[:j] # j can be a number '65' or list of numbers '65,43,382' 
+# 			copts[:f]= "#{eval("[#{copts[:j]}]").inspect}.include? id"
+# 		end
+# 		if copts[:z]
+# 			Log.log_file = Dir.pwd + '/.cr_logfile.txt'
+# 			Log.clean_up
+# 		else 
+# 			Log.log_file = nil
+# 		end
+# 		copts[:F] = (copts[:F].class == Hash ? copts[:F] : (copts[:F].class == String and copts[:F] =~ /\A\{.*\}\Z/) ? eval(copts[:F]) : {})
+# 		copts[:G]= [copts[:G]] if copts[:G].kind_of? String
+# 		copts[:g]= [copts[:g]] if copts[:g].kind_of? String
+# 		if copts[:Y] and copts[:Y] =~ /:/ 
+# 			copts[:running_remotely] = true
+# 		else
+# 			copts[:Y].gsub!(/~/, ENV['HOME']) if copts[:Y]
+# 			Dir.chdir((copts[:Y] or Dir.pwd)) do
+# 				set_runner_defaults(copts)
+# 			end
+# 		end
+# 		if copts[:p] and copts[:p].class == String # should be a hash or an inspected hash
+# 			copts[:p] = eval(copts[:p])
+# 		end
+# # 		ep Log.log_file
+# 	end
+# 	
+# 	# Retrieve the runner with the folder (and possibly server) given in copts[:Y]. If no runner has been loaded for that folder, load one.
+# 	
+# 	def self.fetch_runner(copts={})
+# # 		ep copts
+# 		process_command_options(copts)
+# 		@runners ||= {}
+# 		runner = nil
+# 		if copts[:Y] and copts[:Y] =~ /:/ 
+# 			copts_r = copts.dup
+# 			host, folder = copts[:Y].split(':')
+# 			copts_r[:Y] = nil
+# 			copts[:Y] = nil
+# 			unless @runners[[host, folder]]
+# 				runner = @runners[[host, folder]] = RemoteCommandLineFlunky.new(host, folder, copts)
+# 				(eputs 'Updating remote...'; runner.update) unless (copts[:g] and (copts[:g].kind_of? String or copts[:g].size > 0)) or copts[:no_update] 
+# 			else 
+# 				runner = @runners[[host, folder]]
+# 			end
+# 		else
+# 		  
+# 			copts[:Y] ||= Dir.pwd
+# 		  	Dir.chdir((copts[:Y] or Dir.pwd)) do
+# 				unless @runners[copts[:Y]]
+# 					runner = @runners[copts[:Y]] = CommandLineFlunky.new(Dir.pwd, code: copts[:C], modlet: copts[:m], version: copts[:v], executable: copts[:X])
+# 					runner.update unless copts[:no_update]
+# 				else
+# 					runner = @runners[copts[:Y]]
+# 				end
+# # 				p 'reading defaults', @r.conditions, DEFAULT_RUNNER_OPTIONS
+# 				runner.read_defaults
+# # 				p 'read defaults', @r.conditions
+# 				
+# 			end #Dir.chdir
+# 		end
+# 		return runner
+# # 		@r.read_defaults
+# 	end
+# 	def self.update_runners
+# 		@runners ||= {}
+# 		@runners.each{|runner| runner.update}
+# 	end
+
+
+	INTERACTIVE_METHODS = <<EOF
+CommandLineFlunky::COMMANDS.each do |command|
+	eval("def #\{command[1]}(*args) 
+		  CommandLineFlunky.send(#\{command[0].to_sym.inspect}, *args)
+	      end")
+
+EOF
+        def self.runner
+		@runner
+	end
+
+	def CommandLineFlunky.interactive_mode(copts={})
+# 		process_command_options(copts)
+	  			unless false and FileTest.exist? (ENV['HOME'] + "/.#{PROJECT_NAME}_interactive_options.rb")
+				File.open(ENV['HOME'] + "/.#{PROJECT_NAME}_interactive_options.rb", 'w') do |file|
+					file.puts <<EOF
+	$has_put_startup_message = true #please leave!
+	$command_line_flunky_interactive_mode = true #please leave!
+	require 'yaml'
+
+	def reset
+	  Dispatcher.reset_application!
+	end
+	  
+	IRB.conf[:AUTO_INDENT] = true
+	IRB.conf[:USE_READLINE] = true
+	IRB.conf[:LOAD_MODULES] = []  unless IRB.conf.key?(:LOAD_MODULES)
+	unless IRB.conf[:LOAD_MODULES].include?('irb/completion')
+	  IRB.conf[:LOAD_MODULES] << 'irb/completion'
+	end      
+
+				
+	require 'irb/completion'
+	require 'irb/ext/save-history'
+	IRB.conf[:PROMPT_MODE] = :SIMPLE
+	IRB.conf[:SAVE_HISTORY] = 100
+	IRB.conf[:HISTORY_FILE] = "\#\{ENV['HOME']}/.#{PROJECT_NAME}_irb_save_history"
+	IRB.conf[:INSPECT_MODE] = false
+
+
+EOF
+				end
+			end
+			File.open(".int.tmp.rb", 'w')do |file|
+				file.puts "#{copts.inspect}.each do |key, val|
+					CommandLineFlunky::DEFAULT_COMMAND_OPTIONS[key] = val
+				end"
+				file.puts CommandLineFlunky::INTERACTIVE_METHODS
+			end
+			exec %[#{Config::CONFIG['bindir']}/irb#{Config::CONFIG['ruby_install_name'].sub(/ruby/, '')} -f -I '#{SCRIPT_FOLDER}' -I '#{File.dirname(__FILE__)}' -I '#{Dir.pwd}' -I '#{ENV['HOME']}' -r '.#{PROJECT_NAME}_interactive_options' -r '#{File.basename(SCRIPT_FILE)}'  -r .int.tmp ]
+	end
+
+# # 	def self.setup
+# # 	end
+	
+	def CommandLineFlunky.run_script
+		CommandLineFlunky.setup(DEFAULT_COMMAND_OPTIONS)
+		return if $command_line_flunky_interactive_mode
+		command = COMMANDS.find{|com| com.slice(0..1).include? ARGV[0]}
+		raise "Command #{ARGV[0]} not found" unless command
+		send(command[0].to_sym, *ARGV.slice(1...(1+command[2])), DEFAULT_COMMAND_OPTIONS)
+	end
+end
+
+CommandLineFlunky.set_default_command_options_from_command_line
+
+####################
+# CommandLineFlunky.run_script unles
+###################
+
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'commandlineflunky'
+
+class Test::Unit::TestCase
+end

data/test/test_commandlineflunky.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCommandlineflunky < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: commandlineflunky
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Edmund Highcock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: A library for quickly creating a command line program. Quickly create
+  commands, options and a built in manual.
+email: edmundhighcock@sourceforge.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- commandlineflunky.gemspec
+- lib/commandlineflunky.rb
+- test/helper.rb
+- test/test_commandlineflunky.rb
+homepage: http://github.com/edmundhighcock/commandlineflunky
+licenses:
+- GPLv3
+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: -681905963035614078
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A library for quickly creating a command line program.
+test_files: []