specimen 0.0.1.alpha.b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '091d4e836ac67953118af5d330c4254d7e29716b7cb3e2756369b45a0ba74a88'
+  data.tar.gz: 69249e8db11054399bbc70c2fdee9163b9cbac769ae79ed55182c61f4083448a
+SHA512:
+  metadata.gz: 83f173e5ecfe205b8581e18851aed9de5e0e19f52c995790f53af3316d7e16238d8ff02104339c360caf0db07916347c157664c955522bc89b6ad2a6c28dbcbe
+  data.tar.gz: 0ab049182afb589bfe054d0325114cd0d3536c4ec9990df0e222bfd5ef8713e93b2e901dbf2ae534794e9fda09d5bd4a42a87e778d8142346ea6f1bd50d817fc

data/README.md

@@ -0,0 +1,43 @@
+# specimen
+
+Doing the same things over and over again in test automation was the initial inspiration of coming up with a gem which
+will help me with:
+
+- setting up a new test automation project, including README, Gemfile, rubocop.yml, etc...
+- run Cucumber and RSpec tests with configs that make sense (e.g. parallel execution, reporting)
+- provide a Rails like templating approach in terms of _convention over configuration_ to provide a maintainable base for
+  API or UI tests using RSpec and/or Cucumber.
+
+
+**Beware**
+
+At the point of writing the README and setting the repo to public, the gem does not do much yet so the current functionality
+is minimal, not optimized and not tested :). Hopefully that will change in the future.
+
+```shell
+# install Specimen gem
+$> gem install specimen
+
+# creates a new project relative to the current working directory. Will ask for a project name.
+$> specimen init
+
+# creates a new project 'foobar' relative to the current working directory.
+# Inside /foobar you will find the default dir structures for Cucumber and RSpec tests and a few more files
+$> specimen init -n foobar
+
+# look at the command help
+$> specimen help init
+Usage:
+  specimen init
+
+Options:
+  --name, -n, [--project-name=PROJECT_NAME]
+              [--api-only], [--no-api-only], [--skip-api-only]  # Default: false  
+              [--cucumber], [--no-cucumber], [--skip-cucumber]  # Default: true
+```
+
+
+### Known issues
+
+- tests are missing
+- generated Gemfile contains Watir and Selenium webdriver, it should be only one of them.

data/VERSION

@@ -0,0 +1 @@
+0.0.1.alpha.b

data/bin/specimen

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib_path = File.expand_path('..', __dir__) + '/lib'
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'specimen/cli'
+Specimen::CLI.start!(ARGV.dup)

data/lib/specimen/cli/default_command.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'specimen/generator'
+
+module Specimen
+  module CLI
+    class DefaultCommand < Commands::BaseCommand
+      include Generator
+
+      namespace :default
+
+      def self.banner(task, namespace = true, subcommand = false)
+        "#{basename} #{task.name}"
+      end
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      desc 'init', 'Initialize a new Specimen project'
+
+      method_option :project_name, aliases: %w[--name -n], type: :string, default: ''
+      method_option :api_only, type: :boolean, default: false
+      method_option :cucumber, type: :boolean, default: true
+
+      def init
+        SpecimenProject.start([options.dup])
+      end
+
+      desc 'commands', 'print all commands'
+
+      def commands
+        [DefaultCommand].each { |cmd| cmd.new.help }
+      end
+    end
+  end
+end

data/lib/specimen/cli.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'specimen'
+require 'specimen/cli/default_command'
+
+module Specimen
+  module CLI
+    class << self
+      def start!(args = ARGV)
+        command = args.shift
+
+        case command
+        when '--version', '-v'
+          show_version
+        else
+          DefaultCommand.start(ARGV.dup)
+        end
+      end
+
+      def show_version
+        puts(Specimen::VERSION::STRING)
+      end
+    end
+  end
+end

data/lib/specimen/commands.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Specimen
+  module Commands
+    class BaseCommand < Thor
+      include Thor::Actions
+
+      def self.banner(task, namespace = true, subcommand = false)
+        "#{basename} #{self.namespace} #{task.name}"
+      end
+    end
+
+    class BaseGroupCommand < Thor::Group
+      include Thor::Actions
+
+      def self.banner(task, namespace = true, subcommand = false)
+        "#{basename} #{self.namespace} #{task.name}"
+      end
+    end
+  end
+end

data/lib/specimen/extensions/ruby/hash.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+class Hash
+  # Returns a new hash with all keys converted to strings.
+  #
+  #   hash = { name: 'Rob', age: '28' }
+  #
+  #   hash.stringify_keys
+  #   # => {"name"=>"Rob", "age"=>"28"}
+  def stringify_keys
+    transform_keys(&:to_s)
+  end
+
+  # Destructively converts all keys to strings. Same as
+  # +stringify_keys+, but modifies +self+.
+  def stringify_keys!
+    transform_keys!(&:to_s)
+  end
+
+  # Returns a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  #
+  #   hash = { 'name' => 'Rob', 'age' => '28' }
+  #
+  #   hash.symbolize_keys
+  #   # => {:name=>"Rob", :age=>"28"}
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+  alias_method :to_options,  :symbolize_keys
+
+  # Destructively converts all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  def symbolize_keys!
+    transform_keys! { |key| key.to_sym rescue key }
+  end
+  alias_method :to_options!, :symbolize_keys!
+
+  # Validates all keys in a hash match <tt>*valid_keys</tt>, raising
+  # +ArgumentError+ on a mismatch.
+  #
+  # Note that keys are treated differently than HashWithIndifferentAccess,
+  # meaning that string and symbol keys will not match.
+  #
+  #   { name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age"
+  #   { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'"
+  #   { name: 'Rob', age: '28' }.assert_valid_keys(:name, :age)   # => passes, raises nothing
+  def assert_valid_keys(*valid_keys)
+    valid_keys.flatten!
+    each_key do |k|
+      unless valid_keys.include?(k)
+        raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
+      end
+    end
+  end
+
+  # Returns a new hash with all keys converted by the block operation.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #   hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #   hash.deep_transform_keys{ |key| key.to_s.upcase }
+  #   # => {"PERSON"=>{"NAME"=>"Rob", "AGE"=>"28"}}
+  def deep_transform_keys(&block)
+    _deep_transform_keys_in_object(self, &block)
+  end
+
+  # Destructively converts all keys by using the block operation.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_transform_keys!(&block)
+    _deep_transform_keys_in_object!(self, &block)
+  end
+
+  # Returns a new hash with all keys converted to strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  #
+  #   hash = { person: { name: 'Rob', age: '28' } }
+  #
+  #   hash.deep_stringify_keys
+  #   # => {"person"=>{"name"=>"Rob", "age"=>"28"}}
+  def deep_stringify_keys
+    deep_transform_keys(&:to_s)
+  end
+
+  # Destructively converts all keys to strings.
+  # This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_stringify_keys!
+    deep_transform_keys!(&:to_s)
+  end
+
+  # Returns a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+. This includes the keys from the root hash
+  # and from all nested hashes and arrays.
+  #
+  #   hash = { 'person' => { 'name' => 'Rob', 'age' => '28' } }
+  #
+  #   hash.deep_symbolize_keys
+  #   # => {:person=>{:name=>"Rob", :age=>"28"}}
+  def deep_symbolize_keys
+    deep_transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # Destructively converts all keys to symbols, as long as they respond
+  # to +to_sym+. This includes the keys from the root hash and from all
+  # nested hashes and arrays.
+  def deep_symbolize_keys!
+    deep_transform_keys! { |key| key.to_sym rescue key }
+  end
+
+  private
+  # Support methods for deep transforming nested hashes and arrays.
+  def _deep_transform_keys_in_object(object, &block)
+    case object
+    when Hash
+      object.each_with_object(self.class.new) do |(key, value), result|
+        result[yield(key)] = _deep_transform_keys_in_object(value, &block)
+      end
+    when Array
+      object.map { |e| _deep_transform_keys_in_object(e, &block) }
+    else
+      object
+    end
+  end
+
+  def _deep_transform_keys_in_object!(object, &block)
+    case object
+    when Hash
+      object.keys.each do |key|
+        value = object.delete(key)
+        object[yield(key)] = _deep_transform_keys_in_object!(value, &block)
+      end
+      object
+    when Array
+      object.map! { |e| _deep_transform_keys_in_object!(e, &block) }
+    else
+      object
+    end
+  end
+end

data/lib/specimen/generator/file_by_template.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class FileByTemplate < Commands::BaseGroupCommand
+      argument :template_file, type: :string
+      argument :destination, type: :string
+      argument :data, type: :hash, default: {}
+
+      def self.source_root
+        "#{File.dirname(__FILE__)}/templates"
+      end
+
+      def create
+        template(template_file, destination, data)
+      end
+    end
+  end
+end

data/lib/specimen/generator/specimen_project.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'specimen_project_config'
+
+module Specimen
+  module Generator
+    class SpecimenProject < Commands::BaseGroupCommand
+      include Generator
+
+      argument :project_options
+
+      def self.source_root
+        "#{File.dirname(__FILE__)}/templates"
+      end
+
+      def initialize(_, _, _)
+        super
+        @opts = project_options.to_h.deep_symbolize_keys
+      end
+
+      def start
+        say('Initialize new Specimen project', Color::BOLD)
+
+        @opts[:project_name].empty? ? ask_for_name : @opts[:project_name]
+        @opts[:destination_root] = destination_root
+        @config = SpecimenProjectConfig.new(@opts)
+      end
+
+      def execute
+        empty_directory(@config.project_name)
+        create_root_files
+
+        inside @config.project_root do
+          if @config.cucumber?
+            empty_directory('features/step_definitions')
+            empty_directory('features/support')
+          end
+
+          empty_directory('spec/support')
+        end
+      end
+
+      def finish
+        say("created new Specimen project in #{@config.project_root}", Color::GREEN)
+      end
+
+      no_commands do
+        def ask_for_name
+          @opts[:project_name] = ask('What is the name of the project?')
+        end
+
+        def create_root_files
+          project_root_files.each do |file|
+            dest = dot_files.include?(file) ? ".#{file}" : file
+            create_file_by_template(file, "#{@config.project_root}/#{dest}", @config.data)
+          end
+        end
+
+        def dot_files
+          %w[gemrc rbenv-gemsets rubocop.yml]
+        end
+
+        def project_root_files
+          %w[gemrc
+             rbenv-gemsets
+             rubocop.yml
+             Gemfile
+             README.md]
+        end
+      end
+    end
+  end
+end

data/lib/specimen/generator/specimen_project_config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class SpecimenProjectConfig
+      GEM_LIST = %w[
+        activesupport dotenv ffaker rest-client thor uuid
+        cucumber cuke_modeler parallel_tests rspec
+        selenium-webdriver watir
+        debug pry rubocop
+      ].freeze
+
+      def initialize(options)
+        @options = options
+      end
+
+      def data
+        @data ||= {
+          project_name: project_name,
+          gems: project_gems,
+          project_root: project_root,
+          api_only: api_only?,
+          cucumber: cucumber?
+        }
+      end
+
+      def project_gems
+        gems.reject! { |gem| gem.eql?('selenium-webdriver') || gem.eql?('watir') } if api_only?
+        gems.reject! { |gem| gem.eql?('cucumber') || gem.eql?('cuke_modeler') } unless cucumber?
+        gems.sort
+      end
+
+      def project_root
+        "#{@options[:destination_root]}/#{project_name}"
+      end
+
+      def project_name
+        @options[:project_name]
+      end
+
+      def gems
+        @gems ||= GEM_LIST.dup
+      end
+
+      def api_only?
+        @options[:api_only]
+      end
+
+      def cucumber?
+        @options[:cucumber]
+      end
+    end
+  end
+end

data/lib/specimen/generator/templates/Gemfile.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+<% data[:gems].sort.each do |gem| -%>
+<% if gem == 'debug' || gem == 'pry' -%>
+gem '<%= gem %>', require: false
+<% else -%>
+gem '<%= gem %>'
+<% end -%>
+<% end -%>

data/lib/specimen/generator/templates/README.md.tt

@@ -0,0 +1 @@
+#  <%= "#{data[:project_name]}" %>

data/lib/specimen/generator/templates/gemrc.tt

@@ -0,0 +1 @@
+gem: --no-rdoc --no-ri

data/lib/specimen/generator/templates/rbenv-gemsets.tt

@@ -0,0 +1 @@
+<%= data[:project_name] %>-gems

data/lib/specimen/generator/templates/rubocop.yml.tt

@@ -0,0 +1,32 @@
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/AbcSize:
+  Enabled: false
+  CountRepeatedAttributes: true
+
+Metrics/MethodLength:
+  Max: 25
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+
+Style/NumericLiterals:
+  Enabled: false
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - '.irbrc'

data/lib/specimen/generator/templates/specimen/specimen.yml.tt

@@ -0,0 +1 @@
+project_name: 'Foo'

data/lib/specimen/generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'generator/file_by_template'
+require_relative 'generator/specimen_project'
+
+module Specimen
+  module Generator
+    def create_file_by_template(template, destination, data = {})
+      FileByTemplate.start([template, destination, data])
+    end
+  end
+end

data/lib/specimen/version.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Specimen
+  # Returns the currently loaded version of \Rails as a +Gem::Version+.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = "alpha.b"
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+
+end

data/lib/specimen.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+# require Ruby extensions
+require 'specimen/extensions/ruby/hash'
+
+require 'specimen/version'
+
+module Specimen
+  extend ActiveSupport::Autoload
+
+  autoload :CLI
+  autoload :Commands
+  autoload :Generator
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: specimen
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.b
+platform: ruby
+authors:
+- Marek Witkowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.64.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.64.1
+description: Create maintainable automated tests using Rails-like COC approach
+email: info@marekwitkowski.de
+executables:
+- specimen
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VERSION
+- bin/specimen
+- lib/specimen.rb
+- lib/specimen/cli.rb
+- lib/specimen/cli/default_command.rb
+- lib/specimen/commands.rb
+- lib/specimen/extensions/ruby/hash.rb
+- lib/specimen/generator.rb
+- lib/specimen/generator/file_by_template.rb
+- lib/specimen/generator/specimen_project.rb
+- lib/specimen/generator/specimen_project_config.rb
+- lib/specimen/generator/templates/Gemfile.tt
+- lib/specimen/generator/templates/README.md.tt
+- lib/specimen/generator/templates/gemrc.tt
+- lib/specimen/generator/templates/rbenv-gemsets.tt
+- lib/specimen/generator/templates/rubocop.yml.tt
+- lib/specimen/generator/templates/specimen/specimen.yml.tt
+- lib/specimen/version.rb
+homepage: https://github.com/dev-dots/specimen
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dev-dots/specimen/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Specimen
+test_files: []