executable 1.0.0

data/HISTORY

@@ -0,0 +1,11 @@
+= HISTORY
+
+== 1.0.0 / 2009-06-25
+
+This is the initialize release of Cliable (as a stand alone project).
+Cliable is a mixin that can turn any class into an commandline interface.
+
+* 1 Major Enhancement
+
+  * Birthday!
+

data/LICENSE

@@ -0,0 +1,204 @@
+.
+                             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/PROFILE

@@ -0,0 +1,30 @@
+---
+title  : Executable
+summary: Any class, a command-line interface.
+created: 2008-08-08
+
+description:
+  The Executable mixin is a very quick and and easy
+  way to make almost any class usable via a command
+  line interface. It simply uses writer methods as
+  option setters, and the first command line argument
+  as the method to call, with the subsequent arguments
+  passed to the method.
+
+authors:
+  - Thomas Sawyer
+
+resources:
+  home: http://rubyworks.github.com/executable
+  code: http://github.com/rubyworks/executable
+
+repositories:
+  public: git://github.com/rubyworks/cliable.git
+
+requires:
+  - turn (test)
+
+collection : RubyWorks
+license    : Apache 2.0
+copyright  : Copyright (c) 2008 Thomas Sawyer
+

data/README

@@ -0,0 +1,77 @@
+= Executable
+
+* http://rubyworks.github.com/executable
+* http://github.com/rubyworks/executable
+
+
+== DESCRIPTION
+
+The Executable mixin is a very quick and and easy
+way to make almost any class usable via a command
+line interface. It simply uses writer methods as
+option setters, and the first command line argument
+as the method to call, with the subsequent arguments
+passed to the method.
+
+
+== FEATURES
+
+* Super easy to use, just mixin.
+* Public writters become CLI options.
+* Public methods become subcommands.
+
+
+== RELEASE NOTES
+
+Please see HISTORY file.
+
+
+== SYNOPSIS
+
+Simply mixin Executable, then call #execute_command.
+
+  class X
+    include Executable
+    attr_accessor :quiet
+    def bread(*args)
+      ["BREAD", quiet, *args]
+    end
+    def butter(*args)
+      ["BUTTER", quiet, *args]
+    end
+  end
+
+  x = X.new
+
+  x.execute_command("butter yum")
+  => ["BUTTER", nil, "yum"]
+
+  x.execute_command("bread --quiet")
+  => ["BREAD", true]
+
+See RDocs for more information.
+
+
+== INSTALL
+
+  $ sudo gem install executable
+
+
+== LEGAL
+
+(Apache 2.0)
+
+Copyright (c) 2009 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this program 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/Rakefile

@@ -0,0 +1,11 @@
+task :default => [:test]
+
+desc "run tests"
+task :test do
+  sh "ruby -rtest/unit -Ilib test/*.rb"
+end
+
+desc "run tests with turn"
+task :turn do
+  sh "turn -T -Ilib test/*.rb"
+end

data/lib/executable.rb

@@ -0,0 +1,194 @@
+# = Executable Mixin
+#
+# The Executable mixin is a very quick and and easy
+# way to make almost any class usable via a command
+# line interface. It simply uses writer methods as
+# option setters, and the first command line argument
+# as the method to call, with the subsequent arguments
+# passed to the method.
+#
+# The only limitation of this approach (besides the weak
+# control of the process) is that required options must
+# be specified with the key=value notation.
+#
+#   class X
+#     include Executable
+#
+#     attr_accessor :quiet
+#
+#     def bread(*args)
+#       ["BREAD", quiet, *args]
+#     end
+#
+#     def butter(*args)
+#       ["BUTTER", quiet, *args]
+#     end
+#   end
+#
+#   x = X.new
+#
+#   x.execute_command("butter yum")
+#   => ["BUTTER", nil, "yum"]
+#
+#   x.execute_command("bread --quiet")
+#   => ["BUTTER", true]
+#
+# Executable also defines #command_missing and #option_missing,
+# which you can override to provide suitable results.
+#
+# TODO: Maybe command_missing is redundant, and method_missing would suffice?
+#
+module Executable
+
+  class NoCommandError < NameError
+  end
+
+  class NoOptionError < ArgumentError
+  end
+
+  # Used to invoke the command.
+  def execute_command(argv=ARGV)
+    Executable.run(self, argv)
+  end
+
+  # This is the fallback subcommand. Override this to provide
+  # a fallback when no command is given on the commandline.
+  def command_missing
+    raise NoCommandError
+  end
+
+  # Override option_missing if needed.
+  # This receives the name of the option and
+  # the remaining arguments list. It must consume
+  # any argument it uses from the (begining of)
+  # the list.
+  def option_missing(opt, *argv)
+    raise NoOptionError, opt
+  end
+
+  class << self
+
+    def run(obj, argv=ARGV)
+      args = parse(obj, argv)
+      subcmd = args.shift
+      if subcmd && !obj.respond_to?("#{subcmd}=")
+        obj.send(subcmd, *args)
+      else
+        obj.command_missing
+      end
+    end
+
+    #def run(obj)
+    #  methname, args = *parse(obj)
+    #  meth = obj.method(methname)
+    #  meth.call(*args)
+    #end
+
+    #
+    def parse(obj, argv)
+      case argv
+      when String
+        require 'shellwords'
+        argv = Shellwords.shellwords(argv)
+      else
+        argv = argv.dup
+      end
+
+      argv = argv.dup
+      args, opts, i = [], {}, 0
+      while argv.size > 0
+        case opt = argv.shift
+        when /=/
+          parse_equal(obj, opt, argv)
+        when /^--/
+          parse_option(obj, opt, argv)
+        when /^-/
+          parse_flags(obj, opt, argv)
+        else
+          args << opt
+        end
+      end
+      return args
+    end
+
+    #
+    def parse_equal(obj, opt, argv)
+      if md = /^[-]*(.*?)=(.*?)$/.match(opt)
+        x, v = md[1], md[2]
+      else
+        raise ArgumentError, "#{x}"
+      end
+      if obj.respond_to?("#{x}=")
+        # TODO: to_b if 'true' or 'false' ?
+        obj.send("#{x}=",v)
+      else
+        obj.option_missing(x, v) # argv?
+      end
+    end
+
+    #
+    def parse_option(obj, opt, argv)
+      x = opt[2..-1]
+      if obj.respond_to?("#{x}=")
+        obj.send("#{x}=",true)
+      else
+        obj.option_missing(x, argv)
+      end
+    end
+
+    #
+    def parse_flags(obj, opt, args)
+      x = opt[1..-1]
+      c = 0
+      x.split(//).each do |k|
+        if obj.respond_to?("#{k}=")
+          obj.send("#{k}=",true)
+        else
+          obj.option_missing(x, argv)
+        end
+      end
+    end
+
+  end #class << self
+
+end
+
+
+=begin SPEC
+
+class X
+  include Executable
+
+  attr_accessor :file
+  attr_accessor :quiet
+
+  attr :cmd
+
+  #
+  def bread(*args)
+    @cmd = "BREAD"
+  end
+
+  #
+  def butter(*args)
+    @cmd = "BUTTER"
+  end
+end
+
+Respect.spec "Executable" do
+
+  it "first command runs" do
+    x = X.new
+    x.execute_command("bread")
+    x.cmd.assert == "BREAD"
+  end
+
+  it "second command runs" do
+    x = X.new
+    x.execute_command("butter")
+    x.cmd.assert == "BUTTER"
+  end
+end
+
+=end
+

data/test/test_executable.rb

@@ -0,0 +1,38 @@
+require 'executable'
+
+class TestExecutable < Test::Unit::TestCase
+
+  class SampleCli
+    include Executable
+
+    attr :result
+
+    def initialize
+      @result = []
+    end
+
+    def output=(value)
+      @result << "output: #{value}"
+    end
+
+    def jump
+      @result << "jump"
+    end
+  end
+
+  #
+  def test_parse_without_option
+    s = SampleCli.new
+    s.execute_command("jump")
+    assert_equal(s.result, ["jump"])
+  end
+
+  #
+  def test_parse_with_option
+    s = SampleCli.new
+    s.execute_command("jump --output=home")
+    assert_equal(s.result, ['output: home', 'jump'])
+  end
+
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: executable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Thomas Sawyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: The Executable mixin is a very quick and and easy way to make almost any class usable via a command line interface. It simply uses writer methods as option setters, and the first command line argument as the method to call, with the subsequent arguments passed to the method.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/executable.rb
+- test/test_executable.rb
+- Rakefile
+- PROFILE
+- LICENSE
+- README
+- HISTORY
+homepage: http://rubyworks.github.com/executable
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: 
+- --title
+- Executable API
+- --main
+- README
+require_paths: 
+- 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: executable
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Any class, a command-line interface.
+test_files: 
+- test/test_executable.rb