cancun 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3ca94770ee376416da95e6989144638bf8499ba
-  data.tar.gz: 40a137a6f821e04360f338e09a4f925a5b39707b
+  metadata.gz: 84b8d158bc5a21247c93bd015f3980a69fbf44f4
+  data.tar.gz: 0e3f721f036794332d448d5eccbfae9c25ce1a15
 SHA512:
-  metadata.gz: 05e648f03b08ae9e3ad45d50cdcc4ac6af9bfc408a48387f8124a2a30a6f73c435f4a00ee0e36050c7a9fd274b2f94bf9f1354c9ffc7e85a14ab4ddd982c75ba
-  data.tar.gz: 2b88306b4747ca7da1285e3a6cbf21b8a47b63c8f61fd5ec18b743d50b7265e7358d1ceff25eb393e51dccdb158a3486326cfe5379ed369ac61b3f206cbed7a5
+  metadata.gz: 25183361d4ab917554abe86dc0d0d518cd437d48b287aac95990fbd4397039eb14518aea68cc48e99a2789d9d116f00faa88683731d51ea10660fbe0fbdbb96d
+  data.tar.gz: a35931bd69932e4465fb4a35135696c577fe289cd1ed5b4ee2a4330b0776b01c12b19f7fc23ae16e9edb9208e725586d8f3ea2b3e58c5c5517eb296a938ba43c

data/README.md

@@ -1,6 +1,6 @@
 # Cancun
 
-TODO: Write a gem description
+DSL for testing command line applications in ruby
 
 ## Installation
 
@@ -18,7 +18,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Require cancun on your spec_helper.rb when using *Rspec*:
+```ruby
+require 'cancun'
+```
+
+
+### Testing highline with Rspec:
+
+For testing this ruby class:
+```ruby
+class Foo
+  def salute
+      h = HighLine.new
+      h.ask 'what is your name?'
+      h.say "Hi #{name}"
+    end
+  end
+end
+```
+cancun would work the following way:
+
+```ruby
+require 'spec_helper'
+
+describe Foo do
+  include Cancun::Highline
+  before { init_highline_test }
+ 
+  describe '#hello' do
+    it 'says hello correctly' do
+      run described_class.new.salute do
+        type 'bonzo'
+        output.should be('Hi bonzo')
+      end
+    end
+  end
+```
+
+###testing executable with Rspec:
+
+For testing this ./executable:
+
+```bash
+#!/usr/bin/env ruby
+
+puts 'who are you?'
+name = gets
+puts "Hi #{name}"
+```
+
+You would use this code:
+
+```ruby
+require 'spec_helper'
+
+describe 'executable' do
+  include Cancun::Executable
+  
+  it 'test executable' do
+    run './executable' do
+      type 'bonzo'
+      output.should be('Hi bonzo')
+    end
+  end
+end
+```
 
 ## Contributing
 

data/cancun.gemspec

@@ -19,5 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'highline'
+  spec.add_development_dependency 'debugger'
   spec.add_development_dependency "rake"
 end

data/lib/cancun.rb

@@ -1,7 +1,7 @@
 require "cancun/version"
 
 module Cancun
-  # Your code goes here...
 end
+
 require 'cancun/executable'
 require 'cancun/highline'

data/lib/cancun/executable.rb

@@ -1,17 +1,32 @@
 require 'open3'
 module Cancun
   module Executable
+    def init_cancun
+      @output_read, @output_write = IO.pipe
+      @input_read, @input_write = IO.pipe
+    end
+
     def run(executable)
       @w = nil
-      IO.popen(executable, 'w') do |w|
-        @w = w
-        yield if block_given?
-      end
+
+      IO.popen(executable, out: @output_write, in: @input_read)
     end
 
-    def type(*stream)
-      @w.puts stream
-      @w.flush
+    def type(*args)
+      @input_write << [*args].flatten.join("\n") + "\n"
+      sleep 0.01
+    end
+
+    # def type(*stream)
+
+      # @w.puts stream
+      # @w.flush
+    # end
+
+    def output
+      @output ||= ''
+      @output << @output_read.dup.read_nonblock(4096) rescue Errno::EAGAIN
+      @output
     end
   end
 end

data/lib/cancun/highline.rb

@@ -1,6 +1,17 @@
 module Cancun
   module Highline
-    def init_highline_test
+    attr_reader :exit_code
+
+    class << self
+      def no_timeout!
+        @no_timeout = true
+      end
+
+      def timeout?
+        !!@no_timeout
+      end
+    end
+    def  init_cancun_highline
       @input_read, @input_write = IO.pipe
       @output_read, @output_write = IO.pipe
       @exit_code = nil
@@ -19,17 +30,23 @@ module Cancun
       Thread.new do
         Thread.abort_on_exception = true
         begin
+
+        if Cancun::Highline.timeout?
           Timeout.timeout(0.3){ @exit_code = yield }
-        rescue Timeout::Error => e
+        else
+        @exit_code = yield
 
         end
+        rescue Timeout::Error
+          warn 'WARNING: cancun timeout, you can set Cancun::Highline.no_timeout!'
+        end
+
       end
     end
 
     def run_sync
       run { yield }.join
     end
-    attr_reader :exit_code
     def output
       @output ||= ''
       @output << @output_read.dup.read_nonblock(4096) rescue Errno::EAGAIN

data/lib/cancun/version.rb

@@ -1,3 +1,3 @@
 module Cancun
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dummy/bin/foo

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../foo'
+Foo.new.salute

data/spec/dummy/foo.rb

@@ -0,0 +1,9 @@
+require 'highline'
+
+class Foo
+  def salute
+    h = HighLine.new
+    name = h.ask 'what is your name?'
+    h.say "Hi #{name}"
+  end
+end

data/spec/lib/executable_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'excutable spec' do
+  include Cancun::Executable
+
+  it 'works for highline' do
+    init_cancun
+      type 'Bonzo'
+    run './spec/dummy/bin/foo'
+      output.should include('Hi Bonzo')
+  end
+end
+

data/spec/lib/highline_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'highline spec' do
+  include Cancun::Highline
+
+  before do
+    init_cancun_highline
+  end
+
+  it 'works for highline' do
+      type 'bonzo'
+      run_sync {Foo.new.salute}
+      output.should include('Hi Bonzo')
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'cancun'
+require 'dummy/foo'
+require 'debugger'
+
+RSpec.configure do |config|
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cancun
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - bonzofenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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: debugger
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +98,11 @@ files:
 - lib/cancun/executable.rb
 - lib/cancun/highline.rb
 - lib/cancun/version.rb
+- spec/dummy/bin/foo
+- spec/dummy/foo.rb
+- spec/lib/executable_spec.rb
+- spec/lib/highline_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bonzofenix/cancun
 licenses:
 - MIT
@@ -81,4 +128,9 @@ signing_key:
 specification_version: 4
 summary: this gem should provide a simple DSL solution for unit and integration tests
   of Command Line apps
-test_files: []
+test_files:
+- spec/dummy/bin/foo
+- spec/dummy/foo.rb
+- spec/lib/executable_spec.rb
+- spec/lib/highline_spec.rb
+- spec/spec_helper.rb