docker_rails_proxy 0.1.14 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fad751379dd5d549c8011a29940d27331f621f795e51eabab58e3dcc1255333
-  data.tar.gz: 39192659415b1591d866f09db17bde167208dfaf9a54e4d980820ee3e855720b
+  metadata.gz: 8446a39b234fb3588cdd8c13256daf3fca61fcb8507a16cca046721178c0fea1
+  data.tar.gz: ff209e1236606d59fcdb8e00522006911dff44edd1990f9c7e1e272b61dfa4f5
 SHA512:
-  metadata.gz: 7138508ef6629f939d0c9639bfd9dfbc6fa57e23e5f3f7745998c856d2da0c258c8b16b58d9eb00f69fbae212f039b6d3341973704d8aebb5daaaf0396448f70
-  data.tar.gz: 291bc344901a060ed5a7dd7bdaf7f48b75bab002ee982e0f323d459d3b7e7fbb11f8c42a60cad8195cab00b3945849deb657811a1708f72bd8f3fea231f15a9b
+  metadata.gz: 5eccccf5651aeab7c860049d66e79f5e5c6acb4e1c08af74e74a764d69d360bd62c1c4603775a6491f6b9f185cfc8ce1baea7491b45e4da0015aeaaca39a3dfd
+  data.tar.gz: bceae22e15ab76e82f0408c012edcb699be0ab03e28f45fbea1f3dfcc0b0bcdb928b899d82ea95ab077ef61e9f44b5229a28f94fddfafdd9ec0b44431ae741b0

data/lib/docker_rails_proxy.rb

@@ -1,3 +1,5 @@
+require 'optparse'
+
 Dir[File.expand_path('../docker_rails_proxy/extends/*.rb', __FILE__)].map do |f|
   require f
 end
@@ -27,7 +29,14 @@ module DockerRailsProxy
     include Rsync
     include Logger
 
-    attr_reader :arguments, :additional_arguments
+    attr_accessor :additional_arguments_options
+    attr_reader   :arguments, :additional_arguments
+
+    after_initialize { self.additional_arguments_options = {} }
+    after_initialize { additional_arguments_parser.parse!(additional_arguments) }
+    after_initialize do
+      DockerRailsProxy.log_level(level: additional_arguments_options[:debug])
+    end
 
     def initialize(arguments:, additional_arguments:)
       @arguments            = arguments
@@ -52,7 +61,7 @@ module DockerRailsProxy
 
         klass.send :_run_before_initialize_callbacks
 
-        resource = klass.new(options)
+        resource = klass.new(**options)
 
         klass.send :_run_after_initialize_callbacks, resource: resource
 
@@ -71,7 +80,7 @@ module DockerRailsProxy
       raise NotImplementedError, 'Subclasses must implement a process method'
     end
 
-  private
+    private
 
     def build_path(*args, &block)
       self.class.build_path(*args, &block)
@@ -84,16 +93,16 @@ module DockerRailsProxy
 
     def get_option(values, default: nil, array: false)
       flush_stdin
-      print ": "
+      print ': '
       option = $stdin.gets.chomp
 
       return default if option.blank?
 
       if array
         options = option.split(',')
-        return nil unless options.map{|o| o =~ NUMBER_REGEXP }.all?
+        return unless options.all? { |o| o =~ NUMBER_REGEXP }
 
-        options.map{|o| values[o.to_i].split(',') }.flatten.compact.uniq.join(',')
+        options.map { |o| values[o.to_i].split(',') }.flatten.compact.uniq.join(',')
       else
         values[option.to_i] if option =~ NUMBER_REGEXP
       end
@@ -104,7 +113,7 @@ module DockerRailsProxy
 
       while value.nil? do
         print_options(values, message)
-        value = get_option(values, options)
+        value = get_option(values, **options)
       end
 
       value
@@ -115,6 +124,23 @@ module DockerRailsProxy
         Timeout::timeout(0.1) { $stdin.gets.chomp } rescue break
       end
     end
+
+    def additional_arguments_parser
+      @additional_arguments_parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: bin/#{APP_NAME} #{self.class.name.demodulize.parameterize} [<arguments>] -- [<additional_arguments>]".bold
+
+        opts.on('--debug', 'Debug mode') do |debug|
+          additional_arguments_options[:debug] = ::Logger::DEBUG
+        end
+
+        yield opts if block_given?
+
+        opts.on('-h', '--help', 'Display this screen') do
+          puts opts
+          exit
+        end
+      end
+    end
   end
 
   class AwsCli < Base
@@ -169,10 +195,9 @@ module DockerRailsProxy
     end
 
     after_initialize { self.docker_options = {} }
-    after_initialize { docker_arguments_parser.parse!(additional_arguments) }
     after_initialize :set_app_container_id
 
-  private
+    private
 
     def docker_compose?
       !!Docker.kubernetes_running == false
@@ -216,32 +241,23 @@ module DockerRailsProxy
       replace_process ? exec(command) : system(command)
     end
 
-    def docker_arguments_parser
-      @docker_arguments_parser ||= OptionParser.new do |opts|
-        opts.banner = "Usage: bin/#{APP_NAME} #{self.class.name.demodulize.parameterize} -- [<docker exec arguments>]".bold
-
-        opts.on('-w', '--workdir WORKDIR', 'Working directory inside the container') do |workdir|
+    def additional_arguments_parser
+      super do |opts|
+        opts.on('--docker-workdir WORKDIR', 'Working directory inside the container') do |workdir|
           docker_options['-w'] = workdir
         end
 
-        opts.on('-u', '--user USER', 'Username or UID (format: <name|uid>[:<group|gid>])') do |user|
+        opts.on('--docker-user USER', 'Username or UID (format: <name|uid>[:<group|gid>])') do |user|
           docker_options['-u'] = user
         end
 
-        opts.on('-t', '--tty', 'Allocate a pseudo-TTY') do |tty|
+        opts.on('--docker-tty', 'Allocate a pseudo-TTY') do |tty|
           docker_options['-t'] = nil
         end
 
-        opts.on('-i', '--interactive', 'Keep STDIN open even if not attached') do |interactive|
+        opts.on('--docker-interactive', 'Keep STDIN open even if not attached') do |interactive|
           docker_options['-i'] = nil
         end
-
-        yield opts if block_given?
-
-        opts.on('-h', '--help', 'Display this screen') do
-          puts opts
-          exit
-        end
       end
     end
   end

data/lib/docker_rails_proxy/cli.rb

@@ -2,8 +2,8 @@ module DockerRailsProxy
   class Cli
     class << self
       def invoke(arguments)
-        command, *all_arguments = arguments
-        arguments, additional_arguments  = split_arguments(all_arguments)
+        command, *all_arguments         = arguments
+        arguments, additional_arguments = split_arguments(all_arguments)
 
         if command.nil?
           $stderr.puts <<-EOF
@@ -16,7 +16,7 @@ module DockerRailsProxy
 
         if COMMANDS.include? command
           arguments << '-h' if arguments.empty?
-          "DockerRailsProxy::#{command}".constantize.(
+          "DockerRailsProxy::#{command}".constantize.call(
             arguments: arguments, additional_arguments: additional_arguments
           )
         else
@@ -39,9 +39,10 @@ module DockerRailsProxy
       private
 
       def split_arguments(arguments)
-        arguments = arguments.join(' ') if arguments.is_a?(Array)
-        arguments, additional_arguments = arguments.split('-- ')
-        [arguments.split(' '), additional_arguments.to_s.split(' ')]
+        return [arguments, []] unless (separator_index = arguments.index('--'))
+
+        arguments.delete_at(separator_index)
+        arguments.partition.with_index { |_, index| index < separator_index }
       end
     end
   end

data/lib/docker_rails_proxy/commands/build.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module DockerRailsProxy
   class Build < Docker
     attr_accessor :options

data/lib/docker_rails_proxy/commands/compose/up.rb

@@ -1,5 +1,4 @@
 require 'pty'
-require 'optparse'
 
 module DockerRailsProxy
   class Compose < Docker
@@ -52,7 +51,7 @@ module DockerRailsProxy
         seed                 if from_scratch?
       end
 
-    private
+      private
 
       def seed
         logger.info "Seeding #{APP_NAME} data"
@@ -77,10 +76,12 @@ module DockerRailsProxy
       end
 
       def fswatch_start
+        logger.debug "fswatch command: #{FSWATCH_CMD}"
         logger.info 'fswatch has been started'
+
         PTY.spawn(FSWATCH_CMD) do |stdout, stdin, pid|
           begin
-            stdout.each { |path| sync_or_kill(path: path, pid: pid) }
+            stdout.each { |path| sync_or_kill(path: path.strip, pid: pid) }
           rescue Errno::EIO
             logger.error EIO_ERROR
           end
@@ -98,7 +99,9 @@ module DockerRailsProxy
         return if stopping?
 
         if branch_name == (branch = current_branch)
+          logger.debug("syncing #{path}")
           sync source: path
+          logger.debug("#{path} synced")
         else
           $stderr.puts %(
           `git checkout #{branch}` was detected, stopping fswatch

data/lib/docker_rails_proxy/commands/data_bags.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module DockerRailsProxy
   class DataBags < AwsCli
     autoload :Pull, 'docker_rails_proxy/commands/data_bags/pull'

data/lib/docker_rails_proxy/commands/kubectl.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module DockerRailsProxy
   class Kubectl < Base
     autoload :Bash,          'docker_rails_proxy/commands/kubectl/bash'
@@ -12,7 +10,7 @@ module DockerRailsProxy
     end
 
     validates do
-      unless File.exist? KUBECONFIG_PATH
+      unless File.exist?(KUBECONFIG_PATH)
         <<-EOS
 
         kubeconfig is required, run this command to set it
@@ -21,7 +19,7 @@ module DockerRailsProxy
       end unless arguments.first == 'set-kubeconfig'
     end
 
-    builds -> (params:) do
+    builds ->(params:) do
       case params[:arguments].first
       when 'bash'           then Bash
       when 'set-kubeconfig' then SetKubeconfig
@@ -32,10 +30,12 @@ module DockerRailsProxy
       kubectl arguments.join(' ')
     end
 
-  private
+    private
 
     def kubectl(command)
-      exec "kubectl --kubeconfig='#{KUBECONFIG_PATH}' #{command}"
+      cmd =  "kubectl --kubeconfig='#{KUBECONFIG_PATH}' #{command}"
+      cmd << " -- #{additional_arguments.join(', ')}" unless additional_arguments.empty?
+      exec cmd
     end
 
     def kubectl_output(command)

data/lib/docker_rails_proxy/commands/kubectl/bash.rb

@@ -1,20 +1,23 @@
-require 'optparse'
 require 'json'
 
 module DockerRailsProxy
   class Kubectl < Base
     class Bash < self
+      UNNEEDED_ATTRIBUTES = %w[livenessProbe readinessProbe command lifecycle].freeze
+
       attr_accessor :data
 
       before_process do
-        self.data = JSON.parse kubectl_output("get pod #{pod} -o json")
+        self.data = JSON.parse(
+          kubectl_output("get pod #{cloned_pod_name} -o json")
+        )
       end
 
-      def process
-        %w[livenessProbe readinessProbe command lifecycle].each do |attr|
-          container.delete attr
-        end
+      before_process do
+        UNNEEDED_ATTRIBUTES.each { |attribute| container.delete(attribute) }
+      end
 
+      def process
         overrides = {
           metadata: {
             annotations: {
@@ -50,28 +53,27 @@ module DockerRailsProxy
         pod_name = "#{container['name']}-bash-#{Time.now.strftime '%Y%m%d%H%M%S'}"
         puts "Starting #{pod_name} pod ..."
 
-        kubectl <<-EOS
+        kubectl <<-RUN_COMMAND
           run #{pod_name} --rm -i --tty \
             --image='#{container['image']}' \
-            --generator='run-pod/v1' \
             --overrides='#{overrides.to_json}'
-        EOS
+        RUN_COMMAND
       end
 
-    private
+      private
 
-      def pod
-        @pod_name ||= begin
-          pods = kubectl_output(<<-EOS).split(" ")
+      def cloned_pod_name
+        @cloned_pod_name ||= begin
+          pods = kubectl_output(<<-GET_PODS).split(" ")
             get pods -o jsonpath='{range .items[*]}{.metadata.name},{.status.phase}{" "}{end}'}
-          EOS
+          GET_PODS
 
           pods = pods.map do |values|
             name, phase = values.split(',')
             phase == 'Running' ? name : nil
           end.compact
 
-          until_get_option pods, "Choose a pod and press [ENTER]"
+          until_get_option(pods, "Choose a pod and press [ENTER]")
         end
       end
 
@@ -80,9 +82,9 @@ module DockerRailsProxy
           containers = data.dig('spec', 'containers')
 
           if containers.size > 1
-            names = containers.map{|c| c['name'] }
-            name  = until_get_option names, "Choose a container and press [ENTER]"
-            containers.detect{|c| c['name'] == name }
+            names = containers.map { |container| container['name'] }
+            name  = until_get_option(names, "Choose a container and press [ENTER]")
+            containers.find { |container| container['name'] == name }
           else
             containers.first
           end

data/lib/docker_rails_proxy/commands/kubectl/set_kubeconfig.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'optparse'
 require 'yaml'
 
 module DockerRailsProxy

data/lib/docker_rails_proxy/commands/rails.rb

@@ -2,6 +2,16 @@ module DockerRailsProxy
   class Rails < SyncBack
     attr_reader :args
 
+    autoload :Credentials, 'docker_rails_proxy/commands/rails/credentials'
+
+    builds ->(params:) do
+      case params[:arguments].first
+      when 'credentials' then Credentials
+      else
+        DockerRailsProxy::Rails
+      end
+    end
+
     def process
       command, *@args = arguments
 
@@ -11,13 +21,12 @@ module DockerRailsProxy
       when 'logs'             then logs
       when 'restart', 'touch' then restart
       when 'secrets'          then secrets
-      when 'credentials'      then credentials
       else
         execute "bin/rails #{command} #{args.join(' ')}", tty: true
       end
     end
 
-  private
+    private
 
     def console
       execute "bin/rails c #{args.join(' ')}", tty: true, replace_process: true
@@ -52,8 +61,8 @@ module DockerRailsProxy
     end
 
     def credentials
-      #environment = args.first
-      #raise 'Invalid environment' if environment.present? && !%w[development stage].include?(environment)
+      # Temporary solution to use credentials in Rails 5.2
+      # Future version will use the --environment argument instead
       command = "RAILS_ENV=#{args.first} EDITOR=vim bin/rails credentials:edit"
       execute "bash -c '#{command}'", tty: true
     end

data/lib/docker_rails_proxy/commands/rails/credentials.rb

@@ -0,0 +1,34 @@
+module DockerRailsProxy
+  class Rails < SyncBack
+    class Credentials < self
+      attr_accessor :options
+
+      after_initialize { self.options = {} }
+      after_initialize { opt_parser.parse!(arguments) }
+
+      validates { '--environment is required' if options[:environment].nil? }
+
+      def process
+        command = "EDITOR=vim bin/rails credentials:edit --environment #{options[:environment]}"
+        execute "bash -c '#{command}'", tty: true
+      end
+
+      private
+
+      def opt_parser
+        @opt_parser ||= OptionParser.new do |opts|
+          opts.banner = "Usage: bin/#{APP_NAME} rails credentials [options]"
+
+          opts.on(
+            '--environment ENVIRONMENT', 'App environment'
+          ) { |environment| options[:environment] = environment }
+
+          opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docker_rails_proxy/commands/ssh.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module DockerRailsProxy
   class Ssh < DockerMainApp
     def process

data/lib/docker_rails_proxy/commands/stack.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module DockerRailsProxy
   class Stack < AwsCli
     autoload :Create,  'docker_rails_proxy/commands/stack/create'

data/lib/docker_rails_proxy/concerns/callbacks.rb

@@ -50,18 +50,10 @@ module DockerRailsProxy
       def _make_lambda(callback:)
         case callback
         when Symbol
-          ->(resource, *rest) { resource.send(callback, *rest) }
+          ->(resource, *args, **kw_args) { resource.send(callback, *args, **kw_args) }
         when ::Proc
-          if callback.arity <= 0
-            ->(resource) { resource.instance_exec(&callback) }
-          else
-            ->(resource, *rest) do
-              if rest.empty?
-                resource.instance_exec(resource, &callback)
-              else
-                resource.instance_exec(*rest, &callback)
-              end
-            end
+          lambda do |resource, *args, **kw_args|
+            resource.instance_exec(*args, **kw_args, &callback)
           end
         else
           ->(*) {}

data/lib/docker_rails_proxy/concerns/logger.rb

@@ -1,6 +1,18 @@
 require 'logger'
 
 module DockerRailsProxy
+  def self.logger
+    @logger ||= ::Logger.new(STDOUT).tap do |log|
+      log.formatter = proc do |severity, datetime, progname, msg|
+        "#{severity[0]}, [#{datetime.strftime('%Y-%m-%d %T')}] -- : #{msg}\n"
+      end
+    end
+  end
+
+  def self.log_level(level: nil)
+    logger.level = level || ::Logger::INFO
+  end
+
   module Logger
     class << self
       def included(base)
@@ -10,16 +22,12 @@ module DockerRailsProxy
 
     module ClassMethods
       def logger
-        @logger ||= ::Logger.new(STDOUT).tap do |log|
-          log.formatter = proc do |severity, datetime, progname, msg|
-            "> #{datetime.strftime '%Y-%m-%d %T'} -- #{msg}\n"
-          end
-        end
+        ::DockerRailsProxy.logger
       end
     end
 
     def logger
-      self.class.logger
+      ::DockerRailsProxy.logger
     end
   end
 end

data/lib/docker_rails_proxy/concerns/rsync.rb

@@ -31,7 +31,7 @@ module DockerRailsProxy
       _rsync.sync source: source, reverse: reverse, silent: silent
     end
 
-  private
+    private
 
     def _rsync_host
       @_rsync_host ||= begin
@@ -64,15 +64,16 @@ module DockerRailsProxy
       end
 
       def sync(options)
-        return if source_in_exclusions?(options)
-        source, target, volume = normalize_options(options)
+        return if source_in_exclusions?(**options)
+
+        source, target, volume = normalize_options(**options)
 
-        result = send "sync_#{volume}", {
-          source: source, target: target, reverse: options[:reverse]
-        }
+        result = send(
+          "sync_#{volume}", source: source, target: target, reverse: options[:reverse]
+        )
 
         if result && options[:silent].eql?(false)
-          puts "#{source}   =======>   #{target}"
+          DockerRailsProxy.logger.info "#{source}   =======>   #{target}"
         end
 
         result

data/lib/docker_rails_proxy/version.rb

@@ -1,3 +1,3 @@
 module DockerRailsProxy
-  VERSION = '0.1.14'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: docker_rails_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.1
 platform: ruby
 authors:
 - Jairo
 - Vázquez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies: []
 description: Configures docker-compose and provides rails command helpers
 email:
@@ -37,6 +37,7 @@ files:
 - lib/docker_rails_proxy/commands/kubectl/bash.rb
 - lib/docker_rails_proxy/commands/kubectl/set_kubeconfig.rb
 - lib/docker_rails_proxy/commands/rails.rb
+- lib/docker_rails_proxy/commands/rails/credentials.rb
 - lib/docker_rails_proxy/commands/rake.rb
 - lib/docker_rails_proxy/commands/rspec.rb
 - lib/docker_rails_proxy/commands/spring.rb
@@ -60,7 +61,7 @@ homepage: https://github.com/jairovm/docker_rails_proxy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: docker, docker-compose and rails wrapper
 test_files: []