solidus_dev_support 1.4.0 → 2.1.0

data/README.md

@@ -1,6 +1,8 @@
 # solidus_dev_support
 
-[![CircleCI](https://circleci.com/gh/solidusio/solidus_dev_support.svg?style=svg)](https://circleci.com/gh/solidusio/solidus_dev_support)
+
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_dev_support.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_dev_support)
+[![codecov](https://codecov.io/gh/solidusio/solidus_dev_support/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus_dev_support)
 
 This gem contains common development functionality for Solidus extensions.
 

data/Rakefile

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
+require 'github_changelog_generator/task'
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = 'solidusio'
+  config.project = 'solidus_dev_support'
+  config.exclude_labels = %w[infrastructure]
+  config.issues = false
+  config.base = "#{__dir__}/OLD_CHANGELOG.md"
+  config.since_tag = 'v1.4.0'
+end
+
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/lib/solidus_dev_support/extension.rb

@@ -3,6 +3,8 @@
 require 'thor'
 require 'pathname'
 
+require 'solidus_dev_support/version'
+
 module SolidusDevSupport
   class Extension < Thor
     include Thor::Actions
@@ -38,6 +40,7 @@ module SolidusDevSupport
       template 'rspec', "#{path}/.rspec"
       template 'spec/spec_helper.rb.tt', "#{path}/spec/spec_helper.rb"
       template 'rubocop.yml', "#{path}/.rubocop.yml"
+      template 'github_changelog_generator', "#{path}/.github_changelog_generator"
     end
 
     no_tasks do
@@ -89,7 +92,7 @@ module SolidusDevSupport
           'remote get-url origin',
           "git@github.com:#{github_user}/#{file_name}.git"
         ).sub(
-          %r{^.*github\.com.([^/]+)/([^/\.]+).*$},
+          %r{^.*github\.com.([^/]+)/([^/.]+).*$},
           'https://github.com/\1/\2'
         )
       end

data/lib/solidus_dev_support/rake_tasks.rb

@@ -23,6 +23,7 @@ module SolidusDevSupport
       install_test_app_task
       install_dev_app_task
       install_rspec_task
+      install_changelog_task
     end
 
     def install_test_app_task
@@ -71,5 +72,16 @@ module SolidusDevSupport
         end
       end
     end
+
+    def install_changelog_task
+      require 'github_changelog_generator/task'
+
+      user, project = gemspec.homepage.split("/")[3..5]
+      GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
+        config.user = user || 'solidus-contrib'
+        config.project = project || gemspec.name
+        config.future_release = "v#{gemspec.version}"
+      end
+    end
   end
 end

data/lib/solidus_dev_support/rspec/capybara.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Allow to override the initial windows size
+CAPYBARA_WINDOW_SIZE = (ENV['CAPYBARA_WINDOW_SIZE'] || '1920x1080').split('x', 2).map(&:to_i)
+
+Capybara.javascript_driver = (ENV['CAPYBARA_JAVASCRIPT_DRIVER'] || "solidus_chrome_headless").to_sym
+Capybara.default_max_wait_time = 10
+Capybara.server = :puma, { Silent: true } # A fix for rspec/rspec-rails#1897
+
+Capybara.drivers[:selenium_chrome_headless].tap do |original_driver|
+  Capybara.register_driver :solidus_chrome_headless do |app|
+    original_driver.call(app).tap do |driver|
+      driver.options[:options].args << "--window-size=#{CAPYBARA_WINDOW_SIZE.join(',')}"
+    end
+  end
+end
+
+require 'spree/testing_support/capybara_ext'

data/lib/solidus_dev_support/rspec/feature_helper.rb

@@ -10,30 +10,29 @@
 require 'solidus_dev_support/rspec/rails_helper'
 
 require 'capybara-screenshot/rspec'
-require 'capybara/apparition'
+require 'solidus_dev_support/rspec/capybara'
 
-Capybara.javascript_driver = (ENV['CAPYBARA_DRIVER'] || :apparition).to_sym
-Capybara.default_max_wait_time = 10
-Capybara.server = :puma, { Silent: true } # A fix for rspec/rspec-rails#1897
-
-Capybara.register_driver :apparition do |app|
-  Capybara::Apparition::Driver.new(app, window_size: [1920, 1080])
+def dev_support_assets_preload
+  if Rails.application.respond_to?(:precompiled_assets)
+    Rails.application.precompiled_assets
+  else
+    # For older sprockets 2.x
+    Rails.application.config.assets.precompile.each do |asset|
+      Rails.application.assets.find_asset(asset)
+    end
+  end
 end
 
-require 'spree/testing_support/capybara_ext'
-
 RSpec.configure do |config|
   config.when_first_matching_example_defined(type: :feature) do
     config.before :suite do
-      # Preload assets
-      if Rails.application.respond_to?(:precompiled_assets)
-        Rails.application.precompiled_assets
-      else
-        # For older sprockets 2.x
-        Rails.application.config.assets.precompile.each do |asset|
-          Rails.application.assets.find_asset(asset)
-        end
-      end
+      dev_support_assets_preload
+    end
+  end
+
+  config.when_first_matching_example_defined(type: :system) do
+    config.before :suite do
+      dev_support_assets_preload
     end
   end
 end

data/lib/solidus_dev_support/rspec/rails_helper.rb

@@ -67,14 +67,17 @@ RSpec.configure do |config|
   rescue NameError => e
     class ZeitwerkNameError < NameError; end
 
-    message = <<~WARN
-      Zeitwerk raised the following error when trying to eager load your extension:
-
-      #{if e.message =~ /expected file .*? to define constant [\w:]+/
+    error_message =
+      if e.message =~ /expected file .*? to define constant [\w:]+/
         e.message.sub(/expected file #{Regexp.escape(File.expand_path('../..', Rails.root))}./, "expected file ")
       else
         e.message
-      end}
+      end
+
+    message = <<~WARN
+      Zeitwerk raised the following error when trying to eager load your extension:
+
+      #{error_message}
 
       This most likely means that your extension's file structure is not
       compatible with the Zeitwerk autoloader.

data/lib/solidus_dev_support/rubocop/config.yml

@@ -1,203 +1,82 @@
-# Relaxed.Ruby.Style
-## Version 2.4
-
-Style/Alias:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylealias
-
-Style/AsciiComments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
-
-Style/BeginBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
-
-Style/BlockDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
-
-Style/CommentAnnotation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
-
-Style/Documentation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledocumentation
-
-Layout/DotPosition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
-
-Style/DoubleNegation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
-
-Style/EndBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleendblock
-
-Style/FormatString:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleformatstring
-
-Style/IfUnlessModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
-
-Style/Lambda:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylelambda
-
-Style/ModuleFunction:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
-
-Style/MultilineBlockChain:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
-
-Style/NegatedIf:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
-
-Style/NegatedWhile:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
-
-Style/NumericPredicate:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
-
-Style/ParallelAssignment:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
-
-Style/PerlBackrefs:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
-
-Style/Semicolon:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
-
-Style/SignalException:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
-
-Style/SingleLineBlockParams:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
-
-Style/SingleLineMethods:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
-
-Layout/SpaceInsideParens:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
-
-Style/SpecialGlobalVars:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
-
-Style/StringLiterals:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
-
-Style/TrailingCommaInArguments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
-
-Style/SymbolArray:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
-
-Style/WhileUntilModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
-
-Style/WordArray:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewordarray
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
-
-Lint/AssignmentInCondition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockNesting:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-# Metrics/LineLength:
-#   Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-# Our overrides after this point:
-
-require:
-  - rubocop-rspec
-  - rubocop-rails
-  - rubocop-performance
-
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - spec/dummy/**/*
-    - sandbox/**/*
-    - vendor/**/*
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: true
-  Max: 100
-
-RSpec/ExampleLength:
-  Enabled: false
-
-Layout/AlignArguments:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/MultilineOperationIndentation:
-  Enabled: false
+require: ["rubocop-rspec", "rubocop-rails", "rubocop-performance"]
+
+AllCops: {TargetRubyVersion: 2.5, Exclude: ["spec/dummy/**/*", "sandbox/**/*", "vendor/**/*"]}
+
+Layout/ArgumentAlignment: {EnforcedStyle: with_fixed_indentation}
+Layout/DotPosition: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutdotposition"}
+Layout/EmptyLinesAroundAttributeAccessor: {Enabled: true}
+Layout/FirstArgumentIndentation: {EnforcedStyle: "consistent"}
+Layout/FirstArrayElementIndentation: {EnforcedStyle: "consistent"}
+Layout/LineLength: {Enabled: true, Max: 120}
+Layout/MultilineOperationIndentation: {Enabled: false}
+Layout/SpaceAroundMethodCallOperator: {Enabled: true}
+Layout/SpaceBeforeBlockBraces: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutspacebeforeblockbraces"}
+Layout/SpaceInsideParens: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutspaceinsideparens"}
+Lint/AmbiguousRegexpLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#lintambiguousregexpliteral"}
+Lint/AssignmentInCondition: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#lintassignmentincondition"}
+Lint/DeprecatedOpenSSLConstant: {Enabled: true}
+Lint/MixedRegexpCaptureTypes: {Enabled: true}
+Lint/RaiseException: {Enabled: true}
+Lint/StructNewOverride: {Enabled: true}
+Metrics/AbcSize: {Enabled: false}
+Metrics/BlockLength: {Enabled: false}
+Metrics/BlockNesting: {Enabled: false}
+Metrics/ClassLength: {Enabled: false}
+Metrics/CyclomaticComplexity: {Enabled: false}
+Metrics/MethodLength: {Enabled: false}
+Metrics/ModuleLength: {Enabled: false}
+Metrics/ParameterLists: {Enabled: false}
+Metrics/PerceivedComplexity: {Enabled: false}
+Performance/AncestorsInclude: {Enabled: true}
+Performance/BigDecimalWithNumericArgument: {Enabled: true}
+Performance/RedundantSortBlock: {Enabled: true}
+Performance/RedundantStringChars: {Enabled: true}
+Performance/ReverseFirst: {Enabled: true}
+Performance/SortReverse: {Enabled: true}
+Performance/Squeeze: {Enabled: true}
+Performance/StringInclude: {Enabled: true}
+RSpec/DescribeClass: {Exclude: ["spec/features/**/*"]} # Feature specs are not describing any class or module.
+RSpec/ExampleLength: {Enabled: false}
+Style/AccessorGrouping: {Enabled: true}
+Style/Alias: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylealias"}
+Style/AsciiComments: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleasciicomments"}
+Style/BeginBlock: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylebeginblock"}
+Style/BisectedAttrAccessor: {Enabled: true}
+Style/BlockDelimiters: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleblockdelimiters"}
+Style/CommentAnnotation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylecommentannotation"}
+Style/Documentation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styledocumentation"}
+Style/DoubleNegation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styledoublenegation"}
+Style/EndBlock: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleendblock"}
+Style/ExponentialNotation: {Enabled: true}
+Style/FormatString: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleformatstring"}
+Style/FrozenStringLiteralComment: {Exclude: ["spec/**/*", "db/migrate/**/*", "bin/**/*"]}
+Style/HashEachMethods: {Enabled: true}
+Style/HashTransformKeys: {Enabled: true}
+Style/HashTransformValues: {Enabled: true}
+Style/IfUnlessModifier: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleifunlessmodifier"}
+Style/Lambda: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylelambda"}
+Style/ModuleFunction: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylemodulefunction"}
+Style/MultilineBlockChain: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylemultilineblockchain"}
+Style/NegatedIf: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenegatedif"}
+Style/NegatedWhile: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenegatedwhile"}
+Style/NumericPredicate: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenumericpredicate"}
+Style/ParallelAssignment: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleparallelassignment"}
+Style/PercentLiteralDelimiters: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylepercentliteraldelimiters"}
+Style/PerlBackrefs: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleperlbackrefs"}
+Style/RedundantAssignment: {Enabled: true}
+Style/RedundantFetchBlock: {Enabled: true}
+Style/RedundantRegexpCharacterClass: {Enabled: true}
+Style/RedundantRegexpEscape: {Enabled: true}
+Style/Semicolon: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesemicolon"}
+Style/SignalException: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesignalexception"}
+Style/SingleLineBlockParams: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesinglelineblockparams"}
+Style/SingleLineMethods: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesinglelinemethods"}
+Style/SlicingWithRange: {Enabled: true}
+Style/SpecialGlobalVars: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylespecialglobalvars"}
+Style/StringLiterals: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylestringliterals"}
+Style/SymbolArray: {Enabled: false, StyleGuide: "http://relaxed.ruby.style/#stylesymbolarray"}
+Style/TrailingCommaInArguments: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainarguments"}
+Style/TrailingCommaInArrayLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainarrayliteral"}
+Style/TrailingCommaInHashLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainhashliteral"}
+Style/WhileUntilModifier: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylewhileuntilmodifier"}
+Style/WordArray: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylewordarray"}