pry-auditlog 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67d9ed197727c56d85aa7aefa09f11cde697742d
+  data.tar.gz: d737eade85330cc3479a9b0fec714ae1ae3ff28d
+SHA512:
+  metadata.gz: 612ea3ed9905a1a035a456ed0307464cd884f43b50f546dcf8c8e77531f6f6187aba9d20622faa5a4896b1abd1f80f2f1aa6860191389769abd4df0d7564330f
+  data.tar.gz: 62b61633fd4d5b2cbb1cd3bbd130ab91d057adcbfeaba3f8f82a38f7e01d97e75dea4891de6bcdc382aed59527839e1703221d64149d1029f17d46b21950866c

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pry-auditlog.gemspec
 gemspec
+
+group :development do
+  gem 'rubocop'
+end

data/lib/ext/pry/repl.rb

@@ -0,0 +1,54 @@
+class Pry
+  class REPL
+    # Read a line of input from the user.
+    # @return [String] The line entered by the user.
+    # @return [nil] On `<Ctrl-D>`.
+    # @return [:control_c] On `<Ctrl+C>`.
+    # @return [:no_more_input] On EOF.
+    def read
+      @indent.reset if pry.eval_string.empty?
+      current_prompt = pry.select_prompt
+      indentation = pry.config.auto_indent ? @indent.current_prefix : ''
+
+      val = read_line("#{current_prompt}#{indentation}")
+
+      # Return nil for EOF, :no_more_input for error, or :control_c for <Ctrl-C>
+      return val unless String === val
+
+      if pry.config.auto_indent
+        original_val = "#{indentation}#{val}"
+        indented_val = @indent.indent(val)
+
+        if pry.config.correct_indent && Pry::Helpers::BaseHelpers.use_ansi_codes?
+
+          # if we're logging output, send the input line through the original
+          # pry output, so that we see it prettified on the TTY.
+          if Pry.config.auditlog_log_output
+            pry.config.original_output.print @indent.correct_indentation(
+              current_prompt, indented_val,
+              original_val.length - indented_val.length
+            )
+            pry.config.original_output.flush
+          # Fall back on default behavior, our stuff isn't loaded
+          elsif output.tty?
+            output.print @indent.correct_indentation(
+              current_prompt, indented_val,
+              original_val.length - indented_val.length
+            )
+            output.flush
+          end
+        end
+      else
+        indented_val = val
+      end
+
+      # send the prompt and log line to our logger.
+      if Pry.config.auditlog_log_input
+        PryAuditlog::Logger.set_prompt(current_prompt)
+        PryAuditlog::Logger.log('I', indented_val)
+      end
+
+      indented_val
+    end
+  end
+end

data/lib/pry-auditlog.rb

@@ -1,38 +1,40 @@
 require 'pry'
 require 'pry-auditlog/version'
-require 'pry-auditlog/logger'
-require 'pry-auditlog/output'
 
-
-Pry.config.auditlog_enabled ||= false
-Pry.config.auditlog_file ||= "~/.pry_auditlog"
-Pry.config.auditlog_log_input ||= true
-Pry.config.auditlog_log_output ||= true
+Pry.config.auditlog_enabled = false unless defined?(Pry.config.auditlog_enabled)
+Pry.config.auditlog_file = '/dev/null' unless defined?(Pry.config.auditlog_file)
+Pry.config.auditlog_log_input = true unless defined?(Pry.config.auditlog_log_input)
+Pry.config.auditlog_log_output = true unless defined?(Pry.config.auditlog_log_output)
 
 if Pry.config.auditlog_enabled
-  if Pry.config.auditlog_log_input
-    require 'ext/pry/history'
-    require 'ext/pry/pry_instance'
-  end
+  require 'pry-auditlog/logger'
+  require 'pry-auditlog/output'
+  require 'ext/pry/repl'
 
   if Pry.config.auditlog_log_output
     Pry.config._orig_stdout = $stdout
     Pry.config._orig_stderr = $stderr
 
-    original_output = Pry.config.output
+    Pry.config.original_output = Pry.config.output
     Pry.config.output = PryAuditlog::Output.new
-    Pry.config.output._set_original_output(original_output)
+    Pry.config.output._set_original_output(Pry.config.original_output)
   end
 
-  Pry.config.hooks.add_hook(:before_session, :prepare_auditlog) do
+  local_hooks = Pry::Hooks.new
+
+  local_hooks.add_hook(:before_session, :prepare_auditlog) do
     $stdout = $stderr = Pry.config.output if Pry.config.auditlog_log_output
     PryAuditlog::Logger.set_session_token(Time.now.to_i)
-    PryAuditlog::Logger.log("AUDIT LOG", "Pry session started")
+    PryAuditlog::Logger.log('AUDIT LOG', 'Pry session started')
   end
 
-  Pry.config.hooks.add_hook(:after_session, :unhijack_stdout) do
-    $stdout = Pry.config._orig_stdout
-    $stderr = Pry.config._orig_stderr
-    PryAuditlog::Logger.log("AUDIT LOG", "Pry session ended")
+  local_hooks.add_hook(:after_session, :clean_up_auditlog) do
+    if Pry.config.auditlog_log_output
+      $stdout = Pry.config._orig_stdout
+      $stderr = Pry.config._orig_stderr
+    end
+    PryAuditlog::Logger.log('AUDIT LOG', 'Pry session ended')
   end
+
+  Pry.config.hooks = local_hooks
 end

data/lib/pry-auditlog/logger.rb

@@ -1,8 +1,14 @@
 module PryAuditlog
   class Logger
+    @@current_prompt = ''
+    @@session_token = ''
     begin
-      @@audit_file = File.open(Pry.config.auditlog_file, 'a', 0600).tap { |f| f.sync = true }
-    rescue Errno::EACCES
+      if Pry.config.auditlog_file
+        @@audit_file = File.open(Pry.config.auditlog_file, 'a', 0600).tap { |f| f.sync = true }
+      else
+        @@audit_file = false
+      end
+    rescue Errno::EACCES, Errno::ENOENT
       @@audit_file = false
     end
 
@@ -15,12 +21,9 @@ module PryAuditlog
     end
 
     def self.log(type, line)
-      if type == 'I'
-        line = "#{@@current_prompt}#{line}"
-      end
+      line = "#{@@current_prompt}#{line}" if type == 'I'
       log_line = "[#{Time.now.to_s}][#{@@session_token}][#{type}] #{line}"
-      @@audit_file.puts log_line if @@audit_file
+      @@audit_file.puts log_line if @@audit_file && !line.strip.empty?
     end
-
   end
-end
+end

data/lib/pry-auditlog/output.rb

@@ -1,13 +1,14 @@
 module PryAuditlog
   class Output < StringIO
-
     def _set_original_output(orig)
       @original_output = orig
     end
 
-    def puts(line)
-      PryAuditlog::Logger.log("O", line)
-      @original_output.puts(line)
+    def print(line)
+      PryAuditlog::Logger.log('O', line)
+      @original_output.print(line)
     end
+    alias << print
+    alias write print
   end
 end

data/lib/pry-auditlog/version.rb

@@ -1,3 +1,3 @@
 module PryAuditlog
-  VERSION = "0.1.0"
-end
+  VERSION = '0.2.0'
+end

data/pry-auditlog.gemspec

@@ -4,16 +4,16 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pry-auditlog/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pry-auditlog"
+  spec.name          = 'pry-auditlog'
   spec.version       = PryAuditlog::VERSION
-  spec.authors       = ["Cozy Services Ltd.", "Matt Greensmith"]
-  spec.email         = ["opensource@cozy.co"]
+  spec.authors       = ['Cozy Services Ltd.', 'Matt Greensmith']
+  spec.email         = ['opensource@cozy.co']
   spec.summary       = %q{Adds audit log capability to Pry}
   spec.description   = %q{PryAuditlog is a plugin for the Pry REPL that enables logging of any combination of Pry input and output to a configured audit log file.}
-  spec.homepage      = "http://github.com/cozyco/pry-auditlog"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/cozyco/pry-auditlog'
+  spec.license       = 'MIT'
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'pry', '~> 0.9'
+  spec.add_dependency 'pry', '~> 0.10'
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-auditlog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Cozy Services Ltd.
@@ -10,24 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 description: PryAuditlog is a plugin for the Pry REPL that enables logging of any
   combination of Pry input and output to a configured audit log file.
 email:
@@ -40,8 +37,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- lib/ext/pry/history.rb
-- lib/ext/pry/pry_instance.rb
+- lib/ext/pry/repl.rb
 - lib/pry-auditlog.rb
 - lib/pry-auditlog/logger.rb
 - lib/pry-auditlog/output.rb
@@ -50,26 +46,25 @@ files:
 homepage: http://github.com/cozyco/pry-auditlog
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Adds audit log capability to Pry
 test_files: []

data/lib/ext/pry/history.rb

@@ -1,30 +0,0 @@
-class Pry
-  class History
-    
-    #attr_accessor :original_pusher
-
-    # we monkeypatch 'load' to 
-    # 1. Overwrite @pusher with our own audit_and_push method
-    # 2. ensure that we don't write the entire history into the audit log on load.
-    def load
-      @original_pusher ||= @pusher
-      @pusher = method(:audit_and_push) if Pry.config.auditlog_enabled
-      @loader.call do |line|
-        if Pry.config.auditlog_enabled
-          @original_pusher.call(line.chomp)
-        else
-          @pusher.call(line.chomp)
-        end
-        @history << line.chomp
-      end
-      @saved_lines = @original_lines = @history.length
-    end
-
-    # new method
-    def audit_and_push(line)
-      PryAuditlog::Logger.log("I", line)
-      @original_pusher.call(line)
-    end
-
-  end
-end

data/lib/ext/pry/pry_instance.rb

@@ -1,11 +0,0 @@
-class Pry
-  # we monkeypatch retrieve_line to send the current prompt string to the logger
-
-  alias original_retrieve_line retrieve_line
-
-  def retrieve_line(eval_string, target)
-    current_prompt = select_prompt(eval_string, target)
-    PryAuditlog::Logger.set_prompt(current_prompt)
-    original_retrieve_line(eval_string, target)
-  end
-end