Merge pull request #47 from at-grandpa/add-io-to-run-block

Add io to run block

README.md

@@ -54,7 +54,7 @@ Add this to your application's `shard.yml`:
 dependencies:
   clim:
     github: at-grandpa/clim
-    version: 0.8.2
+    version: 0.9.0
 ```
 
 ## Minimum sample
@@ -644,6 +644,24 @@ class MyCli < Clim
 end
 ```
 
+### `io` in run block
+
+You can receive `io` in a run block by passing it as the second argument to the start method.
+
+```crystal
+class IoCommand < Clim
+  main do
+    run do |opts, args, io|
+      io.puts "in main_command"
+    end
+  end
+end
+
+io = IO::Memory.new
+IoCommand.start([] of String, io: io)
+io.to_s # => "in main_command\n"
+```
+
 ## Development
 
 ```

shard.yml

@@ -1,5 +1,5 @@
 name: clim
-version: 0.8.2
+version: 0.9.0
 
 authors:
   - at-grandpa <@at_grandpa>
@@ -8,6 +8,6 @@ targets:
   clim:
     main: src/clim.cr
 
-crystal: 0.31.0
+crystal: 0.31.1
 
 license: MIT

spec/clim_spec.cr

@@ -5,17 +5,57 @@ class IoCommand < Clim
     desc "main command."
     usage "main [sub_command] [arguments]"
     run do |opts, args, io|
-      io.puts "Test"
+      io.puts "in main_command"
+    end
+  end
+end
+
+class IoSubCommand < Clim
+  main do
+    run do |opts, args|
+    end
+    sub "sub_command" do
+      desc "sub command."
+      usage "sub_command [arguments]"
+      run do |opts, args, io|
+        io.puts "in sub_command"
+      end
+    end
+  end
+end
+
+class IoSubSubCommand < Clim
+  main do
+    run do |opts, args|
+    end
+    sub "sub_command" do
+      run do |opts, args|
+      end
+      sub "sub_sub_command" do
+        run do |opts, args, io|
+          io.puts "in sub_sub_command"
+        end
+      end
     end
   end
 end
 
 describe Clim do
-  describe "#start_parse" do
-    context "with custom IO - memory" do
+  describe "#start" do
+    it "with IO::Memory in main command" do
+      io = IO::Memory.new
+      IoCommand.start([] of String, io: io)
+      io.to_s.should eq "in main_command\n"
+    end
+    it "with IO::Memory in sub command" do
+      io = IO::Memory.new
+      IoSubCommand.start(["sub_command"], io: io)
+      io.to_s.should eq "in sub_command\n"
+    end
+    it "with IO::Memory in sub sub command" do
       io = IO::Memory.new
-      IoCommand.start_parse([] of String, io: io)
-      io.to_s.should eq "Test\n"
+      IoSubSubCommand.start(["sub_command", "sub_sub_command"], io: io)
+      io.to_s.should eq "in sub_sub_command\n"
     end
   end
 end

src/clim.cr

@@ -23,8 +23,8 @@ class Clim
       command.parse(argv).run(io)
     end
 
-    def self.start(argv)
-      start_parse(argv)
+    def self.start(argv, io : IO = STDOUT)
+      start_parse(argv, io)
     rescue ex : ClimException
       puts "ERROR: #{ex.message}"
     rescue ex : ClimInvalidOptionException | ClimInvalidTypeCastException

src/clim/version.cr

@@ -1,3 +1,3 @@
 class Clim
-  VERSION = "0.8.2"
+  VERSION = "0.9.0"
 end