coglius 0.0.1

data/lib/coglius/option_parser_factory.rb

@@ -0,0 +1,45 @@
+module Coglius
+  # Factory for creating an OptionParser based on app configuration and DSL calls
+  class OptionParserFactory
+    # Create an OptionParserFactory for the given
+    # flags, switches, and accepts
+    def initialize(flags,switches,accepts)
+      @flags = flags
+      @switches = switches
+      @accepts = accepts
+    end
+
+    # Return an option parser to parse the given flags, switches and accepts
+    def option_parser
+      options = {}
+      option_parser = OptionParser.new do |opts|
+        self.class.setup_accepts(opts,@accepts)
+        self.class.setup_options(opts,@switches,options)
+        self.class.setup_options(opts,@flags,options)
+      end
+      [option_parser,options]
+    end
+
+  private
+
+    def self.setup_accepts(opts,accepts)
+      accepts.each do |object,block|
+        opts.accept(object) do |arg_as_string|
+          block.call(arg_as_string)
+        end
+      end
+    end
+
+    def self.setup_options(opts,tokens,options)
+      tokens.each do |ignore,token|
+        opts.on(*token.arguments_for_option_parser) do |arg|
+          [token.name,token.aliases].flatten.compact.map(&:to_s).each do |name|
+            options[name] = arg
+            options[name.to_sym] = arg
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/coglius/options.rb

@@ -0,0 +1,23 @@
+require 'ostruct'
+
+module Coglius
+  # Subclass of +OpenStruct+ that provides hash-like methods for #[] and #[]=.  Note that is is *not* a Hash.
+  # By using Coglius::App#use_openstruct, your options will be coerced into one of these.
+  class Options < OpenStruct
+
+    # Return the value of an attribute
+    def [](k)
+      @table[k.to_sym]
+    end
+
+    # Set the value of an attribute
+    def []=(k, v)
+      @table[k.to_sym] = v
+    end
+
+    def map(&block)
+      @table.map(&block)
+    end
+  end
+end
+

data/lib/coglius/switch.rb

@@ -0,0 +1,35 @@
+require 'coglius/command_line_option.rb'
+
+module Coglius
+  # Defines a command line switch
+  class Switch < CommandLineOption #:nodoc:
+
+    attr_accessor :default_value
+    attr_reader :negatable
+
+    # Creates a new switch
+    #
+    # names - Array of symbols or strings representing the names of this switch
+    # options - hash of options:
+    #           :desc - the short description
+    #           :long_desc - the long description
+    #           :negatable - true or false if this switch is negatable; defaults to true
+    #           :default_value - default value if the switch is omitted
+    def initialize(names,options = {})
+      super(names,options)
+      @default_value = false if options[:default_value].nil?
+      @negatable = options[:negatable].nil? ? true : options[:negatable]
+      if @default_value != false && @negatable == false
+        raise "A switch with default #{@default_value} that isn't negetable is useless"
+      end
+    end
+
+    def arguments_for_option_parser
+      all_forms_a
+    end
+
+    def negatable?
+      @negatable
+    end
+  end
+end

data/lib/coglius/terminal.rb

@@ -0,0 +1,94 @@
+module Coglius
+  # Class to encapsulate stuff about the terminal. This is useful to application developers
+  # as a canonical means to get information about the user's current terminal configuraiton.
+  # Coglius uses this to determine the number of columns to use when printing to the screen.
+  #
+  # To access it, use Terminal.instance.  This is a singleton mostly to facilitate testing, but
+  # it seems reasonable enough, since there's only one terminal in effect
+  #
+  # Example:
+  #
+  #     Terminal.instance.size[0] # => columns in the terminal
+  #     Terminal.default_size = [128,24] # => change default when we can't figure it out
+  #     raise "no ls?!?!?" unless Terminal.instance.command_exists?("ls")
+  #
+  class Terminal
+
+    @@default_size = [80,24]
+
+    # Get the default size of the terminal when we can't figure it out
+    # 
+    # Returns an array of int [cols,rows]
+    def self.default_size
+      @@default_size
+    end
+
+    # Set the default size of the terminal to use when we can't figure it out
+    #
+    # +size+:: array of two int [cols,rows]
+    def self.default_size=(size)
+      @@default_size = size
+    end
+
+    # Provide access to the shared instance.  
+    def self.instance; @@instance ||= Terminal.new; end
+
+    # Call this to cause methods to throw exceptions rather than return a sane default.  You
+    # probably don't want to call this unless you are writing tests
+    def make_unsafe! #:nodoc:
+      @unsafe = true
+    end
+
+    # Returns true if the given command exists on this system
+    #
+    # +command+:: The command, as a String, to check for, without any path information.
+    def self.command_exists?(command)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|dir| File.exists? File.join(dir, command) }
+    end
+
+    def command_exists?(command)
+      self.class.command_exists?(command)
+    end
+
+    SIZE_DETERMINERS = [
+      [
+        lambda { (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/) },
+        lambda { [ENV['COLUMNS'].to_i, ENV['LINES'].to_i] }
+      ],
+      [
+        lambda { (jruby? || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput') },
+        lambda { [run_command('tput cols').to_i, run_command('tput lines').to_i] }
+      ],
+      [ 
+        lambda { STDIN.tty? && command_exists?('stty') },
+        lambda { run_command('stty size').scan(/\d+/).map { |size_element| size_element.to_i }.reverse }
+      ],
+      [
+        lambda { true },
+        lambda { Terminal.default_size },
+      ],
+    ]
+
+    # Get the size of the current terminal.
+    # Ripped from hirb[https://github.com/cldwalker/hirb/blob/master/lib/hirb/util.rb]
+    #
+    # Returns an Array of size two Ints representing the terminal width and height
+    def size
+      SIZE_DETERMINERS.select { |(predicate,ignore)| predicate.call }.first[1].call
+    rescue Exception => ex
+      raise ex if @unsafe
+      Terminal.default_size
+    end
+
+    private
+
+    # Runs a command using backticks.  Extracted to allow for testing
+    def self.run_command(command)
+      `#{command}`
+    end
+
+    # True if we are JRuby; exposed to allow for testing
+    def self.jruby?; RUBY_PLATFORM =~ /java/; end
+
+  end
+end

data/lib/coglius/version.rb

@@ -0,0 +1,5 @@
+module Coglius
+  unless const_defined? :VERSION
+    VERSION = '0.0.1'
+  end
+end

data/templates/coglius/generator.rb.erb

@@ -0,0 +1,26 @@
+extend Coglius::App
+
+program_desc 'Describe your application here'
+
+version '0.0.1'
+
+desc 'Describe some switch here'
+switch [:s,:switch]
+
+desc 'Describe some flag here'
+default_value 'the default'
+arg_name 'The name of the argument'
+flag [:f,:flagname]
+
+desc 'Describe my_command here'
+arg_name 'Describe arguments to my_command here'
+command :my_command do |c|
+  c.desc 'Describe a switch to my_command'
+  c.switch :s
+
+  c.desc 'Describe a flag to my_command'
+  c.default_value 'default'
+  c.flag :f
+end
+
+stamp_app

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification 
+name: coglius
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin Tonon
+- David Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  version_requirements: *id001
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 3
+        - 11
+        version: "3.11"
+  version_requirements: *id002
+  name: rdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  version_requirements: *id003
+  name: rainbow
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: clean_test
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: aruba
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: sdoc
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id007
+  name: faker
+  prerelease: false
+  type: :development
+description: Build command-suite CLI apps that are awesome.  Bootstrap your app, add commands, options and documentation while maintaining a well-tested idiomatic command-line app
+email: kevin@betweenconcepts.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Cogfile
+- LICENSE
+- templates/coglius/generator.rb.erb
+- lib/coglius/app.rb
+- lib/coglius/app_support.rb
+- lib/coglius/command.rb
+- lib/coglius/command_line_option.rb
+- lib/coglius/command_line_token.rb
+- lib/coglius/command_support.rb
+- lib/coglius/commands/compound_command.rb
+- lib/coglius/commands/doc.rb
+- lib/coglius/commands/help.rb
+- lib/coglius/commands/help_modules/arg_name_formatter.rb
+- lib/coglius/commands/help_modules/command_finder.rb
+- lib/coglius/commands/help_modules/command_help_format.rb
+- lib/coglius/commands/help_modules/global_help_format.rb
+- lib/coglius/commands/help_modules/help_completion_format.rb
+- lib/coglius/commands/help_modules/list_formatter.rb
+- lib/coglius/commands/help_modules/one_line_wrapper.rb
+- lib/coglius/commands/help_modules/options_formatter.rb
+- lib/coglius/commands/help_modules/text_wrapper.rb
+- lib/coglius/commands/help_modules/tty_only_wrapper.rb
+- lib/coglius/commands/help_modules/verbatim_wrapper.rb
+- lib/coglius/commands/initconfig.rb
+- lib/coglius/commands/rdoc_document_listener.rb
+- lib/coglius/commands/scaffold.rb
+- lib/coglius/copy_options_to_aliases.rb
+- lib/coglius/dsl.rb
+- lib/coglius/exceptions.rb
+- lib/coglius/flag.rb
+- lib/coglius/gli_option_parser.rb
+- lib/coglius/option_parser_factory.rb
+- lib/coglius/options.rb
+- lib/coglius/switch.rb
+- lib/coglius/terminal.rb
+- lib/coglius/version.rb
+- lib/coglius.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Not ready for use.
+test_files: []
+