docker_rails_proxy 0.1.11 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b3dcd393e5a9b60e7cfe3188671314011b44f802ad471c1267442d52dc878b
-  data.tar.gz: fb97c5c91622fefb42a69e9a3bea41b6420be47647aa73a1de58db6ba5adb938
+  metadata.gz: 8282c9ba08244394394df207bd38bd75332699cb68966f3e4e92feab3e63a4de
+  data.tar.gz: 2ae4f4bdefba0e1ca762968dc32e99f10fc6e5bf33d0425d0fbe736699682e2d
 SHA512:
-  metadata.gz: 31de2c5a3f1f54b8dacc4e75c19a08f82b19c0c0aef99a53a36f3df49be1c7f6ba8466b6bfaed881df3fcdfd943637fdd868948337d45e69b296b709f82e44ce
-  data.tar.gz: 4e70215519f80cff3d7f5e84155dba08b37a4aa4ec205f9a155077f57a96b1e472e6906453e364c59862d6af450fb2ab1dc49fc3e008771a25d606c2fa4a6571
+  metadata.gz: e490b98391af24d96d7cc791fb4305322da17e378c83f76c6fc3a465c0f4c07c3910bffc78346a76844401a3efd1f9365b9dbf21eca7bcb527ffd4d724e26d04
+  data.tar.gz: 8fb03b2ab38190e2e95887dac8069f25e414f9413d1ac236db248d2b58e9403e876d44cf8d172478dde8976789a039a6f03c16ca45e5a31bbba8b3f39f319142

data/README.md

@@ -1,6 +1,28 @@
 ### To release a new version
 
-Update `lib/docker_rails_proxy/version.rb` with the new version and commit that change.
+**Test locally**
+
+change the version on `lib/docker_rails_proxy/version.rb`
+
+and build the gem
+
+```
+gem build docker_rails_proxy.gemspec                                                                                                                                      [ruby-2.6.3]
+  Successfully built RubyGem
+  Name: docker_rails_proxy
+  Version: 0.1.13
+  File: docker_rails_proxy-0.1.13.gem
+```
+
+on the repo when you want to test, i.e `~/Projects/Eureka`
+
+install the local gem
+
+```
+gem install docker_rails_proxy -l ~/Projects/docker_rails_proxy/docker_rails_proxy-0.1.13.gem
+```
+
+Once it's ready, create the tag and push
 
 **Git Tag**
 ```bash
@@ -12,6 +34,5 @@ git push origin v0.0.1
 
 The user on rubygems.org is eureaktechteam@gmail.com.  Credentials are in 1password "Eureka Tech" vault 
 ```bash
-gem build docker_rails_proxy.gemspec
 gem push docker_rails_proxy-0.0.1.gem
 ```

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,10 +29,18 @@ module DockerRailsProxy
     include Rsync
     include Logger
 
-    attr_reader :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:)
-      @arguments = arguments
+    def initialize(arguments:, additional_arguments:)
+      @arguments            = arguments
+      @additional_arguments = additional_arguments
     end
 
     class << self
@@ -70,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)
@@ -83,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
@@ -114,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
@@ -129,7 +156,7 @@ module DockerRailsProxy
       attr_accessor :vm_provisioner, :kubernetes_running
     end
 
-    attr_accessor :app_container_id
+    attr_accessor :app_container_id, :docker_options
 
     before_initialize do
       unless system 'type docker &> /dev/null'
@@ -167,9 +194,10 @@ module DockerRailsProxy
       end if Docker.kubernetes_running
     end
 
+    after_initialize { self.docker_options = {} }
     after_initialize :set_app_container_id
 
-  private
+    private
 
     def docker_compose?
       !!Docker.kubernetes_running == false
@@ -199,17 +227,39 @@ module DockerRailsProxy
                 tty: false,
                 container_id: app_container_id,
                 replace_process: false,
-                user: nil,
                 **)
 
-      options = []
+      docker_options['-ti'] = nil if tty
 
-      options << '-ti' if tty
-      options << "-u #{user}" if user
+      command = [
+        'docker exec',
+        docker_options.map { |key, value| [key, value].compact.join(' ') },
+        container_id,
+        command
+      ].join(' '.freeze)
 
-      command = "docker exec #{options.join(' '.freeze)} #{container_id} #{command}"
       replace_process ? exec(command) : system(command)
     end
+
+    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('--docker-user USER', 'Username or UID (format: <name|uid>[:<group|gid>])') do |user|
+          docker_options['-u'] = user
+        end
+
+        opts.on('--docker-tty', 'Allocate a pseudo-TTY') do |tty|
+          docker_options['-t'] = nil
+        end
+
+        opts.on('--docker-interactive', 'Keep STDIN open even if not attached') do |interactive|
+          docker_options['-i'] = nil
+        end
+      end
+    end
   end
 
   class DockerMainApp < Docker

data/lib/docker_rails_proxy/cli.rb

@@ -2,20 +2,23 @@ module DockerRailsProxy
   class Cli
     class << self
       def invoke(arguments)
-        command, *args = arguments
+        command, *all_arguments         = arguments
+        arguments, additional_arguments = split_arguments(all_arguments)
 
         if command.nil?
           $stderr.puts <<-EOF
           #{"bin/#{APP_NAME} requires 1 argument.".bold}
 
-          #{"Usage: bin/#{APP_NAME} <command> [<args>]".bold}
+          #{"Usage: bin/#{APP_NAME} <command> [<arguments>]".bold}
           EOF
           exit 1
         end
 
         if COMMANDS.include? command
-          args << '-h' if args.empty?
-          "DockerRailsProxy::#{command}".constantize.(arguments: args)
+          arguments << '-h' if arguments.empty?
+          "DockerRailsProxy::#{command}".constantize.call(
+            arguments: arguments, additional_arguments: additional_arguments
+          )
         else
           $stderr.puts <<-EOS
           #{'No such command'.yellow}
@@ -25,13 +28,22 @@ module DockerRailsProxy
 
           COMMANDS.each do |script|
             $stderr.puts <<-EOS
-            #{script.parameterize.bold} [<args>]
+            #{script.parameterize.bold} [<arguments>]
             EOS
           end
 
           exit 1
         end
       end
+
+      private
+
+      def split_arguments(arguments)
+        return [arguments, []] unless (separator_index = arguments.index('--'))
+
+        arguments.delete_at(separator_index)
+        arguments.partition.with_index { |_, index| index < separator_index }
+      end
     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
@@ -37,7 +36,7 @@ module DockerRailsProxy
         self.from_scratch = if docker_compose?
           %x(docker-compose ps | grep -c #{APP_NAME}).to_i.zero?
         elsif kubernetes?
-          %x(kubectl get deploy -l 'app=#{APP_NAME}' -o name).empty?
+          %x(kubectl get deployment #{APP_NAME} -o name).empty?
         end
       end
 
@@ -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'

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

@@ -1,4 +1,3 @@
-require 'optparse'
 require 'json'
 
 module DockerRailsProxy

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

@@ -1,14 +1,17 @@
 module DockerRailsProxy
   class Rails < SyncBack
+    attr_reader :args
+
     def process
-      command, *args = arguments
+      command, *@args = arguments
 
       case command
-      when 'c',  'console'    then console args
-      when 'db', 'dbconsole'  then db args
-      when 'logs'             then logs args
+      when 'c',  'console'    then console
+      when 'db', 'dbconsole'  then db
+      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
@@ -16,11 +19,11 @@ module DockerRailsProxy
 
   private
 
-    def console(args)
+    def console
       execute "bin/rails c #{args.join(' ')}", tty: true, replace_process: true
     end
 
-    def db(args)
+    def db
       container_id = get_docker_container_id(:mysql)
 
       if container_id.empty?
@@ -36,7 +39,7 @@ module DockerRailsProxy
       )
     end
 
-    def logs(args)
+    def logs
       execute "tail -f log/#{args.first || 'development'}.log", replace_process: true
     end
 
@@ -47,5 +50,12 @@ module DockerRailsProxy
     def secrets
       execute "bash -c 'EDITOR=vim bin/rails secrets:edit'", tty: true
     end
+
+    def credentials
+      # 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
   end
 end

data/lib/docker_rails_proxy/commands/rake.rb

@@ -1,8 +1,7 @@
 module DockerRailsProxy
   class Rake < SyncBack
-    def process
-      command, *args = arguments
-      execute "bin/rake #{command} #{args.join(' ')}"
+    builds ->(params:) do
+      Rails
     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

@@ -1,16 +1,16 @@
 module DockerRailsProxy
   module Callbacks
-    INHERITABLE_CALLBACKS = %w(
+    INHERITABLE_CALLBACKS = %w[
       _before_initialize
       _after_initialize
       _validates
       _before_process
       _after_process
-    ).freeze
+    ].freeze
 
-    UNINHERITABLE_CALLBACKS = %w(
+    UNINHERITABLE_CALLBACKS = %w[
       _builds
-    ).freeze
+    ].freeze
 
     def self.included(base)
       base.extend(ClassMethods)
@@ -50,12 +50,12 @@ module DockerRailsProxy
       def _make_lambda(callback:)
         case callback
         when Symbol
-          -> (resource, *rest) { resource.send(callback, *rest) }
+          ->(resource, *rest) { resource.send(callback, *rest) }
         when ::Proc
           if callback.arity <= 0
-            -> (resource) { resource.instance_exec(&callback) }
+            ->(resource) { resource.instance_exec(&callback) }
           else
-            -> (resource, *rest) do
+            ->(resource, *rest) do
               if rest.empty?
                 resource.instance_exec(resource, &callback)
               else
@@ -64,13 +64,13 @@ module DockerRailsProxy
             end
           end
         else
-          -> (*) {}
+          ->(*) {}
         end
       end
 
       def _run_before_initialize_callbacks
         Array(_before_initialize).each do |callback|
-          if (result = callback.call(self)).is_a? String
+          if (result = callback.call(self)).is_a?(String)
             $stderr.puts %(
               #{result}
             )
@@ -85,7 +85,7 @@ module DockerRailsProxy
 
       def _run_validation_callbacks(resource:)
         Array(_validates).each do |callback|
-          if (result = callback.call(resource)).is_a? String
+          if (result = callback.call(resource)).is_a?(String)
             $stderr.puts %(
               #{result}
             )

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
@@ -72,7 +72,7 @@ module DockerRailsProxy
         }
 
         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.11'
+  VERSION = '0.1.16'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: docker_rails_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.16
 platform: ruby
 authors:
 - Jairo
 - Vázquez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies: []
 description: Configures docker-compose and provides rails command helpers
 email:
@@ -60,7 +60,7 @@ homepage: https://github.com/jairovm/docker_rails_proxy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,9 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: docker, docker-compose and rails wrapper
 test_files: []