hanami-devtools 2023.02.16

data/lib/hanami/devtools/integration/random_port.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "socket"
+require "timeout"
+
+module RSpec
+  module Support
+    # Returns a random, non-sudo, free port
+    #
+    # @since 0.2.0
+    module RandomPort
+      HOST       = "localhost"
+      PORT_RANGE = 1024..65_535
+      TIMEOUT    = 1 # second
+
+      def self.call
+        result = -1
+
+        loop do
+          result = Kernel.rand(PORT_RANGE)
+          break unless open?(result)
+        end
+
+        result
+      end
+
+      def self.open?(port) # rubocop:disable Metrics/MethodLength
+        Timeout.timeout(TIMEOUT) do
+          begin
+            s = TCPSocket.new(HOST, port)
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EADDRNOTAVAIL
+            return false
+          end
+        end
+
+        false
+      rescue Timeout::Error
+        false
+      end
+
+      private_class_method :open?
+    end
+  end
+end

data/lib/hanami/devtools/integration/retry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Support
+    # Implement retry logic.
+    #
+    # It may happen that the setup of a test is slower then expected.
+    # Instead of let it to blow up, we can retry after a few seconds.
+    #
+    # @since 0.2.0
+    module Retry
+      private
+
+      def retry_exec(exception) # rubocop:disable Metrics/MethodLength
+        attempts           = 1
+        max_retry_attempts = Platform.match do
+          engine(:ruby)  { 10 }
+          engine(:jruby) { 20 }
+        end
+
+        begin
+          sleep 1
+          yield
+        rescue exception
+          raise if attempts > max_retry_attempts
+          attempts += 1
+          retry
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::Retry, type: :integration
+end

data/lib/hanami/devtools/integration/silently.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+module RSpec
+  # RSpec support utilities
+  #
+  # @since 0.2.0
+  module Support
+    def self.silently(cmd)
+      out    = Tempfile.new("hanami-out")
+      result = system(cmd, out: out.path)
+
+      return if result
+
+      out.rewind
+      fail "#{cmd} failed:\n#{out.read}" # rubocop:disable Style/SignalException
+    end
+
+    # Don't print unnecessary output during tests
+    #
+    # @since 0.2.0
+    module Silently
+      private
+
+      def silently(cmd)
+        Support.silently(cmd)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::Silently, type: :integration
+end

data/lib/hanami/devtools/integration/with_clean_env_project.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "hanami/devtools/integration/with_project"
+require "hanami/devtools/integration/bundler"
+
+module RSpec
+  module Support
+    # Generate a Hanami project with a Bundler clean environment.
+    #
+    # @since 0.2.0
+    #
+    # @see http://bundler.io/man/bundle-exec.1.html#Shelling-out
+    module WithCleanEnvProject
+      private
+
+      def with_clean_env_project(project = "bookshelf", args = {})
+        RSpec::Support::Bundler.with_clean_env do
+          with_project(project, args) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithCleanEnvProject, type: :integration
+end

data/lib/hanami/devtools/integration/with_directory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module RSpec
+  module Support
+    # Execute the given code inside a specified directory.
+    #
+    # NOTE: this changes the current `Dir.pwd`
+    #
+    # @since 0.2.0
+    module WithDirectory
+      private
+
+      def with_directory(directory)
+        current = Dir.pwd
+        target  = Pathname.new(Dir.pwd).join(directory)
+
+        Dir.chdir(target)
+        yield
+      ensure
+        Dir.chdir(current)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithDirectory
+end

data/lib/hanami/devtools/integration/with_project.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "hanami/devtools/integration/silently"
+require "hanami/devtools/integration/bundler"
+require "hanami/devtools/integration/with_tmp_directory"
+require "hanami/devtools/integration/within_project_directory"
+
+module RSpec
+  module Support
+    # Generates a Hanami project
+    #
+    # @since 0.2.0
+    module WithProject
+      private
+
+      KNOWN_ARGUMENTS = %i[database template test].freeze
+
+      def with_project(project = "bookshelf", args = {}) # rubocop:disable Metrics/MethodLength
+        with_tmp_directory do
+          create_project(project, args)
+
+          within_project_directory(project) do
+            begin
+              setup_gemfile(gems: gem_dependencies(args), exclude_gems: args.fetch(:exclude_gems, []))
+              bundle_install
+              yield
+            ensure
+              restore_gemfile
+            end
+          end
+        end
+      end
+
+      def create_project(project, args)
+        silently "hanami new #{project}#{_create_project_args(args)}"
+      end
+
+      def gem_dependencies(args) # rubocop:disable Metrics/MethodLength
+        result = args.fetch(:gems, [])
+
+        case args.fetch(:console, nil)
+        when :pry
+          result << "pry"
+        when :ripl
+          result << "ripl"
+        end
+
+        case args.fetch(:server, nil)
+        when :puma
+          result << "puma"
+        when :unicorn
+          result << "unicorn"
+        when :thin
+          result << "thin"
+        end
+
+        result
+      end
+
+      def _create_project_args(args)
+        return if args.empty?
+
+        flags = args.dup.keep_if { |k, _| KNOWN_ARGUMENTS.include?(k) }
+
+        result = flags.map do |arg, value|
+          "--#{arg}=#{value}"
+        end.join(" ")
+
+        " #{result}"
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithProject, type: :integration
+end

data/lib/hanami/devtools/integration/with_system_tmp_directory.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "hanami/devtools/integration/with_tmp_directory"
+
+module RSpec
+  module Support
+    # Execute the given code inside the system temporary directory (aka `/tmp`).
+    #
+    # NOTE: this changes the current `Dir.pwd`
+    #
+    # @since 0.2.0
+    module WithSystemTmpDirectory
+      private
+
+      def with_system_tmp_directory(&blk)
+        with_tmp_directory(Dir.mktmpdir, &blk)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithSystemTmpDirectory, type: :integration
+end

data/lib/hanami/devtools/integration/with_tmp_directory.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "hanami/utils/files"
+require "hanami/devtools/integration/with_directory"
+
+module RSpec
+  module Support
+    # Execute the given code inside a temporary directory.
+    #
+    # NOTE: this changes the current `Dir.pwd`
+    #
+    # @since 0.2.0
+    module WithTmpDirectory
+      private
+
+      def with_tmp_directory(dir = Pathname.new("tmp").join("aruba"))
+        delete_tmp_directory(dir)
+        create_tmp_directory(dir)
+
+        with_directory(dir) do
+          yield
+        end
+      ensure
+        delete_tmp_directory(dir)
+      end
+
+      def create_tmp_directory(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      def delete_tmp_directory(dir)
+        directory = case dir
+                    when Pathname
+                      dir
+                    when String
+                      Pathname.new(dir)
+                    end
+
+        Hanami::Utils::Files.delete_directory(directory) if directory.exist?
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithTmpDirectory, type: :integration
+end

data/lib/hanami/devtools/integration/within_project_directory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "hanami/devtools/integration/with_directory"
+require "hanami/devtools/integration/env"
+
+module RSpec
+  module Support
+    # Execute the given code inside the Hanami project directory (at the root).
+    #
+    # NOTE: this changes the current `Dir.pwd`
+    #
+    # @since 0.2.0
+    module WithinProjectDirectory
+      private
+
+      def within_project_directory(project)
+        cd(project.to_s) do
+          # Aruba resets ENV and its API to set new env vars is broken.
+          #
+          # We need to manually setup the following env vars:
+          #
+          # ENV["PATH"] is required by Capybara's selenium/poltergeist drivers
+          ENV["PATH"] = RSpec::Support::Env.fetch_from_original("PATH")
+          # Bundler on CI can't find HOME and it fails to run Hanami commands
+          ENV["HOME"] = RSpec::Support::Env.fetch_from_original("HOME")
+
+          yield
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::WithinProjectDirectory
+end

data/lib/hanami/devtools/integration.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "hanami/utils"
+Hanami::Utils.require!("#{__dir__}/integration")

data/lib/hanami/devtools/rake_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rake"
+
+module Hanami
+  module Devtools
+    # Distribute Rake tasks
+    class RakeHelper
+      include Rake::DSL
+
+      def self.install_tasks
+        new.install
+      end
+
+      def install # rubocop:disable Metrics/MethodLength
+        namespace :codecov do
+          desc "Uploads the latest simplecov result set to codecov.io"
+          task :upload do
+            if ENV["CI"]
+              require "simplecov"
+              require "codecov"
+
+              formatter = SimpleCov::Formatter::Codecov.new
+              formatter.format(SimpleCov::ResultMerger.merged_result)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/devtools/rake_tasks.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "hanami/devtools/rake_helper"
+Hanami::Devtools::RakeHelper.install_tasks

data/lib/hanami/devtools/unit/support/coverage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+if ENV["CI"]
+  require "simplecov"
+
+  SimpleCov.command_name ENV["SIMPLECOV_COMMAND_NAME"] || "spec:unit"
+  SimpleCov.start do
+    add_filter(/spec/)
+  end
+end

data/lib/hanami/devtools/unit/support/silence_deprecations.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rspec"
+require "hanami/utils/io"
+
+RSpec.configure do |config|
+  config.around(:example, silence_deprecations: true) do |example|
+    Hanami::Utils::IO.silence_warnings do
+      example.run
+    end
+  end
+end

data/lib/hanami/devtools/unit.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "hanami/utils"
+Hanami::Utils.require!("#{__dir__}/unit")

data/lib/hanami/devtools/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Devtools
+    VERSION = "2023.02.16"
+  end
+end

data/lib/hanami/devtools.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Hanami
+  # Hanami devtools
+  module Devtools
+    require "hanami/devtools/version"
+  end
+end

data/script/setup

@@ -0,0 +1,36 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+banner() {
+  echo "Using hanami-devtools at: $(git rev-parse --short HEAD)"
+}
+
+install_hanami() {
+  hanami_gems=($(bundle show | grep hanami))
+
+  for bundler_gem_info in "${hanami_gems[@]}"
+  do
+    local gem_name=$(echo $bundler_gem_info | cut -d' ' -f 4)
+    local gem_directory=$(bundle show $gem_name)
+
+
+    pushd $gem_directory > /dev/null
+      find . -name \*.gem -delete
+      gem build $gem_name.gemspec > /dev/null
+
+      local pkg=($gem_name-*.gem)
+      gem install --force $pkg > /dev/null
+      rm $pkg
+
+      echo Installed $pkg from $gem_directory
+    popd > /dev/null
+  done
+}
+
+main() {
+  banner &&
+    install_hanami
+}
+
+main