clue 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adc1f6e8d6b476ddecc339386015e71bab4d4c0d
-  data.tar.gz: 2f5bd6a517174c7c8cc43d2e332b19b37810ca16
+  metadata.gz: 52b1b3fba7f900b089e9f1a7555a4dc946218df5
+  data.tar.gz: dac8a07689cb0a35bf9d22ee4b3fbf3e9fdd9618
 SHA512:
-  metadata.gz: 24232473b4740567d10ec39695048b28b4361d5842ecdb31e2228bdca093d51ef184621d2f43f43c2429f93960b5fa585f48aa9d3129d9759964cbe0ed16b239
-  data.tar.gz: dae14fdd4fe484416e2c5991428ebe8208d24cdcc65bf73b9ab86d333d886003f58493ff926e16c50fb3dbf47b80da5bb86560c72925a5563c81c867a211e5d7
+  metadata.gz: f760a74830c914fdea3c57a63674f1664bbd1550d6cf10a806b933dc00dbcfb7d57aecf3d31c39ced1582a07d39f5ce18a07da6e736377bf070bab32835d405e
+  data.tar.gz: 413240c4ef79e0ae264461e83daef3208ecb5acd1c37833400e3531786d872d0d4f2766354a2a3b366cf896da1fc7894a3fb12f9c37f13c290d5862fb60120fe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clue (1.0.0)
+    clue (1.1.0)
       activesupport
 
 GEM

data/README.md

@@ -6,6 +6,8 @@ The use-case in mind when creating this gem was rake tasks/capistrano recipes in
 
 ## Prerequisites
 
+[![Build Status](https://travis-ci.org/novelys/clue.png?branch=master)](https://travis-ci.org/novelys/clue)
+
 This gem depends only on activesupport. It is tested agains many rubies: 1.8.7, 1.9.3, 2.0.0, jruby-18, jruby-19, rubinius-18, rubinius-19, thanks to travis-ci.
 
 While it is tested against Ruby 1.8, we do not garanty support in future releases, as it is approaching end of life.
@@ -35,11 +37,23 @@ clue.call
 The command name can be supplied when initializing the object, as done above, or at a later point, by setting `command` to some value.
 Calling `call` will raise an exception if `command` is not present.
 
+### Config
+
+Not all command line tools expects the same format of options, value, inputs; you can configure those when initialiazing the object, or at a later point using the  `config` hash. It recognizes :
+
+* `between_arguments`: defaults to `' '`. Used between arguments list
+* `between_options`: defaults to `' '`. Used between options list.
+* `between_streams`: defaults to `' '`. Used between streams list.
+* `option_value_separator`: defaults to `' '`. Used between an option and its value. Will usually be `' '` or `=`.
+* `option_prefix`: defaults to `'--'`. Prepended to an option. Will usually be `-`, or `--`.
+* `option_delimiter`: defaults to `"'"`. Surrounds an option value, in order to prevent escaping issues.
+* `stream_delimiter`: defaults to `"'"`. Surrounds a stream, in order to prevent escaping issues.
+
 ### Options
 
 `Clue` accepts options when initializing, as in `clue = Clue.new(options: [:first, :second, {third: :value}])`.
 
-You must supply "singular" (options without value) first, and "valued" options as a trailing hash, as shown above.  
+You must supply "singular" (options without value) first, and "valued" options as a trailing hash, as shown above.
 You can add options at a later point use `add_singular_option`, `add_singular_options`, `add_option`, and `add_options`.
 
 ### Arguments
@@ -76,4 +90,5 @@ There is no mecanisme built-in for validating the presence/format of arguments,
 
 ## Changelog
 
+* `1.1.0`: Allow configuration of cli command string defaults.
 * `1.0.0`: First version.

data/lib/clue.rb

@@ -12,6 +12,8 @@ class Clue
   include Options
   include Streams
 
+  attr_accessor :config
+
   # Store command name, parse & store args
   def initialize(*args)
     hsh = args.last.kind_of?(Hash) && args.pop || {}
@@ -23,10 +25,26 @@ class Clue
     self.verbose = hsh.delete(:verbose)
     self.dry_run = hsh.delete(:dry_run)
 
+    init_config hsh.delete(:config)
     init_options hsh[:options]
     init_arguments hsh[:arguments]
     init_streams hsh
 
     after_initialize(command, hsh) if self.respond_to?(:after_initialize)
   end
+
+  # Handles config
+  def init_config(config = {})
+    @config = {
+      :between_arguments      => ' ',
+      :between_options        => ' ',
+      :between_streams        => ' ',
+      :option_value_separator => ' ',
+      :option_prefix          => '--',
+      :option_delimiter       => "'",
+      :stream_delimiter       => "'"
+    }
+
+    @config.merge!(config) if config
+  end
 end

data/lib/clue/arguments.rb

@@ -16,7 +16,7 @@ module Clue::Arguments
       value = [value]
     end
 
-    @arguments = value 
+    @arguments = value
   end
 
   # Add one argument
@@ -36,6 +36,6 @@ module Clue::Arguments
 
   # Returns a string or arguments suitable for cli use
   def cli_arguments
-    @arguments.join(' ')
+    @arguments.join self.config[:between_arguments]
   end
 end

data/lib/clue/options.rb

@@ -17,7 +17,7 @@ module Clue::Options
       @options = options
     elsif options.kind_of?(Array)
       @singular_options = options
-      @options = @singular_options.pop if @singular_options.last.kind_of?(Hash)    
+      @options = @singular_options.pop if @singular_options.last.kind_of?(Hash)
     elsif options.kind_of?(String) || options.kind_of?(Symbol)
       @singular_options = [options.to_sym]
     end
@@ -50,19 +50,23 @@ module Clue::Options
 
   # Returns the options string
   def cli_options
-    options_as_array.join(' ')
+    options_as_array.join self.config[:between_options]
   end
 
   # Returns options as an array
   def options_as_array
     # Valued options
     ary = @options.each_with_object([]) do |(key, value), memo|
-      memo << "--#{key.to_s} '#{value.to_s}'"
+      prefix = self.config[:option_prefix]
+      separator = self.config[:option_value_separator]
+      delimiter = self.config[:option_delimiter]
+      memo << "#{prefix}#{key.to_s}#{separator}#{delimiter}#{value.to_s}#{delimiter}"
     end
 
     # Singular options
     ary = @singular_options.each_with_object(ary) do |opt, memo|
-      memo << "--#{opt.to_s}"
+      prefix = self.config[:option_prefix]
+      memo << "#{prefix}#{opt.to_s}"
     end
 
     ary

data/lib/clue/streams.rb

@@ -32,9 +32,10 @@ module Clue::Streams
   def cli_streams
     ary = STREAMS_SYMBOLS.each_with_object([]) do |(key, value), memo|
       ivar = instance_variable_get "@#{key}"
-      memo << "#{value} '#{ivar}'" if ivar
+      delimiter = self.config[:stream_delimiter]
+      memo << "#{value} #{delimiter}#{ivar}#{delimiter}" if ivar
     end
 
-    ary.join(' ')
+    ary.join self.config[:between_streams]
   end
 end

data/lib/clue/version.rb

@@ -1,3 +1,3 @@
 class Clue
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/arguments_spec.rb

@@ -1,7 +1,7 @@
 require 'clue'
 
 describe "Arguments" do
-  subject { Clue.new 'commandname'}
+  subject { Clue.new 'commandname', :config => {:between_arguments => "FOO"}}
   let(:arguments) { subject.instance_variable_get :@arguments }
 
   it 'should add one argument' do
@@ -32,7 +32,7 @@ describe "Arguments" do
 
   it 'can merge arguments into a string' do
     subject.add_arguments %w(john jim jones)
-    
+
     expect(subject.cli_arguments).to include "john"
     expect(subject.cli_arguments).to include "jim"
     expect(subject.cli_arguments).to include "jones"
@@ -53,8 +53,10 @@ describe "Arguments" do
 
   it 'can merge arguments into a string' do
     subject.add_arguments %w(john jim)
-    
+    sep = subject.config[:between_arguments]
+
     expect(subject.cli_arguments).to include "john"
     expect(subject.cli_arguments).to include "jim"
+    expect(subject.cli_arguments).to eq "john#{sep}jim"
   end
 end

data/spec/options_spec.rb

@@ -1,7 +1,14 @@
 require 'clue'
 
 describe "Options" do
-  subject { Clue.new 'commandname'}
+  subject do
+    Clue.new 'commandname', :config => {
+      :option_prefix => '_',
+      :option_value_separator => '==',
+      :option_delimiter => '"""'
+    }
+  end
+
   let(:options) { subject.instance_variable_get :@options }
   let(:singular) { subject.instance_variable_get :@singular_options }
 
@@ -52,12 +59,16 @@ describe "Options" do
   it 'can merge options into a string' do
     subject.add_options :key1 => 'value1', :key2 => 'value2'
     subject.add_singular_options %w(john jim jones)
-    
-    expect(subject.cli_options).to include "--key1 'value1'"
-    expect(subject.cli_options).to include "--key2 'value2'"
-    expect(subject.cli_options).to include "--john"
-    expect(subject.cli_options).to include "--jim"
-    expect(subject.cli_options).to include "--jones"
+
+    prefix = subject.config[:option_prefix]
+    sep = subject.config[:option_value_separator]
+    delim = subject.config[:option_delimiter]
+
+    expect(subject.cli_options).to include "#{prefix}key1#{sep}#{delim}value1#{delim}"
+    expect(subject.cli_options).to include "#{prefix}key2#{sep}#{delim}value2#{delim}"
+    expect(subject.cli_options).to include "#{prefix}john"
+    expect(subject.cli_options).to include "#{prefix}jim"
+    expect(subject.cli_options).to include "#{prefix}jones"
   end
 
   it 'should recognize options given during initialization' do

data/spec/streams_spec.rb

@@ -1,7 +1,7 @@
 require 'clue'
 
 describe "Streams" do
-  subject { Clue.new 'commandname'}
+  subject { Clue.new 'commandname', :config => {:stream_delimiter => '<>'}}
 
   let(:stdin)  { subject.stdin }
   let(:stdout) { subject.stdout }
@@ -38,9 +38,9 @@ describe "Streams" do
 
   it 'can merge streams into a string' do
     subject.set_streams :stdin => 'value', :stdout => 'value2', :stderr => 'val3'
-    
-    expect(subject.cli_streams).to include "> 'value2'"
-    expect(subject.cli_streams).to include "< 'value'"
-    expect(subject.cli_streams).to include "2> 'val3'"
+    delim = subject.config[:stream_delimiter]
+    expect(subject.cli_streams).to include "> #{delim}value2#{delim}"
+    expect(subject.cli_streams).to include "< #{delim}value#{delim}"
+    expect(subject.cli_streams).to include "2> #{delim}val3#{delim}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Soltysiak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport