chemlab 0.5.0 → 0.6.0

data/lib/chemlab/runtime/logger.rb

@@ -1,23 +1,26 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'forwardable'
-
 module Chemlab
   module Runtime
+    # Logger module
     module Logger
-      extend SingleForwardable
-
-      def_delegators :logger, :debug, :info, :warn, :error, :fatal, :unknown
+      # Log something to a stream
+      # @param [Any] obj Any object that responds to #to_s
+      # @param [Symbol] type The type of message logged
+      # @param [Hash] args Any additional arguments
+      # @example
+      #   log('something', :info)                                   #=> logs INFO :: something, to $stdout
+      #   log('error', :err)                                        #=> logs ERR  :: error, to $stderr
+      #   log('important', :important, stream: $stderr)             #=> logs IMPO :: important, to $stderr
+      #   log('to file', :info, stream: File.open('file.txt', 'w')) #=> logs INFO :: to file, to the file.txt file
+      def log(obj, type = :info, **args)
+        raise ArgumentError, "Cannot log #{obj} as it does not respond to to_s!" unless obj.respond_to?(:to_s)
 
-      singleton_class.module_eval do
-        attr_writer :logger
+        args[:stream] = type.match?(/(err(or)?|warn(ing)?)/) ? $stderr : $stdout
 
-        def logger
-          @logger ||= ::Logger.new(Runtime::Env.log_destination).tap do |logger|
-            logger.level = Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::ERROR
-          end
-        end
+        prefix = Time.now.strftime('%Y-%m-%d %H:%M:%S / ')
+        prefix << type[0..3].upcase << "\t:: " # we only want the prefix to be four chars long
+        args[:stream].puts(prefix << obj.to_s)
       end
     end
   end

data/lib/chemlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chemlab
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/tasks/generate.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+desc <<-DESCRIPTION
+  Generate something
+
+  Arguments: WHAT NAME [ARGS]
+  Examples:
+    - generate page Login path=/users/sign_in
+        Generates a page library
+  Notes:
+    - [ARGS] will be in form key=value separated by `=`
+DESCRIPTION
+task :generate do |_, args|
+  require_relative '../chemlab/cli/generator'
+
+  raise ArgumentError, 'Please specify what to generate and the name' if args.size < 2
+
+  what = args.shift
+  name = args.shift
+
+  Chemlab::CLI::Generator.generate(what, name, args)
+end

data/lib/tasks/generate_stubs.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+namespace :generate do
+  desc <<-DESCRIPTION
+    Generate page library stubs
+
+    Arguments: PATH
+    Examples:
+      - generate:stubs qa/page/login.rb
+        Generate stubs for a specific page library
+      - generate:stubs qa/page
+        Generates stubs for all page libraries in `qa/page`
+  DESCRIPTION
+  task :stubs do |_, path|
+    puts "Doin some stubbin in #{path}"
+
+    require_relative '../chemlab/cli/stubber'
+    Chemlab::CLI::Stubber.stub_all(path)
+  end
+end

data/lib/tasks/help.rake

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'colorize'
+
+desc 'Show the help'
+task '--help' do
+  usage = +%(Usage: #{$PROGRAM_NAME} TASK\n)
+
+  Rake.application.tasks.each do |task|
+    usage += %(#{task.name.bold}: #{task.comment}\n)
+
+    next unless task.full_comment && task.full_comment != task.comment
+
+    # standardize and colorize the description
+    full_comment = task.full_comment.gsub(/(Arguments|Examples|Notes):/, '\1:'.underline)
+
+    # remove the short description and the newlines
+    full_comment = full_comment[task.comment.size + 2..]
+
+    usage += %(#{full_comment}\n\n)
+  end
+
+  $stdout.puts usage
+end

data/lib/tasks/new.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+desc <<-DESCRIPTION
+  Scaffold a new Chemlab Library
+
+  Arguments: PATH
+  Examples:
+    - new my-library
+      Scaffolds a new Chemlab Library in the `my-library` directory.
+      This will fail if the PATH already exists
+DESCRIPTION
+task 'new' do |_, args|
+  require_relative '../chemlab/cli/new_library'
+
+  library = args.first
+
+  warn "NOTE: Only creating #{library}" if args.size > 1
+  Chemlab::CLI::NewLibrary.scaffold(library)
+end

data/lib/tasks/version.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc 'Shows the version'
+task '--version' do
+  require_relative '../chemlab/version'
+
+  $stdout.puts %(#{$PROGRAM_NAME} version #{Chemlab::VERSION})
+end

metadata

@@ -1,161 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: chemlab
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: debase
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4.1
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4.1
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 1.10.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 1.10.9
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rspec-parameterized
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
-  name: rspec-retry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: activesupport-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.9
-  type: :development
+        version: 0.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.9
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -187,28 +209,44 @@ dependencies:
 description:
 email:
 - quality@gitlab.com
-executables: []
+executables:
+- chemlab
 extensions: []
 extra_rdoc_files: []
 files:
+- Rakefile
+- bin/chemlab
+- bin/chemlab-suite
+- bin/chemlab-test
 - lib/chemlab.rb
-- lib/chemlab/api_fabricator.rb
 - lib/chemlab/attributable.rb
+- lib/chemlab/cli/fixtures/new_library/.gitignore
+- lib/chemlab/cli/fixtures/new_library/Gemfile
+- lib/chemlab/cli/fixtures/new_library/README.md.erb
+- lib/chemlab/cli/fixtures/new_library/lib/new_library.rb.erb
+- lib/chemlab/cli/fixtures/new_library/lib/page/sample.rb.erb
+- lib/chemlab/cli/fixtures/new_library/new_library.gemspec.erb
+- lib/chemlab/cli/fixtures/new_library/spec/integration/page/sample_spec.rb.erb
+- lib/chemlab/cli/fixtures/new_library/spec/unit/page/sample_spec.rb.erb
+- lib/chemlab/cli/generator.rb
+- lib/chemlab/cli/generator/templates/page.erb
+- lib/chemlab/cli/new_library.rb
+- lib/chemlab/cli/stub.erb
+- lib/chemlab/cli/stubber.rb
 - lib/chemlab/component.rb
 - lib/chemlab/configuration.rb
 - lib/chemlab/element.rb
 - lib/chemlab/page.rb
-- lib/chemlab/resource.rb
-- lib/chemlab/runtime/api_client.rb
 - lib/chemlab/runtime/browser.rb
 - lib/chemlab/runtime/env.rb
 - lib/chemlab/runtime/logger.rb
-- lib/chemlab/support/api.rb
-- lib/chemlab/support/logging.rb
-- lib/chemlab/support/repeater.rb
-- lib/chemlab/support/waiter.rb
 - lib/chemlab/version.rb
-homepage: https://about.gitlab.com
+- lib/tasks/generate.rake
+- lib/tasks/generate_stubs.rake
+- lib/tasks/help.rake
+- lib/tasks/new.rake
+- lib/tasks/version.rake
+homepage: https://about.gitlab.com/
 licenses:
 - MIT
 metadata: {}
@@ -220,14 +258,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Automation framework built by GitLab, for the world.

data/lib/chemlab/api_fabricator.rb

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/object/deep_dup'
-
-module Chemlab
-  # API Fabricator
-  module ApiFabricator
-    ResourceFabricationFailedError = Class.new(RuntimeError)
-    ResourceNotDeletedError = Class.new(RuntimeError)
-    ResourceNotFoundError = Class.new(RuntimeError)
-    ResourceQueryError = Class.new(RuntimeError)
-    ResourceUpdateFailedError = Class.new(RuntimeError)
-    ResourceURLMissingError = Class.new(RuntimeError)
-    InternalServerError = Class.new(RuntimeError)
-
-    attr_reader :api_resource, :api_response
-    attr_writer :api_client
-    attr_accessor :user
-
-    def api_support?
-      respond_to?(:api_get_path) &&
-        (respond_to?(:api_post_path) && respond_to?(:api_post_body)) ||
-        (respond_to?(:api_put_path) && respond_to?(:api_put_body))
-    end
-
-    def fabricate_via_api!
-      unless api_support?
-        raise NotImplementedError, "Resource #{self.class.name} does not support fabrication via the API!"
-      end
-
-      resource_web_url(api_post)
-    end
-
-    def reload!
-      api_get
-
-      self
-    end
-
-    def remove_via_api!
-      api_delete
-    end
-
-    def eager_load_api_client!
-      return unless api_client.nil?
-
-      api_client.tap do |client|
-        # Eager-load the API client so that the personal token creation isn't
-        # taken in account in the actual resource creation timing.
-        client.user = user
-        client.personal_access_token
-      end
-    end
-
-    include Support::API
-
-    attr_writer :api_resource, :api_response
-
-    def api_put(body = api_put_body)
-      response = put(
-        Runtime::API::Request.new(api_client, api_put_path).url,
-        body)
-
-      unless response.code == HTTP_STATUS_OK
-        raise ResourceFabricationFailedError, "Updating #{self.class.name} using the API failed (#{response.code}) with `#{response}`."
-      end
-
-      process_api_response(parse_body(response))
-    end
-
-    private
-
-    def resource_web_url(resource)
-      resource.fetch(:web_url) do
-        raise ResourceURLMissingError, "API resource for #{self.class.name} does not expose a `web_url` property: `#{resource}`."
-      end
-    end
-
-    def api_get
-      process_api_response(parse_body(api_get_from(api_get_path)))
-    end
-
-    def api_get_from(get_path)
-      url = Runtime::API::Request.new(api_client, get_path).url
-      response = get(url)
-
-      if response.code == HTTP_STATUS_SERVER_ERROR
-        raise InternalServerError, "Failed to GET #{url} - (#{response.code}): `#{response}`."
-      elsif response.code != HTTP_STATUS_OK
-        raise ResourceNotFoundError, "Resource at #{url} could not be found (#{response.code}): `#{response}`."
-      end
-
-      response
-    end
-
-    def api_post
-      response = post(
-        Runtime::API::Request.new(api_client, api_post_path).url,
-        api_post_body)
-
-      unless response.code == HTTP_STATUS_CREATED
-        raise ResourceFabricationFailedError, "Fabrication of #{self.class.name} using the API failed (#{response.code}) with `#{response}`."
-      end
-
-      process_api_response(parse_body(response))
-    end
-
-    def api_delete
-      url = Runtime::API::Request.new(api_client, api_delete_path).url
-      response = delete(url)
-
-      unless [HTTP_STATUS_NO_CONTENT, HTTP_STATUS_ACCEPTED].include? response.code
-        raise ResourceNotDeletedError, "Resource at #{url} could not be deleted (#{response.code}): `#{response}`."
-      end
-
-      response
-    end
-
-    def api_client
-      @api_client ||= begin
-                        Runtime::API::Client.new(:gitlab, is_new_session: !current_url.start_with?('http'), user: user)
-                      end
-    end
-
-    def process_api_response(parsed_response)
-      self.api_response = parsed_response
-      self.api_resource = transform_api_resource(parsed_response.deep_dup)
-    end
-
-    def transform_api_resource(api_resource)
-      api_resource
-    end
-  end
-end