replr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1711e27578931850f67a30057b13f315126fdcf28aeddd7cb585b6b0a651631
-  data.tar.gz: 21e698cddf5834b086a90db3724882df09c37ed03476e0c60afcc8882e1cf2db
+  metadata.gz: f3baafd9472b824734be5f808a2618e87120ba9adb87ef3a5fa6e09685d0a12a
+  data.tar.gz: d54f510d068f819de8aae695e76abe3fe7f45642cc7f5574d44ccf1d39509856
 SHA512:
-  metadata.gz: ce4f85bf76dbc96ceea24b63a4af130c6a623046e91507bafaf126743d67e1b461ae3f07b4224835a4cbf1ed8355622cde0f899164f1098f1014f2b1391d34c1
-  data.tar.gz: 98910ccbd262ef3de617eba52f4ddca7ba5dbf93c63591f4085dbc859530ebd77b4a59c699f4a586194cbf1660750ffde6cb3c0a10aad692398ff0ed05634363
+  metadata.gz: df87112be9e15dcb0a9754d6baa12c520567a335c78cd582201ed76aaa190dd5c0e49faba2f4c18e3d7a7dff43cf2e9fca0fe79fc63f0fc9561e1849e207e8c6
+  data.tar.gz: '03887359a7e34df5f4ec3c8583cc93cb0bb7663941b1db3a7643923259f0cde76a4ea14e24ed404e579c54437c8b91bba25162f134189ba60ea8b45ac540bb67'

data/bin/replr

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/replr'
-Replr.new.start
+Replr::REPLMaker.new.start

data/lib/replr.rb

@@ -1,142 +1,2 @@
-require 'tmpdir'
-require 'open3'
-
-# :nodoc:
-class Replr
-  attr_reader :arguments, :workdir, :docker_image_tag
-
-  def start
-    @arguments = ARGV.map { |argument| argument.downcase.strip }
-
-    check_docker!
-    check_argument_length!
-    check_arguments!
-
-    @workdir = Dir.mktmpdir
-    @docker_image_tag = "replr/ruby-#{libraries.join('-')}"
-
-    process_arguments
-  end
-
-  private
-
-  def process_arguments
-    if arguments[0] == 'prune'
-      execute_prune_command
-    else
-      copy_library_file
-      copy_docker_file
-      initialize_docker_repl
-    end
-  end
-
-  def check_argument_length!
-    if arguments.empty?
-      puts_usage
-      exit
-    end
-  end
-
-  def check_arguments!
-    unless ['ruby', 'prune'].include? arguments[0]
-      puts_error 'Only supports ruby as a stack right now'
-      puts_usage
-      exit
-    end
-  end
-
-  def puts_usage
-    puts_error "\nUsage: replr <stack> <libraries...>\n\n"
-    puts_error "A single line REPL for your favorite languages & libraries\n\n"
-    puts_error "\t<stack> is now only 'ruby'"
-    puts_error "\t<libraries...> is a space separated list of libraries for the stack\n\n"
-    puts_error "More commands:\n\n\treplr prune to delete all replr docker images (this saves space)"
-  end
-
-  def execute_prune_command
-    prune_command = %q(docker images -a |  grep "replr/" | awk '{print $3}' | xargs docker rmi)
-    system(prune_command)
-  end
-
-  def check_docker!
-    unless system('which docker >/dev/null')
-      puts_error 'Needs docker installed & in path to work.'
-      exit
-    end
-  end
-
-  def puts_error(string)
-    STDERR.puts(string)
-  end
-
-  def copy_library_file
-    Dir.chdir(workdir) do
-      File.open('Gemfile', 'w') do |f|
-        f.write(library_file_with(libraries))
-      end
-    end
-  end
-
-  def copy_docker_file
-    docker_file = "#{__dir__}/Dockerfile"
-    bootstrap_file = "#{__dir__}/replr-bootstrap.rb"
-    FileUtils.cp(docker_file, workdir)
-    FileUtils.cp(bootstrap_file, workdir)
-  end
-
-  def libraries
-    arguments[1..-1]
-  end
-
-  def library_file_with(libraries)
-    gemfile = "source 'https://rubygems.org/'\n"
-    libraries.each do |library|
-      gemfile << "gem '#{library}'\n"
-    end
-    gemfile
-  end
-
-  def initialize_docker_repl
-    Dir.chdir(workdir) do
-      build_command = "docker build -t #{docker_image_tag} ."
-      run_command = "docker run --rm -it #{docker_image_tag}"
-      matching = Regexp.union([/upgrading/i, /installing/i, /gem/i])
-      not_matching = Regexp.union([/step/i])
-      execute_filtered_process(build_command, matching,
-                               not_matching) do |stderr, process_thread|
-        execute_command_if_not_stderr(run_command, stderr, process_thread)
-      end
-    end
-  end
-
-  # Runs *command* and only prints those lines that match
-  # *matching_regex* and doesn't match *not_matching_regex*. After
-  # execution, it passes *stderr* and the waiting *process_thread*
-  # to a block.
-  def execute_filtered_process(command, matching_regex,
-                               not_matching_regex, &_block)
-    Open3.popen3(command) do |_stdin, stdout, stderr, process_thread|
-      stdout.each_line do |outline|
-        if outline.match(matching_regex) &&
-           !outline.match(not_matching_regex)
-          puts outline
-        end
-      end
-
-      # Yield to block to process next set of commands or handle stderr
-      yield(stderr, process_thread)
-    end
-  end
-
-  # Executes *new_command* if the previous *process_thread* had a
-  # non-zero return. Otherwise prints out *stderr* of the previous
-  # process to *STDERR*
-  def execute_command_if_not_stderr(new_command, stderr, process_thread)
-    outerror = stderr.read.chomp
-    if process_thread.value.to_i.zero?
-      system(new_command)
-    else
-      STDERR.puts outerror
-    end
-  end
-end
+require_relative 'replr/base'
+require_relative 'replr/repl_maker'

data/lib/{Dockerfile → replr/Dockerfile.template}

@@ -1,4 +1,4 @@
-FROM ruby:2.3.1-alpine
+FROM ruby:%%VERSION%%alpine
 ADD Gemfile /app/
 RUN apk --update add --virtual build-dependencies ruby-dev build-base && \
   gem install bundler --no-ri --no-rdoc && \

data/lib/replr/argument_processor.rb

@@ -0,0 +1,55 @@
+require_relative '../replr'
+
+# :nodoc:
+module Replr
+  # Processes command-line arguments
+  class ArgumentProcessor
+    COMMANDS = ['prune']
+    STACKS = ['ruby']
+
+    attr_reader :arguments
+
+    def initialize
+      @arguments = ARGV.map { |argument| argument.downcase.strip }
+      check_argument_length!
+      check_arguments!
+    end
+
+    def check_argument_length!
+      if arguments.empty?
+        puts_usage
+        exit
+      end
+    end
+
+    def check_arguments!
+      valid_stack = STACKS.detect do |stack|
+        arguments[0].match(/^#{stack}:?.*?/)
+      end
+      valid_command = COMMANDS.detect do |command|
+        arguments[0] == command
+      end
+
+      unless valid_stack or valid_command
+        puts_error "First argument must be either be a command:
+\t#{COMMANDS.join(' ')}
+or one of a supported stack:
+\t#{STACKS.join(' ')}"
+        puts_usage
+        exit
+      end
+    end
+
+    def puts_usage
+      puts_error "\nUsage: replr <stack> <libraries...>\n\n"
+      puts_error "A single line REPL for your favorite languages & libraries\n\n"
+      puts_error "\t<stack> is now only 'ruby'"
+      puts_error "\t<libraries...> is a space separated list of libraries for the stack\n\n"
+      puts_error "More commands:\n\n\treplr prune to delete all replr docker images (this saves space)"
+    end
+
+    def puts_error(string)
+      STDERR.puts(string)
+    end
+  end
+end

data/lib/replr/base.rb

@@ -0,0 +1,3 @@
+#:nodoc:
+module Replr
+end

data/lib/replr/process_runner.rb

@@ -0,0 +1,48 @@
+require_relative '../replr'
+
+module Replr
+  # Executes and manages processes
+  class ProcessRunner
+    # Executes command using system. Use this when you have no
+    # need for a return value
+    def execute_command(command)
+      system(command)
+    end
+
+    # Checks whether process exists using `which`
+    def process_exists?(process)
+      system("which #{process} >/dev/null")
+    end
+
+    # Runs *command* and only prints those lines that match
+    # *matching_regex* and doesn't match *not_matching_regex*. After
+    # execution, it passes *stderr* and the waiting *process_thread*
+    # to a block.
+    def execute_filtered_process(command, matching_regex,
+                                 not_matching_regex, &_block)
+      Open3.popen3(command) do |_stdin, stdout, stderr, process_thread|
+        stdout.each_line do |outline|
+          if outline.match(matching_regex) &&
+             !outline.match(not_matching_regex)
+            puts outline
+          end
+        end
+
+        # Yield to block to process next set of commands or handle stderr
+        yield(stderr, process_thread)
+      end
+    end
+
+    # Executes *new_command* if the previous *process_thread* had a
+    # non-zero return. Otherwise prints out *stderr* of the previous
+    # process to *STDERR*
+    def execute_command_if_not_stderr(new_command, stderr, process_thread)
+      outerror = stderr.read.chomp
+      if process_thread.value.to_i.zero?
+        system(new_command)
+      else
+        STDERR.puts outerror
+      end
+    end
+  end
+end

data/lib/replr/repl_maker.rb

@@ -0,0 +1,114 @@
+require_relative '../replr'
+require_relative 'argument_processor'
+require_relative 'process_runner'
+
+require 'tmpdir'
+require 'open3'
+
+# :nodoc:
+module Replr
+  # Creates a REPL using template Dockerfiles & libraries
+  class REPLMaker
+    attr_reader :argument_processor, :process_runner
+    attr_reader :stack, :libraries, :workdir
+
+    def start
+      @argument_processor = Replr::ArgumentProcessor.new
+      @process_runner = Replr::ProcessRunner.new
+
+      @stack = argument_processor.arguments[0]
+      @libraries = argument_processor.arguments[1..-1].sort!
+      @workdir = Dir.mktmpdir
+
+      check_docker!
+      execute_processsed_arguments!
+    end
+
+    private
+
+    def check_docker!
+      unless process_runner.process_exists?('docker')
+        puts_error 'Needs docker installed & in path to work.'
+        exit
+      end
+    end
+
+    def execute_processsed_arguments!
+      if argument_processor.arguments[0] == 'prune'
+        execute_prune_command
+      else
+        copy_library_file
+        copy_initialization_files
+        initialize_docker_repl
+      end
+    end
+
+    def execute_prune_command
+      prune_command = %q(docker images -a |  grep "replr/" | awk '{print $3}' | xargs docker rmi)
+      process_runner.execute_command(prune_command)
+    end
+
+    def puts_error(string)
+      STDERR.puts(string)
+    end
+
+    def copy_library_file
+      Dir.chdir(workdir) do
+        File.open('Gemfile', 'w') do |f|
+          f.write(library_file_with(libraries))
+        end
+      end
+    end
+
+    def copy_initialization_files
+      create_docker_file
+      bootstrap_file = "#{__dir__}/replr-bootstrap.rb"
+      FileUtils.cp(bootstrap_file, workdir)
+    end
+
+    def create_docker_file
+      _stack, version = stack.split(':')
+      docker_file_template = "#{__dir__}/Dockerfile.template"
+      docker_file_contents = File.read(docker_file_template)
+      docker_file_contents.gsub!('%%VERSION%%', version ? "#{version}-" : '')
+      File.open(File.join(workdir, 'Dockerfile'), 'w') do |file|
+        file.puts docker_file_contents
+      end
+    end
+
+    def library_file_with(libraries)
+      gemfile = "source 'https://rubygems.org/'\n"
+      libraries.each do |library|
+        if library.include?(':')
+          library, version = library.split(':')
+          gemfile << "gem '#{library}', '#{version}'\n"
+        else
+          gemfile << "gem '#{library}'\n"
+        end
+      end
+      gemfile
+    end
+
+    def initialize_docker_repl
+      Dir.chdir(workdir) do
+        build_command = "docker build -t #{docker_image_tag} ."
+        run_command = "docker run --rm -it #{docker_image_tag}"
+        matching = Regexp.union([/upgrading/i, /installing/i, /gem/i])
+        not_matching = Regexp.union([/step/i])
+        process_runner.execute_filtered_process(build_command, matching,
+                                                not_matching) do |stderr, process_thread|
+          process_runner.execute_command_if_not_stderr(run_command, stderr, process_thread)
+        end
+      end
+    end
+
+    def docker_image_tag
+      normalized_library_string = libraries.map do |library|
+        library.gsub(':', '-v')
+      end.join('-')
+      normalized_stack_string = stack.gsub(':', '-v')
+
+      "replr/#{normalized_stack_string}-#{normalized_library_string}"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: replr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vishnu Gopal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: vg@vishnugopal.com
@@ -19,9 +19,13 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - bin/replr
-- lib/Dockerfile
-- lib/replr-bootstrap.rb
 - lib/replr.rb
+- lib/replr/Dockerfile.template
+- lib/replr/argument_processor.rb
+- lib/replr/base.rb
+- lib/replr/process_runner.rb
+- lib/replr/repl_maker.rb
+- lib/replr/replr-bootstrap.rb
 homepage: https://github.com/vishnugopal/replr
 licenses:
 - MIT