cucumber-create-meta 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc6fadee5d6df3e7e90f5f21741bd7eb9850b645efa7b120098329932dc9f165
+  data.tar.gz: 8e9553277de8b14d988529b320489685c9a104f60a31a6adf35160ed751e9e76
+SHA512:
+  metadata.gz: cf282b4a220dfb292340b9d216b379a46094ca932d30227382a94f3ec14fca86025504d74f8c334903ff354818ea94b82d7515966ee2550c2d185ca4377dfeb9
+  data.tar.gz: cc3c3328c0c32dc453f2dd5d4fd4a5821aa8ec09fd7e3a4ddeca96b059dea802d6aabf29dee78270c0079acf21272707af9b516d0a5b45066a5f2fefd11c75f0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cucumber Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/cucumber/ciDict.json

@@ -0,0 +1,110 @@
+{
+  "Azure Pipelines": {
+    "url": "${BUILD_URI}",
+    "git": {
+      "remote": "${BUILD_REPOSITORY_URI}",
+      "revision": "${BUILD_SOURCEVERSION}",
+      "branch": "${refbranch BUILD_SOURCEBRANCH}",
+      "tag": "${reftag BUILD_SOURCEBRANCH}"
+    }
+  },
+  "Bamboo": {
+    "url": "${bamboo.buildResultsUrl}",
+    "git": {
+      "remote": "${bamboo.planRepository.1.repositoryUrl}",
+      "revision": "${bamboo.planRepository.1.revision}",
+      "branch": "${bamboo.planRepository.1.branch}",
+      "tag": null
+    }
+  },
+  "Buddy": {
+    "url": "${BUDDY_EXECUTION_URL}",
+    "git": {
+      "remote": "${BUDDY_SCM_URL}",
+      "revision": "${BUDDY_EXECUTION_REVISION}",
+      "branch": "${BUDDY_EXECUTION_BRANCH}",
+      "tag": "${BUDDY_EXECUTION_TAG}"
+    }
+  },
+  "CircleCI": {
+    "url": "${CIRCLE_BUILD_URL}",
+    "git": {
+      "remote": "${CIRCLE_REPOSITORY_URL}",
+      "revision": "${CIRCLE_SHA1}",
+      "branch": "${CIRCLE_BRANCH}",
+      "tag": "${CIRCLE_TAG}"
+    }
+  },
+  "CodeShip": {
+    "url": "${CF_BUILD_URL}",
+    "git": {
+      "remote": "${CF_COMMIT_URL}",
+      "revision": "${CF_REVISION}",
+      "branch": "${CF_BRANCH}",
+      "tag": null
+    }
+  },
+  "GitHub Actions": {
+    "url": "${_GITHUB_BASEURL | https://github.com/}${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}",
+    "git": {
+      "remote": "${_GITHUB_BASEURL | https://github.com/}${GITHUB_REPOSITORY}.git",
+      "revision": "${GITHUB_SHA}",
+      "branch": "${refbranch GITHUB_REF}",
+      "tag": "${reftag GITHUB_REF}"
+    }
+  },
+  "GitLab": {
+    "url": "${CI_JOB_URL}",
+    "git": {
+      "remote": "${CI_REPOSITORY_URL}",
+      "revision": "${CI_COMMIT_SHA}",
+      "branch": "${CI_COMMIT_BRANCH}",
+      "tag": "${CI_COMMIT_TAG}"
+    }
+  },
+  "GoCD": {
+    "url": "${GO_SERVER_URL}/???",
+    "git": {
+      "remote": null,
+      "revision": "${GO_REVISION}",
+      "branch": null,
+      "tag": null
+    }
+  },
+  "Semaphore": {
+    "url": "${SEMAPHORE_ORGANIZATION_URL}/${}",
+    "git": {
+      "remote": "${SEMAPHORE_GIT_URL}",
+      "revision": "${SEMAPHORE_GIT_SHA}",
+      "branch": "${SEMAPHORE_GIT_BRANCH}",
+      "tag": "${SEMAPHORE_GIT_TAG_NAME}"
+    }
+  },
+  "TeamCity": {
+    "url": "${teamcity.serverUrl}/app/rest/builds/id:${teamcity.build.id}",
+    "git": {
+      "remote": null,
+      "revision": "${build.vcs.number}",
+      "branch": "${teamcity.build.branch}",
+      "tag": null
+    }
+  },
+  "Travis CI": {
+    "url": "${TRAVIS_BUILD_WEB_URL}",
+    "git": {
+      "remote": "https://github.com/${TRAVIS_REPO_SLUG}.git",
+      "revision": "${TRAVIS_COMMIT}",
+      "branch": "${TRAVIS_BRANCH}",
+      "tag": "${TRAVIS_TAG}"
+    }
+  },
+  "Wercker": {
+    "url": "${WERCKER_RUN_URL}",
+    "git": {
+      "remote": "https://${WERCKER_GIT_DOMAIN}/${WERCKER_GIT_OWNER}/${WERCKER_GIT_REPOSITORY}.git",
+      "revision": "${WERCKER_GIT_COMMIT}",
+      "branch": "${WERCKER_GIT_BRANCH}",
+      "tag": null
+    }
+  }
+}

data/lib/cucumber/create_meta.rb

@@ -0,0 +1,84 @@
+require 'cucumber/messages'
+require 'sys/uname'
+require 'json'
+
+module Cucumber
+  module CreateMeta
+    CI_DICT = JSON.parse(IO.read(File.join(File.dirname(__FILE__),"ciDict.json")))
+
+    def create_meta(tool_name, tool_version)
+      Cucumber::Messages::Meta.new(
+        protocol_version: Cucumber::Messages::VERSION,
+        implementation: Cucumber::Messages::Meta::Product.new(
+          name: tool_name,
+          version: tool_version
+        ),
+        runtime: Cucumber::Messages::Meta::Product.new(
+          name: RUBY_ENGINE,
+          version: RUBY_VERSION
+        ),
+        os: Cucumber::Messages::Meta::Product.new(
+          name: RbConfig::CONFIG['target_os'],
+          version: Sys::Uname.uname.version
+        ),
+        cpu: Cucumber::Messages::Meta::Product.new(
+          name: RbConfig::CONFIG['target_cpu']
+        )
+      )
+    end
+
+    def detect_ci(env)
+      detected = CI_DICT.map do |ci_name, ci_system|
+        create_ci(ci_name, ci_system, env)
+      end.compact
+
+      detected.length == 1 ? detected[0] : nil
+    end
+
+    def create_ci(ci_name, ci_system, env)
+      url = evaluate(ci_system['url'], env)
+      return nil if url.nil?
+
+      Cucumber::Messages::Meta::CI.new(
+        url: url,
+        name: ci_name,
+        git: Cucumber::Messages::Meta::CI::Git.new(
+          remote: evaluate(ci_system['git']['remote'], env),
+          revision: evaluate(ci_system['git']['revision'], env),
+          branch: evaluate(ci_system['git']['branch'], env),
+          tag: evaluate(ci_system['git']['tag'], env),
+        )
+      )
+    end
+
+    def evaluate(template, env)
+      return nil if template.nil?
+      begin
+        template.gsub(/\${((refbranch|reftag)\s+)?([^\s}]+)(\s+\|\s+([^}]+))?}/) do
+          func = $2
+          variable = $3
+          default_value = $5 == "" ? nil : $5
+          value = env[variable] || default_value
+
+          if func == 'refbranch'
+            value = group1(value, /^refs\/heads\/(.*)/)
+          elsif func == 'reftag'
+            value = group1(value, /^refs\/tags\/(.*)/)
+          end
+          raise "Undefined variable: #{variable}" if value.nil?
+          value
+        end
+      rescue
+        nil
+      end
+    end
+
+    def group1(value, regexp)
+      m = value.match(regexp)
+      raise "No match" if m.nil?
+      m[1]
+    end
+
+    module_function :create_meta, :detect_ci, :create_ci, :group1, :evaluate
+  end
+end

data/spec/capture_warnings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# With thanks to @myronmarston
+# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
+
+module CaptureWarnings
+  def report_warnings(&block)
+    current_dir = Dir.pwd
+    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
+    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
+
+    if errors.any?
+      puts errors.join("\n")
+    end
+
+    if other_warnings.any?
+      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
+      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
+    end
+
+    # Until they fix https://bugs.ruby-lang.org/issues/10661
+    if RUBY_VERSION == "2.2.0"
+      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
+    end
+
+    if project_warnings.any?
+      puts "#{ project_warnings.count } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
+    end
+
+    ensure_system_exit_if_required
+  end
+
+  def capture_error(&block)
+    old_stderr = STDERR.clone
+    pipe_r, pipe_w = IO.pipe
+    pipe_r.sync    = true
+    error          = String.new
+    reader = Thread.new do
+      begin
+        loop do
+          error << pipe_r.readpartial(1024)
+        end
+      rescue EOFError
+      end
+    end
+    STDERR.reopen(pipe_w)
+    block.call
+  ensure
+    capture_system_exit
+    STDERR.reopen(old_stderr)
+    pipe_w.close
+    reader.join
+    return error.split("\n")
+  end
+
+  def print_warnings(type, warnings)
+    puts
+    puts "-" * 30 + " #{type} warnings: " + "-" * 30
+    puts
+    puts warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  def ensure_system_exit_if_required
+    raise @system_exit if @system_exit
+  end
+
+  def capture_system_exit
+    @system_exit = $!
+  end
+end

data/spec/cucumber/create_meta_spec.rb

@@ -0,0 +1,16 @@
+require 'cucumber/create_meta'
+
+describe 'createMeta' do
+  it 'generates a Meta message with platform information' do
+    meta = Cucumber::CreateMeta.create_meta('cucumba-ruby', 'X.Y.Z')
+
+    expect(meta.protocol_version).to match(/\d+\.\d+\.\d+/)
+    expect(meta.implementation.name).to eq('cucumba-ruby')
+    expect(meta.implementation.version).to eq('X.Y.Z')
+    expect(meta.runtime.name).to match(/(jruby|ruby)/)
+    expect(meta.runtime.version).to eq(RUBY_VERSION)
+    expect(meta.os.name).to match(/.+/)
+    expect(meta.os.version).to match(/.+/)
+    expect(meta.cpu.name).to match(/.+/)
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-create-meta
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vincent Prêtre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber-messages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.2.0
+- !ruby/object:Gem::Dependency
+  name: sys-uname
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: Produce the meta message for Cucumber Ruby
+email: cukes@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/cucumber/ciDict.json
+- lib/cucumber/create_meta.rb
+- spec/capture_warnings.rb
+- spec/cucumber/create_meta_spec.rb
+homepage: https://github.com/cucumber/create-meta-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cucumber/cucumber/issues
+  changelog_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/CHANGELOG.md
+  documentation_uri: https://cucumber.io/docs/gherkin/
+  mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
+  source_code_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/ruby
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: cucumber-create-meta-1.0.0
+test_files:
+- spec/cucumber/create_meta_spec.rb
+- spec/capture_warnings.rb