bamm_log 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjYxNTE0ZjU1ZGEzYjg0MWJmOWU2MzI2YjJhYzkyNzgzNzdmZDA3YQ==
+    ZDJlNmU4NzcyYTljNTI5MjhiZDJlNDFhMGJmNjUzNWM4YjgwYjlhYw==
   data.tar.gz: !binary |-
-    MDgyNWU5NDFiOTE2N2QxOGEwZjc5YTBkODQ1NmIwMDA5ZGE3OTg2MQ==
+    MDU5MTFkM2NmNjY0ZTc4MjA5ZWYzOTA4NGMwMjg1ZmRiZjMyZDk4YQ==
 SHA512:
   metadata.gz: !binary |-
-    NTAzMjU1NjE2NGVlYjc5YTk3Mjg4NDFiMjIyZmI4MWM3MmYwNmQ1NmQ0Nzk1
-    ZDA0N2ViOTQwZDk2NzA1NDRhOGQyMjA2ZWExYTM3YzY4N2JmMWExM2RlNzIy
-    NjJmOWQ2Nzk1ZTAyODdjOTc0ZGQ1ZWUxODgzZWUwYWQzMzBkNTg=
+    NGE3Mzg5OTAyZWJiYzEzNTk4YjhkZTc2ZjIwOTM0YjRkMGU2YzFkYjdjN2Vh
+    MDM3NjcxOGE3OTZlYjYzZTRkMjU4ODZmN2IyZTQ1Zjk2Y2E1Y2IyZDU0ZmQx
+    OGE5NTUxZTFiM2YzM2RmNjA2YjM4MmZiNGEwNmQ3NzliZjA3MjQ=
   data.tar.gz: !binary |-
-    NDJmOTA4MjUwNmFiOTFkZjMzZjAwYjllNjEwMzE3OTgyOWVkZmMwY2UzOTU4
-    NTJlMjNkZGZlZjM1OGUyZDE3OTlkNTQyNDc0Mzc3YjUyMmQxMTZjM2YwMWYy
-    Y2JmMjkxY2RlNWI0MjhmNGNhMjkxMTlmYjVmNDFhZmY2ZDhlZGI=
+    NGJhMDk0ODE0ZjdlYzJiYWRiZTg4Mzc1MDVjY2NkMGUwMzJkZmFjODU3MmM5
+    YmIzNzQ2NDAyMWUwOWRmM2NhNWJiYzU4YzkyZTYxMWMyYTc0NTQyZWI2Zjgz
+    Y2FlM2U4ZmY5YjFmNWUxYjZkMjE2YjhlNTA0OTcyM2E5OWZiMGE=

data/README.md

@@ -1,7 +1,9 @@
 # Bamm Log
+A Sinatra Logger
 
-Who doen't need to log what's going on in your Modular Sinatra App? Well.. I need.
-By default sinatra logs this:
+For the record.. this is a WIP gem..
+
+By default Sinatra logs this:
 
 
 > <sub>127.0.0.1 - - [25/Aug/2014 17:23:11] "GET /page HTTP/1.1" 200 6736 2.5322</sub><br />
@@ -12,8 +14,7 @@ By default sinatra logs this:
 
 > <sub>127.0.0.1 - - [25/Aug/2014 17:24:33] "POST /error HTTP/1.1" 500 5443 0.1238</sub>
 
-This page returns 500 for what? You can check our apage error.log file or you can log everything in one file, like Rails!
-
+This page returns 500 for what? You can check your apache error.log file or you can log everything to one file, like Rails do.
 
 After reading some implementations, I joined some ideas and created this gem.
 It's not tested yet, so.. don't use it on production.
@@ -50,21 +51,21 @@ Or install it yourself as:
 
 ## Usage
 
-    class RequisitionsService < Sinatra::Base
-
-      configure :staging do
-        include BammLog::Logger
-      end
+Include in your app
 
-      # if you want to user logger in your application,
-      # being logged to the same "environment".log file
-      def logger
-        BammLog.logger
-      end
+    class App < Sinatra::Base
 
+      include BammLog::Logger
+      
     end
     
-This will create a file with the name "environment".log (ex: staging.log) and log all the accesses and errors from you application.
+And add manual logs
+
+    BammLog.print "This is a log"
+
+
+In development environment, bamm_log logs to your terminal.<br />
+In live environment, training or staging, bamm_log creates a file with the name "environment".log in /log and logs all the accesses and errors from your application.
 
 ## Contributing
 

data/hola.gemspec

@@ -16,6 +16,4 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/bamm_log}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "pry"
 end

data/lib/bamm_log/exception_middleware.rb

@@ -1,40 +1,56 @@
 module BammLog
   class ExceptionMiddleware
 
+    attr_reader :env
+
     def initialize(app, options={})
       @app  = app
     end
 
     def call(env)
+      @env = env
 
       begin
-        BammLog.logger.info "Started #{env['REQUEST_METHOD']} \"#{env['REQUEST_URI']}\""
-        BammLog.logger.info "Parameters: #{request_params(env).inspect}"  
+        log_start
+        log_params
         @app.call(env)
       rescue Exception => e
-        log_exception env['sinatra.error']
+        log_exception
         @app.call(env)
       end
-      
     end
 
     private
 
-    def request_params(env)
-      if env['REQUEST_METHOD'] == 'POST'
+    def request_params
+      if request_body_params?
         env['rack.request.form_hash']
       else
         Rack::Utils.parse_nested_query(env['QUERY_STRING'])
       end
     end
 
-    def log_exception(e)
-      BammLog.logger.info "Bamm! #{e.class}: #{e.message}"
+    def log_start
+      BammLog.print "Started #{env['REQUEST_METHOD']} \"#{env['REQUEST_URI']}\""
+    end
+
+    def log_params
+      BammLog.print "Parameters: #{request_params.inspect}"
+    end
+
+    def log_exception
+      e = env['sinatra.error']
+
+      BammLog.print "Bamm! #{e.class}: #{e.message}"
       
       e.backtrace.each do |line|
-        BammLog.logger.info "#{line}"
+        BammLog.print "#{line}"
       end
     end
 
+    def request_body_params?
+      ['POST', 'PUT', 'PATCH'].include? env['REQUEST_METHOD']
+    end
+
   end
 end

data/lib/bamm_log/version.rb

@@ -1,3 +1,3 @@
 module BammLog
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/bamm_log.rb

@@ -6,35 +6,67 @@ module BammLog
   module Logger
 
     def self.included(klass)
-      @klass = klass
+      klass.configure do    
+        klass.enable :logging
+        klass.use BammLog::ExceptionMiddleware
+      end
+      
+      klass.include BammLog::Formatter
+      
+      @instance ||= if klass.environment != :development        
+        EnvLogger.new(klass)
+      else
+        DevLogger.new
+      end
+
+      klass.configure do
+        klass.use Rack::CommonLogger, BammLog::Logger.instance
+      end
+    end
+
+    def self.instance
+      @instance
+    end
+
+    # ------------------------------------------------------------- loggers
+
+    class EnvLogger
+
+      attr_accessor :logger
 
-      def self.instance
-        @instance ||= ::Logger.new(log_file).tap do |logger|
+      def initialize(app)
+        self.logger = ::Logger.new(EnvLogger.log_file(app)).tap do |logger|
           ::Logger.class_eval { alias :write :'<<' }
           logger.level = ::Logger::INFO
         end
       end
 
-      def self.log_file
-        @log_file ||= File.new("#{@klass.root}/log/#{@klass.environment}.log", 'a+').tap do |log_file|
+      def self.log_file(app)
+        @log_file ||= File.new("#{app.root}/log/#{app.environment}.log", 'a+').tap do |log_file|
           log_file.sync = true
         end
       end
 
-      klass.include(BammLog::Formatter)
-      
-      klass.configure do
-        klass.enable :logging
-        klass.use Rack::CommonLogger, BammLog::Logger.instance
-        klass.use BammLog::ExceptionMiddleware
+      def method_missing(method, args, &block)
+        logger.send(method, args, &block)
       end
+
+    end
+
+    class DevLogger
+
+      def info(text)
+        puts BammLog::Formatter.call_formatted(Time.now, text)
+      end
+    
     end
-  
-  end
 
-  def logger
-    BammLog::Logger.instance
   end
 
+  def print(message)
+    BammLog::Logger.instance.info message
+  end
+  
   extend self
+
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bamm_log
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Joaquim Adráz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - joaquim.adraz@gmail.com
@@ -43,6 +29,7 @@ files:
 - pkg/bamm_log-0.0.2.gem
 - pkg/bamm_log-0.0.3.gem
 - pkg/bamm_log-0.0.4.gem
+- pkg/bamm_log-0.0.5.gem
 homepage: https://github.com/joaquimadraz/bamm_log
 licenses:
 - MIT