diff --git a/.circleci/config.yml b/.circleci/config.yml index f0bf36a..2fd7722 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -11,47 +11,40 @@ orbs: solidusio_extensions: solidusio/extensions@volatile jobs: + run-specs-with-sqlite: + executor: + name: solidusio_extensions/sqlite + ruby_version: "3.0" + steps: + - browser-tools/install-chrome + - solidusio_extensions/run-tests run-specs-with-postgres: executor: name: solidusio_extensions/postgres - ruby_version: "3.2" + ruby_version: "3.0" steps: - - checkout - browser-tools/install-chrome - - solidusio_extensions/run-tests-solidus-master - - solidusio_extensions/store-test-results - + - solidusio_extensions/run-tests run-specs-with-mysql: executor: name: solidusio_extensions/mysql - ruby_version: "3.1" - steps: - - checkout - - browser-tools/install-chrome - - solidusio_extensions/run-tests-solidus-current - - solidusio_extensions/store-test-results - - run-specs-with-sqlite: - executor: - name: solidusio_extensions/sqlite ruby_version: "3.0" steps: - - checkout - browser-tools/install-chrome - - solidusio_extensions/run-tests-solidus-older - - solidusio_extensions/store-test-results - + - solidusio_extensions/run-tests lint-code: - executor: solidusio_extensions/sqlite + executor: + name: solidusio_extensions/sqlite-memory + ruby_version: "3.0" steps: - solidusio_extensions/lint-code workflows: "Run specs on supported Solidus versions": jobs: + - run-specs-with-sqlite - run-specs-with-postgres - run-specs-with-mysql - - run-specs-with-sqlite - lint-code "Weekly run specs against master": @@ -63,6 +56,6 @@ workflows: only: - master jobs: + - run-specs-with-sqlite - run-specs-with-postgres - run-specs-with-mysql - - run-specs-with-sqlite diff --git a/.github/stale.yml b/.github/stale.yml index d9f6563..0d0b1c9 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -1,17 +1 @@ -# 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 -# Issues with these labels will never be considered stale -exemptLabels: - - pinned - - security -# Label to use when marking an issue as stale -staleLabel: wontfix -# 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 - for your contributions. -# Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false \ No newline at end of file +_extends: .github diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 0000000..eac0962 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,2 @@ +issues=false +exclude-labels=infrastructure diff --git a/.gitignore b/.gitignore index 6ad1ffe..9ace17b 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,7 @@ pkg spec/dummy spec/examples.txt .ruby-version +Gemfile-local +/sandbox +.rvmrc +.ruby-gemset diff --git a/.rubocop.yml b/.rubocop.yml index c68caa2..ed101eb 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -3,14 +3,5 @@ inherit_from: .rubocop_todo.yml require: - solidus_dev_support/rubocop -inherit_gem: - solidus_dev_support: .rubocop.yml - AllCops: - Exclude: - - spec/dummy/**/* - - vendor/**/* - -Rails/SkipsModelValidations: - Exclude: - - db/migrate/**/* + NewCops: disable diff --git a/Gemfile b/Gemfile index aafc521..38bbbe3 100644 --- a/Gemfile +++ b/Gemfile @@ -3,14 +3,17 @@ source 'https://rubygems.org' git_source(:github) { |repo| "https://github.com/#{repo}.git" } -branch = ENV.fetch('SOLIDUS_BRANCH', 'master') -solidus_git, solidus_frontend_git = if (branch == 'master') || (branch >= 'v3.2') - %w[solidusio/solidus solidusio/solidus_frontend] - else - %w[solidusio/solidus] * 2 - end -gem 'solidus', github: solidus_git, branch: branch -gem 'solidus_frontend', github: solidus_frontend_git, branch: branch +branch = ENV.fetch('SOLIDUS_BRANCH', 'main') +gem 'solidus', github: 'solidusio/solidus', branch: branch + +# The solidus_frontend gem has been pulled out since v3.2 +if branch >= 'v3.2' + gem 'solidus_frontend' +elsif branch == 'main' + gem 'solidus_frontend', github: 'solidusio/solidus_frontend', branch: branch +else + gem 'solidus_frontend', github: 'solidusio/solidus', branch: branch +end # Needed to help Bundler figure out how to resolve dependencies, # otherwise it takes forever to resolve them. @@ -19,9 +22,8 @@ gem 'rails', '>0.a' # Provides basic authentication functionality for testing parts of your engine gem 'solidus_auth_devise' -gem 'solidus_dev_support' -case ENV['DB'] +case ENV.fetch('DB', nil) when 'mysql' gem 'mysql2' when 'postgresql' @@ -30,9 +32,26 @@ else gem 'sqlite3' end +group :development, :test do + gem 'factory_bot', '> 4.10.0' + gem 'pry-rails' +end + group :test do gem 'rails-controller-testing' gem 'rspec-activemodel-mocks' end +# While we still support Ruby < 3 we need to workaround a limitation in +# the 'async' gem that relies on the latest ruby, since RubyGems doesn't +# resolve gems based on the required ruby version. +gem 'async', '< 3' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3') + gemspec + +# Use a local Gemfile to include development dependencies that might not be +# relevant for the project or for other contributors, e.g. pry-byebug. +# +# We use `send` instead of calling `eval_gemfile` to work around an issue with +# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658. +send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local' diff --git a/Rakefile b/Rakefile index ecdfc67..ded716a 100644 --- a/Rakefile +++ b/Rakefile @@ -1,5 +1,6 @@ # frozen_string_literal: true +require 'bundler/gem_tasks' require 'solidus_dev_support/rake_tasks' SolidusDevSupport::RakeTasks.install diff --git a/app/assets/javascripts/spree/backend/solidus_reports.js b/app/assets/javascripts/spree/backend/solidus_reports.js index 8aa3b01..103cdc7 100644 --- a/app/assets/javascripts/spree/backend/solidus_reports.js +++ b/app/assets/javascripts/spree/backend/solidus_reports.js @@ -1,2 +1,2 @@ // Placeholder manifest file. -// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js' \ No newline at end of file +// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js' diff --git a/app/assets/javascripts/spree/frontend/solidus_reports.js b/app/assets/javascripts/spree/frontend/solidus_reports.js index a79f2e9..9b2fd60 100644 --- a/app/assets/javascripts/spree/frontend/solidus_reports.js +++ b/app/assets/javascripts/spree/frontend/solidus_reports.js @@ -1,2 +1,2 @@ // Placeholder manifest file. -// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js' \ No newline at end of file +// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js' diff --git a/bin/rails b/bin/rails index c535fd2..d9210f3 100755 --- a/bin/rails +++ b/bin/rails @@ -1,15 +1,9 @@ -#!/usr/bin/env ruby - # frozen_string_literal: true -app_root = 'spec/dummy' +#!/usr/bin/env ruby -unless File.exist? "#{app_root}/bin/rails" - system "bin/rake", app_root or begin # rubocop:disable Style/AndOr - warn "Automatic creation of the dummy app failed" - exit 1 - end +if %w[g generate].include? ARGV.first + exec "#{__dir__}/rails-engine", *ARGV +else + exec "#{__dir__}/rails-sandbox", *ARGV end - -Dir.chdir app_root -exec 'bin/rails', *ARGV diff --git a/bin/rails-engine b/bin/rails-engine new file mode 100755 index 0000000..69dc282 --- /dev/null +++ b/bin/rails-engine @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +#!/usr/bin/env ruby +# This command will automatically be run when you run "rails" with Rails gems +# installed from the root of your application. + +ENGINE_ROOT = File.expand_path('..', __dir__) +ENGINE_PATH = File.expand_path('../lib/solidus_reports/engine', __dir__) + +# Set up gems listed in the Gemfile. +ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__) +require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE']) + +require 'rails/all' +require 'rails/engine/commands' diff --git a/bin/rails-sandbox b/bin/rails-sandbox new file mode 100755 index 0000000..feabee1 --- /dev/null +++ b/bin/rails-sandbox @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +#!/usr/bin/env ruby + +app_root = 'sandbox' + +unless File.exist? '#{app_root}/bin/rails' + warn 'Creating the sandbox app...' + Dir.chdir '#{__dir__}/..' do + system '#{__dir__}/sandbox' or begin + warn 'Automatic creation of the sandbox app failed' + exit 1 + end + end +end + +Dir.chdir app_root +exec 'bin/rails', *ARGV diff --git a/bin/rake b/bin/rake new file mode 100755 index 0000000..836ad3b --- /dev/null +++ b/bin/rake @@ -0,0 +1,7 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +require 'rubygems' +require 'bundler/setup' + +load Gem.bin_path('rake', 'rake') diff --git a/bin/sandbox b/bin/sandbox new file mode 100755 index 0000000..4c4d678 --- /dev/null +++ b/bin/sandbox @@ -0,0 +1,78 @@ +# frozen_string_literal: true + +#!/usr/bin/env bash + +set -e +test -z "${DEBUG+empty_string}" || set -x + +test "$DB" = "sqlite" && export DB="sqlite3" + +if [ -z "$SOLIDUS_BRANCH" ] +then + echo "~~> Use 'export SOLIDUS_BRANCH=[main|v3.2|...]' to control the Solidus branch" + SOLIDUS_BRANCH="main" +fi +echo "~~> Using branch $SOLIDUS_BRANCH of solidus" + +if [ -z "$SOLIDUS_FRONTEND" ] +then + echo "~~> Use 'export SOLIDUS_FRONTEND=[solidus_frontend|solidus_starter_frontend]' to control the Solidus frontend" + SOLIDUS_FRONTEND="solidus_frontend" +fi +echo "~~> Using branch $SOLIDUS_FRONTEND as the solidus frontend" + +extension_name="solidus_reports" + +# Stay away from the bundler env of the containing extension. +function unbundled { + ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@ +} + +rm -rf ./sandbox +unbundled bundle exec rails new sandbox \ + --database="${DB:-sqlite3}" \ + --skip-bundle \ + --skip-git \ + --skip-keeps \ + --skip-rc \ + --skip-spring \ + --skip-test \ + --skip-javascript + +if [ ! -d "sandbox" ]; then + echo 'sandbox rails application failed' + exit 1 +fi + +cd ./sandbox +cat <> Gemfile +gem 'solidus', github: 'solidusio/solidus', branch: '$SOLIDUS_BRANCH' +gem 'rails-i18n' +gem 'solidus_i18n' +gem '$extension_name', path: '..' +group :test, :development do + platforms :mri do + gem 'pry-byebug' + end +end +RUBY + +unbundled bundle install --gemfile Gemfile + +unbundled bundle exec rake db:drop db:create + +unbundled bundle exec rails generate solidus:install \ + --auto-accept \ + --user_class=Spree::User \ + --enforce_available_locales=true \ + --with-authentication=true \ + --payment-method=none \ + --frontend=${SOLIDUS_FRONTEND} \ + $@ + +unbundled bundle exec rails generate solidus:auth:install --auto-run-migrations +unbundled bundle exec rails generate ${extension_name}:install --auto-run-migrations + +echo +echo "๐Ÿš€ Sandbox app successfully created for $extension_name!" +echo "๐Ÿงช This app is intended for test purposes." diff --git a/bin/setup b/bin/setup index c3563af..a8b5039 100755 --- a/bin/setup +++ b/bin/setup @@ -1,8 +1,3 @@ -#!/usr/bin/env bash -set -euo pipefail -IFS=$'\n\t' -set -vx - gem install bundler --conservative bundle update -bundle exec rake extension:test_app +bin/rake clobber diff --git a/lib/generators/solidus_reports/install/install_generator.rb b/lib/generators/solidus_reports/install/install_generator.rb index 5e75ea1..991cc93 100644 --- a/lib/generators/solidus_reports/install/install_generator.rb +++ b/lib/generators/solidus_reports/install/install_generator.rb @@ -11,20 +11,20 @@ def add_javascripts end def add_stylesheets - inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_reports\n", before: %r{\*/}, verbose: true - inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_reports\n", before: %r{\*/}, verbose: true + inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_reports\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength + inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_reports\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength end def add_migrations - run 'bundle exec rake railties:install:migrations FROM=solidus_reports' + run 'bin/rails railties:install:migrations FROM=solidus_reports' end def run_migrations - run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) + 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 'bundle exec rake db:migrate' + run 'bin/rails db:migrate' else - puts 'Skipping rake db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output + puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output end end end diff --git a/lib/solidus_reports.rb b/lib/solidus_reports.rb index 85ee088..bf15e2e 100644 --- a/lib/solidus_reports.rb +++ b/lib/solidus_reports.rb @@ -1,6 +1,3 @@ # frozen_string_literal: true -require 'solidus_core' -require 'solidus_support' - require 'solidus_reports/engine' diff --git a/lib/solidus_reports/engine.rb b/lib/solidus_reports/engine.rb index 02115a9..38876ce 100644 --- a/lib/solidus_reports/engine.rb +++ b/lib/solidus_reports/engine.rb @@ -1,22 +1,23 @@ # frozen_string_literal: true -require "spree/core" +require 'solidus_core' +require 'solidus_support' module SolidusReports class Engine < Rails::Engine include SolidusSupport::EngineExtensions - isolate_namespace Spree + isolate_namespace ::Spree - engine_name "solidus_reports" + engine_name 'solidus_reports' # use rspec for tests config.generators do |g| g.test_framework :rspec end - initializer "solidus_reports.environment", before: :load_config_initializers do - require_dependency "solidus_reports/configuration" + initializer 'solidus_reports.environment', before: :load_config_initializers do + require_dependency 'solidus_reports/configuration' SolidusReports::Config = SolidusReports::Configuration.new end end diff --git a/solidus_reports.gemspec b/solidus_reports.gemspec index b5e563c..dec6a86 100644 --- a/solidus_reports.gemspec +++ b/solidus_reports.gemspec @@ -1,34 +1,39 @@ # frozen_string_literal: true $:.push File.expand_path("lib", __dir__) -require "solidus_reports/version" +require 'solidus_reports/version' Gem::Specification.new do |s| - s.name = "solidus_reports" + s.name = 'solidus_reports' s.version = SolidusReports::VERSION - s.summary = "Reports module from Solidus core" + s.summary = 'Reports module from Solidus core' s.description = s.summary - s.license = "BSD-3-Clause" + s.license = 'BSD-3-Clause' - s.author = "Jonathan Tapia" - s.email = "jonathan.tapia@magmalabs.io" - s.homepage = "http://github.com/solidusio-contrib/solidus_reports" + s.author = 'Jonathan Tapia' + s.email = 'jonathan.tapia@magmalabs.io' + s.homepage = 'http://github.com/solidusio-contrib/solidus_reports' if s.respond_to?(:metadata) - s.metadata["homepage_uri"] = s.homepage - s.metadata["source_code_uri"] = s.homepage + s.metadata['homepage_uri'] = s.homepage + s.metadata['source_code_uri'] = s.homepage end - s.required_ruby_version = [">= 2.5", "< 4.0"] + s.required_ruby_version = '>= 2.5' - s.files = Dir.chdir(File.expand_path(__dir__)) do - `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } - end - s.test_files = Dir["spec/**/*"] - s.bindir = "exe" - s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) } - s.require_paths = ["lib"] + # 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. + files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") } + + s.files = files.grep_v(%r{^(test|spec|features)/}) + s.test_files = files.grep(%r{^(test|spec|features)/}) + s.bindir = 'exe' + s.executables = files.grep(%r{^exe/}) { |f| File.basename(f) } + s.require_paths = ['lib'] + + s.add_dependency 'solidus_core', ['>= 2.0.0', '< 5'] + s.add_dependency 'solidus_support', '~> 0.8' - s.add_dependency "solidus_core", [">= 2.5", "< 4.0"] - s.add_dependency "solidus_support", "~> 0.5" + s.add_development_dependency 'rails-controller-testing' + s.add_development_dependency 'solidus_dev_support', '~> 2.7' end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index bc7e469..27063a2 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -3,22 +3,33 @@ # Configure Rails Environment ENV['RAILS_ENV'] = 'test' +require 'rails-controller-testing' +Rails::Controller::Testing.install + # 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/solidus_reports/factories.rb -require 'solidus_reports/factories' +# Requires factories defined in Solidus core and this extension. +# See: lib/solidus_reports/testing_support/factories.rb +SolidusDevSupport::TestingSupport::Factories.load_for(SolidusReports::Engine) 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