clintegracon 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66075c5c5f568f363aeb4427edfe784b28658d73
-  data.tar.gz: 2eebf0522c50cedf00cc06612c8fc3fef1200ffe
+  metadata.gz: da046b97927be25951f614f5a1d4fa20feab0520
+  data.tar.gz: 5f499a259ddc350ba287541be417d440e69db5c7
 SHA512:
-  metadata.gz: 21d257b2d152d77a7c3c63cdf24b10c250b358543e6ff1f0b5b0ae72426a2167f4e405dfa0086c0451f60bb231908d9a62ac7ffb005b48ae0970ac3e5959ac4a
-  data.tar.gz: bb71dbb097317af4f98322de319adaeb4769c51dd47ea14b23c195ce43333d002e51bf9c28591851db0444bfbba001a35745b583d99198a272674acf0b33c682
+  metadata.gz: d65d4fa9ae1a25a3dfd934dd5e5bd20ffe654c9ca773684f3f111a414b6d99381b9c1c5d25e037f8f7c7b25f3a8dc2e0059e8a60e742d26febc0a5b8ca68f3b1
+  data.tar.gz: 4faacee342cdfbbb01b4b43ae83fd79cda250c250294d28ca7c1d1e2fd11c4e3a2a62eb3e67243c9082aa18744aa0807d75cb98a0a83707a5fbe134da03f677c

data/Gemfile.lock

@@ -1,18 +1,22 @@
 PATH
   remote: .
   specs:
-    clintegracon (0.5.3)
+    clintegracon (0.6.0)
       colored (~> 1.2)
       diffy
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (3.2.20)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
     bacon (1.2.0)
     claide (0.7.0)
     coderay (1.1.0)
     colored (1.2)
     diffy (3.0.6)
+    i18n (0.6.11)
     inch (0.5.0)
       pry
       sparkr (>= 0.2.0)
@@ -24,6 +28,7 @@ GEM
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
+    multi_json (1.10.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -40,6 +45,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (>= 3.1)
   bacon
   bundler (~> 1.3)
   claide

data/clintegracon.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha-on-bacon"
   spec.add_development_dependency "claide"              # Example CLI
   spec.add_development_dependency "inch"
+  spec.add_development_dependency 'activesupport', '>= 3.1'
 
   spec.add_runtime_dependency 'colored', '~> 1.2'
   spec.add_runtime_dependency 'diffy'

data/lib/CLIntegracon/subject.rb

@@ -24,12 +24,12 @@ module CLIntegracon
     #         Those are added behind the arguments given on +launch+.
     attr_accessor :default_args
 
-    # @return [Hash<String,String>]
-    #         The replace paths, whose keys are expected to occur in the output,
-    #         which are not printed relative to the project, when the subject will
-    #         be executed. These are e.g. paths were side-effects occur, like manipulation
-    #         of user configurations in dot files or caching-specific directories.
-    attr_accessor :replace_paths
+    # @return [Hash<String|Regexp,String>]
+    #         The replace patterns, whose keys are expected to occur in the output,
+    #         which should be redacted, when the subject will be executed. These are
+    #         e.g. paths were side-effects occur, like manipulation of user configurations
+    #         in dot files or caching-specific directories or just dates and times.
+    attr_accessor :replace_patterns
 
     # @return [String]
     #         The path where the output of the executable will be written to.
@@ -53,7 +53,7 @@ module CLIntegracon
       self.executable = executable || name
       self.environment_vars = {}
       self.default_args = []
-      self.replace_paths = {}
+      self.replace_patterns = {}
       self.output_path = 'execution_output.txt'
     end
 
@@ -62,7 +62,20 @@ module CLIntegracon
 
     # @!group DSL-like Setter
 
-    # Define a path, whose occurrences in the output should been replaced by
+    # Define a pattern, whose occurrences in the output should be replaced by a
+    # given placeholder.
+    #
+    # @param [Regexp|String] pattern
+    #        The pattern
+    #
+    # @param [String] replacement
+    #        The replacement
+    #
+    def replace_pattern(pattern, replacement)
+      self.replace_patterns[replacement] = pattern
+    end
+
+    # Define a path, whose occurrences in the output should be replaced by
     # either its basename or a given placeholder.
     #
     # @param [String] path
@@ -73,19 +86,20 @@ module CLIntegracon
     #
     def replace_path(path, name=nil)
       name ||= File.basename path
-      self.replace_paths[name] = path
+      self.replace_pattern path, name
     end
 
     # Define a path in the user directory, whose occurrences in the output
-    # should been replaced by either its basename or a given placeholder.
+    # should be replaced by either its basename or a given placeholder.
     #
     # @param [String] path
     #        The path
     #
     # @param [String] name
-    #        The name of the path, or the basename of the given path
+    #        The name of the path, or the given path
     #
     def replace_user_path(path, name=nil)
+      name ||= "$HOME/#{path}"
       self.replace_path %r[/Users/.*/#{path.to_s}], name
     end
 
@@ -107,24 +121,86 @@ module CLIntegracon
     #         The output, which is emitted while execution.
     #
     def launch(head_arguments='', tail_arguments='')
-      vars = environment_vars.map { |key,value| "#{key}=#{value}" }.join ' '
+      command = command_line(head_arguments, tail_arguments)
+      output = apply_replacements(run(command))
+      write_output(command, output)
+      output
+    end
+
+    #-----------------------------------------------------------------------------#
+
+    # @!group Helpers
+
+    protected
+
+    # Serializes configured environment variables
+    #
+    # @return [String]
+    #         Serialized assignment of configured environment variables.
+    #
+    def environment_var_assignments
+      environment_vars.map { |key,value| "#{key}=#{value}" }.join ' '
+    end
+
+    # Run the command.
+    #
+    # @param  [String] command_line
+    #         THe command line to execute
+    #
+    # @return [String]
+    #         The output, which is emitted while execution.
+    #
+    def run(command_line)
+      `#{environment_var_assignments} #{command_line} 2>&1`
+    end
+
+    # Merges the given with the configured arguments and returns the command
+    # line to execute.
+    #
+    # @param  [String] head_arguments
+    #         The arguments to pass to the executable before the default arguments.
+    #
+    # @param  [String] tail_arguments
+    #         The arguments to pass to the executable after the default arguments.
+    #
+    # @return [String]
+    #         The command line to execute.
+    #
+    def command_line(head_arguments='', tail_arguments='')
       args = [head_arguments, default_args, tail_arguments].flatten.compact.select { |s| s.length > 0 }.join ' '
-      command = "#{vars} #{executable} #{args} 2>&1"
+      "#{executable} #{args}"
+    end
 
-      output = `#{command}`
+    # Apply the configured replacements to the output.
+    #
+    # @param  [String] output
+    #         The output, which was emitted while execution.
+    #
+    # @return [String]
+    #         The redacted output.
+    #
+    def apply_replacements(output)
+      replace_patterns.each do |key, path|
+        output = output.gsub(path, key)
+      end
+      output
+    end
 
+    # Saves the output in a file called #output_path, relative to current dir.
+    #
+    # @param  [String] command
+    #         The executed command line.
+    #
+    # @param  [String] output
+    #         The output, which was emitted while execution.
+    #
+    def write_output(command, output)
       File.open(output_path, 'w') do |file|
-        file.write command.sub(executable, name)
+        printable_command = "#{environment_var_assignments} #{command} 2>&1"
+        file.write printable_command.sub(executable, name)
         file.write "\n"
-
-        replace_paths.each do |key, path|
-          output.gsub!(path, key)
-        end
-
         file.write output
       end
-
-      output
     end
 
   end

data/lib/CLIntegracon/version.rb

@@ -1,3 +1,3 @@
 module CLIntegracon
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

data/spec/unit/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'CLIntegracon'
 require 'mocha-on-bacon'
+require 'active_support/core_ext/string/strip'

data/spec/unit/subject_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe CLIntegracon::Subject do
+
+  def subject
+    CLIntegracon::Subject
+  end
+
+  before do
+    @subject = subject.new('cat')
+  end
+
+  describe '#launch' do
+    it 'should redact paths from output' do
+      output = <<-eos.strip_heredoc
+        /Users/marius/.im/chat.log
+        /tmp/im/chat.log
+      eos
+      @subject.expects(:`).returns(output)
+      @subject.stubs(:write_output)
+      @subject.replace_user_path '.im/chat.log'
+      @subject.replace_path '/tmp', '$TMP'
+      @subject.launch.should.be == <<-eos.strip_heredoc
+        $HOME/.im/chat.log
+        $TMP/im/chat.log
+      eos
+    end
+
+    it 'should redact patterns from output' do
+      output = <<-eos.strip_heredoc
+        Fri Nov 14 22:46:37 - @samuel > ¡Hola!
+        Fri Nov 14 22:46:54 - @olivier > Hi
+        Fri Nov 14 22:47:13 - @marius > hey
+      eos
+      @subject.expects(:`).returns(output)
+      @subject.stubs(:write_output)
+      @subject.replace_pattern /\w{3} \w{3} \d{2} \d{2}:\d{2}:\d{2}/, '<#DATE#>'
+      @subject.replace_pattern /@\w+/, '<REDACTED>'
+      @subject.launch.should.be == <<-eos.strip_heredoc
+        <#DATE#> - <REDACTED> > ¡Hola!
+        <#DATE#> - <REDACTED> > Hi
+        <#DATE#> - <REDACTED> > hey
+      eos
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clintegracon
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Marius Rackwitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +197,7 @@ files:
 - spec/unit/configuration_spec.rb
 - spec/unit/formatter_spec.rb
 - spec/unit/spec_helper.rb
+- spec/unit/subject_spec.rb
 homepage: https://github.com/mrackwitz/CLIntegracon
 licenses:
 - MIT
@@ -229,4 +244,5 @@ test_files:
 - spec/unit/configuration_spec.rb
 - spec/unit/formatter_spec.rb
 - spec/unit/spec_helper.rb
+- spec/unit/subject_spec.rb
 has_rdoc: