ironment 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4415806f87a95416f7abf1a012b87f583ecc44a5
-  data.tar.gz: e555823df2d1509014e618b94c0ffea662e03690
+  metadata.gz: dec374e4c49972f58d40fb7e79634773e2976897
+  data.tar.gz: aab2478fd0f04eb260f0769ff380e377eacce6e6
 SHA512:
-  metadata.gz: 039f36bb0cd8af1b1b34ab5dad95db6dfdde5aa79fb0863ecc6004d720cdf94759fdbb71287990aedfa8c396ba368f9326e585b40e6c485a3a2837c5044ff232
-  data.tar.gz: ef98639f90836ce9a852b18f0d0ca9816a9bffe017c565a448f73e2debdecc7cb37b94fbec0672df3977b89569f749a2ace5a9277c1f23f33523bc082f26b20a
+  metadata.gz: 454ae0ac18f0a36ef243b79301bdac830fde933abcd960a6f7f0fb04e5df2d6948f674ff4d727a3a6b54f29b1d1e9da6fdb8b49c3c1c64a465378f2468e8f068
+  data.tar.gz: 66e7a89d0f77ddea16814dae968b4ddd360102cabd3c18841e66e5bec0cb4b5c5c95a22707ad3aad0e7bb0f3a200b418decc3b718b432e242790a0d71ff103dc

data/README.md

@@ -43,6 +43,10 @@ $ yaourt -S ruby-ironment
 
 ## Changelog
 
+### 1.1.0
+
+* Remove runtime dependency on [commander][commander].
+
 ### 1.0.2
 
 * Correct a regression of the view feature of the executable.
@@ -84,3 +88,5 @@ $ yaourt -S ruby-ironment
 * Initial version. Contains basic support for wrapping commands and populating
   the environment by recursively reading the directory structure upwards and
   looking for .envrc files.
+
+[commander]: https://github.com/commander-rb/commander

data/bin/iron

@@ -1,44 +1,10 @@
 #!/usr/bin/env ruby
 
-require "commander/import"
 require "ironment"
-require "ironment/version"
 
 Signal.trap("INT") do
   puts "Aborted"
   exit 1
 end
 
-program :name, "Ironment"
-program :version, Ironment::VERSION
-program :description, "Environment populator & command wrapper utility."
-
-command :exec do |c|
-  c.syntax = "exec [files..]"
-  c.description = "create a new environment (default)"
-  c.action do |args|
-    Ironment::CL.new.exec_with_environment *args
-  end
-end
-
-command :trust do |c|
-  c.syntax = "trust [files..]"
-  c.description = "add a file as trusted"
-  c.action do |args|
-    args.each do |file|
-      Ironment::CL.new.trust file
-    end
-  end
-end
-
-command :untrust do |c|
-  c.syntax = "untrust [files..]"
-  c.description = "remove a file as trusted"
-  c.action do |args|
-    args.each do |file|
-      Ironment::CL.new.untrust file
-    end
-  end
-end
-
-default_command :exec
+exit Ironment::Optparse.new(argv: ARGV).parse || 0

data/lib/ironment.rb

@@ -1,11 +1,14 @@
 require "ironment/cl"
 require "ironment/config"
 require "ironment/finder"
+require "ironment/optparse/help_texts"
+require "ironment/optparse"
 require "ironment/populator"
 require "ironment/cl/prompter"
 require "ironment/executor"
 require "ironment/runcom"
 require "ironment/truster"
+require "ironment/version"
 
 class Ironment
   class IronmentError < StandardError; end

data/lib/ironment/optparse.rb

@@ -0,0 +1,81 @@
+class Ironment
+  class Optparse
+    HELP_OPTIONS = ["-h", "--help"]
+    VERSION_OPTIONS = ["-v", "--version"]
+
+    def initialize(options = {})
+      @argv = options[:argv] || ARGV
+      @stdout = options[:stdout] || $stdout
+      @stderr = options[:stderr] || $stderr
+      @cl = options[:cl] || CL.new
+    end
+
+    def parse
+      if include_version?(@argv)
+        @stdout.puts "Ironment #{VERSION}"
+        return
+      end
+
+      unknown_options = options(@argv) - HELP_OPTIONS - VERSION_OPTIONS
+
+      if !unknown_options.empty?
+        @stderr.puts "Unknown option: #{unknown_options.first}"
+        return 1
+      end
+
+      case @argv.first
+      when "help"
+        case @argv[1]
+        when "exec"
+          @stdout.puts EXEC_HELP_TEXT
+        when "trust"
+          @stdout.puts TRUST_HELP_TEXT
+        when "untrust"
+          @stdout.puts UNTRUST_HELP_TEXT
+        when "help", nil
+          @stdout.puts BASE_HELP_TEXT
+        else
+          @stderr.puts "Unknown command: #{@argv[1]}"
+          return 1
+        end
+      when "trust"
+        return @stdout.puts TRUST_HELP_TEXT if include_help?(@argv)
+        @argv.drop(1).each do |arg|
+          @cl.trust arg
+        end
+      when "untrust"
+        return @stdout.puts UNTRUST_HELP_TEXT if include_help?(@argv)
+        @argv.drop(1).each do |arg|
+          @cl.untrust arg
+        end
+      when "exec"
+        return @stdout.puts EXEC_HELP_TEXT if include_help?(@argv)
+        @cl.exec_with_environment *@argv.drop(1)
+      else
+        return @stdout.puts BASE_HELP_TEXT if include_help?(@argv)
+        return @stdout.puts BASE_HELP_TEXT if @argv.empty?
+        @cl.exec_with_environment *@argv
+      end
+    end
+
+    private
+
+    def include_help?(argv)
+      !(options(argv) & HELP_OPTIONS).empty?
+    end
+
+    def include_version?(argv)
+      !(options(argv) & VERSION_OPTIONS).empty?
+    end
+
+    def options(argv)
+      if ["help", "exec", "trust", "untrust"].include?(argv.first)
+        argv = argv.drop(1)
+      end
+
+      argv.take_while do |arg|
+        arg.start_with?("-")
+      end
+    end
+  end
+end

data/lib/ironment/optparse/help_texts.rb

@@ -0,0 +1,83 @@
+class Ironment
+  class Optparse
+    class << self
+      private
+
+      def unindent(s)
+        s.gsub(/^#{s.scan(/^[ \t]+(?=\S)/).min}/, '')
+      end
+    end
+
+    BASE_HELP_TEXT = unindent(<<-TXT)
+      Environment populator & command wrapper utility.
+
+      \e[1mUSAGE\e[0m
+
+        $ iron COMMAND [OPTIONS]...
+
+      \e[1mCOMMANDS\e[0m
+
+        exec     Create a new environment (default)
+        help     Display global or [command] help documentation
+        trust    Add a file as trusted
+        untrust  Remove a file as trusted
+
+      \e[1mGLOBAL OPTIONS\e[0m
+
+        -h, --help
+            Display help documentation
+
+        -v, --version
+            Display version information
+    TXT
+
+    EXEC_HELP_TEXT = unindent(<<-TXT)
+      Create a new environment
+
+      \e[1mUSAGE\e[0m
+
+        $ iron exec COMMAND [ARG]...
+        $ iron COMMAND [ARG]...
+
+      \e[1mGLOBAL OPTIONS\e[0m
+
+        -h, --help
+            Display help documentation
+
+        -v, --version
+            Display version information
+    TXT
+
+    TRUST_HELP_TEXT = unindent(<<-TXT)
+      Add a file / files as trusted
+
+      \e[1mUSAGE\e[0m
+
+        $ iron trust [FILE]...
+
+      \e[1mGLOBAL OPTIONS\e[0m
+
+        -h, --help
+            Display help documentation
+
+        -v, --version
+            Display version information
+    TXT
+
+    UNTRUST_HELP_TEXT = unindent(<<-TXT)
+      Remove a file / files as trusted
+
+      \e[1mUSAGE\e[0m
+
+        $ iron untrust [FILE]...
+
+      \e[1mGLOBAL OPTIONS\e[0m
+
+        -h, --help
+            Display help documentation
+
+        -v, --version
+            Display version information
+    TXT
+  end
+end

data/lib/ironment/version.rb

@@ -1,3 +1,3 @@
 class Ironment
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/test/optparse_test.rb

@@ -0,0 +1,141 @@
+require "stringio"
+
+def truncate(string, options = {})
+  max = options.fetch(:max, 20)
+
+  if string.length > max
+    "#{string[0..max]} (...)"
+  else
+    string
+  end
+end
+
+def test_optparse_passthrough(options)
+  argv = options.delete(:argv)
+
+  raise ArgumentError, "Expected a single expectation" unless options.size == 1
+
+  expectation, arguments = options.first
+
+  it "should parse \"#{argv.join(" ")}\" and invoke ##{expectation} with #{arguments.inspect}" do
+    cl = Minitest::Mock.new
+    cl.expect expectation, nil, arguments
+
+    Ironment::Optparse.new(
+      cl: cl,
+      argv: argv
+    ).parse
+
+    cl.verify
+  end
+end
+
+def test_optparse_stdout(options)
+  argv, stdout = options.values_at(:argv, :stdout)
+
+  it "should parse \"#{argv.join(" ")}\" and output #{truncate(stdout).inspect}" do
+    actual_stdout = StringIO.new
+
+    Ironment::Optparse.new(
+      cl: Minitest::Mock.new, # Dummmy mock without expectations
+      argv: argv,
+      stdout: actual_stdout
+    ).parse
+
+    assert_equal stdout, actual_stdout.string
+  end
+end
+
+def test_optparse_stderr(options)
+  argv, stderr = options.values_at(:argv, :stderr)
+
+  it "should parse \"#{argv.join(" ")}\" and output #{truncate(stderr).inspect}" do
+    actual_stderr = StringIO.new
+
+    Ironment::Optparse.new(
+      cl: Minitest::Mock.new, # Dummmy mock without expectations
+      argv: argv,
+      stderr: actual_stderr
+    ).parse
+
+    assert_equal stderr, actual_stderr.string
+  end
+end
+
+def test_optparse_ret_value(options)
+  argv, ret_value = options.values_at(:argv, :ret_value)
+
+  it "should parse \"#{argv.join(" ")}\" and return #{ret_value}" do
+    actual_stderr = StringIO.new
+
+    actual_ret_value = Ironment::Optparse.new(
+      cl: Minitest::Mock.new, # Dummmy mock without expectations
+      argv: argv,
+      stdout: StringIO.new,
+      stderr: StringIO.new
+    ).parse
+
+    assert_equal ret_value, actual_ret_value
+  end
+end
+
+describe Ironment::Optparse do
+  test_optparse_passthrough argv: ["foo"], exec_with_environment: ["foo"]
+  test_optparse_passthrough argv: ["foo", "--bar"], exec_with_environment: ["foo", "--bar"]
+  test_optparse_passthrough argv: ["foo", "--help"], exec_with_environment: ["foo", "--help"]
+  test_optparse_passthrough argv: ["exec", "foo"], exec_with_environment: ["foo"]
+  test_optparse_passthrough argv: ["trust", "foo"], trust: ["foo"]
+  test_optparse_passthrough argv: ["untrust", "foo"], untrust: ["foo"]
+
+  test_optparse_stdout argv: [], stdout: Ironment::Optparse::BASE_HELP_TEXT
+  test_optparse_stdout argv: ["-h"], stdout: Ironment::Optparse::BASE_HELP_TEXT
+  test_optparse_stdout argv: ["--help"], stdout: Ironment::Optparse::BASE_HELP_TEXT
+  test_optparse_stdout argv: ["help"], stdout: Ironment::Optparse::BASE_HELP_TEXT
+
+  test_optparse_stdout argv: ["exec", "-h"], stdout: Ironment::Optparse::EXEC_HELP_TEXT
+  test_optparse_stdout argv: ["exec", "--help"], stdout: Ironment::Optparse::EXEC_HELP_TEXT
+  test_optparse_stdout argv: ["help", "exec"], stdout: Ironment::Optparse::EXEC_HELP_TEXT
+
+  test_optparse_stdout argv: ["trust", "-h"], stdout: Ironment::Optparse::TRUST_HELP_TEXT
+  test_optparse_stdout argv: ["trust", "--help"], stdout: Ironment::Optparse::TRUST_HELP_TEXT
+  test_optparse_stdout argv: ["help", "trust"], stdout: Ironment::Optparse::TRUST_HELP_TEXT
+
+  test_optparse_stdout argv: ["untrust", "-h"], stdout: Ironment::Optparse::UNTRUST_HELP_TEXT
+  test_optparse_stdout argv: ["untrust", "--help"], stdout: Ironment::Optparse::UNTRUST_HELP_TEXT
+  test_optparse_stdout argv: ["help", "untrust"], stdout: Ironment::Optparse::UNTRUST_HELP_TEXT
+
+  test_optparse_stdout argv: ["-v"], stdout: "Ironment #{Ironment::VERSION}\n"
+  test_optparse_stdout argv: ["--version"], stdout: "Ironment #{Ironment::VERSION}\n"
+
+  test_optparse_stderr argv: ["--foo", "bar"], stderr: "Unknown option: --foo\n"
+  test_optparse_ret_value argv: ["--foo", "bar"], ret_value: 1
+
+  test_optparse_stderr argv: ["help", "foo"], stderr: "Unknown command: foo\n"
+  test_optparse_ret_value argv: ["help", "foo"], ret_value: 1
+
+  it "should invoke #trust once for each argument" do
+    cl = Minitest::Mock.new
+    cl.expect :trust, nil, ["foo"]
+    cl.expect :trust, nil, ["bar"]
+
+    Ironment::Optparse.new(
+      cl: cl,
+      argv: ["trust", "foo", "bar"]
+    ).parse
+
+    cl.verify
+  end
+
+  it "should invoke #untrust once for each argument" do
+    cl = Minitest::Mock.new
+    cl.expect :untrust, nil, ["foo"]
+    cl.expect :untrust, nil, ["bar"]
+
+    Ironment::Optparse.new(
+      cl: cl,
+      argv: ["untrust", "foo", "bar"]
+    ).parse
+
+    cl.verify
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
-require "codeclimate-test-reporter"
+require "simplecov"
 
-CodeClimate::TestReporter.start
+SimpleCov.start
 
 require "ironment"
 require "fakefs/safe"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ironment
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Amundsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: commander
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.5
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +112,8 @@ files:
 - lib/ironment/exec.rb
 - lib/ironment/executor.rb
 - lib/ironment/finder.rb
+- lib/ironment/optparse.rb
+- lib/ironment/optparse/help_texts.rb
 - lib/ironment/populator.rb
 - lib/ironment/runcom.rb
 - lib/ironment/truster.rb
@@ -135,6 +123,7 @@ files:
 - test/executor_test.rb
 - test/finder_test.rb
 - test/ironment_test.rb
+- test/optparse_test.rb
 - test/populator_test.rb
 - test/runcom_test.rb
 - test/test_helper.rb
@@ -159,17 +148,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Environment populator & command wrapper utility.
 test_files:
-- test/executor_test.rb
-- test/truster_test.rb
-- test/runcom_test.rb
-- test/cl_test.rb
+- test/config_test.rb
 - test/finder_test.rb
+- test/test_helper.rb
 - test/populator_test.rb
+- test/runcom_test.rb
+- test/truster_test.rb
 - test/ironment_test.rb
-- test/config_test.rb
-- test/test_helper.rb
+- test/optparse_test.rb
+- test/executor_test.rb
+- test/cl_test.rb