sanultari-commander 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p286@sancommander"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.15 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec"
+  gem "yard"
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  bundler
+  jeweler
+  rdoc
+  rspec
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jeong, Jiung
+
+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 @@
+= sanultari-commander
+
+Description goes here.
+
+== Contributing to sanultari-commander
+ 
+* 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 Jeong, Jiung. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,39 @@
+# 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 = "sanultari-commander"
+  gem.homepage = "http://github.com/sanultari/commander"
+  gem.license = "BSD"
+  gem.summary = %Q{REPL representable command line tool framework}
+  gem.description = %Q{REPL representable command line tool framework.
+    its goal is composable, gem distributable, descriptable, expandable CUI tool framework.
+  }
+  gem.email = "ethernuiel@sanultari.com"
+  gem.authors = ["Jeong, Jiung"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

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

data/lib/sanultari-commander.rb

@@ -0,0 +1,4 @@
+module SanUltari end
+require 'sanultari/command_parameter'
+require 'sanultari/command_wrapper'
+require 'sanultari/command_descriptor'

data/lib/sanultari/command_descriptor.rb

@@ -0,0 +1,91 @@
+require 'sanultari/command_wrapper'
+
+module SanUltari::CommandDescriptor
+  def self.included target
+    target.extend ClassMethods
+  end
+
+  module ClassMethods
+    @registry = {}
+
+    def map command, clazz, options = nil
+      @registry ||= {}
+      @registry[command.to_sym] = SanUltari::CommandWrapper.new command, clazz, nil, options
+    end
+
+    def desc command, description
+    end
+
+    def param command, param, options = nil
+      @registry[command.to_sym].add_param param, options
+    end
+
+    def option command, option, options = nil
+    end
+
+    def import clazz, operation = nil
+      targets = operation
+      targets ||= clazz.available_commands
+      unless targets.kind_of? Array
+        targets = [targets]
+      end
+
+      targets.each do |cmd|
+        command = cmd.to_sym
+        wrapper = clazz.get command
+        @registry[command] = wrapper
+      end
+    end
+
+    def group group_name, clazz, operation = nil
+    end
+
+    def default command
+      @default_command = command.to_sym
+    end
+
+    def get command
+      @registry[command.to_sym]
+    end
+
+    def available_commands
+      @registry.keys
+    end
+
+    def list
+
+    end
+
+    def run argv
+      selected_command = nil
+      options = []
+      args = []
+      argument_list = argv.clone
+      argv.each do |arg|
+        if arg.start_with? '-'
+          value = argument_list.shift
+          args.push value
+          options.push value
+          next
+        end
+
+        unless @registry.include? arg.to_sym
+          args.push argument_list.shift
+          next
+        end
+
+        selected_command = @registry[argument_list.shift.to_sym]
+      end
+
+      args += argument_list
+      if selected_command == nil
+        options.clear
+      else
+        args -= options
+      end
+
+      selected_command ||= @registry[@default_command] unless @default_command == nil
+      selected_command.run(args, options) if selected_command != nil
+    end
+  end
+end

data/lib/sanultari/command_parameter.rb

@@ -0,0 +1,22 @@
+class SanUltari::CommandParameter
+  attr_reader :name, :default, :type, :order
+
+  def initialize name, options = nil
+    if options
+      @default = options[:default]
+      @type = options[:type]
+      @type ||= :accessor
+      @require = options[:require]
+      @require ||= true
+      if @type == :parameter
+        @order = options[:order]
+        @order ||= -1
+      end
+    end
+    @name = name
+  end
+
+  def require?
+    @require
+  end
+end

data/lib/sanultari/command_wrapper.rb

@@ -0,0 +1,126 @@
+require 'sanultari/command_parameter'
+
+class SanUltari::CommandWrapper
+  attr_reader :clazz, :params, :options
+
+  def initialize name, clazz, params = nil, options = nil
+    @name = name
+    @clazz = clazz
+    @params = params
+    @params ||= []
+    @options = options
+    @options ||= {}
+    @freeze = false
+    @required_param_count = 0
+
+    # TODO : deprecate
+    @args = []
+  end
+
+  def add_param param_name, options
+    param = SanUltari::CommandParameter.new(param_name, options)
+    if param.require? && !param.default
+      @required_param_count += 1
+    end
+    @params.push param
+  end
+
+  def params= value
+    @clazz = value if !@freeze
+  end
+
+  def clazz= value
+    @clazz = value if !@freeze
+  end
+
+  def freeze?
+    @freeze
+  end
+
+  def freeze!
+    @freeze = true
+  end
+
+  def run args = nil, options = nil
+    args ||= []
+    options ||= []
+    unless args.length >= @required_param_count
+      # TODO: standard output change
+      puts "this command has #{@required_param_count} parameters at least"
+      return
+    end
+
+    runner = @clazz.new
+    # TODO options parsing
+    options, param_configs = set_values runner, args, options
+    set_defaults runner, param_configs
+
+    if runner.public_method(@name).parameters.length > 0
+      runner.public_send @name, *@args
+    else
+      runner.public_send @name
+    end
+  end
+
+  private
+  def set_value object, name, value
+    object.public_send "#{name}=".to_sym, value
+  end
+
+  def handle_args param_config, value
+    if param_config.order < 0
+      @args.push value
+    else
+      if @args[order] == nil
+        @args[order] = value
+      else
+        puts "this command is mis-configured. some arguments have same order."
+      end
+    end
+  end
+
+  def set_defaults object, param_configs
+    param_configs.each do |param_config|
+      value = param_config.default
+
+      if param_config.require? && !value
+        puts "required parameter(#{param_config.name}) is missing"
+        return
+      end
+      set_value(object, param_config.name, value) unless value == nil
+      param_configs.shift
+    end
+  end
+
+  def set_values object, args, options
+    param_configs = @params.clone
+    args.each do |arg|
+      if param_configs.empty?
+        index = args.index arg
+        options += args[index..-1]
+        break
+      end
+
+      current_param_config = param_configs[0]
+      if arg.start_with? '-'
+        options.push arg
+        next
+      end
+
+      # set params
+      if current_param_config.type == :parameter
+        handle_args current_param_config, arg
+      else
+        unless object.respond_to? "#{current_param_config.name}=".to_sym
+          next
+        end
+        set_value object, current_param_config.name, arg
+      end
+      param_configs.shift
+    end
+
+    return options, param_configs
+  end
+
+  private :set_defaults, :set_value, :set_values
+end

data/spec/sample.rb

@@ -0,0 +1,52 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Hello
+  attr_accessor :name
+
+  def hello
+    puts "Hello, #{self.name}"
+  end
+end
+
+class Goodbye
+  def bye name
+    puts "Goodbye #{name}"
+  end
+
+  def bye2
+    puts "잘가라"
+  end
+end
+
+class AnotherRunner
+  include SanUltari::CommandDescriptor
+
+  #, desc: 'goodbye command'
+  map :bye, Goodbye
+  param :bye, :name, type: :parameter
+
+  map :bye2, Goodbye
+end
+
+class Runner
+  include SanUltari::CommandDescriptor
+
+  default :hello
+
+  map :hello, Hello, desc: 'hello command'
+  desc :hello, 'hello'
+  # type: :attribute is default
+  param :hello, :name, require: true, default: 'World'
+  # second parameter is optional. second parameter can remove for importing all commands
+  import AnotherRunner
+  # another importing method. imported commands has group. commands having same name can be distinguish
+  # last optional parameter is same functionally with above method
+  group :say, AnotherRunner
+end
+
+Runner.run ARGV
+
+
+# ruby sample.rb -v -h --help hello --test tim
+#  > Hello, tim

data/spec/sanultari-commander_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SanultariCommander" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'sanultari-commander'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: sanultari-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeong, Jiung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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: '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: bundler
+  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: jeweler
+  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'
+description: ! "REPL representable command line tool framework.\n    its goal is composable,
+  gem distributable, descriptable, expandable CUI tool framework.\n  "
+email: ethernuiel@sanultari.com
+executables:
+- sucmd
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/sucmd
+- lib/sanultari-commander.rb
+- lib/sanultari/command_descriptor.rb
+- lib/sanultari/command_parameter.rb
+- lib/sanultari/command_wrapper.rb
+- spec/sample.rb
+- spec/sanultari-commander_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sanultari/commander
+licenses:
+- BSD
+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: 3489927732922680914
+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: REPL representable command line tool framework
+test_files: []