futest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35a95d6ea6fbf97288d5911168bec2c8c7a4d63b
-  data.tar.gz: 82d69b0048efe37201021c0f3799defba323045c
+  metadata.gz: 224339334e5136b565f5d838828e203f0e74eefb
+  data.tar.gz: 5750d699b9cc98f47250893587ecf2b1f78e5dfc
 SHA512:
-  metadata.gz: 62a1557f1ea417b35e2eb30bd723228b76206c24852ce1d996754ab650415214f35a607751b90e91c995957fd59fbb8a63a6d6ce12a55e81f38738d0db2e6424
-  data.tar.gz: 93f4788d9ea0708a3214e5182a6495ad4bcb38075748fe591b2d2a3e6cad9138dcd4df55c71e59e5b9c605bfc0e4fb44da979b9c2220d818c9c7aece62896fe0
+  metadata.gz: aaf9b7fdbf3ce190129d084bd3340cdb3bc70cd295a2388e453025a76d19c3af5e9bb9ff4643db781b262be852acaa64cad5cc7ea124430ac471257f7d432348
+  data.tar.gz: 255682cbdf14cd3437ff53220ec476a02f2810143f039cee3eabeb80afa0fc0355fa7ec6cf7873b79af48d312a95c364d27b296bd34713dad3748efcd1dffdce

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+**Version 0.1.0** - *2017-01-04*
+
+- :v and :vv options to err for more verbose output
+- Fixed show command link replacement

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rerun'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Fugroup
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,196 @@
+# Futest flexible testing for Ruby
+
+Test driven development has never been easier. If you like to write scripts instead of tests, and not worry about how your testing framework works, then Futest will give you exactly what you need.
+
+### Installation
+```
+gem install futest
+```
+or add to Gemfile. In your tests include the line
+```ruby
+include Futest::Helpers
+```
+and you're good to go.
+
+### Settings
+```ruby
+# The command to run when you use 'show' to show the @body from the last pull.
+# The default is for MacOs. The -g flag opens the page in the background.
+Futest.show = 'open -g'
+
+# Mode, default is development
+Futest.mode = ENV['RACK_ENV'] || 'development'
+
+# Debug
+Futest.debug = false
+```
+
+### Commands
+- **test:** Takes a message and optional setup methods, then prints the message and current line number.
+- **stop:** Stop test and print message along with line number.
+- **is:** Checks if something is true and stops if it isn't. See the usage section below.
+- **pull:** Pulls a URL and expose varibles with info you can use.
+- **show:** Shows the body from the last pull in your web browser.
+- **err:** Print formatted exception error message and stops the test.
+
+### Usage
+For a real-world example with a test runner ready, have a look at [the tests for Futest.](https://github.com/fugroup/futest/tree/master/test)
+```ruby
+# Require futest if not using Bundler
+require 'futest'
+
+# Include the Futest helpers in your test runner
+include Futest::Helpers
+
+# Run the tests from your app root directory
+ruby test/run.rb
+
+# Auto-test with Rerun, Guard or other libraries
+Rerun: https://github.com/alexch/rerun
+gem 'rerun'
+gem 'rb-fsevent'
+gem 'terminal-notifier'
+
+# Example command for Rerun, can be added to a shell alias
+bundle exec rerun --dir .,config --pattern '**/*.{rb,ru,yml}' -- ruby test/run.rb
+
+# Use begin to have formatted output on error
+begin
+
+  # Print string in green
+  test 'Testing Heliocentric Model'
+
+  # Optionally pass setup methods to run as symbols
+  # define setup methods
+  def setup; @hello = 'Welcome to the curve.'; end
+
+  def setup_user
+    @user = User.first
+  end
+
+  test 'Reality', :setup, :setup_user
+  is @user, :a? => User
+  is @hello, 'Welcome to the flatness.'
+
+  # :eq is default, can be omitted
+  is 'horizon', 'curved'
+  is 1, 1
+  is 1, :eq => 1
+  is 1, :gt => 0
+  is 1, :lt => 2
+  is 1, :a? => Integer
+
+  # 1 argument is also allowed
+  is 'everything' == 'stories'
+
+  # Use stop to end the test run
+  stop "Can't process" if :earth == 'flat'
+
+  # Pass the validated model object to print the error messages
+  @user = User.first
+  @user.name = "Truth"
+
+  stop "Can't believe user", @user unless @user.save
+
+  # Here are the tests that show how it works
+  # There options are:
+  # :a?, :eq, :lt, :lte, :gt, :gte, :in, :nin, :has
+  s = 'hello'
+  is s, 'hello'
+  is s == 'hello', true
+  is s != 'hello', false
+  is s.start_with?('h'), true
+  is nil, NilClass
+
+  is 1, 1
+  is 1, Integer
+  is 1, :a? => Integer
+  is 1, :eq => 1
+  is 1, :lt => 2
+  is 1, :lte => 2
+  is 2, :lte => 2
+  is 2, :gte => 2
+  is 3, :gte => 2
+  is 6, :gte => 2
+  is 1, :in => [1,2,3]
+  is 5, :nin => [1,2,3]
+  is({:test => 1}, :has => :test)
+
+  # Set up the @host variable to use pull if you want to test requests
+  # The pull format is pull(method = :get, path, params, headers)
+  # Default is :get, but :post, :delete, :update, :patch are supported.
+
+  # You can set the @host globally with $host in stead, or $base for @base
+  # Optionally specify a @base variable to pre-add a path after the @host
+  @base = '/login' # Optional
+  @host = 'http://waveorb.com' # Required
+
+  # URL will be @host + @base, http://waveorb.com/login in this case
+  pull '/login'
+  pull '/login', :duration => 'long'
+  pull '/login', {:duration => 'long'}, :pjax => '1'
+
+  # The pull command exposes these variables for use with tests
+  is @host, 'http://waveorb.com'
+  is @page, :a? => String
+  is @code, 200
+  is @cookies, :a? => Hash
+  is @headers, :a? => Hash
+  is @raw, :a? => Hash
+  is @history, :a? => Array
+  is @body, :a? => String
+
+
+  # # # # # # # # # # # #
+  # Example test with login
+
+  # Post the email and password to the login resource
+  def login
+    pull :post, '/login', :email => 'vidar@fugroup.net', :password => 'test'
+  end
+
+  # Print the name of the test, and run the login
+  # Cookies will be sent back automatically, so your login works for the duration of the test
+  test 'Profile', :login
+
+  # Now that we're logged in, we can view the profile page
+  pull '/profile'
+
+  # The show command displays the last @body from the pull in the browser
+  show
+
+  # Now @page, @code, @cookies, @headers, @raw, @history, @body, @url is available
+  is @page, :a? => String     # => Actually a RestClient response object
+  is @code, 200
+  is @cookies, :a? => Hash
+  is @headers, :a? => Hash
+  is @raw, :a? => Hash
+  is @history, :a? => Array
+  is @body, :a? => String
+  is @url, :a? => String
+
+  # Check if the HTML contains a string
+  is @body.include?('string')
+
+  # Flexible, many ways to do it.
+  is @body =~ /string/, Integer
+  is @body !~ /string/, false
+  is @body =~ /string/, :ne => nil
+
+rescue => x
+  # You can print more information here if you need to debug
+  puts x.message
+  puts x.backtrace
+
+  # Err prints a short backtrace and the line number, then stops the tests.
+  err x
+
+  # Err takes options as symbols
+  err x, :v      # Verbose, prints the full message
+  err x, :vv     # Very verbose, prints the full backtrace as well
+end
+```
+
+Created and maintained by [Fugroup Ltd.](https://www.fugroup.net) We are the creators of [CrowdfundHQ.](https://crowdfundhq.com)
+
+`@authors: Vidar`

data/config/boot.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.require(:default, :development)
+
+MODE = ENV['RACK_ENV'] || 'development'
+
+require './lib/futest.rb'
+require './models/model.rb'

data/futest.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'futest'
+  s.version     = '0.1.1'
+  s.date        = '2017-01-05'
+  s.summary     = "Futest flexible testing for Ruby"
+  s.description = "Program your tests as normal scripts without dependencies, mocks, stubs and rules."
+  s.authors     = ["Fugroup Limited"]
+
+  s.add_runtime_dependency 'rest-client', '>= 2.0'
+
+  s.email       = 'mail@fugroup.net'
+  s.homepage    = 'https://github.com/fugroup/futest'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+end

data/lib/futest.rb

@@ -1,3 +1,4 @@
+require 'rest-client'
 require 'json'
 
 module Futest

data/lib/futest/helpers.rb

@@ -0,0 +1,170 @@
+module Futest
+  module Helpers
+
+    CMD = {
+      :a? => 'is', :a => 'is',
+      :eq => '==', :ne => '!=',
+      :gt => '>',  :gte => '>=',
+      :lt => '<',  :lte => '<=',
+      :in => 'in', :nin => 'nin',
+      :has => 'has'
+    }
+
+    ##############
+    # TEST METHODS
+    ##############
+
+    # Prints error message and stops execution
+    def stop(str, model = nil, n = line(caller))
+      m = "#{n}: #{str}"
+
+      # Support for errors when using Object DB ORM
+      if model and model.errors and model.errors.any?
+        q = model.errors.messages rescue model.errors
+        m += ":\n=> " + q.each{|k, v| q[k] = v.join(', ')}.to_json[1..-2].gsub('","', '", "')
+      end
+
+      puts red(%{#{m}\n}); exit(0)
+    end
+
+    # Prints the test and runs setup methods
+    def test(*args)
+      n = args[-1].is_a?(Integer) ? args[-1] : line(caller)
+      args.select{|r| r.is_a?(Symbol)}.each{|k| send(k)}
+      puts green("#{n}: #{args[0]}")
+    end
+
+    # Equality tester
+    def is(v1, v2 = :udef, n = line(caller))
+
+      # Use :a? if v2 is not a string and looks like a class
+      v2 = {:a? => v2} if !v2.is_a?(String) and v2.to_s[0] =~ /[A-Z]/
+
+      # Use :eq if v2 is defined and it's not a Hash
+      v2 = {:eq => v2} if v2 != :udef and !v2.is_a?(Hash)
+
+      # Symbolize keys
+      k, v = (v2.is_a?(Hash) ? v2 : {}).inject({}){|q,(k,v)|q[k.to_sym] = v; q}.to_a.flatten
+
+      # Extract values
+      s = ["#{v1.class} #{v1} #{CMD[k]} #{v.class} #{v}", nil, n]
+
+      # Set @debug = true to print info
+      puts s.join('-') if @debug
+
+      # Stop unless true
+      stop(*s) unless
+      case k
+      when nil then !!v1
+      when :eq  then v1 == v
+      when :ne  then v1 != v
+      when :gt  then v1 > v
+      when :gte then v1 >= v
+      when :lt  then v1 < v
+      when :lte then v1 <= v
+      when :in  then v2[:in].include?(v1)
+      when :nin then !v2[:nin].include?(v1)
+      when :has then v1.has_key?(v2[:has])
+      when :a?, :a then v1.is_a?(v)
+      else false end
+    end
+
+
+    ##############
+    # REQUEST HELPERS
+    ##############
+
+    # Pulls any data source and returns the response
+    def pull(*args)
+      # Define $host in your test helper
+      # or @host before you call pull
+      # set @base to add paths to @host
+      @host ||= $host
+      @base ||= ($base || '')
+      stop('@host not defined') unless @host
+
+      @method = args[0].is_a?(Symbol) ? args.delete_at(0) : :get
+      @path = (args[0] || '/')
+      @params = (args[1] || {})
+      @headers = (args[2] || {})
+      @headers.merge!(:cookies => @cookies) if @cookies
+
+      args.each do |a|
+        @params.merge!(a) if a.is_a?(Hash)
+        @method = a if a.is_a?(Symbol)
+        @path = a if a.is_a?(String)
+      end
+
+      # Add host and base to url
+      @url = @host + (@base || '') + @path
+
+      o = {
+        :method => @method,
+        :url => @url,
+        :timeout => 2,
+        :payload => @params,
+        :headers => @headers
+      }
+      RestClient::Request.execute(o){|z| @page = z}
+      # Make result available in instance variables
+      [:code, :cookies, :headers, :history].each{|i| instance_variable_set("@#{i}", @page.send(i))}
+      @raw = @page.raw_headers
+      @body = @page.body
+    end
+
+    # Show the last @body in the browser
+    def show
+      stop('@body is not defined') unless @body
+
+      # Add @host and @base to all links in HTML to fetch CSS and images
+      @body.scan(/(<.*(src|href)=["'](\/?.+)["'].*>)/).each do |m|
+        @body.gsub!(m[0], m[0].gsub(m[2], "#{@host}#{@base}#{m[2][0] == '/' ? m[2] : "/#{m[2]}"}")) unless %w[ht //].include?(m[2][0..1])
+      end
+
+      # Write body to tmp file
+      name = "/tmp/#{Time.now.to_i}_fushow.html"
+      File.open(name, 'w'){|f| f.write(@body)}
+
+      # Open with default browser, set Futest.show to change this
+      `#{Futest.show} #{name}`
+    end
+
+
+    ##############
+    # HELPER METHODS
+    ##############
+
+    # Colorize output, 33 is :green (default), 31 is :red
+    def out(s, c = :green)
+      z = {:green => 33, :red => 31}; %{\e[#{z[c] || c}m#{s}\e[0m}
+    end
+
+    # Colorize input green
+    def green(s); out(s); end
+
+    # Colorize input red
+    def red(s); out(s, :red); end
+
+    # Print error message
+    def err(*args)
+      x = args[0]
+
+      # Pass :v or :vv to print more information about the error
+      puts x.backtrace.join("\n") if args.include?(:vv)
+      puts x.message if args.include?(:v)
+
+      # Normally just print the first line in the message
+      x.backtrace.first.match(/(\/.+\/.*.rb):(\d{1,9}):/)
+      stop(%{#{x.message}\n=> ~/#{$1.split('/')[3..-1].join('/')}}, nil, $2) if $1 and $2
+
+      # Print more if the backtrace doesn't match
+      stop(%{#{x.message}\n=> #{x.backtrace[0..60].join("\n")}})
+    end
+
+    # Get the line number
+    def line(q)
+      q.first.split(':')[1]
+    end
+
+  end
+end

data/models/model.rb

@@ -0,0 +1,8 @@
+class Model
+
+  attr_accessor :errors
+
+  def initialize
+    @errors = {}
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fugroup Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -31,7 +31,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- config/boot.rb
+- futest.gemspec
 - lib/futest.rb
+- lib/futest/helpers.rb
+- models/model.rb
 homepage: https://github.com/fugroup/futest
 licenses:
 - MIT