rspec_log 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54d9a38887fb52da80082d4445c5a0754a55a4b2
+  data.tar.gz: b1e474547b21fccd021fcf2e4362db6d938ce456
+SHA512:
+  metadata.gz: c44f4becb20f5ed2e3c5c0e8727d39ef9dd410b4621456083533a765dd87064b590ca644fde926063758d99cb1a19e6902569f181fb1be070202a23520bdb2a3
+  data.tar.gz: 0a168639ac58898cf8499b12a501c54e26b33e731be6abdc5bb243c3798222910c4d291e8782980515b95a5029f1769ecc04efa6dba90e2b0d680febd466652b

data/LICENSE

@@ -0,0 +1,19 @@
+
+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,24 @@
+# rspec_log
+RSPEC logging which is persistent accross runs, can be reset on command!
+
+```ruby
+gem 'rspec_log'
+```
+
+Setup the test this way in your spec_helper.rb file:
+```ruby
+config.before :suite do
+  logs = RSpecLog.new(newfile: true) # newfile clears the file if it exists
+end
+
+config.after :all do
+  logs.write_file
+end
+
+config.after :suite do
+  RSpecLog.print_logs_from_file
+end
+```
+```ruby
+RSpecLog.add_to_log 'Name log', 'context info'
+```

data/lib/rspec_log.rb

@@ -0,0 +1,58 @@
+require 'colorize'
+require 'yaml'
+
+DEFAULT_LOG_FILE = '.rspec_log.yml'.freeze
+
+# Class that allows for displaying logs or general messages at that are consistent across rspec tests
+class RSpecLog
+  def initialize(filename: DEFAULT_LOG_FILE, newfile: false)
+    @filename = filename
+    RSpecLog.write_hash_to_file({}, @filename) if newfile || !File.exist?(filename)
+    RSpecLog.log_hash_set(YAML.load_file(@filename))
+  end
+
+  # Writes log_hash to, by default, currently set log file or custom file passed to it
+  def write_file(filename: @filename)
+    raise 'Filename is not set, you need to initialize RSpecLog before writing' if filename.nil?
+    RSpecLog.write_hash_to_file(RSpecLog.log_hash, filename)
+  end
+
+  # Parse the YAML log file and print it out in a nice manner
+  def self.print_logs_from_file(filename: DEFAULT_LOG_FILE)
+    file_contents = YAML.load_file(filename)
+
+    return puts 'No logs found'.green if file_contents.empty?
+    puts 'RSpecLogs: '.yellow.bold
+
+    file_contents.each do |key, value|
+      puts key
+      value.each { |v| puts " - #{v.to_s.yellow}" }
+    end
+  end
+
+  # @name - Name of the log message
+  # @value - Content of log message
+  def self.add_to_log(name, value)
+    log_hash[current_node] = [] if log_hash[current_node].nil?
+    log_hash[current_node] << "#{name}, #{value}"
+    log_hash_set(log_hash)
+  end
+
+  private_class_method
+
+  def self.write_hash_to_file(log_hash, filename = DEFAULT_LOG_FILE)
+    File.open(filename, 'w') { |f| f.write(YAML.dump(log_hash, line_width: -1)) }
+  end
+
+  def self.log_hash
+    RSpecLog.instance_variable_get(:@log_hash)
+  end
+
+  def self.log_hash_set(item)
+    RSpecLog.instance_variable_set(:@log_hash, item)
+  end
+
+  def self.current_node
+    ENV.fetch('TARGET_HOST', "Logged from: #{RSpec.current_example.description.yellow.bold}")
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rspec_log
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrea Capri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    Provides a Logging system separate to RSpec that can be persistent
+  throughout\n    multiple runs of RSpec i.e. multiple files.\n  "
+email:
+- andrea.a.capri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rspec_log.rb
+homepage: 
+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.1.0
+signing_key: 
+specification_version: 4
+summary: An RSpec Logger that is persistent throughout multiple rspec files
+test_files: []