cputs 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1d3d28e41a68ab5b79a4fb79956e44902089640
-  data.tar.gz: 79f53672bdaa44c29c4335f20f1b2a956d559dd1
+  metadata.gz: 0c3a5103e5c704a4aa1cf9312b84b96fd84bcf0c
+  data.tar.gz: d270b38afd332642521a777a125250a82afa3aec
 SHA512:
-  metadata.gz: 0771ec3cbe339855f85f4940e56a49182080534a8b50120637a3faf86b79b1459583179e927824f9066276bba283956958511a38bb817a54660616addaaf537a
-  data.tar.gz: 50d78a19a1b1ec73273a33573d27d52361fdfce52a319220801efe78dc0a4e4921ad7996b659b2d1feb12d89bb58ccf4d4fbd1d4520d5bd58362bc91c4ca5023
+  metadata.gz: 4154a534b0782db49ad34127afb73fb5fb1572db9f1cb2bf017ce8de0e9d71b4bab9b7ff01d1a738994188d0e3edaa7e299889c504c7da04a6c8bf7f4734999e
+  data.tar.gz: 57dfb4584a5132e31fba81425ff71df00125fa6577a37d27a40f763fe72574e8239c5843e1fcc2ba91177dbf61178a8408f230d68db7b2a83e369a4b82d001ce

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .idea/
+*.gem

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cputs.gemspec
 gemspec
-gem 'rspec'
+gem 'rspec'

data/README.md

@@ -28,6 +28,13 @@ Or using a preffix and/or suffix to make the output more noticeable:
 <----------------------------
 ```
 
+You could also add a Timestamp to every output
+```
+---------------------------->
+2016-01-03T18:28:32 /Users/JGutierrezC/AwesomeProjects/the_best/app/controllers/randoms_controller at line 2: Project4 - The name is still to decide. user jgutierrezc
+<----------------------------
+```
+
 This way, you'll **NEVER** lose your output messages and hopefully they won't make it to production.
 ###Sometimes even the Gems are printing to your console. Find out which gem is doing that by using `CPuts.override_puts` :)
 
@@ -66,9 +73,16 @@ CPuts.set_preffix_and_suffix('-----------------')
 # to set different preffix and suffix in a single method for every output:
 CPuts.set_preffix_and_suffix('----------->', '<-----------')
 
+# to set default timestamp to be shown along with the preffix:
+CPuts.set_timestamp(true)
+
+# to set a custom timestamp to be shown along with the preffix:
+CPuts.set_timestamp('%H:%M:%S')
 
 ```
 
+**Note:** Please refer to http://apidock.com/ruby/DateTime/strftime for time formatting
+
 And use cputs command to output your message:
 
 ```
@@ -93,9 +107,23 @@ The output will be as follows (previously defined preffix and suffix):
 ----------------------------> /Users/JGutierrezC/AwesomeProjects/the_best/app/controllers/randoms_controller at line 2: Project4 - The name is still to decide. user jgutierrezc <----------------------------
 ```
 
+### Defaults
+
+By default preffix is
+```
+----------------->
+```
+
+Timestamp format (if set) is
+```
+%Y-%m-%dT%H:%M:%S (2016-01-03T18:28:32)
+```
+
+Suffix is empty
+
 ### When using rails
 
-Add `puts` to your Gemfile and then add a cputs initializer:
+Add `cputs` to your Gemfile and then add a cputs.rb initializer:
 
 ```
 # config/initializers/cputs.rb

data/lib/cputs.rb

@@ -17,7 +17,7 @@ module CPuts
     # Override the usual *puts* method to always use
     # cputs instead.
 
-    def self.override_puts
+    def CPuts.override_puts
         require_relative 'cputs/override.rb'
     end
 
@@ -42,6 +42,16 @@ module CPuts
         CPuts::Functions.preffix_and_suffix *args
     end
 
+    ##
+    # Sets timestamp to be shown in the output. It can be:
+    # False to disable it
+    # True to enable it
+    # String with format, which also enables it
+
+    def CPuts.set_timestamp(format=nil)
+        CPuts::Functions.timestamp(format)
+    end
+
     alias :default_puts :puts
 
 end

data/lib/cputs/functions.rb

@@ -1,31 +1,80 @@
 module CPuts
     module Functions
-        attr :preffix, :suffix
+        class Decorators
+
+            attr_writer :preffix, :suffix
+
+            def preffix
+                @preffix ||= Decorators.default_preffix
+                "#{"#{formatted_time} " if formatted_time}#{@preffix}"
+            end
+
+            def suffix
+                @suffix ||= Decorators.default_suffix
+            end
+
+            def self.default_preffix
+                "----------------->"
+            end
+
+            def self.default_suffix
+                ''
+            end
+
+            def self.default_time_format
+                '%Y-%m-%dT%H:%M:%S'
+            end
+
+            def add_time_to_preffix(format=nil)
+                begin
+                    @format = format
+                    return unless @format
+                    Time.now.strftime(@format)
+                    raise Exception.new('') if @format == ''
+                rescue Exception => ex
+                    @format = Decorators.default_time_format
+                    print "Warning: Format #{format} is wrong. Please refer to http://apidock.com/ruby/DateTime/strftime"
+                end
+            end
+
+            private
+            def formatted_time
+                Time.now.strftime(@format) if @format
+            end
+        end
 
         def self.cputs(message, caller)
             matcher = caller.first.match(/^(.*)\:(\d+)/)
             file, line = matcher.captures[0..1] unless matcher.nil?
-            default_puts "#{@preffix}#{file} at line #{line}: #{message}#{@suffix}"
+            default_puts "#{decorator.preffix}#{file} at line #{line}: #{message}#{decorator.suffix}"
         end
 
         def self.preffix(preffix)
-            @preffix = preffix
+            decorator.preffix = preffix
         end
 
         def self.suffix(suffix)
-            @suffix = suffix
+            decorator.suffix = suffix
         end
 
         def self.preffix_and_suffix(*args)
             case args.length
                 when 1
-                    @preffix = args[0]
-                    @suffix = args[0]
+                    decorator.preffix = args[0]
+                    decorator.suffix = args[0]
                 when 2
-                    @preffix = args[0]
-                    @suffix  = args[1]
+                    decorator.preffix = args[0]
+                    decorator.suffix = args[1]
             end
         end
 
+        def self.timestamp(format)
+            decorator.add_time_to_preffix(format)
+        end
+
+        def self.decorator
+            @decorator ||= Decorators.new
+        end
+
     end
 end

data/lib/cputs/version.rb

@@ -1,3 +1,3 @@
 module Cputs
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: cputs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - JGutierrezC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   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'
 description: Custom Puts is as it's name says, a customized puts command that will
@@ -76,8 +76,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -101,17 +101,17 @@ 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.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: CPuts - CustomPuts