solidus_dev_support 1.2.0 → 2.0.0

data/lib/solidus_dev_support/solidus_command.rb

@@ -18,4 +18,3 @@ module SolidusDevSupport
     end
   end
 end
-

data/lib/solidus_dev_support/templates/extension/.circleci/config.yml

@@ -16,12 +16,18 @@ jobs:
     executor: solidusio_extensions/mysql
     steps:
       - solidusio_extensions/run-tests
+  lint-code:
+    executor: solidusio_extensions/sqlite-memory
+    steps:
+      - solidusio_extensions/lint-code
 
 workflows:
   "Run specs on supported Solidus versions":
     jobs:
       - run-specs-with-postgres
       - run-specs-with-mysql
+      - lint-code
+
   "Weekly run specs against master":
     triggers:
       - schedule:

data/lib/solidus_dev_support/templates/extension/.github/stale.yml

@@ -1,17 +1,17 @@
 # Number of days of inactivity before an issue becomes stale
 daysUntilStale: 60
 # Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
+daysUntilClose: false
 # Issues with these labels will never be considered stale
 exemptLabels:
   - pinned
   - security
 # Label to use when marking an issue as stale
-staleLabel: wontfix
+staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable
 markComment: >
   This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
+  recent activity. It might be closed if no further activity occurs. Thank you
   for your contributions.
 # Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
+closeComment: false

data/lib/solidus_dev_support/templates/extension/README.md

@@ -1,10 +1,15 @@
-<%= class_name %>
-<%= "=" * class_name.size %>
+# <%= class_name.gsub(/(?<=[^A-Z])([A-Z])/, ' \1') %>
 
-Introduction goes here.
+<!-- Replace REPO_ORG and uncomment the following to show badges for CI and coverage. -->
 
-Installation
-------------
+<!--
+[![CircleCI](https://circleci.com/gh/REPO_ORG/<%= file_name %>.svg?style=shield)](https://circleci.com/gh/REPO_ORG/<%= file_name %>)
+[![codecov](https://codecov.io/gh/REPO_ORG/<%= file_name %>/branch/master/graph/badge.svg)](https://codecov.io/gh/REPO_ORG/<%= file_name %>)
+-->
+
+[Explain what your extension does.]
+
+## Installation
 
 Add <%= file_name %> to your Gemfile:
 
@@ -15,17 +20,22 @@ gem '<%= file_name %>'
 Bundle your dependencies and run the installation generator:
 
 ```shell
-bundle
-bundle exec rails g <%= file_name %>:install
+bin/rails generate <%= file_name %>:install
 ```
 
-Testing
--------
+## Usage
+
+[Explain how to use your extension once it's been installed.]
+
+## Development
 
-First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `bin/rake extension:test_app`.
+### Testing the extension
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
+app if it does not exist, then it will run specs. The dummy app can be regenerated by using
+`bin/rake extension:test_app`.
 
 ```shell
-bundle
 bin/rake
 ```
 
@@ -42,16 +52,15 @@ Simply add this require statement to your spec_helper:
 require '<%= file_name %>/factories'
 ```
 
-Sandbox app
------------
+### Running the sandbox
 
-To run this extension in a sandboxed Solidus application you can run `bin/sandbox`
-The path for the sandbox app is `./sandbox` and `bin/rails` will forward any Rails command
-to `sandbox/bin/rails`.
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
 
-Example:
+Here's an example:
 
-```shell
+```
 $ bin/rails server
 => Booting Puma
 => Rails 6.0.2.1 application starting in development
@@ -59,13 +68,29 @@ $ bin/rails server
 Use Ctrl-C to stop
 ```
 
-Releasing
----------
+### Updating the changelog
+
+Before and after releases the changelog should be updated to reflect the up-to-date status of
+the project:
+
+```shell
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
+```
+
+### Releasing new versions
 
 Your new extension version can be released using `gem-release` like this:
 
 ```shell
-bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+bundle exec gem bump -v 1.6.0
+bin/rake changelog
+git commit -a --amend
+git push
+bundle exec gem release
 ```
 
-Copyright (c) <%= Time.now.year %> [name of extension creator], released under the New BSD License
+## License
+
+Copyright (c) <%= Time.now.year %> [name of extension author], released under the New BSD License.

data/lib/solidus_dev_support/templates/extension/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/lib/solidus_dev_support/templates/extension/bin/{sandbox_rails → rails-sandbox}

@@ -1,13 +1,11 @@
 #!/usr/bin/env ruby
 
-# frozen_string_literal: true
-
 app_root = 'sandbox'
 
 unless File.exist? "#{app_root}/bin/rails"
   warn 'Creating the sandbox app...'
   Dir.chdir "#{__dir__}/.." do
-    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+    system "#{__dir__}/sandbox" or begin
       warn 'Automatic creation of the sandbox app failed'
       exit 1
     end

data/lib/solidus_dev_support/templates/extension/bin/sandbox.tt

@@ -72,9 +72,11 @@ unbundled bundle exec rails generate spree:install \
   --user_class=Spree::User \
   --enforce_available_locales=true \
   --with-authentication=false \
+  --payment-method=none \
   $@
 
 unbundled bundle exec rails generate solidus:auth:install
+unbundled bundle exec rails generate ${extension_name}:install
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

data/lib/solidus_dev_support/templates/extension/extension.gemspec.tt

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = '<%= gemspec.homepage %>'
   spec.metadata['changelog_uri'] = '<%= gemspec.metadata["changelog_uri"] %>'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.4')
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
-  spec.add_dependency 'solidus_support', '~> 0.4.0'
+  spec.add_dependency 'solidus_support', '~> 0.5'
 
-  spec.add_development_dependency 'solidus_dev_support'
+  spec.add_development_dependency 'solidus_dev_support', '<%= SolidusDevSupport.gem_version.approximate_recommendation %>'
 end

data/lib/solidus_dev_support/templates/extension/gitignore

@@ -15,3 +15,6 @@ pkg
 spec/dummy
 spec/examples.txt
 /sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/lib/solidus_dev_support/templates/extension/lib/generators/%file_name%/install/install_generator.rb.tt

@@ -6,13 +6,13 @@ module <%= class_name %>
       class_option :auto_run_migrations, type: :boolean, default: false
 
       def add_javascripts
-        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/<%= file_name %>\n" # rubocop:disable Metrics/LineLength
-        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/<%= file_name %>\n" # rubocop:disable Metrics/LineLength
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/<%= file_name %>\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/<%= file_name %>\n"
       end
 
       def add_stylesheets
-        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/<%= file_name %>\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
-        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/<%= file_name %>\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/<%= file_name %>\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/<%= file_name %>\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
       end
 
       def add_migrations
@@ -20,7 +20,7 @@ module <%= class_name %>
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
         if run_migrations
           run 'bin/rails db:migrate'
         else

data/lib/solidus_dev_support/templates/extension/rubocop.yml

@@ -1,7 +1,2 @@
 require:
   - solidus_dev_support/rubocop
-
-AllCops:
-  Exclude:
-    - sandbox/**/*
-    - spec/dummy/**/*

data/lib/solidus_dev_support/templates/extension/spec/spec_helper.rb.tt

@@ -6,14 +6,17 @@ ENV['RAILS_ENV'] = 'test'
 # Run Coverage report
 require 'solidus_dev_support/rspec/coverage'
 
-require File.expand_path('dummy/config/environment.rb', __dir__)
+# Create the dummy app if it's still missing.
+dummy_env = "#{__dir__}/dummy/config/environment.rb"
+system 'bin/rake extension:test_app' unless File.exist? dummy_env
+require dummy_env
 
 # Requires factories and other useful helpers defined in spree_core.
 require 'solidus_dev_support/rspec/feature_helper'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
 
 # Requires factories defined in lib/<%= file_name %>/factories.rb
 require '<%= file_name %>/factories'
@@ -21,4 +24,8 @@ require '<%= file_name %>/factories'
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.use_transactional_fixtures = false
+
+  if Spree.solidus_gem_version < Gem::Version.new('2.11')
+    config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :system
+  end
 end

data/lib/solidus_dev_support/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 module SolidusDevSupport
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
+
+  def self.gem_version
+    Gem::Version.new(VERSION)
+  end
 end

data/solidus_dev_support.gemspec

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'solidus_dev_support/version'
+require_relative 'lib/solidus_dev_support/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'solidus_dev_support'
@@ -16,33 +14,37 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/solidusio/solidus_dev_support'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio/solidus_dev_support/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'apparition', '~> 0.4'
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
   spec.add_dependency 'capybara', '~> 3.29'
   spec.add_dependency 'capybara-screenshot', '~> 1.0'
-  spec.add_dependency 'codecov', '~> 0.1.16'
+  spec.add_dependency 'codecov', '~> 0.2'
   spec.add_dependency 'database_cleaner', '~> 1.7'
   spec.add_dependency 'factory_bot_rails', '~> 5.1'
   spec.add_dependency 'ffaker', '~> 2.13'
   spec.add_dependency 'gem-release', '~> 2.1'
   spec.add_dependency 'github_changelog_generator', '~> 1.15'
   spec.add_dependency 'puma', '~> 4.3'
-  spec.add_dependency 'rspec-rails', '~> 4.0.0.beta3'
   spec.add_dependency 'rspec_junit_formatter'
-  spec.add_dependency 'rubocop', '~> 0.76.0'
+  spec.add_dependency 'rspec-rails', '~> 4.0.0.beta3'
+  spec.add_dependency 'rubocop', '~> 0.90'
   spec.add_dependency 'rubocop-performance', '~> 1.5'
   spec.add_dependency 'rubocop-rails', '~> 2.3'
   spec.add_dependency 'rubocop-rspec', '~> 1.36'
   spec.add_dependency 'solidus_core', ['>= 2.0', '< 3']
+  spec.add_dependency 'webdrivers', '~> 4.4'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/spec/features/create_extension_spec.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open3'
+require 'spec_helper'
+
+RSpec.describe 'Create extension' do
+  include FileUtils
+
+  let(:gem_root) { File.expand_path('../..', __dir__) }
+  let(:solidus_cmd) { "#{gem_root}/exe/solidus" }
+  let(:extension_name) { 'test_extension' }
+  let(:gemspec_name) { "solidus_#{extension_name}.gemspec" }
+  let(:tmp_path) { Pathname.new(gem_root).join('tmp') }
+  let(:install_path) { tmp_path.join("solidus_#{extension_name}") }
+
+  class CommandFailed < StandardError; end
+
+  before do
+    rm_rf(install_path)
+    mkdir_p(tmp_path)
+  end
+
+  def step(method_name)
+    puts "Step #{method_name}"
+    send method_name
+  end
+
+  it 'checks the create extension process' do
+    step :check_solidus_cmd
+    step :check_create_extension
+    step :check_bundle_install
+    step :check_default_task
+    step :check_run_specs
+    step :check_sandbox
+  end
+
+  private
+
+  def check_solidus_cmd
+    cd(tmp_path) do
+      output = `#{solidus_cmd} -h`
+      expect($?).to be_success
+      expect(output).to include('Commands:')
+    end
+  end
+
+  def check_create_extension
+    cd(tmp_path) do
+      output = `#{solidus_cmd} extension #{extension_name}`
+      expect($?).to be_success
+      expect(output).to include(gemspec_name)
+      expect(output).to include('.circleci')
+    end
+
+    cd(install_path) do
+      aggregate_failures do
+        %w[
+          bin/console
+          bin/rails
+          bin/rails-engine
+          bin/rails-sandbox
+          bin/sandbox
+          bin/setup
+        ].each do |bin|
+          bin = Pathname(bin)
+          expect(
+            name: bin,
+            exist: bin.exist?,
+            executable: bin.stat.executable?
+          ).to eq(
+            name: bin,
+            exist: true,
+            executable: true
+          )
+        end
+      end
+    end
+  end
+
+  def check_bundle_install
+    cd(install_path) do
+      open('Gemfile', 'a') { |f| f.puts "gem 'solidus_dev_support', path: '../../..'" }
+    end
+
+    expect { bundle_install }.to raise_error(CommandFailed, /invalid gemspec/)
+
+    # Update gemspec with the required fields
+    gemspec_path = install_path.join(gemspec_name)
+    gemspec = gemspec_path.read.lines
+    gemspec.grep(/spec\.author/).first.replace("  spec.author = 'John Doe'\n")
+    gemspec.grep(/spec\.email/).first.replace("  spec.email = 'john@example.com'\n")
+    gemspec.grep(/spec\.summary/).first.replace("  spec.summary = 'A nice extension'\n")
+    gemspec.grep(/spec\.description/).first.replace("  spec.description = 'A super nice extension'\n")
+    gemspec_path.write(gemspec.join)
+
+    expect(bundle_install).to match(/Bundle complete/)
+  end
+
+  def check_default_task
+    cd(install_path) do
+      output = sh('bin/rake')
+      expect(output).to include('Generating dummy Rails application')
+      expect(output).to include('0 examples, 0 failures')
+    end
+  end
+
+  def check_run_specs
+    install_path.join('spec', 'some_spec.rb').write(
+      "require 'spec_helper'\nRSpec.describe 'Some test' do it { expect(true).to be_truthy } end\n"
+    )
+    cd(install_path) do
+      output = sh('bundle exec rspec')
+      expect(output).to include('1 example, 0 failures')
+      expect(output).to include(ENV['CODECOV_TOKEN'] ? 'Coverage reports upload successfully' : 'Provide a CODECOV_TOKEN environment variable to enable Codecov uploads')
+    end
+  end
+
+  def check_sandbox
+    cd(install_path) do
+      # rubocop:disable Lint/InterpolationCheck
+      command = 'bin/rails-sandbox runner "puts %{The version of SolidusTestExtension is #{SolidusTestExtension::VERSION}}"'
+      # rubocop:enable Lint/InterpolationCheck
+
+      first_run_output = sh(command)
+      expect(first_run_output).to include("Creating the sandbox app...")
+      expect(first_run_output).to include('The version of SolidusTestExtension is 0.0.1')
+
+      second_run_output = sh(command)
+      expect(second_run_output).not_to include("Creating the sandbox app...")
+      expect(second_run_output).to include('The version of SolidusTestExtension is 0.0.1')
+    end
+  end
+
+  def sh(*args)
+    command = args.size == 1 ? args.first : args.shelljoin
+    output, status = with_unbundled_env { Open3.capture2e(command) }
+
+    if status.success?
+      output.to_s
+    else
+      if $DEBUG
+        warn '~' * 80
+        warn "$ #{command}"
+        warn output.to_s
+      end
+      raise(CommandFailed, "command failed: #{command}\n#{output}")
+    end
+  end
+
+  def with_unbundled_env(&block)
+    if Bundler.respond_to?(:with_unbundled_env)
+      Bundler.with_unbundled_env(&block)
+    else
+      Bundler.with_clean_env(&block)
+    end
+  end
+
+  def bundle_install
+    # Optimize the bundle path within the CI, in this context using bundler env
+    # variables doesn't help because commands are run with a clean env.
+    bundle_path = "#{gem_root}/vendor/bundle"
+
+    command = 'bundle install'
+    command += " --path=#{bundle_path.shellescape}" if File.exist?(bundle_path)
+
+    output = nil
+    cd(install_path) { output = sh command }
+    output
+  end
+end