Add additional tasks, some grammar fixes, main readme file

andrcuns · andrcuns · commit 4e9a76a89a31 · 2019-05-15T09:06:11.000+03:00
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# Allure ruby
+
+Ruby testing framework adaptors for generating allure compatible test reports
+
+## allure-ruby-commons
+
+```ruby
+gem "allure-ruby-commons"
+```
+
+## allure-cucumber
+
+```ruby
+gem "allure-cucumber
+```
diff --git a/Rakefile b/Rakefile
@@ -1,22 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "tasks/test"
 require_relative "tasks/release"
 
+desc "Run all tests by default"
+task default: :test
+
 desc "Build gem files for all projects"
 task build: "all:build"
 
 desc "Release all gems to rubygems"
 task release: "all:push"
-
-desc "Run all tests by default"
-task default: :test
-
-%w[test rubocop gem].each do |task_name|
-  desc "Run #{task_name} for all projects"
-  task task_name do
-    errors = FRAMEWORKS.each_with_object([]) do |project, a|
-      system(%(cd #{project} && #{$PROGRAM_NAME} #{task_name} --trace)) || a << project
-    end
-    raise Exception.new("Errors in #{errors.join(', ')}") unless errors.empty?
-  end
-end
diff --git a/allure-cucumber/README.md b/allure-cucumber/README.md
@@ -89,4 +89,4 @@ Allure.add_link("Custom Url", "http://www.github.com")
 ```
 
 ## How to generate report
-This adapter only generates json files containing information about tests. See [wiki section](https://docs.qameta.io/allure/#_reporting) on how to generate report.
+This adaptor only generates json files containing information about tests. See [wiki section](https://docs.qameta.io/allure/#_reporting) on how to generate report.
diff --git a/allure-cucumber/Rakefile b/allure-cucumber/Rakefile
@@ -4,7 +4,7 @@ require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:test) do |t|
-  t.rspec_opts = "--color --require spec_helper --format documentation --tag ~integration"
+  t.rspec_opts = "--color --require spec_helper"
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
diff --git a/allure-cucumber/allure-cucumber.gemspec b/allure-cucumber/allure-cucumber.gemspec
@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = "allure-cucumber"
   s.version = version
-  s.summary = "Allure cucumber ruby adapter"
-  s.description = "Cucumber adapter to generate rich allure test reports"
+  s.summary = "Allure cucumber ruby adaptor"
+  s.description = "Cucumber adaptor to generate rich allure test reports"
 
   s.required_ruby_version = ">= 2.5.0"
 
diff --git a/allure-ruby-commons/Rakefile b/allure-ruby-commons/Rakefile
@@ -4,7 +4,7 @@ require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:test) do |t|
-  t.rspec_opts = "--color --require spec_helper --format documentation --tag ~integration"
+  t.rspec_opts = "--color --require spec_helper --tag ~integration"
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|
diff --git a/allure-ruby-commons/lib/allure-ruby-commons.rb b/allure-ruby-commons/lib/allure-ruby-commons.rb
@@ -5,7 +5,7 @@
 require "uuid"
 require_rel "allure_ruby_commons/**/*rb"
 
-# Namespace for classes that handle allure report generation and different framework adapters
+# Namespace for classes that handle allure report generation and different framework adaptors
 module Allure
   class << self
     # Get thread specific allure lifecycle object
diff --git a/allure-ruby-commons/lib/allure_ruby_commons/util.rb b/allure-ruby-commons/lib/allure_ruby_commons/util.rb
@@ -14,7 +14,7 @@ class << self
       # Download allure bin if appropriate version is not in path
       # @return [String] allure executable
       def allure_cli
-        return "allure" if Version::ALLURE == `allure --version`.chomp
+        return "allure" if ALLURE_CLI_VERSION == `allure --version`.chomp
 
         cli_dir = File.join(".allure", "allure-#{ALLURE_CLI_VERSION}")
         zip = File.join(".allure", "allure.zip")
diff --git a/allure.gemspec b/allure.gemspec
@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = "allure-ruby"
   s.version = version
-  s.summary = "Allure ruby commons and ruby testing framework adapters"
+  s.summary = "Allure ruby commons and ruby testing framework adaptors"
 
   s.required_ruby_version = ">= 2.5.0"
 
diff --git a/tasks/release.rb b/tasks/release.rb
@@ -1,39 +1,33 @@
 # frozen_string_literal: true
 
-FRAMEWORKS = %w[allure-ruby-commons allure-cucumber].freeze
-
 root = File.expand_path("..", __dir__)
 version = File.read("#{root}/ALLURE_VERSION").strip
 
 directory "pkg"
 
-FRAMEWORKS.each do |framework|
-  namespace framework do
-    gem = "pkg/#{framework}-#{version}.gem"
-    gemspec = "#{framework}.gemspec"
+ADAPTORS.each do |adaptor|
+  namespace adaptor do
+    gem = "pkg/#{adaptor}-#{version}.gem"
+    gemspec = "#{adaptor}.gemspec"
 
     task :clean do
       rm_f gem
     end
 
     task gem: "pkg" do
-      sh "cd #{framework} && gem build #{gemspec} && mv #{framework}-#{version}.gem #{root}/pkg/"
+      sh "cd #{adaptor} && gem build #{gemspec} && mv #{adaptor}-#{version}.gem #{root}/pkg/"
     end
 
     task build: %i[clean gem]
 
-    task install: :build do
-      sh "gem install --pre #{gem}"
-    end
-
     task push: :build do
       sh "gem push #{gem}"
     end
   end
 end
 
 namespace :all do
-  task build: FRAMEWORKS.map { |framework| "#{framework}:build" }
-  task install: FRAMEWORKS.map { |framework| "#{framework}:install" }
-  task push: FRAMEWORKS.map { |framework| "#{framework}:push" }
+  task build: ADAPTORS.map { |adaptor| "#{adaptor}:build" }
+  task install: ADAPTORS.map { |adaptor| "#{adaptor}:install" }
+  task push: ADAPTORS.map { |adaptor| "#{adaptor}:push" }
 end
diff --git a/tasks/test.rb b/tasks/test.rb
@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+ADAPTORS = %w[allure-ruby-commons allure-cucumber].freeze
+
+# Run specific task for all adaptors
+%w[test rubocop].each do |task_name|
+  desc "Run #{task_name} for all projects"
+  task task_name do
+    errors = ADAPTORS.each_with_object([]) do |adaptor, a|
+      system("cd #{adaptor} && #{$PROGRAM_NAME} #{task_name}") || a << adaptor
+    end
+    raise Exception.new("Errors in #{errors.join(', ')}") unless errors.empty?
+  end
+end
+
+# Run specific task for single adaptor
+ADAPTORS.each do |adaptor|
+  namespace adaptor do
+    %w[test rubocop].each do |task_name|
+      desc "Run #{task_name} for #{adaptor}"
+      task task_name do
+        system("cd #{adaptor} && #{$PROGRAM_NAME} #{task_name}")
+      end
+    end
+  end
+end
