cmds 0.0.1

data/spec/cmds/sub_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe "Cmds::sub" do
+  it "should work with a keyword substitutions" do
+    expect(
+      Cmds.sub "psql <%= opts %> <%= database %> < <%= filepath %>",
+        [],
+        database: "blah",
+        filepath: "/where ever/it/is.psql",
+        opts: {
+          username: "bingo bob",
+          host: "localhost",
+          port: 12345,
+        }
+    ).to eq 'psql --host=localhost --port=12345 --username=bingo\ bob blah < /where\ ever/it/is.psql'
+  end
+
+  it "should work with positional substitutions" do
+    expect(
+      Cmds.sub "psql <%= arg %> <%= arg %> < <%= arg %>", [
+        {
+          username: "bingo bob",
+          host: "localhost",
+          port: 12345,
+        },
+        "blah",
+        "/where ever/it/is.psql",
+      ]
+    ).to eq 'psql --host=localhost --port=12345 --username=bingo\ bob blah < /where\ ever/it/is.psql'
+  end
+
+  it "should work with no arguments" do
+    expect(
+      Cmds.sub "blah <% if true %>blow<% end %>"
+    ).to eq "blah blow"
+  end
+
+  it "should work with positional and keyword substitutions" do
+    expect(
+      Cmds.sub "blah <%= arg %> <%= y %>", ["ex"], y: "why"
+    ).to eq "blah ex why"
+  end
+
+  it "should work with direct reference to args" do
+    expect(
+      Cmds.sub "psql <%= @args[2] %> <%= @args[0] %> < <%= @args[1] %>", [
+        "blah",
+        "/where ever/it/is.psql",
+        {
+          username: "bingo bob",
+          host: "localhost",
+          port: 12345,
+        },
+      ]
+    ).to eq 'psql --host=localhost --port=12345 --username=bingo\ bob blah < /where\ ever/it/is.psql'
+  end
+
+  context "if statement" do
+    let(:tpl) {
+      <<-BLOCK
+        defaults
+        <% if current_host? %>
+          -currentHost <%= current_host %>
+        <% end %>
+        export <%= domain %> <%= filepath %>
+      BLOCK
+    }
+
+    it "should work when value is present" do
+      expect(
+        Cmds.sub tpl, [], current_host: 'xyz',
+                          domain: 'com.nrser.blah',
+                          filepath: '/tmp/export.plist'
+      ).to eq "defaults -currentHost xyz export com.nrser.blah /tmp/export.plist"
+    end
+
+    it "should work when value is missing" do
+      expect(
+        Cmds.sub tpl, [], domain: 'com.nrser.blah',
+                          filepath: '/tmp/export.plist'
+      ).to eq "defaults export com.nrser.blah /tmp/export.plist"
+    end
+  end
+
+  context "each statement" do
+    let(:tpl) {
+      <<-BLOCK
+        defaults write <%= domain %> <%= key %> -dict
+        <% values.each do |key, value| %>
+          <%= key %> <%= value %>
+        <% end %>
+      BLOCK
+    }
+
+    it "should loop correctly and escape values" do
+      expect(
+        Cmds.sub tpl, [], domain: "com.nrser.blah",
+                          key: 'k',
+                          values: {x: '<ex>', y: 'why'}
+      ).to eq "defaults write com.nrser.blah k -dict x \\<ex\\> y why"
+    end
+  end
+
+  context "optional subs" do
+    let(:tpl) {
+      <<-BLOCK
+        blah <%= x? %> <%= y? %> <%= z? %>
+      BLOCK
+    }
+
+    it "should omit the missing subs" do
+      expect(Cmds.sub tpl, [], x: "ex", z: "zee").to eq "blah ex zee"
+    end
+  end
+
+  context "errors" do
+    it "should raise TypeError if subs in not an array or a hash" do
+      expect{Cmds.sub "a <%= b %> <%= c %>", "dee!"}.to raise_error TypeError
+    end
+
+    it "should error when a kwarg is missing" do
+      expect {
+        Cmds.sub "a <%= b %> <%= c %>", [], b: 'bee!'
+      }.to raise_error KeyError
+    end
+
+    it "should error when an arg is missing" do
+      expect {
+        Cmds.sub "a <%= arg %> <%= arg %>", ['bee!']
+      }.to raise_error IndexError
+    end
+
+    it "should error when more than two args are passed" do
+      expect {
+        Cmds.sub "blah", 1, 2, 3
+      }.to raise_error ArgumentError
+    end
+  end # errors
+
+  context "shortcuts" do
+    it "should replace %s" do
+      expect(
+        Cmds.sub "./test/echo_cmd.rb %s", ["hello world!"]
+      ).to eq './test/echo_cmd.rb hello\ world\!'
+    end
+
+    it "should replace %{key}" do
+      expect(
+        Cmds.sub "./test/echo_cmd.rb %{key}", [], key: "hello world!"
+      ).to eq './test/echo_cmd.rb hello\ world\!'
+    end
+
+    it "should replace %<key>s" do
+      expect(
+        Cmds.sub "./test/echo_cmd.rb %<key>s", [], key: "hello world!"
+      ).to eq './test/echo_cmd.rb hello\ world\!'
+    end
+  end # shortcuts
+end # ::sub

data/spec/cmds_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Cmds do
+  it 'has a version number' do
+    expect(Cmds::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'cmds'
+
+def argv result
+  expect(result.ok?).to be true
+  JSON.load(result.out)['ARGV']
+end
+
+def expect_argv result
+  expect(argv(result))
+end
+
+shared_examples "ok" do
+  it "should be ok" do
+    expect( result.ok? ).to be true
+  end
+
+  it "should have empty err" do
+    expect( result.err ).to eq ""
+  end
+end # ok

data/test/echo_cmd.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'json'
+
+# this script echos the command that invoked it back as a 
+# JSON structure for testing
+
+argv = ARGV.clone
+
+data = {
+  '$0' => $0,
+  'ARGV' => argv,
+}
+
+puts JSON.pretty_generate(data)

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: cmds
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nrser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nrser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- neil@ztkae.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ansible/dev.yml
+- ansible/hosts
+- cmds.gemspec
+- lib/cmds.rb
+- lib/cmds/version.rb
+- scratch/blah.rb
+- scratch/erb.rb
+- spec/cmds/call_spec.rb
+- spec/cmds/curry_spec.rb
+- spec/cmds/erb_context_spec.rb
+- spec/cmds/expand_option_hash_spec.rb
+- spec/cmds/replace_shortcuts_spec.rb
+- spec/cmds/run_spec.rb
+- spec/cmds/sub_spec.rb
+- spec/cmds_spec.rb
+- spec/spec_helper.rb
+- test/echo_cmd.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: helps read, write and remember commands.
+test_files:
+- spec/cmds/call_spec.rb
+- spec/cmds/curry_spec.rb
+- spec/cmds/erb_context_spec.rb
+- spec/cmds/expand_option_hash_spec.rb
+- spec/cmds/replace_shortcuts_spec.rb
+- spec/cmds/run_spec.rb
+- spec/cmds/sub_spec.rb
+- spec/cmds_spec.rb
+- spec/spec_helper.rb
+- test/echo_cmd.rb