solidus_dev_support 1.5.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2320ceaf62d68e7e76f5ebd54a77ed582fddbc0f4933caaba3f823d8f8ebb53f
-  data.tar.gz: 765116a27d6167455eee850837d71aee6d807a1ff1437efa916c0890db2e638a
+  metadata.gz: 0bf90c2bc57b80b7ac05afe68db8c72f7c5156ac479e8fee99d61f38d48ce3b4
+  data.tar.gz: '0830edb6f1562d5b58345c9b79702f1d70aab2c5051cc03570772f5dbbef789d'
 SHA512:
-  metadata.gz: a263c2ce6e5ce6de123cb52e4e1a9457be7979b2eb811de170efbbfd5c10b774a697efa116899e08a75e5f1062b6f878d8796d543d172d1b369a760089425e70
-  data.tar.gz: 12a2731dadf62796e4880f7911eb14125691e9fc7886b8bcbde881705a218334e36ac1d5d4602594836fc9de4df0c1eca5b36ecce557522085bae2ce7ccb4970
+  metadata.gz: 2afaf6d12de41f7748891da69a9b02a769af1b30bd8124e65378c1633a79a951c608a7d30a5e47267ac3c631029c781a96e6f07e61405e970c7434dd136e27dc
+  data.tar.gz: 4db74c432e1bc63e853c195d95d24e3ee7ed97854e0386ebea3ea4533bed82dbe23ee4eff46040d8b7603a126154a9d8fe91c7d899ca81e04a752ff49f40c48b

data/.circleci/config.yml

@@ -7,35 +7,27 @@ orbs:
   # or goes EOL.
   solidusio_extensions: solidusio/extensions@volatile
 
-executors:
-  # We don't rely directly on the DB, but we still want to ensure generated
-  # extensions are able to connect and spin up Solidus. Using an in-memory
-  # SQLite makes it blazingly fast.
-  sqlite-memory:
-    docker:
-       - image: circleci/ruby:2.5.6-node-browsers
-         environment:
-           RAILS_ENV: test
-           DB: sqlite
-           DATABASE_URL: sqlite3::memory:?pool=1
-           DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: true
-
 commands:
   setup:
     steps:
       - checkout
-      - run: "gem install bundler -v '>=2' --conservative"
+      - run:
+          command: "gem install bundler -v '>=2' --conservative"
+          no_output_timeout: 20m
 
 jobs:
   solidus-master:
-    executor: sqlite-memory
+    executor: solidusio_extensions/sqlite-memory
     steps: ['setup', 'solidusio_extensions/run-tests-solidus-master']
   solidus-current:
-    executor: sqlite-memory
+    executor: solidusio_extensions/sqlite-memory
     steps: ['setup', 'solidusio_extensions/run-tests-solidus-current']
   solidus-older:
-    executor: sqlite-memory
+    executor: solidusio_extensions/sqlite-memory
     steps: ['setup', 'solidusio_extensions/run-tests-solidus-older']
+  lint-code:
+    executor: solidusio_extensions/sqlite-memory
+    steps: ['setup', 'solidusio_extensions/lint-code']
 
 workflows:
   "Run specs on supported Solidus versions":
@@ -43,6 +35,7 @@ workflows:
       - solidus-master
       - solidus-current
       - solidus-older
+      - lint-code
 
   "Weekly run specs against master":
     triggers:

data/.mergify.yml

@@ -34,6 +34,8 @@ pull_request_rules:
       - base=master
       - -label="needs changelog label"
       - -label=blocked
+      - "#approved-reviews-by>=1"
+      - -draft
     actions:
       merge:
         method: merge

data/.rubocop.yml

@@ -1,11 +1,53 @@
 inherit_from:
   - https://relaxed.ruby.style/rubocop.yml
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
 AllCops:
+  TargetRubyVersion: 2.5
   Exclude:
     - tmp/**/*
+    - "vendor/**/*"
+    # Generated binstubs
+    - bin/rake
+  NewCops: enable
 
 Style/FrozenStringLiteralComment:
   Exclude:
     - "**/bin/*"
     - "**/exe/*"
+    - "spec/**/*"
+

data/CHANGELOG.md

@@ -1,5 +1,77 @@
 # Changelog
 
+## [2.2.0](https://github.com/solidusio/solidus_dev_support/tree/2.2.0) (2020-11-27)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.1.0...2.2.0)
+
+**Implemented enhancements:**
+
+- Improve the URL generation for the gemspec and Readme \(defaulting to the solidusio-contrib organization\), consistently use a file-based Changelog [\#159](https://github.com/solidusio/solidus_dev_support/pull/159) ([elia](https://github.com/elia))
+- Configuration Cleanup [\#158](https://github.com/solidusio/solidus_dev_support/pull/158) ([elia](https://github.com/elia))
+- Refer to Solidus wiki page for gem release info [\#157](https://github.com/solidusio/solidus_dev_support/pull/157) ([spaghetticode](https://github.com/spaghetticode))
+- Upgrade to RuboCop 1.0 [\#156](https://github.com/solidusio/solidus_dev_support/pull/156) ([aldesantis](https://github.com/aldesantis))
+- Add a command to display gem's version [\#154](https://github.com/solidusio/solidus_dev_support/pull/154) ([igorbp](https://github.com/igorbp))
+
+**Fixed bugs:**
+
+- Require "webdrivers" before using it as the default javascript driver [\#152](https://github.com/solidusio/solidus_dev_support/pull/152) ([ccarruitero](https://github.com/ccarruitero))
+
+**Merged pull requests:**
+
+- Don't let mergify mark a PR as red because it's missing a review [\#153](https://github.com/solidusio/solidus_dev_support/pull/153) ([elia](https://github.com/elia))
+
+## [v2.1.0](https://github.com/solidusio/solidus_dev_support/tree/v2.1.0) (2020-10-02)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.0.1...v2.1.0)
+
+**Implemented enhancements:**
+
+- Add standard github\_changelog\_generator configuration [\#151](https://github.com/solidusio/solidus_dev_support/pull/151) ([aldesantis](https://github.com/aldesantis))
+- Move generated factories to `testing\_support/` [\#150](https://github.com/solidusio/solidus_dev_support/pull/150) ([aldesantis](https://github.com/aldesantis))
+- Add extension configuration boilerplate [\#149](https://github.com/solidusio/solidus_dev_support/pull/149) ([aldesantis](https://github.com/aldesantis))
+
+**Fixed bugs:**
+
+- Fix `NewCops: Enable` option for RuboCop [\#148](https://github.com/solidusio/solidus_dev_support/pull/148) ([aldesantis](https://github.com/aldesantis))
+
+## [v2.0.1](https://github.com/solidusio/solidus_dev_support/tree/v2.0.1) (2020-09-22)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v2.0.0...v2.0.1)
+
+**Fixed bugs:**
+
+- Fix gem\_version not being found during extension generation [\#144](https://github.com/solidusio/solidus_dev_support/pull/144) ([aldesantis](https://github.com/aldesantis))
+
+## [v2.0.0](https://github.com/solidusio/solidus_dev_support/tree/v2.0.0) (2020-09-22)
+
+[Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.5.0...v2.0.0)
+
+**Breaking changes:**
+
+- Switch the JS driver to WebDriver/Selenium [\#136](https://github.com/solidusio/solidus_dev_support/pull/136) ([elia](https://github.com/elia))
+
+**Implemented enhancements:**
+
+- Enable new RuboCop cops automatically [\#143](https://github.com/solidusio/solidus_dev_support/pull/143) ([aldesantis](https://github.com/aldesantis))
+- Don't forcefully close issues via stale-bot [\#139](https://github.com/solidusio/solidus_dev_support/pull/139) ([elia](https://github.com/elia))
+- Add the approximate recommendation for dev-support to the gemspec [\#137](https://github.com/solidusio/solidus_dev_support/pull/137) ([elia](https://github.com/elia))
+- Let the extension name include spaces [\#133](https://github.com/solidusio/solidus_dev_support/pull/133) ([elia](https://github.com/elia))
+- Add precompiled badges fro CI and coverage [\#132](https://github.com/solidusio/solidus_dev_support/pull/132) ([elia](https://github.com/elia))
+- Add Changelog Rake task [\#128](https://github.com/solidusio/solidus_dev_support/pull/128) ([tvdeyen](https://github.com/tvdeyen))
+- Readme fixes [\#122](https://github.com/solidusio/solidus_dev_support/pull/122) ([elia](https://github.com/elia))
+
+**Fixed bugs:**
+
+- fix capybara driver declaration [\#141](https://github.com/solidusio/solidus_dev_support/pull/141) ([ccarruitero](https://github.com/ccarruitero))
+- Bump RuboCop to latest 0.90.0 version [\#138](https://github.com/solidusio/solidus_dev_support/pull/138) ([peterberkenbosch](https://github.com/peterberkenbosch))
+- Fix missing backslash in solidus install command [\#135](https://github.com/solidusio/solidus_dev_support/pull/135) ([nirebu](https://github.com/nirebu))
+- Don't install a payment-method in the sandbox [\#131](https://github.com/solidusio/solidus_dev_support/pull/131) ([elia](https://github.com/elia))
+- Run extension generator in sandbox [\#127](https://github.com/solidusio/solidus_dev_support/pull/127) ([elia](https://github.com/elia))
+
+**Merged pull requests:**
+
+- Update readme template [\#109](https://github.com/solidusio/solidus_dev_support/pull/109) ([aldesantis](https://github.com/aldesantis))
+
 ## [v1.5.0](https://github.com/solidusio/solidus_dev_support/tree/v1.5.0) (2020-06-13)
 
 [Full Changelog](https://github.com/solidusio/solidus_dev_support/compare/v1.4.0...v1.5.0)

data/Gemfile

@@ -15,10 +15,10 @@ gem 'rails', '>0.a'
 
 # These gems will be used by the temporary extensions generated by tests
 group :test do
-  gem 'solidus_auth_devise'
   gem 'factory_bot', '> 4.10.0'
   gem 'mysql2'
   gem 'pg'
+  gem 'solidus_auth_devise'
   gem 'sqlite3'
 end
 

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.
 
@@ -230,9 +232,16 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 the tests. You can also run `bin/console` for an interactive prompt that will allow you to
 experiment.
 
-To install this gem onto your local machine, run `bin/rake install`. To release a new
-version, update the version number in `version.rb`, and then run `bin/rake release`, which
-will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+To install this gem onto your local machine, run `bin/rake install`.
+
+To release a new version:
+
+1. update the version number in `version.rb`
+2. update the changelog with `bin/rake changelog`
+3. commit the changes using `Bump SolidusDevSupport to 1.2.3` as the message
+3. run `bin/rake release`
+
+The last command will create a git tag for the version, push git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/Rakefile

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
+desc "Update the changelog, specify the version for the unreleased changes appending VERSION=1.2.3 to the command"
+task :changelog do
+  require_relative "lib/solidus_dev_support/version"
+
+  future_release = ENV.fetch("VERSION") {
+    warn "Using current version (#{SolidusDevSupport::VERSION}) for unreleased changes, use VERSION=1.2.3 to select a different one."
+    SolidusDevSupport::VERSION
+  }
+
+  sh "bundle exec github_changelog_generator --project solidus_dev_support --user solidusio --future-release #{future_release}"
+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
@@ -26,6 +28,7 @@ module SolidusDevSupport
         make_executable bin
       end
 
+      template 'CHANGELOG.md', "#{path}/CHANGELOG.md"
       template 'extension.gemspec', "#{path}/#{file_name}.gemspec"
       template 'Gemfile', "#{path}/Gemfile"
       template 'gitignore', "#{path}/.gitignore"
@@ -38,6 +41,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
@@ -47,27 +51,36 @@ module SolidusDevSupport
         @file_name = Thor::Util.snake_case(File.basename(path))
         @file_name = PREFIX + @file_name unless @file_name.start_with?(PREFIX)
 
-        @class_name = Thor::Util.camel_case @file_name
+        @class_name = Thor::Util.camel_case file_name
 
         @root = File.dirname(path)
-        @path = File.join(@root, @file_name)
+        @path = File.join(root, file_name)
+
+        @repo = existing_repo || default_repo
 
         @gemspec = existing_gemspec || default_gemspec
       end
 
+      attr_reader :root, :path, :file_name, :class_name, :gemspec, :repo
+
+      private
+
       def gemspec_path
         @gemspec_path ||= File.join(path, "#{file_name}.gemspec")
       end
 
       def default_gemspec
-        @default_gemspec ||= Gem::Specification.new(@file_name, '0.0.1') do |gem|
+        @default_gemspec ||= Gem::Specification.new(file_name, '0.0.1') do |gem|
           gem.author = git('config user.name', 'TODO: Write your name')
-          gem.description = 'TODO: Write a longer description or delete this line.'
           gem.email = git('config user.email', 'TODO: Write your email address')
-          gem.homepage = default_homepage
-          gem.license = 'BSD-3-Clause'
-          gem.metadata['changelog_uri'] = default_homepage + '/releases'
+
           gem.summary = 'TODO: Write a short summary, because RubyGems requires one.'
+          gem.description = 'TODO: Write a longer description or delete this line.'
+          gem.license = 'BSD-3-Clause'
+
+          gem.metadata['homepage_uri'] = gem.homepage = "https://github.com/#{repo}#readme"
+          gem.metadata['changelog_uri'] = "https://github.com/#{repo}/blob/master/CHANGELOG.md"
+          gem.metadata['source_code_uri'] = "https://github.com/#{repo}"
         end
       end
 
@@ -77,28 +90,26 @@ module SolidusDevSupport
         @existing_gemspec ||= Gem::Specification.load(gemspec_path).tap do |spec|
           spec.author ||= default_gemspec.author
           spec.email ||= default_gemspec.email
-          spec.homepage ||= default_gemspec.homepage
-          spec.license ||= default_gemspec.license
-          spec.metadata['changelog_uri'] ||= default_gemspec.metadata[:changelog_uri]
+
           spec.summary ||= default_gemspec.summary
+          spec.license ||= default_gemspec.license
+
+          spec.homepage ||= default_gemspec.homepage
+          spec.metadata['source_code_uri'] ||= default_gemspec.metadata['source_code_uri']
+          spec.metadata['changelog_uri'] ||= default_gemspec.metadata['changelog_uri']
+          spec.metadata['source_code_uri'] ||= default_gemspec.metadata['source_code_uri']
         end
       end
 
-      def default_homepage
-        @default_homepage ||= git(
-          'remote get-url origin',
-          "git@github.com:#{github_user}/#{file_name}.git"
-        ).sub(
-          %r{^.*github\.com.([^/]+)/([^/\.]+).*$},
-          'https://github.com/\1/\2'
-        )
+      def default_repo
+        "solidusio-contrib/#{file_name}"
       end
 
-      def github_user
-        @github_user ||= git('config github.user', '[USERNAME]')
+      def existing_repo
+        git('remote get-url origin')&.sub(%r{^.*github\.com.([^/]+)/([^/.]+).*$}, '\1/\2')
       end
 
-      def git(command, default)
+      def git(command, default = nil)
         result = `git #{command} 2> /dev/null`.strip
         result.empty? ? default : result
       end
@@ -108,8 +119,6 @@ module SolidusDevSupport
         executable = (path.stat.mode | 0o111)
         path.chmod(executable)
       end
-
-      attr_reader :root, :path, :file_name, :class_name, :gemspec
     end
 
     def self.source_root

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,18 @@ module SolidusDevSupport
         end
       end
     end
+
+    def install_changelog_task
+      require 'github_changelog_generator/task'
+
+      GitHubChangelogGenerator::RakeTask.new(:changelog) do |config|
+        require 'octokit'
+        repo = Octokit::Repository.from_url(gemspec.metadata['source_code_uri'] || gemspec.homepage)
+
+        config.user = repo.owner
+        config.project = repo.name
+        config.future_release = "v#{ENV['UNRELEASED_VERSION'] || gemspec.version}"
+      end
+    end
   end
 end

data/lib/solidus_dev_support/rspec/capybara.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'webdrivers/chromedriver'
+
+# 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