cucumber-create-meta 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c0d4c7da171c38558ed7c0809aa059da8161aeeab9fc0f2a788f757712fc953
-  data.tar.gz: 997e930fe502d8a6f58ab7e8489b4b677b077a8f123d4748c40971ac14a235a5
+  metadata.gz: 8f655f885d4b250da9d8923262231aca56d2c2aff33788fbfc55ed1c86318c58
+  data.tar.gz: 7cc5d5a2e4ac40b40652373ee8afd8a61a3db34be2e58780945b7361b82ce906
 SHA512:
-  metadata.gz: 2a7eabe5cbfcae7db34f143aec073c0341f91e5e09266ad0b417e0419f10ef5daf9ddc1cedec8dabd12976d7f9b24adff217c5b6226511eac758e30aca880463
-  data.tar.gz: 94c175d39941c886a7e8322a90f618747a5fffb148c06a3523034c0ff676a377efbd049f33fa7094270308690e9ec099c65c4aee180940262962ca5a92aa2b9c
+  metadata.gz: e743ddae1ad514729be26e52995f2ab9e5b82f4b29d0ca60c92d48df8a19befb0653476d29326a23c7dc1f1539629cb19f0dea57280d65c919451c1a577e8f72
+  data.tar.gz: 54ce5d5d9ed2a044f68749d0127c4f6e543982d53ecdd746e6c5347dee3f72ba245c1cfb0d10172c8057da259bd4d3c5188f3f03b6264f1a679e3dda4dd3b1b9

data/lib/cucumber/ciDict.json

@@ -4,8 +4,8 @@
     "git": {
       "remote": "${BUILD_REPOSITORY_URI}",
       "revision": "${BUILD_SOURCEVERSION}",
-      "branch": "${refbranch BUILD_SOURCEBRANCH}",
-      "tag": "${reftag BUILD_SOURCEBRANCH}"
+      "branch": "${BUILD_SOURCEBRANCH/refs\/heads\/(.*)/\\1}",
+      "tag": "${BUILD_SOURCEBRANCH/refs\/tags\/(.*)/\\1}"
     }
   },
   "Bamboo": {
@@ -26,6 +26,15 @@
       "tag": "${BUDDY_EXECUTION_TAG}"
     }
   },
+  "Bitrise": {
+    "url": "${BITRISE_BUILD_URL}",
+    "git": {
+      "remote": "${GIT_REPOSITORY_URL}",
+      "revision": "${BITRISE_GIT_COMMIT}",
+      "branch": "${BITRISE_GIT_BRANCH}",
+      "tag": "${BITRISE_GIT_TAG}"
+    }
+  },
   "CircleCI": {
     "url": "${CIRCLE_BUILD_URL}",
     "git": {
@@ -35,7 +44,7 @@
       "tag": "${CIRCLE_TAG}"
     }
   },
-  "CodeShip": {
+  "CodeFresh": {
     "url": "${CF_BUILD_URL}",
     "git": {
       "remote": "${CF_COMMIT_URL}",
@@ -44,13 +53,22 @@
       "tag": null
     }
   },
+  "CodeShip": {
+    "url": "${CI_BUILD_URL}",
+    "git": {
+      "remote": "${CI_PULL_REQUEST/(.*)\\/pull\\/\\d+/\\1.git}",
+      "revision": "${CI_COMMIT_ID}",
+      "branch": "${CI_BRANCH}",
+      "tag": null
+    }
+  },
   "GitHub Actions": {
     "url": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}",
     "git": {
       "remote": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git",
       "revision": "${GITHUB_SHA}",
-      "branch": "${refbranch GITHUB_REF}",
-      "tag": "${reftag GITHUB_REF}"
+      "branch": "${GITHUB_REF/refs\/heads\/(.*)/\\1}",
+      "tag": "${GITHUB_REF/refs\/tags\/(.*)/\\1}"
     }
   },
   "GitLab": {
@@ -63,16 +81,25 @@
     }
   },
   "GoCD": {
-    "url": "${GO_SERVER_URL}/???",
+    "url": "${GO_SERVER_URL}/pipelines/${GO_PIPELINE_NAME}/${GO_PIPELINE_COUNTER}/${GO_STAGE_NAME}/${GO_STAGE_COUNTER}",
     "git": {
-      "remote": null,
+      "remote": "${GO_SCM_*_PR_URL/(.*)\\/pull\\/\\d+/\\1.git}",
       "revision": "${GO_REVISION}",
-      "branch": null,
+      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}",
+      "tag": null
+    }
+  },
+  "Jenkins": {
+    "url": "${BUILD_URL}",
+    "git": {
+      "remote": "${GIT_URL}",
+      "revision": "${GIT_COMMIT}",
+      "branch": "${GIT_LOCAL_BRANCH}",
       "tag": null
     }
   },
   "Semaphore": {
-    "url": "${SEMAPHORE_ORGANIZATION_URL}/${}",
+    "url": "${SEMAPHORE_ORGANIZATION_URL}/jobs/${SEMAPHORE_JOB_ID}",
     "git": {
       "remote": "${SEMAPHORE_GIT_URL}",
       "revision": "${SEMAPHORE_GIT_SHA}",

data/lib/cucumber/create_meta.rb

@@ -1,32 +1,34 @@
 require 'uri'
-require 'cucumber/messages'
 require 'sys/uname'
 require 'json'
+require 'cucumber/messages'
+require 'cucumber/create_meta/variable_expression'
 
 module Cucumber
   module CreateMeta
+    extend Cucumber::CreateMeta::VariableExpression
     CI_DICT = JSON.parse(IO.read(File.join(File.dirname(__FILE__), "ciDict.json")))
 
     def create_meta(tool_name, tool_version, env = ENV)
-      Cucumber::Messages::Meta.new(
+      {
           protocol_version: Cucumber::Messages::VERSION,
-          implementation: Cucumber::Messages::Meta::Product.new(
+          implementation: {
               name: tool_name,
               version: tool_version
-          ),
-          runtime: Cucumber::Messages::Meta::Product.new(
+          },
+          runtime: {
               name: RUBY_ENGINE,
               version: RUBY_VERSION
-          ),
-          os: Cucumber::Messages::Meta::Product.new(
+          },
+          os: {
               name: RbConfig::CONFIG['target_os'],
               version: Sys::Uname.uname.version
-          ),
-          cpu: Cucumber::Messages::Meta::Product.new(
+          },
+          cpu: {
               name: RbConfig::CONFIG['target_cpu']
-          ),
+          },
           ci: detect_ci(env)
-      )
+      }
     end
 
     def detect_ci(env)
@@ -41,44 +43,16 @@ module Cucumber
       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(
+          git: {
               remote: remove_userinfo_from_url(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]
+          }.delete_if {|k,v| v.nil?}
+      }
     end
 
     def remove_userinfo_from_url(value)
@@ -92,6 +66,6 @@ module Cucumber
       end
     end
 
-    module_function :create_meta, :detect_ci, :create_ci, :group1, :evaluate, :remove_userinfo_from_url
+    module_function :create_meta, :detect_ci, :create_ci, :remove_userinfo_from_url
   end
 end

data/lib/cucumber/create_meta/variable_expression.rb

@@ -0,0 +1,41 @@
+module Cucumber
+  module CreateMeta
+    module VariableExpression
+      def evaluate(expression, env)
+        return nil if expression.nil?
+        begin
+          expression.gsub(/\${(.*?)(?:(?<!\\)\/(.*)\/(.*))?}/) do
+            variable = $1
+            pattern = $2
+            replacement = $3
+
+            value = get_value(variable, env)
+            raise "Undefined variable #{variable}" if value.nil?
+            if pattern.nil?
+              value
+            else
+              regexp = Regexp.new(pattern.gsub('\/', '/'))
+              match = value.match(regexp)
+              raise "No match for variable #{variable}" if match.nil?
+              match[1..-1].each_with_index do |group, i|
+                replacement = replacement.gsub("\\#{i+1}", group)
+              end
+              replacement
+            end
+          end
+        rescue
+          nil
+        end
+      end
+
+      def get_value(variable, env)
+        if variable.index('*')
+          env.each do |name, value|
+            return value if Regexp.new(variable.gsub('*', '.*')) =~ name
+          end
+        end
+        env[variable]
+      end
+    end
+  end
+end

data/spec/cucumber/create_meta_spec.rb

@@ -1,16 +1,16 @@
 require 'cucumber/create_meta'
 
-describe 'createMeta' do
+describe 'create_meta' 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(/.+/)
+    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

data/spec/cucumber/evaluate_variable_expression_spec.rb

@@ -0,0 +1,38 @@
+require 'cucumber/create_meta'
+
+describe 'Cucumber::CreateMeta::VariableExpression.evaluate' do
+  include Cucumber::CreateMeta::VariableExpression
+
+  it 'returns nil when a variable is undefined' do
+    expression = "hello-${SOME_VAR}";
+    result = evaluate(expression, {});
+    expect(result).to eq(nil)
+  end
+
+  it 'gets a value without replacement' do
+    expression = "${SOME_VAR}";
+    result = evaluate(expression, {'SOME_VAR' => 'some_value'});
+    expect(result).to eq('some_value')
+  end
+
+  it 'captures a group' do
+    expression = "${SOME_REF/refs\/heads\/(.*)/\\1}";
+    result = evaluate(expression, {'SOME_REF' => 'refs/heads/main'});
+    expect(result).to eq('main')
+  end
+
+  it 'works with star wildcard in var' do
+    expression = "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}";
+    result = evaluate(expression, {'GO_SCM_MY_MATERIAL_PR_BRANCH' => 'ashwankthkumar:feature-1'});
+    expect(result).to eq('feature-1')
+  end
+
+  it 'evaluates a complex expression' do
+    expression = "hello-${VAR1}-${VAR2/(.*) (.*)/\\2-\\1}-world";
+    result = evaluate(expression, {
+      'VAR1' => 'amazing',
+      'VAR2' => 'gorgeous beautiful'
+    })
+    expect(result).to eq('hello-amazing-beautiful-gorgeous-world')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-create-meta
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Vincent Prêtre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '16.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 15.0.0
+        version: 16.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '16.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 15.0.0
+        version: 16.0.0
 - !ruby/object:Gem::Dependency
   name: sys-uname
   requirement: !ruby/object:Gem::Requirement
@@ -99,8 +99,10 @@ files:
 - LICENSE
 - lib/cucumber/ciDict.json
 - lib/cucumber/create_meta.rb
+- lib/cucumber/create_meta/variable_expression.rb
 - spec/capture_warnings.rb
 - spec/cucumber/create_meta_spec.rb
+- spec/cucumber/evaluate_variable_expression_spec.rb
 - spec/cucumber/remove_userinfo_from_url_spec.rb
 homepage: https://github.com/cucumber/create-meta-ruby
 licenses:
@@ -130,8 +132,9 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: cucumber-create-meta-4.0.0
+summary: cucumber-create-meta-5.0.0
 test_files:
 - spec/capture_warnings.rb
 - spec/cucumber/create_meta_spec.rb
+- spec/cucumber/evaluate_variable_expression_spec.rb
 - spec/cucumber/remove_userinfo_from_url_spec.rb