coglius 0.0.1

data/Cogfile

@@ -0,0 +1,15 @@
+# All paths are relative to the directory containing this file.
+
+stamp_generator do |name, dest|
+  @name = name
+  stamp 'coglius/generator.rb', dest, :absolute_destination => true
+end
+
+autoload_plugin :Coglius, 'lib/coglius'
+
+# Define a directory in which to find generators
+generator_path 'generators'
+
+# Define a directory in which to find templates
+template_path 'templates'
+

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/coglius.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'cog'
+require 'coglius/option_parser_factory.rb'
+require 'coglius/gli_option_parser.rb'
+require 'coglius/app_support.rb'
+require 'coglius/app.rb'
+require 'coglius/command_support.rb'
+require 'coglius/command.rb'
+require 'coglius/command_line_token.rb'
+require 'coglius/command_line_option.rb'
+require 'coglius/copy_options_to_aliases.rb'
+require 'coglius/exceptions.rb'
+require 'coglius/flag.rb'
+require 'coglius/options.rb'
+require 'coglius/switch.rb'
+require 'coglius/dsl.rb'
+require 'coglius/version.rb'
+require 'coglius/commands/help'
+require 'coglius/commands/compound_command'
+require 'coglius/commands/initconfig'
+require 'coglius/commands/rdoc_document_listener'
+require 'coglius/commands/doc'
+
+module Coglius
+  include Coglius::App
+  def self.included(klass)
+    warn "You should include Coglius::App instead"
+  end
+end

data/lib/coglius/app.rb

@@ -0,0 +1,250 @@
+require 'etc'
+require 'optparse'
+require 'coglius/copy_options_to_aliases'
+require 'coglius/dsl'
+require 'pathname'
+
+module Coglius
+  # A means to define and parse a command line interface that works as
+  # Git's does, in that you specify global options, a command name, command
+  # specific options, and then command arguments.
+  module App
+    include Cog::Generator
+    include CopyOptionsToAliases
+    include DSL
+    include AppSupport
+
+    # Generate the command-line interface in the target language
+    def stamp_app
+      # TODO: write this
+    end
+    
+    # Describe the overall application/programm.  This should be a one-sentence summary
+    # of what your program does that will appear in the help output.
+    #
+    # +description+:: A String of the short description of your program's purpose
+    def program_desc(description=nil)
+      @program_desc = description if description
+      @program_desc
+    end
+
+    # Provide a longer description of the program.  This can be as long as needed, and use double-newlines
+    # for paragraphs.  This will show up in the help output.
+    #
+    # description:: A String for the description
+    def program_long_desc(description=nil)
+      @program_long_desc = description if description
+      @program_long_desc
+    end
+
+    # Use this if the following command should not have the pre block executed.
+    # By default, the pre block is executed before each command and can result in
+    # aborting the call.  Using this will avoid that behavior for the following command
+    def skips_pre
+      @skips_pre = true
+    end
+
+    # Use this if the following command should not have the post block executed.
+    # By default, the post block is executed after each command.
+    # Using this will avoid that behavior for the following command
+    def skips_post
+      @skips_post = true
+    end
+
+    # Use this if the following command should not have the around block executed.
+    # By default, the around block is executed, but for commands that might not want the
+    # setup to happen, this can be handy
+    def skips_around
+      @skips_around = true
+    end
+
+    # Sets that this app uses a config file as well as the name of the config file.  
+    #
+    # +filename+:: A String representing the path to the file to use for the config file.  If it's an absolute
+    #              path, this is treated as the path to the file.  If it's *not*, it's treated as relative to the user's home
+    #              directory as produced by <code>File.expand_path('~')</code>.
+    def config_file(filename)
+      @config_file = if filename =~ /^\//
+        filename
+      else
+        File.join(File.expand_path(ENV['HOME']),filename)
+      end
+      commands[:initconfig] = InitConfig.new(@config_file,commands,flags,switches)
+      @commands_declaration_order << commands[:initconfig]
+      @config_file
+    end
+
+    # Define a block to run after command line arguments are parsed
+    # but before any command is run.  If this block raises an exception
+    # the command specified will not be executed.
+    # The block will receive the global-options,command,options, and arguments
+    # If this block evaluates to true, the program will proceed; otherwise
+    # the program will end immediately
+    def pre(&a_proc)
+      @pre_block = a_proc
+    end
+
+    # Define a block to run after the command was executed, <b>only
+    # if there was not an error</b>.
+    # The block will receive the global-options,command,options, and arguments
+    def post(&a_proc)
+      @post_block = a_proc
+    end
+
+    # This inverts the pre/post concept.  This is useful when you have a global shared resource that is governed by a block
+    # instead of separate open/close methods.  The block you pass here will be given four parameters:
+    #
+    # global options:: the parsed global options
+    # command:: The Coglius::Command that the user is going to invoke
+    # options:: the command specific options
+    # args:: unparsed command-line args
+    # code:: a block that you must +call+ to execute the command.
+    #
+    # #help_now! and #exit_now! work as expected; you can abort the command call by simply not calling it.
+    #
+    # You can declare as many #around blocks as you want.  They will be called in the order in which they are defined.
+    #
+    # Note that if you declare #around blocks, #pre and #post blocks will still work.  The #pre is called first, followed by
+    # the around, followed by the #post.
+    #
+    # Call #skips_around before a command that should not have this hook fired
+    def around(&a_proc)
+      @around_blocks ||= []
+      @around_blocks << a_proc
+    end
+
+    # Define a block to run if an error occurs.
+    # The block will receive any Exception that was caught.
+    # It should evaluate to false to avoid the built-in error handling (which basically just
+    # prints out a message). Coglius uses a variety of exceptions that you can use to find out what 
+    # errors might've occurred during command-line parsing:
+    # * Coglius::CustomExit
+    # * Coglius::UnknownCommandArgument
+    # * Coglius::UnknownGlobalArgument
+    # * Coglius::UnknownCommand
+    # * Coglius::BadCommandLine
+    def on_error(&a_proc)
+      @error_block = a_proc
+    end
+
+    # Indicate the version of your application
+    #
+    # +version+:: String containing the version of your application.  
+    def version(version)
+      @version = version
+      switch :version, :negatable => false
+    end
+
+    # By default, Coglius mutates the argument passed to it.  This is
+    # consistent with +OptionParser+, but be less than ideal.  Since
+    # that value, for scaffolded apps, is +ARGV+, you might want to
+    # refer to the entire command-line via +ARGV+ and thus not want it mutated.
+    def preserve_argv(preserve=true)
+      @preserve_argv = preserve
+    end
+
+    # Call this with +true+ will cause the +global_options+ and
+    # +options+ passed to your code to be wrapped in
+    # Options, which is a subclass of +OpenStruct+ that adds
+    # <tt>[]</tt> and <tt>[]=</tt> methods.
+    #
+    # +use_openstruct+:: a Boolean indicating if we should use OpenStruct instead of Hashes
+    def use_openstruct(use_openstruct)
+      @use_openstruct = use_openstruct
+    end
+
+    # Configure a type conversion not already provided by the underlying OptionParser.
+    # This works more or less like the OptionParser version.
+    #
+    # object:: the class (or whatever) that triggers the type conversion
+    # block:: the block that will be given the string argument and is expected
+    #         to return the converted value
+    #
+    # Example
+    #
+    #     accept(Hash) do |value|
+    #       result = {}
+    #       value.split(/,/) do |pair|
+    #         k,v = pair.split(/:/)
+    #         result[k] = v
+    #       end
+    #       result
+    #     end
+    #
+    #     flag :properties, :type => Hash
+    def accept(object,&block)
+      accepts[object] = block
+    end
+
+    # Simpler means of exiting with a custom exit code.  This will 
+    # raise a CustomExit with the given message and exit code, which will ultimatley
+    # cause your application to exit with the given exit_code as its exit status
+    # Use #help_now! if you want to show the help in addition to the error message
+    #
+    # message:: message to show the user
+    # exit_code:: exit code to exit as, defaults to 1
+    def exit_now!(message,exit_code=1)
+      raise CustomExit.new(message,exit_code)
+    end
+
+    # Exit now, showing the user help for the command they executed.  Use #exit_now! to just show the error message
+    #
+    # message:: message to indicate how the user has messed up the CLI invocation or nil to just simply show help
+    def help_now!(message=nil)
+      exception = OptionParser::ParseError.new(message)
+      class << exception
+        def exit_code; 64; end
+      end
+      raise exception
+    end
+
+    # Control how commands and options are sorted in help output.  By default, they are sorted alphabetically.
+    #
+    # sort_type:: How you want help commands/options sorted:
+    #             +:manually+:: help commands/options are ordered in the order declared.
+    #             +:alpha+:: sort alphabetically (default)
+    def sort_help(sort_type)
+      @help_sort_type = sort_type
+    end
+
+    # Set how help text is wrapped.
+    #
+    # wrap_type:: Symbol indicating how you'd like text wrapped:
+    #             +:to_terminal+:: Wrap text based on the width of the terminal (default)
+    #             +:verbatim+:: Format text exactly as it was given to the various methods.  This is useful if your output has
+    #                           formatted output, e.g. ascii tables and you don't want it messed with.
+    #             +:one_line+:: Do not wrap text at all.  This will bring all help content onto one line, removing any newlines
+    #             +:tty_only+:: Wrap like +:to_terminal+ if this output is going to a TTY, otherwise don't wrap (like +:one_line+)
+    def wrap_help_text(wrap_type)
+      @help_text_wrap_type = wrap_type
+    end
+
+    def program_name(override=nil) #:nodoc:
+      warn "#program_name has been deprecated"
+    end
+
+    # Sets a default command to run when none is specified on the command line.  Note that
+    # if you use this, you won't be able to pass arguments, flags, or switches
+    # to the command when run in default mode.  All flags and switches are treated
+    # as global, and any argument will be interpretted as the command name and likely
+    # fail.
+    #
+    # +command+:: Command as a Symbol to run as default
+    def default_command(command)
+      @default_command = command.to_sym
+    end
+
+    private
+
+    def load_commands(path)
+      if File.exists? path
+        Dir.entries(path).sort.each do |entry|
+          file = File.join(path,entry)
+          if file =~ /\.rb$/
+            require file
+          end
+        end
+      end
+    end
+  end
+end