specimen 0.0.1.alpha.b → 0.0.2.alpha

data/lib/specimen/commands/gem_help/gem_help_command.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'specimen/command/base'
+
+module Specimen
+  module Command
+    class GemHelpCommand < Base
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      no_commands do
+        def perform
+          if class_usage
+            say class_usage
+          else
+            help
+          end
+        end
+      end
+    end
+  end
+end

data/lib/specimen/commands/init/USAGE

@@ -0,0 +1,38 @@
+Usage:
+  specimen init --name=NAME [options]   # Create a new specimen project which will generate following dirs and files
+
+                                          * default directories /config, /lib, /tmp
+                                          * default directories (/features/..) and files for cucumber unless --skip-cucumber
+                                          * default directories (/spec/..) and files for RSpec unless --skip-rspec
+                                          * root path files:
+                                            * .gemrc
+                                            * .gitignore
+                                            * .rspec (unless --skip-rspec)
+                                            * .rubocop.yml
+                                            * cucumber.yml (unless --skip-cucumber)
+                                            * Gemfile (based on the used options)
+                                            * README.md
+                                            * specimen.yml (default configuration file for the specimen gem
+
+Options:
+  -n, [--name=NAME]                     # required: true
+                                          The name of your project and installation path relative to your current PWD
+
+      [--ui-driver=UI_DRIVER]           # Default: 'watir'
+                                          Valid options are:
+                                            * watir
+                                            * selenium
+                                            * selenium-webdriver
+
+      [--skip-ui]                       # Default: false
+                                          Don´t add selenium or watir gem to your Gemfile
+
+      [--skip-cucumber]                 # Default: false
+                                          No cucumber gems will be added to your Gemfile.
+                                          Creation of cucumber directories and files will be skipped.
+
+      [--skip-rspec]                    # Default: false
+                                          RSpec will still be in your Gemfile (as it´s matchers are used for cucumber)
+                                          but no RSpec directories and files will be generated
+
+  -h, [--help]                          # You are looking at it.

data/lib/specimen/commands/init/init_command.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'specimen/generator'
+
+module Specimen
+  module Command
+    class InitCommand < BaseGroup
+      class RequiredOptionError < StandardError
+        def initialize
+          @msg = "Please provide required option '--name'!"
+          super(@msg)
+        end
+      end
+
+      class ProjectNameError < StandardError
+        def initialize
+          @msg = "Option '--name' can not be empty or equal 'name'!"
+          super(@msg)
+        end
+      end
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      namespace :init
+
+      class_option :name, aliases: %w[-n], type: :string
+      class_option :skip_ui, type: :boolean, default: false
+      class_option :ui_driver, type: :string, default: ''
+      class_option :skip_cucumber, type: :boolean, default: false
+      class_option :skip_rspec, type: :boolean, default: false
+
+      no_commands do
+        def perform
+          run_options_checks!
+
+          Generator::SpecimenProjectGenerator.new(args, options).perform
+        end
+
+        def run_options_checks!
+          raise RequiredOptionError if options[:name].nil?
+          raise RequiredOptionError if options[:name].empty?
+          raise ProjectNameError if options[:name] == 'name'
+        end
+      end
+    end
+  end
+end

data/lib/specimen/commands/specs/specs_command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Command
+    class SpecsCommand < SpecsRunner
+      namespace :specs
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Copied without any regrets from activesupport or rails :) to make the 'deep_symbolize_keys' methods available
 class Hash
   # Returns a new hash with all keys converted to strings.
   #

data/lib/specimen/generator/configs/specimen_project_config.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class SpecimenProjectConfig
+      class InvalidUIDriverError < RuntimeError
+        def initialize(driver)
+          @msg = "Invalid UI driver name '#{driver}'. Set --ui-driver to\n * #{VALID_UI_DRIVER_NAMES.join("\n * ")}"
+          super(@msg)
+        end
+      end
+
+      GEM_LIST = %w[
+        activesupport dotenv ffaker rest-client thor uuid
+        cucumber cuke_modeler parallel_tests rspec
+        selenium-webdriver watir
+        debug pry rubocop
+      ].freeze
+
+      VALID_UI_DRIVER_NAMES = %w[selenium selenium-webdriver watir].freeze
+
+      def self.parse(options)
+        new(options).parse_options
+      end
+
+      def initialize(options)
+        @options = options
+      end
+
+      def parse_options
+        run_ui_driver_check!
+        config
+      end
+
+      def config
+        @config ||= {
+          project_name: project_name,
+          root_path: "#{Specimen.init_wd_path.to_path}/#{project_name}",
+          gems: project_gems,
+          skip_ui: skip_ui?,
+          cucumber: !skip_cucumber?,
+          rspec: !skip_rspec?,
+          ui_driver: ui_driver
+        }
+      end
+
+      def run_ui_driver_check!
+        return if skip_ui?
+
+        raise InvalidUIDriverError, ui_driver unless VALID_UI_DRIVER_NAMES.include?(ui_driver)
+      end
+
+      def project_gems
+        reject_cucumber_gems if skip_cucumber?
+        reject_all_ui_driver_gems if skip_ui?
+        reject_ui_driver_gem
+
+        gems.sort
+      end
+
+      def reject_cucumber_gems
+        gems.reject! { |gem| gem.eql?('cucumber') || gem.eql?('cuke_modeler') }
+      end
+
+      def reject_all_ui_driver_gems
+        gems.reject! { |gem| gem.eql?('selenium-webdriver') || gem.eql?('watir') }
+      end
+
+      def reject_ui_driver_gem
+        reject_watir_gem
+        reject_selenium_gem
+      end
+
+      def reject_watir_gem
+        gems.reject! { |gem| gem.eql?('watir') } if selenium?
+      end
+
+      def reject_selenium_gem
+        gems.reject! { |gem| gem.eql?('selenium-webdriver') } if watir?
+      end
+
+      def selenium?
+        ui_driver == 'selenium' || ui_driver == 'selenium-webdriver'
+      end
+
+      def watir?
+        ui_driver == 'watir'
+      end
+
+      def ui_driver?
+        !@options[:ui_driver].empty?
+      end
+
+      def ui_driver
+        return nil if skip_ui?
+        return @options[:ui_driver] if ui_driver?
+
+        'watir'
+      end
+
+      def project_name
+        @options[:name]
+      end
+
+      def gems
+        @gems ||= GEM_LIST.dup
+      end
+
+      def skip_ui?
+        @options[:skip_ui]
+      end
+
+      def skip_cucumber?
+        @options[:skip_cucumber]
+      end
+
+      def skip_rspec?
+        @options[:skip_rspec]
+      end
+    end
+  end
+end

data/lib/specimen/generator/cucumber/cucumber_project_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class CucumberProjectGenerator < ProjectGeneratorBase
+      DEFAULT_DIRECTORIES = %w[features/examples features/step_definitions/examples features/support].freeze
+      TEMPLATES_DIR = 'cucumber/templates'
+      TEMPLATES = %w[
+        features/examples/add_numbers.feature
+        features/support/env.rb
+        config/cucumber.yml
+      ].freeze
+
+      def execute!
+        perform
+      end
+
+      no_commands do
+        def perform
+          create_directories(DEFAULT_DIRECTORIES)
+          create_files_by_templates(TEMPLATES_DIR, TEMPLATES)
+
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1 @@
+default: --require features/support/env.rb

data/lib/specimen/generator/cucumber/templates/features/examples/add_numbers.feature.tt

@@ -0,0 +1,9 @@
+Feature: Add numbers example feature
+
+  Scenario:
+    Given I add 1 and 1
+    Then the result should be 2
+
+  Scenario:
+    Given I add 1 and 3
+    Then the result should be 3

data/lib/specimen/generator/file_by_template.rb

@@ -2,17 +2,19 @@
 
 module Specimen
   module Generator
-    class FileByTemplate < Commands::BaseGroupCommand
-      argument :template_file, type: :string
+    # Do not move this class to not screw up the template lookup path!
+    class FileByTemplate < GeneratorBase
+      argument :template_path, type: :string
       argument :destination, type: :string
       argument :data, type: :hash, default: {}
 
       def self.source_root
-        "#{File.dirname(__FILE__)}/templates"
+        File.dirname(__FILE__)
       end
 
+      # Example template_path => 'project/templates/root/.gemrc'
       def create
-        template(template_file, destination, data)
+        template(template_path, destination, data)
       end
     end
   end

data/lib/specimen/generator/generator_base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class GeneratorBase < Command::BaseGroup
+      include Generator
+    end
+  end
+end

data/lib/specimen/generator/project/project_root_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class ProjectRootGenerator < ProjectGeneratorBase
+      DEFAULT_DIRECTORIES = %w[config lib tmp].freeze
+      TEMPLATES_DIR = 'project/templates/root'
+      TEMPLATES = %w[
+        .gemrc
+        .gitignore
+        .rubocop.yml
+        Gemfile
+        README.md
+        config/specimen.yml
+      ].freeze
+
+      #  argument :config
+
+      def execute!
+        perform
+      end
+
+      no_commands do
+        def perform
+          create_directories(DEFAULT_DIRECTORIES)
+          create_files_by_templates(TEMPLATES_DIR, TEMPLATES)
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/specimen/generator/project/specimen_project_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class SpecimenProjectGenerator < GeneratorBase
+      def execute!
+        perform
+      end
+
+      no_commands do
+        def perform
+          ProjectRootGenerator.start([config])
+          CucumberProjectGenerator.start([config]) if config[:cucumber]
+          RSpecProjectGenerator.start([config]) if config[:rspec]
+
+          true
+        end
+
+        def config
+          @config ||= Generator::SpecimenProjectConfig.parse(options)
+        end
+      end
+    end
+  end
+end

data/lib/specimen/generator/project/templates/root/.gitignore.tt

@@ -0,0 +1,4 @@
+*.idea/
+/.bundle
+
+tmp/

data/lib/specimen/generator/project/templates/root/config/specimen.yml.tt

@@ -0,0 +1,38 @@
+default: &default
+  threads: 1
+  env:
+    - FOO='123'
+
+cucumber: &cucumber
+  framework: cucumber
+  profiles: []
+  options: &options
+    - --publish-quiet
+    - --format pretty
+    - --format html --out tmp/cucumber_result.html
+  env:
+    - FOO='123'
+    - BAZ='something'
+
+rspec: &rspec
+  framework: rspec
+  options:
+    - --options config/.rspec
+    - --format progress
+    - --format documentation
+    - --format html --out tmp/rspec_result.html
+  env:
+    - FOO='123'
+    - BAZ='something'
+
+ci_specs:
+  <<: *rspec
+  env:
+    - CI='1'
+
+ci_cukes:
+  <<: *cucumber
+  env:
+    - CI='1'
+  profiles:
+    - regression

data/lib/specimen/generator/project_generator_base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class ProjectGeneratorBase < GeneratorBase
+      argument :config
+
+      no_commands do
+        def root_path
+          @root_path ||= config[:root_path]
+        end
+
+        def create_directories(dirs, destination_path = root_path)
+          empty_directory(destination_path)
+
+          inside destination_path do
+            dirs.each { |dir| empty_directory(dir) }
+          end
+        end
+
+        def create_files_by_templates(templates_dir, templates = [], destination_path = root_path)
+          template_paths = templates.map { |template| "#{templates_dir}/#{template}" }
+
+          template_paths.each do |template|
+            file_destination = template.gsub(templates_dir, '').delete_prefix('/')
+            file_destination_path = "#{destination_path}/#{file_destination}"
+
+            create_file_by_template(template, file_destination_path, config)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/specimen/generator/rspec/rspec_project_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Specimen
+  module Generator
+    class RSpecProjectGenerator < ProjectGeneratorBase
+      DEFAULT_DIRECTORIES = %w[spec/examples spec/support].freeze
+      TEMPLATES_DIR = 'rspec/templates'
+      TEMPLATES = %w[
+        spec/examples/example_spec.rb
+        spec/spec_helper.rb
+        config/.rspec
+      ].freeze
+
+      def execute!
+        perform
+      end
+
+      no_commands do
+        def perform
+          create_directories(DEFAULT_DIRECTORIES)
+          create_files_by_templates(TEMPLATES_DIR, TEMPLATES)
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/specimen/generator/rspec/templates/config/.rspec.tt

@@ -0,0 +1,5 @@
+--require ./spec/spec_helper
+
+--format progress
+--format documentation
+--format html --out tmp/rspec_result.html

data/lib/specimen/generator/rspec/templates/spec/examples/example_spec.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Example specs' do
+  context 'run example tests' do
+    before(:example) do
+      @foo = '123'
+    end
+
+    it 'passes' do
+      expect(@foo).to eq '123'
+    end
+  end
+end

data/lib/specimen/generator/rspec/templates/spec/spec_helper.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# require rubygems
+require 'pry'
+
+RSpec.configure do |config|
+  # generic base config for each example
+  config.before(:example) do
+    p 'always running'
+  end
+end
+
+at_exit do
+  p 'bye bye'
+end

data/lib/specimen/generator.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'generator/generator_base'
+require_relative 'generator/project_generator_base'
 require_relative 'generator/file_by_template'
-require_relative 'generator/specimen_project'
+
+require_relative 'generator/configs/specimen_project_config'
+require_relative 'generator/cucumber/cucumber_project_generator'
+require_relative 'generator/project/project_root_generator'
+require_relative 'generator/project/specimen_project_generator'
+require_relative 'generator/rspec/rspec_project_generator'
 
 module Specimen
   module Generator

data/lib/specimen/runtime/yml_parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+module Specimen
+  module Runtime
+    class YmlParser
+      class YmlTypeError < StandardError; end
+      class YmlERBError < StandardError; end
+      class YmlDataError < StandardError; end
+
+      def self.parse!(file)
+        new(file).parse
+      end
+
+      def initialize(file)
+        @file = file
+      end
+
+      def parse
+        specimen_yml_data
+      end
+
+      private
+
+      def specimen_yml
+        @specimen_yml ||= File.read(@file)
+      end
+
+      def specimen_yml_erb
+        @specimen_yml_erb ||= ERB.new(specimen_yml, trim_mode: '%').result(binding)
+      rescue StandardError
+        raise YmlERBError, "#{@file} could not be parsed with ERB!"
+      end
+
+      def specimen_yml_data
+        return @specimen_yml_data if @specimen_yml_data
+
+        data = Psych.load(specimen_yml_erb, aliases: true)
+
+        raise YmlTypeError, 'specimen.yml data could not be parsed' unless data.is_a?(Hash)
+
+        @specimen_yml_data = data
+      rescue StandardError
+        raise YmlDataError, "Could not read data from: '#{@file}'!"
+      end
+    end
+  end
+end

data/lib/specimen/runtime.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative 'runtime/yml_parser'
+
+module Specimen
+  module Runtime
+    class MissingCommandOptionError < RuntimeError
+      def initialize(command, option)
+        @msg = "Command '#{command}' misses option: '#{option}'"
+        super(@msg)
+      end
+    end
+
+    class UndefinedYmlError < RuntimeError
+      def initialize
+        @msg = "Option '--config-fie' is not set!"
+        super(@msg)
+      end
+    end
+
+    class YmlNotFoundError < RuntimeError
+      def initialize(yml_path)
+        @msg = "No such file: '#{yml_path.to_path}'"
+        super(@msg)
+      end
+    end
+
+    DEFAULT_YML_NAME = 'specimen.yml'
+
+    class << self
+      attr_reader :command, :config
+
+      def start!(command, **config)
+        @command = command
+        @config = config
+
+        return if skip_yml_load?
+        raise YmlNotFoundError, yml_path unless yml_path.exist?
+
+        self
+      end
+
+      def work_dir
+        @work_dir ||= Pathname.getwd
+      end
+
+      def config_dir
+        @config_dir ||= Pathname.new("#{work_dir}/config")
+      end
+
+      def yml_path
+        @yml_path ||= Pathname.new("#{config_dir}/#{yml_name}")
+      end
+
+      def skip_yml_load?
+        command.is_a?(Command::InitCommand)
+      end
+
+      def yml_name
+        return @yml_name if @yml_name
+
+        key_name = 'config_file'
+        raise MissingCommandOptionError, command, key_name unless command.options.key?(key_name)
+
+        yml_name = command.options[key_name]
+        raise UndefinedYmlError if yml_name.empty?
+
+        @yml_name = yml_name
+      end
+
+      def yml_data
+        @yml_data ||= YmlParser.parse!(yml_path.to_path)
+      end
+
+      def default_yml_data
+        @default_yml_data ||= profile_yml_data('default')
+      end
+
+      def profile_yml_data(profile = nil)
+        yml_data[profile]
+      end
+    end
+  end
+end