crtu 0.1.1 → 0.2.0

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.3.1
+addons:
+    code_climate:
+        repo_token: fa8920dd36c13df41b9c93d01f7be762795786bea5ed02f701feb412f66f5391

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "codeclimate-test-reporter", group: :test, require: nil
+
 # Specify your gem's dependencies in crtu.gemspec
 gemspec

data/README.md

@@ -1,7 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/crtu.svg)](https://badge.fury.io/rb/crtu)
 [![Build Status](https://travis-ci.org/Th33x1l3/CRTU.svg?branch=master)](https://travis-ci.org/Th33x1l3/CRTU)
 
-CRTU
+[![Code Climate](https://codeclimate.com/github/Th33x1l3/CRTU/badges/gpa.svg)](https://codeclimate.com/github/Th33x1l3/CRTU)
+[![Test Coverage](https://codeclimate.com/github/Th33x1l3/CRTU/badges/coverage.svg)](https://codeclimate.com/github/Th33x1l3/CRTU/coverage)
+[![Issue Count](https://codeclimate.com/github/Th33x1l3/CRTU/badges/issue_count.svg)](https://codeclimate.com/github/Th33x1l3/CRTU)
+
+#CRTU
 
 Cucumber Ruby Test Utilities
 
@@ -11,14 +15,41 @@ For now it has:
 
     Some rake tasks
     Singleton logger utilitie defined with log4r
+    
+# Usage
+
+## Rake Tasks
+To use the rake tasks insert the following lines on your Rakefile:
+
+```
+spec = Gem::Specification.find_by_name('crtu')
+load "#{spec.gem_dir}/lib/tasks/cucumber_tasks.rake"
+
+```
+
+## Loggers
+Add the Utils module to the world, then you can call
+
+if in a class add `include Utils::LocalLogger`
+then you can call
+```
+console_logger.<level> "MESSAGE TO LOG"
+file_logger.<level> "MESSAGE TO LOG"
+all_logger.<level> "MESSAGE TO LOG"
+```
+
+- `console_logger` logs message only to stdout
+- `file_logger` logs to a file
+- `all_logger` logs to both console and file
 
+# Contributing
 
-## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Th33x1l3/crtu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. 
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Th33x1l3/crtu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. Aside from that feel free to send pull requests with useful code that you want to share.
+Aside from that feel free to send pull requests with useful code that you want to share.
 
 
-## License
+# License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/crtu.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency "log4r", "~>1.1.10"
-  spec.add_runtime_dependency "cucumber", '~> 2.3', '> 2.3.0'
+  spec.add_runtime_dependency 'log4r', '~> 1.1', '>= 1.1.10'
+  spec.add_runtime_dependency 'cucumber', '~> 2.3', '> 2.3.0'
 
 end

data/lib/crtu/utils/logger.rb

@@ -2,10 +2,12 @@ require 'rubygems'
 require 'singleton'
 require 'fileutils'
 require 'log4r'
+require 'tmpdir'
 include Log4r
 
 GLOBAL_LOGGER_FOLDER = File.join(Dir.pwd, 'logs')
 GLOBAL_LOGGER_LOG_FILE = File.join(GLOBAL_LOGGER_FOLDER, 'logfile.log')
+SECONDS_IN_DAY ||= 86400
 
 class GlobalLogger
   include Singleton
@@ -24,17 +26,21 @@ class GlobalLogger
       FileUtils.mkdir_p(GLOBAL_LOGGER_FOLDER)
     end
 
-    @global_console_logger= Log4r::Logger.new("GlobalLoggerConsole")
-    @global_file_logger = Log4r::Logger.new("GlobalLoggerFile")
-    @global_mix_logger = Log4r::Logger.new("GlobalLoggerConsoleAndFile")
+    @global_console_logger= Log4r::Logger.new('GlobalLoggerConsole')
+    @global_file_logger = Log4r::Logger.new('GlobalLoggerFile')
+    @global_mix_logger = Log4r::Logger.new('GlobalLoggerConsoleAndFile')
 
     pf = PatternFormatter.new(:pattern => "[%l] @ %d : %M")
 
-    so = StdoutOutputter.new("console", :formatter => pf)
+    so = StdoutOutputter.new('console', :formatter => pf)
     @global_console_logger.outputters << so
     @global_console_logger.level = DEBUG
 
-    fo = FileOutputter.new("f1", :filename => GLOBAL_LOGGER_LOG_FILE, :trunc => false, :formatter => pf)
+    fo = RollingFileOutputter .new('f1',
+                                   filename: GLOBAL_LOGGER_LOG_FILE,
+                                   trunc: false,
+                                   :formatter => pf,
+                                   maxtime: SECONDS_IN_DAY )
     @global_file_logger.outputters << fo
     @global_file_logger.level = DEBUG
 
@@ -89,10 +95,10 @@ module Utils
     # Class console logger. The messages only go to the stdout
     # No message is saved to file
     def console_logger
-      @logger = Log4r::Logger.new("LocalLoggerConsole")
+      @logger = Log4r::Logger.new('LocalLoggerConsole')
       pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
 
-      so = StdoutOutputter.new("console", :formatter => pf)
+      so = StdoutOutputter.new('console', :formatter => pf)
       @logger.outputters << so
       @logger.level = DEBUG
       @logger
@@ -101,11 +107,15 @@ module Utils
     # Class simple file logger. Message is stored in file, but
     # it does not appear on stdout
     def file_logger
-      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? "/tmp/" + self.class.to_s + ".log" : LOCAL_LOGGER_LOG_FILE
-      @logger = Log4r::Logger.new("LocalLoggerFile")
+      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? File.join(Dir.tmpdir , "#{self.class.to_s}.log") : LOCAL_LOGGER_LOG_FILE
+      @logger = Log4r::Logger.new('LocalLoggerFile')
       pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
 
-      fo = FileOutputter.new("f1", :filename => log_file, :trunc => false, :formatter => pf)
+      fo = RollingFileOutputter.new('f1',
+                                    filename: log_file,
+                                    trunc: false,
+                                    formatter: pf,
+                                    maxtime: SECONDS_IN_DAY)
       @logger.outputters << fo
       @logger.level = DEBUG
       @logger
@@ -114,12 +124,16 @@ module Utils
 
     # Class wide console and file logger. Message appears on console output and it's stored on file
     def all_logger
-      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? "/tmp/" + self.class.to_s + ".log" : LOCAL_LOGGER_LOG_FILE
-      @logger = Log4r::Logger.new("LocalLoggerConsoleAndFile")
+      log_file = (LOCAL_LOGGER_LOG_FILE.nil?) ? File.join(Dir.tmpdir , "#{self.class.to_s}.log") : LOCAL_LOGGER_LOG_FILE
+      @logger = Log4r::Logger.new('LocalLoggerConsoleAndFile')
       pf = PatternFormatter.new(:pattern => "[%l] : #{self.class} @ %d : %M")
 
-      so = StdoutOutputter.new("console", :formatter => pf)
-      fo = FileOutputter.new("f1", :filename => log_file, :trunc => false, :formatter => pf)
+      so = StdoutOutputter.new('console', :formatter => pf)
+      fo = RollingFileOutputter.new('f1',
+                                    filename: log_file,
+                                    trunc: false,
+                                    formatter: pf,
+                                    maxtime: SECONDS_IN_DAY)
 
       @logger.outputters << so
       @logger.outputters << fo

data/lib/crtu/version.rb

@@ -1,3 +1,3 @@
 module Crtu
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/tasks/cucumber_tasks.rake

@@ -54,7 +54,7 @@ namespace :features do
   end
 
 
-  desc "Run features with given tags - OR joing"
+  desc 'Run features with given tags - OR joining'
   task :run_with_tags, [:tags] do |t,args|
     if args[:tags].is_a?(String)
       tags_line = args[:tags]
@@ -67,15 +67,15 @@ namespace :features do
   end
 end
 
-desc "Run complete feature build"
+desc 'Run complete feature build'
 task :cruise do
-  finished_successful = run_and_check_for_exception("finished")
-  in_progress_successful = run_and_check_for_exception("in_progress")
+  finished_successful = run_and_check_for_exception('finished')
+  in_progress_successful = run_and_check_for_exception('in_progress')
 
   unless finished_successful && in_progress_successful
     puts
-    puts("Finished features had failing steps") unless finished_successful
-    puts("In-progress Scenario/s passed when they should fail or be pending") unless in_progress_successful
+    puts('Finished features had failing steps') unless finished_successful
+    puts('In-progress Scenario/s passed when they should fail or be pending') unless in_progress_successful
     puts
     raise BuildFailure
   end
@@ -85,7 +85,7 @@ def run_and_check_for_exception(task_name)
   puts "*** Running #{task_name} features ***"
   begin
     Rake::Task["features:#{task_name}"].invoke
-  rescue Exception => e
+  rescue StandardError
     return false
   end
   true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crtu
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fábio André Ramos Rodrigues
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-23 00:00:00.000000000 Z
+date: 2016-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,6 +57,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.10
   type: :runtime
@@ -64,6 +67,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.10
 - !ruby/object:Gem::Dependency
@@ -93,7 +99,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile