command-line-flunky 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99237ec939fb18b1666b3ed840e0ab32f320403e
+  data.tar.gz: d5c93b593ac010cb8bc24c4aa45ff2860c55a4cb
+SHA512:
+  metadata.gz: 5bf7db0ca30a51a61b00a9b526501cee92208cc57f5040385ba0ca00bbc2b7900fed8ace3d37cfff2ee005cea6970d8454ac85a228141429552d54260b3a34a8
+  data.tar.gz: 89e7e0cc72bd938cddef40b0045c921e74cc0d2391bf0ad9b4ab8bf61009ca7db340c3c6512c308e5af05f13303ed7c462875e750a3cb881e504fc1f7ccaa8a0

data/.document

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+  gem "rubyhacks", ">= 0.1.4"
+
+# 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"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 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.rdoc

@@ -0,0 +1,19 @@
+= command-line-flunky
+
+Description goes here.
+
+== Contributing to command-line-flunky
+ 
+* 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) 2014 Edmund Highcock. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# 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://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "command-line-flunky"
+  gem.homepage = "http://github.com/edmundhighcock/command-line-flunky"
+  gem.license = "GPLv3"
+  gem.summary = %Q{A framework for quickly creating a command line tool and manual.}
+  gem.description = %Q{A framework for quickly creating a command line tool and manual. Coherently and simply links a Ruby class/module interface to a set of command line commands and options. A comprehensive example is in the test folder.}
+  gem.email = "edmundhighcock@users.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
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+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 = "command-line-flunky #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/commandlineflunkytestutility

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'command-line-flunky-test-utility'
+rescue LoadError
+  require 'rubygems'
+  require 'command-line-flunky-test-utility'
+end
+
+CommandLineFlunky.run_script

data/lib/command-line-flunky-test-utility.rb

@@ -0,0 +1,101 @@
+# This is a complete example of how to use command-line-flunky
+# which also used for testing
+
+require 'getoptlong'
+
+module CommandLineFlunky
+	
+	STARTUP_MESSAGE = "\n------Test Utility------"
+
+	MANUAL_HEADER = <<EOF
+			
+-------------Test Utility Manual---------------
+
+  Written by Edmund Highcock (2014)
+
+NAME
+
+  test_utility
+
+
+SYNOPSIS
+	
+  test_utility <command> [arguments] [options]
+
+
+DESCRIPTION
+	
+  This test utility is written to test the command-line-flunky gem.
+  
+EXAMPLES
+
+   $ test_utility hello_world
+   
+   $ test_utility test_bool -b
+   
+EOF
+	
+	COMMANDS_WITH_HELP = [
+		['hello_world', 'hello', 0, 'Say hello to the world', [], []],
+		['test_bool', 'tbool', 0,  'Test whether the boolean flag works', [], [:b]],
+		['test_arguments', 'args', 1,  'Test passing an argument to a command and an argument to an option', ['command_argument'], [:a]],
+
+	]
+	
+	COMMAND_LINE_FLAGS_WITH_HELP = [
+		['--boolean', '-b', GetoptLong::NO_ARGUMENT, 'A boolean option'],		
+		['--argument', '-a', GetoptLong::REQUIRED_ARGUMENT, 'An option which requires an argument '],		
+
+		]
+
+	LONG_COMMAND_LINE_OPTIONS = [
+	["--no-short-form", "", GetoptLong::NO_ARGUMENT, %[This boolean option has no short form]],
+	] 
+		
+	# specifying flag sets a bool to be true
+
+	CLF_BOOLS = [:b, :no_short_form]
+
+	CLF_INVERSE_BOOLS = [] # specifying flag sets a bool to be false
+	
+	PROJECT_NAME = 'command_line_flunky_test_utility'
+		
+	def self.method_missing(method, *args)
+# 		p method, args
+		CommandLineFlunkyTestUtility.send(method, *args)
+	end
+	
+	#def self.setup(copts)
+		#CommandLineFlunkyTestUtility.setup(copts)
+	#end
+	
+	SCRIPT_FILE = __FILE__
+end
+
+class CommandLineFlunkyTestUtility
+	class << self
+		def hello_world(copts)
+			puts "Hello World"
+		end
+		def test_bool(copts)
+			puts "Bool is #{copts[:b]}"
+			puts "no-short-form is #{copts[:no_short_form]}"
+		end
+		def test_arguments(argument, copts)
+			puts "command argument was #{argument} and option argument was #{copts[:a]}"
+		end
+		# This function gets called before every command
+		# and allows arbitrary manipulation of the command
+		# options (copts) hash
+		def setup(copts)
+			# None neededed
+	  end
+	end
+end
+
+
+######################################
+# This must be at the end of the file
+#
+require 'command-line-flunky'
+###############################

data/lib/command-line-flunky.rb

@@ -0,0 +1,212 @@
+
+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'
+require 'rubyhacks'
+# $stderr.puts unless $has_put_startup_message
+$has_put_startup_message = true
+
+# Log.log_file = nil
+
+
+module CommandLineFlunky
+# 	CLF = COMMAND_LINE_FLAGS = []
+	CLF = COMMAND_LINE_FLAGS = COMMAND_LINE_FLAGS_WITH_HELP.map{|arr| arr.slice(0..2)}
+	LONG_COMMAND_LINE_FLAGS = LONG_COMMAND_LINE_OPTIONS.map{|arr| [arr[0], arr[2]]}
+	#
+		# 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_WITH_HELP.push ['manual', 'man', 0, 'Print out command line manual', [], []]
+	COMMANDS_WITH_HELP.push ["interactive_mode", "im", 0, 'Launch an interactive terminal. Any command line flags specified set the defaults for the session. Commands must be given in the short form, e.g. man. Options are given as a ruby hash.', [], []]	
+ 
+
+  COMMANDS = COMMANDS_WITH_HELP.map{|arr| arr.slice(0..2)}
+
+	
+	# 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 
+
+	CLF_TO_LONG = LONG_COMMAND_LINE_OPTIONS.inject({}) do |hash, (long, short, req, help)|
+		option = long[2, long.size].gsub(/\-/, '_').to_sym
+		hash[long] = option
+		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] # 
+
+           
+	# 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
+			elsif CLF_BOOLS.include? CLF_TO_LONG[opt]
+				copts[CLF_TO_LONG[opt]] = true
+			elsif CLF_INVERSE_BOOLS.include? CLF_TO_LONG[opt]
+				copts[CLF_TO_LONG[opt]] = false
+			elsif CLF_TO_LONG[opt]
+				copts[CLF_TO_LONG[opt]] = arg
+			else 
+				raise "Unknown command line argument: #{opt}"
+			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 + LONG_COMMAND_LINE_FLAGS))
+		opts.each do |opt, arg|
+		      process_command_line_option(opt, arg, DEFAULT_COMMAND_OPTIONS)
+		end
+	end
+end
+
+module CommandLineFlunky
+	def self.read_default_command_options(copts)
+		DEFAULT_COMMAND_OPTIONS.each do |key, value|
+			copts[key] ||= value
+		end
+	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.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.run_script
+		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
+  def self.manual(copts={})
+			help = <<EOF
+
+			
+#{MANUAL_HEADER}
+
+COMMANDS
+
+   Either the long or the short form of the command may be used, except in interactive mode, where only short form can be used.
+
+    Long(Short)  <Arguments>  (Meaningful Options)  
+    ---------------------------------------------
+
+#{(COMMANDS_WITH_HELP.sort_by{|arr| arr[0]}.map do |arr| 
+	   sprintf(" %s %s(%s) \n\t%s", "#{arr[0]}(#{arr[1]})",    arr[4].map{|arg| "<#{arg}>"}.join(' ').sub(/(.)$/, '\1 '), arr[5].map{|op| op.to_s}.join(','), arr[3], )
+    end).join("\n\n")}
+
+OPTIONS
+
+#{((COMMAND_LINE_FLAGS_WITH_HELP + LONG_COMMAND_LINE_OPTIONS).map do |arr|
+   sprintf("%-15s %-2s\n\t%s", arr[0], arr[1], arr[3])
+  end).join("\n\n")
+		}
+
+EOF
+		 #help.gsub(/(.{63,73} |.{73})/){"#$1\n\t"}.paginate
+		 help.paginate
+		end
+end
+
+CommandLineFlunky.set_default_command_options_from_command_line
+
+####################
+# CommandLineFlunky.run_script unles
+###################
+
+

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+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 'command-line-flunky'
+
+class Test::Unit::TestCase
+end

data/test/test_command-line-flunky.rb

@@ -0,0 +1,9 @@
+
+require 'helper'
+load 'test_utility'
+
+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,143 @@
+--- !ruby/object:Gem::Specification
+name: command-line-flunky
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Edmund Highcock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyhacks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A framework for quickly creating a command line tool and manual. Coherently
+  and simply links a Ruby class/module interface to a set of command line commands
+  and options. A comprehensive example is in the test folder.
+email: edmundhighcock@users.sourceforge.net
+executables:
+- commandlineflunkytestutility
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/commandlineflunkytestutility
+- lib/command-line-flunky-test-utility.rb
+- lib/command-line-flunky.rb
+- test/helper.rb
+- test/test_command-line-flunky.rb
+homepage: http://github.com/edmundhighcock/command-line-flunky
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A framework for quickly creating a command line tool and manual.
+test_files: []