hanami-devtools 2023.02.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b819306f2455421d0ee135fe9e402f4ad942c85107b1675fbd4b45cb8495a30
+  data.tar.gz: e1fd50d1cfc3f3be0097b5283a71a56d762a7f1118a0637ceb3ce079ef9a3557
+SHA512:
+  metadata.gz: d01d8885c60495d028b09afc939e610db3bf1a1a00a377f925a542f1a4ed68807d8beded05bd08f9811541a39dc7df34cec5fb35b7a073ce88a53791bb565a9d
+  data.tar.gz: 192d367e36588f4be482b56c4c3aaa3839b3a9eec665f655e620877479a3ea4152d58b647e14c4d8d100452bbd9eb275df0c14165e991065abbdd2a56026f59b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,158 @@
+# Please keep AllCops, Bundler, Layout, Style, Metrics groups and then order cops
+# alphabetically
+#
+# References:
+#   * https://github.com/bbatsov/ruby-style-guide
+#   * https://rubocop.readthedocs.io/
+#
+# This configuration is for Hanami 2.x and Rubocop ~> 1.0
+AllCops:
+  TargetRubyVersion: 3.0
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: false
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - "vendor/**/*"
+    - "vendor/**/.*" # See https://github.com/bbatsov/rubocop/issues/4832
+Bundler/OrderedGems:
+  Enabled: false
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+Gemspec/OrderedDependencies:
+  Enabled: false
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "spec/**/*_spec.rb"
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+Lint/EmptyClass:
+  Enabled: false
+Lint/RaiseException:
+  Enabled: false
+Lint/StructNewOverride:
+  Enabled: true
+Metrics/AbcSize:
+  Max: 25
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 12
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/MethodName:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/AndOr:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/BisectedAttrAccessor:
+  Enabled: false
+Style/BlockDelimiters:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "spec/**/*_spec.rb"
+Style/ConditionalAssignment:
+  Enabled: false
+Style/DateTime:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/EmptyMethod:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/GuardClause:
+  Enabled: false
+Style/HashConversion:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/IfUnlessModifier:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/RaiseArgs:
+  Enabled: false
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantConstantBase:
+  Enabled: false
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/RegexpLiteral:
+  Enabled: false
+Style/SlicingWithRange:
+  Enabled: true
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: false
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+Style/SymbolArray:
+  Exclude:
+    - "spec/**/*_spec.rb"
+Style/TrailingUnderscoreVariable:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Hanami::Devtools
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hanami/devtools`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hanami-devtools'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hanami-devtools
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/devtools.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hanami/devtools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hanami-devtools.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hanami/devtools/version"
+
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "hanami-devtools"
+  spec.version       = Hanami::Devtools::VERSION
+  spec.authors       = ["Luca Guidi"]
+  spec.email         = ["me@lucaguidi.com"]
+
+  spec.summary       = "Development tools for Hanami"
+  spec.description   = "Development tools for Hanami. This gem is designed for the Hanami core team."
+  spec.homepage      = "http://hanamirb.org"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.required_ruby_version         = ">= 3.0"
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency "aruba", "~> 0.14"
+  spec.add_dependency "bundler", ">= 1.6", "< 3"
+  spec.add_dependency "dotenv", "~> 2.0"
+  spec.add_dependency "capybara", "~> 3.34"
+  spec.add_dependency "codecov", "~> 0.1"
+  spec.add_dependency "excon", "~> 0.60"
+  spec.add_dependency "poltergeist", "~> 1.17"
+  spec.add_dependency "rack", "~> 2.0"
+  spec.add_dependency "rspec", "~> 3.7"
+  spec.add_dependency "dry-core", ">= 0.9", "< 2"
+  spec.add_dependency "hanami-utils"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+end

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

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "open3"
+require "pathname"
+require "hanami/devtools/integration/env"
+require "hanami/devtools/integration/gemfile"
+require "hanami/devtools/integration/silently"
+require "hanami/devtools/integration/files"
+
+module RSpec
+  module Support
+    # Support for Bundler
+    #
+    # @since 0.2.0
+    module Bundler
+      HANAMI_GEMS_PREFIX = "hanami-"
+      HANAMI_GEMS = %w[utils validations router controller view helpers mailer assets model webconsole].freeze
+
+      def self.root
+        @_root
+      end
+
+      def self.root=(value)
+        @_root = Pathname.new(value).realpath
+      end
+
+      self.root = Dir.pwd
+
+      def self.cache
+        root.join("vendor", "cache")
+      end
+
+      def self.setup
+        return unless setup?
+
+        with_clean_env do
+          RSpec::Support.silently(setup_script)
+          Gemfile.write_checksum
+        end
+      end
+
+      def self.setup?
+        return true if Platform.ci?
+
+        Gemfile.changed?
+      end
+
+      def self.setup_script
+        result = root.join("script", "setup")
+        return result.to_s if result.exist?
+
+        Pathname.new(__dir__).join("..", "..", "..", "..", "script", "setup").realpath.to_s
+      end
+
+      def self.with_clean_env(&blk)
+        ::Bundler.with_clean_env(&blk)
+      end
+
+      private
+
+      attr_reader :out, :err, :exitstatus
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_gemfile(gems: [], exclude_gems: [], path: "Gemfile")
+        @current_gemfile_path = RSpec::Support::Env["BUNDLE_GEMFILE"]
+        RSpec::Support::Env["BUNDLE_GEMFILE"] = ::File.join(Dir.pwd, path)
+
+        content = ::File.readlines(path)
+        content = inject_gemfile_sources(content, cache)
+
+        unless gems.empty?
+          gems = gems.map do |g|
+            case g
+            when String
+              "gem '#{g}'\n"
+            when Array
+              "gem '#{g.first}', #{g.last}\n"
+            end
+          end
+
+          content.concat(gems)
+        end
+
+        exclude_gems.each do |g|
+          content.reject! { |line| line.include?(g) }
+        end
+
+        rewrite(path, content)
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      def restore_gemfile
+        RSpec::Support::Env["BUNDLE_GEMFILE"] = @current_gemfile_path if defined?(@current_gemfile_path)
+      end
+
+      def bundle_install
+        bundle "install --local --no-cache --retry 0 --no-color"
+      end
+
+      def bundle_exec(cmd, env: nil, &blk)
+        bundle("exec #{cmd}", env: env, &blk)
+      end
+
+      def bundle(cmd, env: nil, &blk)
+        # ruby_bin   = which("ruby")
+        bundle_bin = which("bundle")
+        hanami_env = "HANAMI_ENV=#{env} " unless env.nil?
+
+        # system_exec("#{hanami_env}#{ruby_bin} -I#{load_paths} #{bundle_bin} #{cmd}", &blk)
+        system_exec("#{hanami_env}#{bundle_bin} #{cmd}", &blk)
+      end
+
+      def inject_gemfile_sources(contents, vendor_cache_path)
+        sources = ["source 'file://#{vendor_cache_path}'\n"]
+        sources + contents[1..-1]
+      end
+
+      # Adapted from Bundler source code
+      #
+      # Bundler is released under MIT license
+      # https://github.com/bundler/bundler/blob/master/LICENSE.md
+      #
+      # A special "thank you" goes to Bundler maintainers and contributors.
+      #
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def system_exec(cmd)
+        Open3.popen3(RSpec::Support::Env.env, cmd) do |stdin, stdout, stderr, wait_thr|
+          yield stdin, stdout, wait_thr if block_given?
+          stdin.close
+
+          @exitstatus = wait_thr&.value&.exitstatus
+          @out = Thread.new { stdout.read }.value.strip
+          @err = Thread.new { stderr.read }.value.strip
+        end
+
+        @all_output ||= ""
+        @all_output += [
+          "$ #{cmd.to_s.strip}",
+          out,
+          err,
+          @exitstatus ? "# $? => #{@exitstatus}" : "",
+          "\n"
+        ].reject(&:empty?).join("\n")
+
+        @out
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def load_paths
+        [root.join("lib"), root.join("spec")].join(":")
+      end
+
+      def root
+        RSpec::Support::Bundler.root
+      end
+
+      def cache
+        RSpec::Support::Bundler.cache
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::Bundler, type: :integration
+
+  config.before(:all, type: :integration) do
+    RSpec::Support::Bundler.setup
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "capybara"
+require "capybara/rspec"
+require "capybara/dsl"
+require "hanami/devtools/integration/platform"
+require "capybara/poltergeist"
+
+RSpec.configure do |config|
+  config.include Capybara::DSL, type: :integration
+end
+
+Capybara.register_driver :poltergeist do |app|
+  Capybara::Poltergeist::Driver.new(app, {js_errors: false})
+end
+
+Capybara.configure do |config|
+  config.run_server = false
+  config.default_driver = :poltergeist
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "aruba"
+require "aruba/api"
+require "pathname"
+
+module RSpec
+  module Support
+    # Run Command Line Interface (CLI) programs
+    #
+    # @since 0.2.0
+    module CLI
+      def self.included(spec)
+        spec.before do
+          aruba = Pathname.new(Dir.pwd).join("tmp", "aruba")
+          aruba.rmtree if aruba.exist?
+
+          setup_aruba
+        end
+      end
+
+      private
+
+      def run_cmd(cmd, output = nil, exit_status: 0)
+        run_command_and_stop "bundle exec #{cmd}", fail_on_error: false
+
+        match_output(output)
+        expect(last_command_started).to have_exit_status(exit_status)
+      end
+
+      def run_cmd_with_clean_env(cmd, successful: true)
+        result = ::Bundler.clean_system(cmd, out: File::NULL)
+        expect(result).to be(successful)
+      end
+
+      def match_output(output)
+        case output
+        when String
+          expect(all_output).to include(output)
+        when Regexp
+          expect(all_output).to match(output)
+        when Array
+          output.each { |o| match_output(o) }
+        end
+      end
+
+      def all_output
+        all_commands.map(&:output).join("\n")
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Aruba::Api,          type: :integration
+  config.include RSpec::Support::CLI, type: :integration
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Support
+    # Code coverage support
+    #
+    # @since 0.2.0
+    module Coverage
+      def self.configure!
+        return unless enabled?
+
+        require "simplecov"
+        require "coveralls"
+
+        configure_simplecov!
+      end
+
+      def self.cover_as!(suite_name)
+        return unless enabled?
+
+        SimpleCov.command_name(suite_name)
+      end
+
+      private_class_method
+
+      def self.ci?
+        !ENV["TRAVIS"].nil?
+      end
+
+      def self.enabled?
+        # !ENV['COVERAGE'].nil?
+        false
+      end
+
+      def self.configure_simplecov!
+        SimpleCov.formatter = Coveralls::SimpleCov::Formatter if ci?
+
+        SimpleCov.start do
+          add_filter "spec/"
+          add_filter "script/"
+          add_filter "tmp/"
+          add_filter "vendor/"
+        end
+      end
+    end
+  end
+end
+
+RSpec::Support::Coverage.configure!
+
+RSpec.configure do |config|
+  config.before do |example|
+    RSpec::Support::Coverage.cover_as!(example.file_path)
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "resolv-replace"
+
+module RSpec
+  module Support
+    # DNS stub utilities
+    module Dns
+      private
+
+      def stub_dns_hosts(hosts)
+        file = Pathname.new(Dir.pwd).join("tmp", "hosts-#{SecureRandom.uuid}")
+        write(file, hosts)
+
+        hosts_resolver = Resolv::Hosts.new(file.to_s)
+        dns_resolver = Resolv::DNS.new
+
+        Resolv::DefaultResolver.replace_resolvers([hosts_resolver, dns_resolver])
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Support::Dns, type: :integration
+end