usecase_tracer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bb8736df1d14096db5ed85f3929c6cf7dff31c0
+  data.tar.gz: 0e06083cd346c9c864f74284f96874342e7c93a0
+SHA512:
+  metadata.gz: 8e7f33ef63cb6d0b07513d84dc25a55bdb68ec59803b986a499d1ee7e519c7b2fbda4fcd815adb48bb63329c21e43ec1c200fe00132cb685754b2e6ffa930f3d
+  data.tar.gz: f3be850a3a6e21e9d17d8f766a0b588bf6703ead4e3cb4ddfe1de09ccb389e0adfecb43a705a91bf01eb04c2fb7036701fbe376356cdbe1f52329b13339ffa57

data/lib/usecase_tracer.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+
+# file: usecase_tracer.rb
+
+require 'indented-tracer'
+
+=begin
+
+# example usecase
+
+# description
+
+usecase 'new day: create a new entry' do
+
+  # preparation (files to create in the 
+  #               /tmp directory, setting of the date etc.)
+
+  # intialisation
+  liveblog = LiveBlog.new
+
+  # setup (i.e. setting the date)
+
+  # conditions
+  if liveblog.date == Date.today and liveblog.today_exists? == false  then
+
+    trace() do
+
+      # public method to be traced
+      s = '# Testing the liveblog #liveblog'
+      liveblog.add_entry(s)
+
+    end
+
+    # optional validator
+    html = File.read(File.join(path, 'index.html'))
+    html =~ /Testing the liveblog/ ? true : false
+
+  end
+
+end # end of run
+=end
+
+
+class UsecaseTracer
+  
+  attr_reader :tracelog, :testresult
+  
+  @@classes = []
+  
+  def initialize()
+    
+    @usecases = []
+    cases()
+    @tracelog = []
+    @testresult = []
+    
+    
+  end
+  
+  def self.class_tracer(*args)
+    a = *args
+    @@classes = a.map(&:to_s)
+  end
+  
+  def classes()
+    @@classes
+  end
+  
+  def run()
+    
+    @usecases.each.with_index do |x, i| 
+      
+      desc, blk = x
+      @desc = desc
+      r = blk.call
+      @testresult << [i, r] if r.is_a?(TrueClass) or r.is_a?(FalseClass)
+      
+    end
+    
+  end
+  
+  def passed?()
+    @testresult.map(&:last).all?
+  end
+  
+  def trace()
+    
+    it = IndentedTracer.new
+    it.classes = @@classes
+    it.on
+    
+    yield
+    
+    it.off
+    @tracelog << it.log(@desc, tags: classes())
+    
+  end  
+  
+  private
+  
+  # override this method with your own implementation of usecase methods
+  #
+  def cases()
+    
+  end  
+  
+  def usecase(desc='', &blk)
+    @usecases << [desc, blk]
+  end  
+end
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: usecase_tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Robertson
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRIwEAYDVQQDDAlnZW1t
+  YXN0ZXIxHjAcBgoJkiaJk/IsZAEZFg5qYW1lc3JvYmVydHNvbjESMBAGCgmSJomT
+  8ixkARkWAmV1MB4XDTE3MDEyMDIwNTk0M1oXDTE4MDEyMDIwNTk0M1owSDESMBAG
+  A1UEAwwJZ2VtbWFzdGVyMR4wHAYKCZImiZPyLGQBGRYOamFtZXNyb2JlcnRzb24x
+  EjAQBgoJkiaJk/IsZAEZFgJldTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBAMzkrxF1kZo6Rv5LFgL4sNpMgyPO+PBXSbJxvKarUfmg6V977kKdeXC71bJb
+  DLSXZK/z1T1FiAwkGd1a7vOTUDurlN158lWMKOTAFiirLZ7WBEOPobKVP2r5MTTp
+  GHmTRvyhuzMSggv3u6fbuJnfYR0AwB/9UOz05FPnmTymHczEV52/zxfqdaAFsiVg
+  9kwURfuYWqpyqM1K1f0qvxMpU+MOnsUZN/0xQq2hSBw0mmjSmlVrAk35xGU02y+O
+  iZ5hnYHsN2JkeVAQyuKUPMUHwcZmJYI2CRpClt0tw5/rgqnL0isEVJRSNmgt00FI
+  NDlTVuKjUmLVUUJmzLDuJPk9UFsCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQUJRknOEmC5uHpx1V1DcCsKMnd2WcwJgYDVR0RBB8w
+  HYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1h
+  c3RlckBqYW1lc3JvYmVydHNvbi5ldTANBgkqhkiG9w0BAQUFAAOCAQEAcwW+2Qof
+  wAtdCA3IaaLeTJI6SvhFzsKbZG7sZPy5f7np9Z94xqor5T33t1Gec9lsi59z1hsT
+  MvILi0m/qp2YVwD1Xtsnb35APfruRVCagsA3wek5UAJ1qrTArpFCrsDbAjQSH3xc
+  vafDUhjDBiKDPAG4evqzD4IGQ4lZUssY95fLRX6vtqYuWsEja20nkPUv7KoQeAux
+  88lnocDsOE0Gz3Tx/OtR6Z6mR1JvYWjtV9v2b7v5fkE9NNpb4xc0pCi5cymPEZW9
+  HGmhPBwL2haWfqW7DnI+6yZ/IunAq0eUCsZpxDveDzQAm3ASzbphaKHR1MGrVme6
+  mvh0ZtZs2h0/HQ==
+  -----END CERTIFICATE-----
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: indented_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: 
+email: james@jamesrobertson.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/usecase_tracer.rb
+homepage: https://github.com/jrobertson/usecase_tracer
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Traces the methods used for each use case and returns them as raw Polyrex
+  documents
+test_files: []