howitzer 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1044884bf6fe39dc63128f59f930a0d75ae80297a946d34d2464f47a30fe17fe
-  data.tar.gz: b5501960e801914414fc6569996a9cc219e601ea78dfea1dac28c7db9d582ac7
+  metadata.gz: 3b59a8a3bed744aeb4c97b117d141bbec762d24d398b97fe6ddfa4f955838360
+  data.tar.gz: 20b21155002eb01cb5e680b610b57f1d64d6b68ede1a683e32b74165d5d3c00e
 SHA512:
-  metadata.gz: 450f74b4dec7185673b2faa9138c8afb4b9568be8680f38718728105ad5893a5e1abfb1d908e759a021fcd3af13093e67775537b3a109219b065b00c30a7f293
-  data.tar.gz: 0bc01379c520937ec1bd004fffcc44b9c558ff9c1c5eea1a292067d65f5d1661f9f5aaf806c5b0183d34e46c2591fc3bd9b71a0cc8288fc7e12b56d9946478d0
+  metadata.gz: 16a09f131e9b6f9ec714e654f1ee6796a8ffd4779f75fd3d8c13e7b42ad6267abbd9f1e258e5ae8552f6cf59d1a3aa4914345734bcd4738e305e5e62561da2b1
+  data.tar.gz: 4bad2e4917e4e19bb0eae5da2c699af26e70adbc558c52b21da9f12781d0c714f23e0d7ea02c8bbf6dc03df44402b488bd87ead92adbeb2d93a06be43e334d69

data/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 ### Bug-fixes
 
+## [2.6.0](https://github.com/strongqa/howitzer/compare/v2.5.0...v2.6.0) (2023-01-16)
+
+
+### Features
+
+* Add Docker support ([#321](https://github.com/strongqa/howitzer/issues/321)) ([d0e7bc9](https://github.com/strongqa/howitzer/commit/d0e7bc953182b13e93b74ab4b609316ece6cf956))
+* Ruby3.2 support ([#327](https://github.com/strongqa/howitzer/issues/327)) ([265acc3](https://github.com/strongqa/howitzer/commit/265acc34fb2eac9b879e097ae938e66c62a6e7f7))
+
+
+### Bug Fixes
+
+* Handle section options ([#324](https://github.com/strongqa/howitzer/issues/324)) ([b976e5b](https://github.com/strongqa/howitzer/commit/b976e5b83800fa1c0671857daba796dd8a1048f4))
+* Section method typo ([#318](https://github.com/strongqa/howitzer/issues/318)) ([984deeb](https://github.com/strongqa/howitzer/commit/984deebe817d27278b93517b3f0e1338af25128a))
+
 ## [2.5.0](https://github.com/strongqa/howitzer/compare/v2.4.0...v2.5.0) (2022-08-16)
 
 

data/bin/howitzer

@@ -31,21 +31,21 @@ module HowitzerCli
         Dir.mkdir(path_to_dir)
         puts "      #{ColorizedString.new('Created').light_green} './#{args.first}' folder"
         Dir.chdir(path_to_dir)
-        Howitzer::ConfigGenerator.new(options)
-        Howitzer::WebGenerator.new(options)
-        Howitzer::TasksGenerator.new(options)
-        Howitzer::EmailsGenerator.new(options)
-        Howitzer::RootGenerator.new(options)
-        Howitzer::PrerequisitesGenerator.new(options)
+        Howitzer::ConfigGenerator.new(options, args)
+        Howitzer::WebGenerator.new(options, args)
+        Howitzer::TasksGenerator.new(options, args)
+        Howitzer::EmailsGenerator.new(options, args)
+        Howitzer::RootGenerator.new(options, args)
+        Howitzer::PrerequisitesGenerator.new(options, args)
         if options[:cucumber]
-          Howitzer::CucumberGenerator.new(options)
+          Howitzer::CucumberGenerator.new(options, args)
         elsif options[:rspec]
-          Howitzer::RspecGenerator.new(options)
+          Howitzer::RspecGenerator.new(options, args)
         elsif options['turnip']
-          Howitzer::TurnipGenerator.new(options)
+          Howitzer::TurnipGenerator.new(options, args)
         end
         puts ColorizedString.new('[WARN] Extra parameters were skipped').yellow if args.size > 1
-      elsif args.size.zero?
+      elsif args.empty?
         exit_now!(ColorizedString.new('Please specify <PROJECT NAME>').red, 64)
       end
     end

data/generators/base_generator.rb

@@ -54,8 +54,8 @@ module Howitzer
       end
     end
 
-    def initialize(_options)
-      super()
+    def initialize
+      super
 
       manifest.each do |type, list|
         case type
@@ -72,6 +72,12 @@ module Howitzer
       []
     end
 
+    def template_context
+      data = options
+      data = options.merge(project_name: project_name) unless project_name.nil?
+      OpenStruct.new(data) # rubocop:disable Style/OpenStructUse
+    end
+
     protected
 
     def copy_files(list)
@@ -90,7 +96,7 @@ module Howitzer
         else
           write_template(destination_path, source_path)
           puts_info "#{ColorizedString.new('Added').light_green} template '#{data[:source]}' with " \
-                    "params '#{@options}' to destination '#{data[:destination]}'"
+                    "params '#{template_context.to_h}' to destination '#{data[:destination]}'"
         end
       end
     end
@@ -118,8 +124,10 @@ module Howitzer
     end
 
     def write_template(dest_path, source_path)
-      File.write(dest_path, ERB.new(File.read(source_path), trim_mode: '-')
-         .result(OpenStruct.new(@options).instance_eval { binding })) # rubocop:disable Style/OpenStructUse
+      File.write(
+        dest_path,
+        ERB.new(File.read(source_path), trim_mode: '-').result(template_context.instance_eval { binding })
+      )
     end
 
     private
@@ -177,14 +185,16 @@ module Howitzer
 
   # Parent class for all generators
   class BaseGenerator
-    attr_reader :options
+    attr_reader :options, :args, :project_name
 
     include Outputable
     include Copyable
 
-    def initialize(options = {})
+    def initialize(options = {}, args = [])
       @options = options.symbolize_keys
-      super
+      @args = args
+      @project_name = args.first
+      super()
     end
   end
 end

data/generators/root/root_generator.rb

@@ -7,12 +7,16 @@ module Howitzer
       { files:
         [
           { source: '.gitignore', destination: '.gitignore' },
+          { source: '.dockerignore', destination: '.dockerignore' },
+          { source: 'Dockerfile', destination: 'Dockerfile' },
           { source: 'Rakefile', destination: 'Rakefile' }
         ],
         templates:
         [
           { source: '.rubocop.yml.erb', destination: '.rubocop.yml' },
-          { source: 'Gemfile.erb', destination: 'Gemfile' }
+          { source: 'docker-compose.yml.erb', destination: 'docker-compose.yml' },
+          { source: 'Gemfile.erb', destination: 'Gemfile' },
+          { source: 'README.md.erb', destination: 'README.md' }
         ] }
     end
 

data/generators/root/templates/Dockerfile

@@ -0,0 +1,34 @@
+FROM ruby:alpine
+
+ENV CHROME_BIN=/usr/bin/chromium-browser \
+    CHROME_PATH=/usr/lib/chromium/ \
+    SEXY_SETTINGS_DELIMITER=";" \
+    CHROME_ARGS="window-size=1920x1080, disable-gpu, no-sandbox, disable-dev-shm-usage, disable-software-rasterizer"
+
+RUN apk update && apk upgrade --no-cache --available \
+    && apk add --no-cache \
+      chromium firefox \
+      chromium-chromedriver \
+      ttf-freefont \
+      font-noto-emoji \
+      build-base bash \
+      curl \
+      git \
+      less dbus \
+    && apk add --no-cache \
+      --repository=https://dl-cdn.alpinelinux.org/alpine/edge/testing font-wqy-zenhei \
+    && wget https://github.com/mozilla/geckodriver/releases/download/v0.31.0/geckodriver-v0.31.0-linux64.tar.gz \
+    && tar -zxf geckodriver-v0.31.0-linux64.tar.gz -C /usr/bin \
+    && dbus-daemon --system
+
+RUN adduser -D howitzer
+USER howitzer
+
+WORKDIR /home/howitzer
+
+COPY --chown=howitzer Gemfile Gemfile.lock /home/howitzer/
+RUN bundle config --global && bundle install --jobs=3 --retry=3
+
+COPY --chown=howitzer . ./
+
+ENTRYPOINT ["sleep", "infinity"]

data/generators/root/templates/README.md.erb

@@ -0,0 +1,33 @@
+# <%= project_name %>
+
+## Run tests in Docker
+
+### Build an image
+
+`docker build -t <%= project_name %> .`
+
+### Run a container
+
+`docker run -d --name <%= project_name %>_container <%= project_name %>
+
+### Connect to the container
+
+`docker exec -it <%= project_name %>_container /bin/bash`
+
+### Run tests in the container
+
+`SEXY_SETTINGS="driver=headless_chrome; headless_chrome_flags=$CHROME_ARGS" bundle exec rake`
+
+or
+
+`SEXY_SETTINGS="driver=headless_firefox" bundle exec rake`
+
+## Run tests via docker compose
+
+### Initialize build, and run a container in detached mode
+
+`docker-compose -f docker-compose.yml up -d`
+
+### Connect to the container
+
+`docker compose exec -it <%= project_name %>  /bin/bash`

data/generators/root/templates/docker-compose.yml.erb

@@ -0,0 +1,9 @@
+version: '1.0'
+
+services:
+  <%= project_name %>:
+    build:
+      context: "."
+      dockerfile: Dockerfile
+    volumes:
+      - '.:/home/howitzer/:cached'

data/lib/howitzer/utils/argument_convertable.rb

@@ -0,0 +1,54 @@
+module Howitzer
+  module Utils
+    # This module mixes in private utils methods for section and element dsl
+    module ArgumentConvertable
+      private
+
+      def convert_arguments(args, options, block_args, block_options)
+        conv_args = args.map { |el| el.is_a?(Proc) ? proc_to_selector(el, block_args, block_options) : el }
+        args_options = pop_options_from_array(conv_args)
+        block_args_options = pop_options_from_array(block_args)
+        conv_options = [args_options, options, block_args_options, block_options].map do |el|
+          el.transform_keys(&:to_sym)
+        end.reduce(&:merge).except(:lambda_args)
+        [conv_args, conv_options]
+      end
+
+      def proc_to_selector(proc, block_args, block_options)
+        lambda_args = extract_lambda_args(block_args, block_options)
+        if lambda_args
+          if lambda_args[:keyword_args].present?
+            proc.call(*lambda_args[:args], **lambda_args[:keyword_args])
+          else
+            proc.call(*lambda_args[:args])
+          end
+        else
+          puts "WARNING! Passing lambda arguments with element options is deprecated.\n" \
+               "Please use 'lambda_args' method, for example: foo_element(lambda_args(title: 'Example'), wait: 10)"
+          proc.call(*block_args.shift(proc.arity))
+        end
+      end
+
+      def extract_lambda_args(block_args, block_options)
+        (block_args.first.is_a?(Hash) && block_args.first[:lambda_args]) || block_options[:lambda_args]
+      end
+
+      def pop_options_from_array(value)
+        if value.last.is_a?(Hash) && !value.last.key?(:lambda_args)
+          value.pop
+        else
+          {}
+        end
+      end
+
+      def lambda_args(*args, **keyword_args)
+        {
+          lambda_args: {
+            args: args,
+            keyword_args: keyword_args
+          }
+        }
+      end
+    end
+  end
+end

data/lib/howitzer/utils.rb

@@ -8,4 +8,5 @@ module Howitzer
   end
 end
 
+require 'howitzer/utils/argument_convertable'
 require 'howitzer/utils/string_extensions'

data/lib/howitzer/version.rb

@@ -1,4 +1,4 @@
 # This module holds howitzer version
 module Howitzer
-  VERSION = '2.5.0'.freeze # :nodoc:
+  VERSION = '2.6.0'.freeze # :nodoc:
 end

data/lib/howitzer/web/element_dsl.rb

@@ -3,67 +3,16 @@ module Howitzer
   module Web
     # This module combines element dsl methods
     module ElementDsl
-      # This module holds element helper methods
-      module Helpers
-        private
-
-        def lambda_args(*args, **keyword_args)
-          {
-            lambda_args: {
-              args: args,
-              keyword_args: keyword_args
-            }
-          }
-        end
-      end
-
       include CapybaraContextHolder
-      include Helpers
+      include Howitzer::Utils::ArgumentConvertable
 
       def self.included(base) # :nodoc:
         base.extend(ClassMethods)
       end
 
-      def convert_arguments(args, options, block_args, block_options)
-        conv_args = args.map { |el| el.is_a?(Proc) ? proc_to_selector(el, block_args, block_options) : el }
-        args_options = pop_options_from_array(conv_args)
-        block_args_options = pop_options_from_array(block_args)
-        conv_options = [args_options, options, block_args_options, block_options].map do |el|
-          el.transform_keys(&:to_sym)
-        end.reduce(&:merge).except(:lambda_args)
-        [conv_args, conv_options]
-      end
-
-      def proc_to_selector(proc, block_args, block_options)
-        lambda_args = extract_lambda_args(block_args, block_options)
-        if lambda_args
-          if lambda_args[:keyword_args].present?
-            proc.call(*lambda_args[:args], **lambda_args[:keyword_args])
-          else
-            proc.call(*lambda_args[:args])
-          end
-        else
-          puts "WARNING! Passing lambda arguments with element options is deprecated.\n" \
-               "Please use 'lambda_args' method, for example: foo_element(lambda_args(title: 'Example'), wait: 10)"
-          proc.call(*block_args.shift(proc.arity))
-        end
-      end
-
-      def extract_lambda_args(block_args, block_options)
-        (block_args.first.is_a?(Hash) && block_args.first[:lambda_args]) || block_options[:lambda_args]
-      end
-
-      def pop_options_from_array(value)
-        if value.last.is_a?(Hash) && !value.last.key?(:lambda_args)
-          value.pop
-        else
-          {}
-        end
-      end
-
       # This module holds element dsl methods
       module ClassMethods
-        include Helpers
+        include Howitzer::Utils::ArgumentConvertable
 
         protected
 
@@ -172,7 +121,6 @@ module Howitzer
             else
               capybara_context.find(*conv_args)
             end
-            return nil
           end
           private "wait_for_#{name}_element"
         end

data/lib/howitzer/web/page_dsl.rb

@@ -50,7 +50,7 @@ module Howitzer
         private
 
         def eval_in_out_context(*args, **options, &block)
-          return nil if args.size.zero?
+          return nil if args.empty?
 
           name = args.shift
           return get_outer_instance_variable(name) if name.to_s.start_with?('@')

data/lib/howitzer/web/section_dsl.rb

@@ -4,6 +4,7 @@ module Howitzer
     # This module combines section dsl methods
     module SectionDsl
       include CapybaraContextHolder
+      include Howitzer::Utils::ArgumentConvertable
 
       def self.included(base) # :nodoc:
         base.extend(ClassMethods)
@@ -11,6 +12,7 @@ module Howitzer
 
       # This module holds section dsl class methods
       module ClassMethods
+        include Howitzer::Utils::ArgumentConvertable
         # This class is for private usage only
         class SectionScope
           attr_accessor :section_class
@@ -61,9 +63,7 @@ module Howitzer
           # @raise [ArgumentError] when finder arguments were not specified
 
           def finder_options
-            @options if @args.present? # it is ok to have blank options, so we rely here on the argments
-
-            @finder_options ||= (section_class.default_finder_options || {})
+            @options.presence || section_class.default_finder_options || {}
           end
         end
 
@@ -135,45 +135,45 @@ module Howitzer
         private
 
         def define_section_method(klass, name, *args, **options)
-          define_method("#{name}_section") do |**block_options|
-            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
-            if kwdargs.present?
-              klass.new(self, capybara_context.find(*args, **kwdargs))
+          define_method("#{name}_section") do |*block_args, **block_options|
+            conv_args, conv_options = convert_arguments(args, options, block_args, block_options)
+            if conv_options.present?
+              klass.new(self, capybara_context.find(*conv_args, **conv_options))
             else
-              klass.new(self, capybara_context.find(*args))
+              klass.new(self, capybara_context.find(*conv_args))
             end
           end
         end
 
         def define_sections_method(klass, name, *args, **options)
-          define_method("#{name}_sections") do |**block_options|
-            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
-            if kwdargs.present?
-              capybara_context.all(*args, **kwdargs).map { |el| klass.new(self, el) }
+          define_method("#{name}_sections") do |*block_args, **block_options|
+            conv_args, conv_options = convert_arguments(args, options, block_args, block_options)
+            if conv_options.present?
+              capybara_context.all(*conv_args, **conv_options).map { |el| klass.new(self, el) }
             else
-              capybara_context.all(*args).map { |el| klass.new(self, el) }
+              capybara_context.all(*conv_args).map { |el| klass.new(self, el) }
             end
           end
         end
 
         def define_has_section_method(name, *args, **options)
-          define_method("has_#{name}_section?") do |**block_options|
-            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
-            if kwdargs.present?
-              capybara_context.has_selector?(*args, **kwdargs)
+          define_method("has_#{name}_section?") do |*block_args, **block_options|
+            conv_args, conv_options = convert_arguments(args, options, block_args, block_options)
+            if conv_options.present?
+              capybara_context.has_selector?(*conv_args, **conv_options)
             else
-              capybara_context.has_selector?(*args)
+              capybara_context.has_selector?(*conv_args)
             end
           end
         end
 
         def define_has_no_section_method(name, *args, **options)
-          define_method("has_no_#{name}_section?") do |**block_options|
-            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
-            if kwdargs.present?
-              capybara_context.has_no_selector?(*args, **kwdarg)
+          define_method("has_no_#{name}_section?") do |*block_args, **block_options|
+            conv_args, conv_options = convert_arguments(args, options, block_args, block_options)
+            if conv_options.present?
+              capybara_context.has_no_selector?(*conv_args, **conv_options)
             else
-              capybara_context.has_no_selector?(*args)
+              capybara_context.has_no_selector?(*conv_args)
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howitzer
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Roman Parashchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -272,8 +272,11 @@ files:
 - generators/prerequisites/templates/user.rb
 - generators/prerequisites/templates/users.rb
 - generators/root/root_generator.rb
+- generators/root/templates/Dockerfile
 - generators/root/templates/Gemfile.erb
+- generators/root/templates/README.md.erb
 - generators/root/templates/Rakefile
+- generators/root/templates/docker-compose.yml.erb
 - generators/rspec/rspec_generator.rb
 - generators/rspec/templates/example_spec.rb
 - generators/rspec/templates/rspec.rake
@@ -322,6 +325,7 @@ files:
 - lib/howitzer/testmail_api.rb
 - lib/howitzer/testmail_api/client.rb
 - lib/howitzer/utils.rb
+- lib/howitzer/utils/argument_convertable.rb
 - lib/howitzer/utils/string_extensions.rb
 - lib/howitzer/version.rb
 - lib/howitzer/web.rb
@@ -342,7 +346,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/strongqa/howitzer/issues
   changelog_uri: https://github.com/strongqa/howitzer/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/howitzer/2.5.0
+  documentation_uri: https://www.rubydoc.info/gems/howitzer/2.6.0
   source_code_uri: https://github.com/strongqa/howitzer
   rubygems_mfa_required: 'false'
 post_install_message: