executable_mock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89e54f80480d9ec55c308051dea7c922eedfc79d0a1e8f8a33e7437d72890a28
+  data.tar.gz: 841ee2e10667111ff0b8ef3e40506b4960e17f408f139805140181884c66eb92
+SHA512:
+  metadata.gz: f2085220dcf0c2e981ec4be0e30d5777fab09cd80a65d462737ec153c4f0aa29d67ddbb6ad2229281ad50c0c75ac9b88f25f74affb3b65d11dfbcca358e0f5c6
+  data.tar.gz: d6b243b5cbc886e1badf5ba30d617e7c7d7ee335b9e1388ed7cf2a946bda4ac5b532360e13fe0d98217b71f1579d5d243a28e6bf3ff063dc6f7ba56dac673003

data/lib/executable_mock/registry.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class ExecutableMock
+  module Registry
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def registry
+        Thread.current[:executable_mocks] ||= Set.new
+      end
+    end
+
+    def register_self
+      self.class.registry << self
+    end
+
+    def deregister_self
+      self.class.registry.delete(self)
+    end
+  end
+end

data/lib/executable_mock/stdlib.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "tempfile"
+require "erb"
+require "set"

data/lib/executable_mock/template.rb.erb

@@ -0,0 +1,34 @@
+#!<%= ruby_bin %>
+
+# Mappings
+
+mappings = <%= mappings %>
+argv_key = ARGV.join(" ")
+unless mappings.key?(argv_key)
+  File.open("<%= call_error_log_file_path %>", "w") do |file|
+    file.write("The executable `<%= name %>` does not support these args:\n#{argv_key}")
+    file.write("\n\nSupported:\n<%= mappings.keys.join("\n") %>")
+  end
+  puts "ExecutableMock: Unsupported arguments"
+  exit 1
+end
+
+# Counter cache handler
+
+call_count = nil
+File.open("<%= counter_cache_path %>", "a+") do |file|
+  file.rewind
+  counter_cache = Marshal.load(file.read)
+  call_count = counter_cache[argv_key]
+  counter_cache[argv_key] += 1
+  file.truncate(0)
+  file.write(Marshal.dump(counter_cache))
+end
+
+# Output
+
+if mappings[argv_key].is_a?(Array)
+  print mappings[argv_key].fetch(call_count)
+else
+  print mappings[argv_key]
+end

data/lib/executable_mock/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ExecutableMock
+  VERSION = "1.0.0"
+end

data/lib/executable_mock.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "executable_mock/stdlib"
+require "executable_mock/registry"
+
+class ExecutableMock
+  include Registry
+  TEMPLATE_PATH = File.expand_path("executable_mock/template.rb.erb", __dir__)
+  TEMPLATE = ERB.new(File.read(TEMPLATE_PATH))
+  Error = Class.new(StandardError)
+
+  attr_reader :file_path, :path_setup
+
+  class << self
+    def generate(name, mappings, ruby_bin: RbConfig.ruby, directory: Dir.mktmpdir)
+      instance = new(name, mappings, ruby_bin: ruby_bin, directory: directory)
+
+      yield(instance).tap do |result|
+        instance.finalize(result)
+      end
+    end
+
+    def finalize_all
+      registry.each(&:finalize)
+    end
+  end
+
+  def initialize(name, mappings, ruby_bin: RbConfig.ruby, directory: Dir.mktmpdir)
+    @mappings = mappings
+    @ruby_bin = ruby_bin
+    @name = name
+    @file_path = File.join(directory, name)
+    @path_setup = %(PATH="#{directory}:$PATH")
+    @call_error_log_file_path = Tempfile.new.path
+
+    write_executable
+    register_self
+  end
+
+  def finalize(command_result = nil)
+    called_argvs_map = Marshal.load(File.read(counter_cache_path)) # rubocop:disable Security/MarshalLoad
+    check_call_error_log_file
+    check_uncalled_argvs(called_argvs_map)
+    check_mismatched_argvs_calls(called_argvs_map)
+  rescue Error
+    puts command_result if command_result
+    raise
+  ensure
+    FileUtils.rm_f([@file_path, @call_error_log_file_path, counter_cache_path])
+    deregister_self
+  end
+
+  def check_call_error_log_file
+    return unless File.size?(@call_error_log_file_path)
+
+    raise(Error, File.read(@call_error_log_file_path))
+  end
+
+  def check_uncalled_argvs(argvs_map)
+    uncalled_argvs = argvs_map.select { |_, v| v.zero? }
+
+    raise(Error, <<~MESSAGE) if uncalled_argvs.any?
+      The following argvs were not called:
+      #{uncalled_argvs.keys.join("\n")}
+    MESSAGE
+  end
+
+  def check_mismatched_argvs_calls(argvs_map)
+    mismatched_argvs_calls = @mappings.select do |argv, outputs|
+      outputs.is_a?(Array) && outputs.size != argvs_map[argv]
+    end
+
+    raise(Error, <<~MESSAGE) if mismatched_argvs_calls.any?
+      The following argvs were not called the correct number of times:
+      #{mismatched_argvs_calls.inspect}
+    MESSAGE
+  end
+
+  def counter_cache_path
+    @counter_cache_path ||= begin
+      Tempfile.new.path.tap do |file_path|
+        data = Marshal.dump(@mappings.transform_values { 0 })
+        File.open(file_path, "w") do |file|
+          file.write(data)
+        end
+      end
+    end
+  end
+
+  def write_executable
+    bindings = {
+      ruby_bin: @ruby_bin,
+      mappings: @mappings,
+      name: @name,
+      call_error_log_file_path: @call_error_log_file_path,
+      counter_cache_path: counter_cache_path
+    }
+
+    executable_contents = TEMPLATE.result_with_hash(bindings)
+
+    File.open(@file_path, "w") do |file|
+      file.write(executable_contents)
+    end
+    File.chmod(0o755, @file_path)
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: executable_mock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christophe Maximin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-03 00:00:00.000000000 Z
+dependencies: []
+description: PLACEHOLDER
+email:
+- christophe.maximin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/executable_mock.rb
+- lib/executable_mock/registry.rb
+- lib/executable_mock/stdlib.rb
+- lib/executable_mock/template.rb.erb
+- lib/executable_mock/version.rb
+homepage: https://github.com/christophemaximin/executable_mock
+licenses: []
+metadata:
+  homepage_uri: https://github.com/christophemaximin/executable_mock
+  source_code_uri: https://github.com/christophemaximin/executable_mock
+  changelog_uri: https://github.com/christophemaximin/executable_mock/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 3.0.0.beta2
+signing_key: 
+specification_version: 4
+summary: PLACEHOLDER
+test_files: []