solidus_dev_support 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3823487a717fb97e853499a6e68ad405e443ae3f0b16bdfc4c11ab97dd31670
-  data.tar.gz: fa21213f5c4726ecaed62f37cff358774c1b09d1f9ad850e16f94e6d2b937722
+  metadata.gz: de90c411c336bc81c47f733d981c94bd1ab190b67ac4f3d4150137939d80e334
+  data.tar.gz: 5fc688becf3ee554bd58ed6c1b93ffc1d780d99ef49965e1820a09ee735cb148
 SHA512:
-  metadata.gz: a80b12e5e9a84e3b0ff6476c3f887277b3acc53ce9c79910679b22d791639ce7d74a1f6ca8a7c2d6550ee64ac1866420c08c1c892ac965a2a89fee053d62c504
-  data.tar.gz: 493cfb3d42a71d111c90ccdad26095010d660f78f5748e25f86518918689b2e0524425caa710e3d9e144b881e022650ae4a3ff13781e6923d994bf499ab9f895
+  metadata.gz: 0d2309d00fc65e1883f45a8d197a9b8da364da2f9752a9cdf0dab4fe15907ed71bdde00d16c981623ebdf6e7a48accd1c6384a8abe22a6fce90ec06a3fa13e30
+  data.tar.gz: b219aa253dc28f0d899c3fd336918d5b5a55074829e3b66ad30b29b261e37621cc5c89c7fd59275b47515adfb7c2ea5f7b5ad7fe115c12939ffdadda711f6a28

data/.circleci/config.yml

@@ -7,21 +7,43 @@ orbs:
   # or goes EOL.
   solidusio_extensions: solidusio/extensions@volatile
 
-jobs:
-  run-specs-with-postgres:
-    executor: solidusio_extensions/postgres
-    steps:
-      - solidusio_extensions/run-tests
-  run-specs-with-mysql:
-    executor: solidusio_extensions/mysql
+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:
-      - solidusio_extensions/run-tests
+      - checkout
+      - run: "gem install bundler -v '>=2' --conservative"
+
+jobs:
+  solidus-master:
+    executor: sqlite-memory
+    steps: ['setup', 'solidusio_extensions/run-tests-solidus-master']
+  solidus-current:
+    executor: sqlite-memory
+    steps: ['setup', 'solidusio_extensions/run-tests-solidus-current']
+  solidus-older:
+    executor: sqlite-memory
+    steps: ['setup', 'solidusio_extensions/run-tests-solidus-older']
 
 workflows:
   "Run specs on supported Solidus versions":
     jobs:
-      - run-specs-with-postgres
-      - run-specs-with-mysql
+      - solidus-master
+      - solidus-current
+      - solidus-older
+
   "Weekly run specs against master":
     triggers:
       - schedule:
@@ -31,5 +53,6 @@ workflows:
               only:
                 - master
     jobs:
-      - run-specs-with-postgres
-      - run-specs-with-mysql
+      - solidus-master
+      - solidus-current
+      - solidus-older

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_dev_support/version.rb'
+  message: Bump SolidusDevSupport to %{version}
+  tag: true

data/.gitignore

@@ -6,9 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
-Gemfile.lock
+/vendor/bundle/
+/Gemfile.lock
+/Gemfile-local*
 
 # rspec failure tracking
 .rspec_status
-
-/spec/tmp/

data/.rubocop-https---relaxed-ruby-style-rubocop-yml

@@ -1,5 +1,5 @@
 # Relaxed.Ruby.Style
-## Version 2.4
+## Version 2.5
 
 Style/Alias:
   Enabled: false
@@ -145,30 +145,9 @@ Lint/AssignmentInCondition:
   Enabled: false
   StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
 
-Metrics/AbcSize:
+Layout/LineLength:
   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:
+Metrics:
   Enabled: false
 

data/CHANGELOG.md

@@ -9,18 +9,98 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
+- Added a binstub for `rake` to the extension generator
+- Added the ability for the generator to reuse existing data for the gemspec
+
+### Fixed
+
+- Fixed Dependabot throwing an error because of `eval_gemfile` in the Gemfile
+
+## [0.6.0] - 2020-01-20
+
+### Added
+
+- Added support for a local Gemfile for local development dependencies (e.g. 'pry-debug')
+- Added a `bin/sandbox` script to all extension for local development with `bin/rails` support.
+
+### Changed
+
+- The default rake task no longer re-generates the `test_app` each time it runs.
+  In order to get that behavior back simply call clobber before launching it:
+  `bin/rake clobber default`
+
+### Fixed
+
+- Fixed generated extensions isolating the wrong namespace
+
+## [0.5.0] - 2020-01-16
+
+### Added
+
+- Added `--require spec_helper` to the generated `.rspec`
+
+### Fixed
+
+- Replaced "Spree" with "Solidus" in the license of generated extensions
+
+### Changed
+
+- Updated gem-release to use tags instead of branches for new releases
+
+## [0.4.1] - 2020-01-15
+
+### Fixed
+
+- Fixed the generated RuboCop config inheriting from this gem's dev-only config
+- Fixed the generated extension not requiring the `version` file
+- Fixed the generator not properly marking `bin/` files as executable
+
+## [0.4.0] - 2020-01-10
+
+### Added
+
+- Enforced Rails version depending on the Solidus version in generated Gemfile
+- Made Git ignore `spec/examples.txt` in generated extensions
+- Added the ability to run `solidus extension .` to update an extension
+
+### Changed
+
+- The `solidus` executable is now solely managed by Thor and is open to extension by other gems
+
+### Fixed
+
+- Fixed generated extensions using an old Rakefile
+- Fixed some RuboCop offenses in the generated files
+- Fixed the `bin/setup` script calling a non-existing Rake binary
+
+### Removed
+
+- Removed RuboCop from the default Rake task
+- Removed the `-v` option from the `solidus` executable
+- Removed the factory_bot gem from the Gemfile
+
+## [0.3.0] - 2020-01-10
+
+### Added
+
 - Adopted Ruby 2.4+ as the minimum Ruby version in generated extensions
 - Added `bin/console`, `bin/rails` and `bin/setup` to generated extensions
 - Added some Bundler gemspec defaults to generated extensions
+- Configured the default Rake task to run generate the test app before running RSpec
 
 ### Changed
 
 - Updated solidus_support to 0.4.0 for Zeitwerk and Rails 6 compatibility
+- Updated the `solidus` executable to only rely on Thor and be open to extension by other gems
 
 ### Removed
 
 - Removed solidus_support as a dependency
 
+### Fixed
+
+- Fixed `extension:test_app` not going back to the root after execution
+
 ## [0.2.0] - 2019-12-16
 
 ### Added
@@ -50,7 +130,12 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Initial release.
 
-[Unreleased]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.2.0...HEAD
-[0.2.0]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.1.1...v0.2.0
-[0.1.1]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.1.0...v0.1.1
-[0.1.0]: https://github.com/solidusio-contrib/solidus_dev_support/releases/tag/v0.1.0
+[Unreleased]: https://github.com/solidusio/solidus_dev_support/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/solidusio/solidus_dev_support/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/solidusio/solidus_dev_support/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/solidusio/solidus_dev_support/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/solidusio/solidus_dev_support/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/solidusio/solidus_dev_support/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/solidusio/solidus_dev_support/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/solidusio/solidus_dev_support/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/solidusio/solidus_dev_support/releases/tag/v0.1.0

data/Gemfile

@@ -6,3 +6,22 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in solidus_dev_support.gemspec
 gemspec
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# A workaround for https://github.com/bundler/bundler/issues/6677
+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 'sqlite3'
+end
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g.: `gem 'pry-debug'`.
+eval_gemfile 'Gemfile-local' if File.exist? 'Gemfile-local'

data/README.md

@@ -1,6 +1,6 @@
 # solidus_dev_support
 
-[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_dev_support.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_dev_support)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_dev_support.svg?style=svg)](https://circleci.com/gh/solidusio/solidus_dev_support)
 
 This gem contains common development functionality for Solidus extensions.
 
@@ -34,6 +34,42 @@ $ solidus extension my_awesome_extension
 This will generate the basic extension structure, already configured to use all the shiny helpers
 in solidus_dev_support.
 
+#### Updating existing extensions
+
+If you have an existing extension and want to update it to use the latest standards from this gem,
+you can run the following in the extension's directory:
+
+```console
+$ solidus extension .
+```
+
+In case of conflicting files, you will be prompted for an action. You can overwrite the files with
+the new version, keep the current version or view the diff and only apply the adjustments that make
+sense to you.
+
+### Sandbox app
+
+When developing an extension you will surely need to try it out within a Rails app with Solidus
+installed. Using solidus_dev_support your extension will have a `bin/rails` executable that will
+operate on a _sandbox_ app (creating it if necessary).
+
+The path for the sandbox app is `./sandbox` and `bin/rails` will forward any Rails command
+to `sandbox/bin/rails`.
+
+Example:
+
+```bash
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+#### Rebuilding the sandbox app
+
+To rebuild the sandbox app just remove the `./sandbox` folder or run `bin/sandbox`.
+
 ### RSpec helpers
 
 This gem provides some useful helpers for RSpec to setup an extension's test environment easily.
@@ -123,15 +159,16 @@ releases for your gem.
 For instance, you can run the following to release a new minor version:
 
 ```console
-$ gem bump --version minor --tag --release
+$ gem bump -v minor -r
 ```
 
 The above command will:
 
-* bump the gem version to the next minor;
-* commit the change and push it to `upstream/master`;
+* bump the gem version to the next minor (you can also use `patch`, `major` or a specific version
+  number);
+* commit the change and push it to `origin/master`;
 * create a Git tag;
-* push the tag to the `upstream` remote;
+* push the tag to the `origin` remote;
 * release the new version on RubyGems.
 
 You can refer to
@@ -154,8 +191,14 @@ contents with the block above.)
 
 This will provide the following tasks:
 
-- `extension:specs` (default), which runs the specs for your extension
 - `extension:test_app`, which generates a dummy app for your extension
+- `extension:specs` (default), which runs the specs for your extension
+
+If your extension requires the `test_app` to be always recreated you can do so by running:
+
+```rb
+bin/rake extension:test_app extension:specs
+```
 
 ## Development
 
@@ -163,8 +206,8 @@ 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 `bundle exec rake install`. To release a new
-version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+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
 [rubygems.org](https://rubygems.org).
 

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/exe/solidus

@@ -1,53 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
+require 'solidus_dev_support/solidus_command'
 
-require 'solidus_dev_support/version'
-
-Options = Struct.new(:name)
-
-class Parser
-  class << self
-    def parse(args)
-      options.parse!(args)
-    end
-
-    def options
-      OptionParser.new do |opts|
-        opts.banner = 'Usage: solidus [[extension extension_name] | [-h] [-v]]'
-
-        opts.on('-h', '--help', 'Prints this help') do
-          puts opts
-        end
-
-        opts.on(
-          '-v',
-          '--version',
-          "Prints the current version: #{SolidusDevSupport::VERSION}"
-        ) do
-          puts SolidusDevSupport::VERSION
-        end
-      end
-    end
-  end
-end
-
-# Print help if no options are supplied
-ARGV << '--help' unless ARGV.first
-
-if ARGV.first == 'extension' || ARGV.first == 'e'
-  ARGV.shift
-
-  unless ARGV.first
-    puts 'An extension must have a name!'
-    puts `solidus -h`
-    exit 1
-  end
-
-  require 'solidus_dev_support'
-  require 'solidus_dev_support/extension'
-  SolidusDevSupport::Extension.start
-else
-  Parser.parse(ARGV)
-end
+SolidusDevSupport::SolidusCommand.start

data/lib/solidus_dev_support/extension.rb

@@ -1,54 +1,106 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'thor/group'
 require 'pathname'
 
 module SolidusDevSupport
-  class Extension < Thor::Group
+  class Extension < Thor
     include Thor::Actions
+    PREFIX = 'solidus_'
 
-    desc 'builds a solidus extension'
-    argument :file_name, type: :string, desc: 'rails app_path', default: '.'
+    default_command :generate
 
-    source_root File.expand_path('templates/extension', __dir__)
+    desc 'generate PATH', 'Generates a new Solidus extension'
+    def generate(raw_path = '.')
+      self.path = raw_path
 
-    def generate
-      use_prefix 'solidus_'
+      empty_directory path
 
-      empty_directory file_name
+      directory 'app', "#{path}/app"
+      directory 'lib', "#{path}/lib"
+      directory 'bin', "#{path}/bin"
+      directory '.circleci', "#{path}/.circleci"
+      directory '.github', "#{path}/.github"
 
-      directory 'app', "#{file_name}/app"
-      directory 'lib', "#{file_name}/lib"
-      directory 'bin', "#{file_name}/bin"
-      directory '.circleci', "#{file_name}/.circleci"
-      directory '.github', "#{file_name}/.github"
-
-      Dir["#{file_name}/bin/*"].each do |executable|
-        make_executable executable
+      Dir["#{path}/bin/*"].each do |bin|
+        make_executable bin
       end
 
-      template 'extension.gemspec.erb', "#{file_name}/#{file_name}.gemspec"
-      template 'Gemfile', "#{file_name}/Gemfile"
-      template 'gitignore', "#{file_name}/.gitignore"
-      template 'gem_release.yml.tt', "#{file_name}/.gem_release.yml"
-      template 'LICENSE', "#{file_name}/LICENSE"
-      template 'Rakefile', "#{file_name}/Rakefile"
-      template 'README.md', "#{file_name}/README.md"
-      template 'config/routes.rb', "#{file_name}/config/routes.rb"
-      template 'config/locales/en.yml', "#{file_name}/config/locales/en.yml"
-      template 'rspec', "#{file_name}/.rspec"
-      template 'spec/spec_helper.rb.tt', "#{file_name}/spec/spec_helper.rb"
-      template 'rubocop.yml', "#{file_name}/.rubocop.yml"
+      template 'extension.gemspec', "#{path}/#{file_name}.gemspec"
+      template 'Gemfile', "#{path}/Gemfile"
+      template 'gitignore', "#{path}/.gitignore"
+      template 'gem_release.yml.tt', "#{path}/.gem_release.yml"
+      template 'LICENSE', "#{path}/LICENSE"
+      template 'Rakefile', "#{path}/Rakefile"
+      template 'README.md', "#{path}/README.md"
+      template 'config/routes.rb', "#{path}/config/routes.rb"
+      template 'config/locales/en.yml', "#{path}/config/locales/en.yml"
+      template 'rspec', "#{path}/.rspec"
+      template 'spec/spec_helper.rb.tt', "#{path}/spec/spec_helper.rb"
+      template 'rubocop.yml', "#{path}/.rubocop.yml"
     end
 
     no_tasks do
-      def class_name
-        Thor::Util.camel_case file_name
+      def path=(path)
+        path = File.expand_path(path)
+
+        @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
+
+        @root = File.dirname(path)
+        @path = File.join(@root, @file_name)
+
+        @gemspec = existing_gemspec || default_gemspec
       end
 
-      def use_prefix(prefix)
-        @file_name = prefix + Thor::Util.snake_case(file_name) unless file_name =~ /^#{prefix}/
+      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|
+          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.'
+        end
+      end
+
+      def existing_gemspec
+        return unless File.exist?(gemspec_path)
+
+        @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
+        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'
+        )
+      end
+
+      def github_user
+        @github_user ||= git('config github.user', '[USERNAME]')
+      end
+
+      def git(command, default)
+        result = `git #{command} 2> /dev/null`.strip
+        result.empty? ? default : result
       end
 
       def make_executable(path)
@@ -56,6 +108,12 @@ 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
+      "#{__dir__}/templates/extension"
     end
   end
 end

data/lib/solidus_dev_support/rake_tasks.rb

@@ -21,38 +21,52 @@ module SolidusDevSupport
 
     def install
       install_test_app_task
+      install_dev_app_task
       install_rspec_task
     end
 
     def install_test_app_task
       require 'rake/clean'
-      ::CLOBBER.include test_app_path
+      require 'spree/testing_support/extension_rake'
 
       ENV['DUMMY_PATH'] = test_app_path.to_s
       ENV['LIB_NAME'] = gemspec.name
-      require 'spree/testing_support/extension_rake'
 
-      namespace :extension do
-        directory ENV['DUMMY_PATH'] do
-          Rake::Task['extension:test_app']
+      ::CLOBBER.include test_app_path
 
-          # We need to go back to the gem root since extension:test_app changes
-          # the working directory to be the dummy app.
+      namespace :extension do
+        # We need to go back to the gem root since the upstream
+        # extension:test_app changes the working directory to be the dummy app.
+        task :test_app do
+          Rake::Task['extension:test_app'].invoke
           cd root
         end
+
+        directory ENV['DUMMY_PATH'] do
+          Rake::Task['extension:test_app'].invoke
+        end
+      end
+    end
+
+    def install_dev_app_task
+      desc "Creates a sandbox application for simulating the Extension code in a deployed Rails app"
+      task :sandbox do
+        warn "DEPRECATED TASK: This task is here just for parity with solidus, please use bin/sandbox directly."
+        exec("bin/sandbox", gemspec.name)
       end
     end
 
     def install_rspec_task
+      require 'rspec/core/rake_task'
+
       namespace :extension do
-        require 'rspec/core/rake_task'
         ::RSpec::Core::RakeTask.new(:specs, [] => FileList[ENV['DUMMY_PATH']]) do |t|
           # Ref: https://circleci.com/docs/2.0/configuration-reference#store_test_results
           # Ref: https://github.com/solidusio/circleci-orbs-extensions#test-results-rspec
           if ENV['TEST_RESULTS_PATH']
             t.rspec_opts =
               "--format progress " \
-              "--format RspecJunitFormatter  --out #{ENV['TEST_RESULTS_PATH']}"
+              "--format RspecJunitFormatter --out #{ENV['TEST_RESULTS_PATH']}"
           end
         end
       end

data/lib/solidus_dev_support/rspec/coverage.rb

@@ -16,7 +16,9 @@ SimpleCov.start('rails') do
   add_filter %r{^/lib/.*/version.rb}
 end
 
-if ENV['CI']
+if ENV['CODECOV_TOKEN']
   require 'codecov'
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
+else
+  warn "Provide a CODECOV_TOKEN environment variable to enable Codecov uploads"
 end

data/lib/solidus_dev_support/solidus_command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'solidus_dev_support/extension'
+
+module SolidusDevSupport
+  class SolidusCommand < Thor
+    namespace ''
+
+    desc 'extension', 'Manage solidus extensions'
+    subcommand 'extension', Extension
+
+    desc 'e', 'Manage solidus extensions (shortcut for "extension")'
+    subcommand 'e', Extension
+
+    def self.exit_on_failure?
+      true
+    end
+  end
+end
+

data/lib/solidus_dev_support/templates/extension/Gemfile

@@ -6,11 +6,14 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
 gem 'solidus', github: 'solidusio/solidus', branch: branch
 
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
 # Provides basic authentication functionality for testing parts of your engine
 gem 'solidus_auth_devise'
 
-gem 'factory_bot', '> 4.10.0'
-
 case ENV['DB']
 when 'mysql'
   gem 'mysql2'
@@ -21,3 +24,10 @@ else
 end
 
 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'

data/lib/solidus_dev_support/templates/extension/LICENSE

@@ -9,7 +9,7 @@ are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name Spree nor the names of its contributors may be used to
+    * Neither the name Solidus nor the names of its contributors may be used to
       endorse or promote products derived from this software without specific
       prior written permission.
 

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

@@ -26,7 +26,7 @@ First bundle your dependencies, then run `rake`. `rake` will default to building
 
 ```shell
 bundle
-bundle exec rake
+bin/rake
 ```
 
 When testing your application's integration with this extension you may use its factories.

data/lib/solidus_dev_support/templates/extension/Rakefile

@@ -1,32 +1,6 @@
 # frozen_string_literal: true
 
-require 'bundler'
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-Bundler::GemHelper.install_tasks
-
-begin
-  require 'spree/testing_support/extension_rake'
-  require 'rubocop/rake_task'
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-
-  RuboCop::RakeTask.new
-
-  task default: %i(first_run rubocop spec)
-rescue LoadError # rubocop:disable Lint/HandleExceptions
-  # no rspec available
-end
-
-task :first_run do
-  if Dir['spec/dummy'].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir('../../')
-  end
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = '<%=file_name%>'
-  Rake::Task['extension:test_app'].invoke
-end
+task default: 'extension:specs'

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

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "<%= file_name %>"
 

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

@@ -1,13 +1,18 @@
 #!/usr/bin/env ruby
 
-app_root = 'spec/dummy'
+# frozen_string_literal: true
+
+app_root = 'sandbox'
 
 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
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
   end
 end
 
-Dir.chdir 'spec/dummy'
+Dir.chdir app_root
 exec 'bin/rails', *ARGV

data/lib/solidus_dev_support/templates/extension/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")

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

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+extension_name="<%= file_name %>"
+
+# 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="$RAILSDB" \
+  --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 <<RUBY >> Gemfile
+
+gem '$extension_name', path: '..'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+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 spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 This app is intended for test purposes."

data/lib/solidus_dev_support/templates/extension/bin/setup

@@ -6,5 +6,3 @@ set -vx
 gem install bundler --conservative
 bundle update
 bin/rake clobber
-bin/rake spec/dummy
-bin/rails railties:install:migrations db:migrate db:seed

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/<%= file_name %>/version'
+
+Gem::Specification.new do |spec|
+  spec.name = '<%= file_name %>'
+  spec.version = <%= class_name %>::VERSION
+  spec.authors = <%= gemspec.authors.inspect.gsub('"', "'") %>
+  spec.email = '<%= gemspec.email %>'
+
+  spec.summary = '<%= gemspec.summary %>'
+  spec.description = '<%= gemspec.description %>'
+  spec.homepage = '<%= gemspec.homepage %>'
+  spec.license = '<%= gemspec.license %>'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = '<%= gemspec.homepage %>'
+  spec.metadata['changelog_uri'] = '<%= gemspec.metadata["changelog_uri"] %>'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.4')
+
+  # 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") }
+
+  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 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '~> 0.4.0'
+
+  spec.add_development_dependency 'solidus_dev_support'
+end

data/lib/solidus_dev_support/templates/extension/gem_release.yml.tt

@@ -2,4 +2,4 @@ bump:
   recurse: false
   file: 'lib/<%=file_name%>/version.rb'
   message: Bump <%=class_name%> to %{version}
-  branch: true
+  tag: true

data/lib/solidus_dev_support/templates/extension/gitignore

@@ -13,3 +13,4 @@ nbproject
 pkg
 *.swp
 spec/dummy
+spec/examples.txt

data/lib/solidus_dev_support/templates/extension/lib/%file_name%.rb.tt

@@ -3,4 +3,5 @@
 require 'solidus_core'
 require 'solidus_support'
 
+require '<%=file_name%>/version'
 require '<%=file_name%>/engine'

data/lib/solidus_dev_support/templates/extension/lib/%file_name%/engine.rb.tt

@@ -6,7 +6,7 @@ module <%= class_name %>
   class Engine < Rails::Engine
     include SolidusSupport::EngineExtensions::Decorators
 
-    isolate_namespace Spree
+    isolate_namespace ::Spree
 
     engine_name '<%= file_name %>'
 

data/lib/solidus_dev_support/templates/extension/lib/%file_name%/version.rb.tt

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module <%= class_name %>
-  VERSION = '0.0.1'
+  VERSION = '<%= gemspec.version %>'
 end

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

@@ -16,15 +16,15 @@ module <%= class_name %>
       end
 
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=<%= file_name %>'
+        run 'bin/rails railties:install:migrations FROM=<%= file_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]'))
         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

data/lib/solidus_dev_support/templates/extension/rspec

@@ -1 +1,2 @@
---color
+--color
+--require spec_helper

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

@@ -1,14 +1,2 @@
 require:
   - solidus_dev_support/rubocop
-
-inherit_gem:
-  solidus_dev_support: .rubocop.yml
-
-AllCops:
-  Exclude:
-    - spec/dummy/**/*
-    - vendor/**/*
-
-Rails/SkipsModelValidations:
-  Exclude:
-    - db/migrate/**/*

data/lib/solidus_dev_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusDevSupport
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apparition
@@ -291,6 +291,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".gem_release.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/stale.yml"
 - ".gitignore"
@@ -303,6 +304,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
 - bin/solidus
 - exe/solidus
@@ -315,6 +317,7 @@ files:
 - lib/solidus_dev_support/rspec/spec_helper.rb
 - lib/solidus_dev_support/rubocop.rb
 - lib/solidus_dev_support/rubocop/config.yml
+- lib/solidus_dev_support/solidus_command.rb
 - lib/solidus_dev_support/templates/extension/.circleci/config.yml
 - lib/solidus_dev_support/templates/extension/.github/stale.yml
 - lib/solidus_dev_support/templates/extension/CONTRIBUTING.md
@@ -328,10 +331,12 @@ files:
 - lib/solidus_dev_support/templates/extension/app/assets/stylesheets/spree/frontend/%file_name%.css
 - lib/solidus_dev_support/templates/extension/bin/console.tt
 - lib/solidus_dev_support/templates/extension/bin/rails
+- lib/solidus_dev_support/templates/extension/bin/rake
+- lib/solidus_dev_support/templates/extension/bin/sandbox.tt
 - lib/solidus_dev_support/templates/extension/bin/setup
 - lib/solidus_dev_support/templates/extension/config/locales/en.yml
 - lib/solidus_dev_support/templates/extension/config/routes.rb
-- lib/solidus_dev_support/templates/extension/extension.gemspec.erb
+- lib/solidus_dev_support/templates/extension/extension.gemspec.tt
 - lib/solidus_dev_support/templates/extension/gem_release.yml.tt
 - lib/solidus_dev_support/templates/extension/gitignore
 - lib/solidus_dev_support/templates/extension/lib/%file_name%.rb.tt

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-$:.push File.expand_path('lib', __dir__)
-require '<%= file_name %>/version'
-
-Gem::Specification.new do |s|
-  s.name = '<%= file_name %>'
-  s.version = <%= class_name %>::VERSION
-  s.summary = 'TODO'
-  s.description = 'TODO'
-  s.license = 'BSD-3-Clause'
-
-  # s.author = 'You'
-  # s.email = 'you@example.com'
-  # s.homepage = 'http://www.example.com'
-
-  if s.respond_to?(:metadata)
-    s.metadata["homepage_uri"] = s.homepage if s.homepage
-    s.metadata["source_code_uri"] = s.homepage if s.homepage
-    s.metadata["changelog_uri"] = 'TODO'
-  end
-
-  s.required_ruby_version = '~> 2.4'
-
-  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"]
-
-  s.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
-  s.add_dependency 'solidus_support', '~> 0.4.0'
-
-  s.add_development_dependency 'solidus_dev_support'
-end