solidus_dev_support 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3823487a717fb97e853499a6e68ad405e443ae3f0b16bdfc4c11ab97dd31670
-  data.tar.gz: fa21213f5c4726ecaed62f37cff358774c1b09d1f9ad850e16f94e6d2b937722
+  metadata.gz: 389395ffb560031a111e0baaba5c71d9b7f2a8ccc6ca750ea2577fb214250410
+  data.tar.gz: a0c401f0b752a9f87dadbb44eb862f4cf43cde5e3337218f974a37333da64436
 SHA512:
-  metadata.gz: a80b12e5e9a84e3b0ff6476c3f887277b3acc53ce9c79910679b22d791639ce7d74a1f6ca8a7c2d6550ee64ac1866420c08c1c892ac965a2a89fee053d62c504
-  data.tar.gz: 493cfb3d42a71d111c90ccdad26095010d660f78f5748e25f86518918689b2e0524425caa710e3d9e144b881e022650ae4a3ff13781e6923d994bf499ab9f895
+  metadata.gz: 8f85910f752ebe285a4dedc588ec00e16c934649b04a754298c907ef1c041b0dee5e86e7cd4702ca6e8bb82947e6533e13ec5043fba086fc3c71dcb4aab01db4
+  data.tar.gz: 5fb1ae79621a936f5abd625205f1980998a7f6769851f9402d3497c2b73d5e2601aa08e0533b1e7f4fd443eecebf039796cf41ddcc3f46a9e8544ed6f39d57b0

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/.gitignore

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

data/CHANGELOG.md

@@ -9,18 +9,48 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### 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] - 2019-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 +80,8 @@ 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
+[Unreleased]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.2.0...v0.3.0
 [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

data/Gemfile

@@ -6,3 +6,18 @@ 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

data/README.md

@@ -146,7 +146,7 @@ To install extension-related Rake tasks, add this to your `Rakefile`:
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 
-task default: 'extension:specs'
+task default: %w[extension:test_app extension:specs]
 ```
 
 (If your extension used the legacy extension Rakefile, then you should completely replace its
@@ -154,8 +154,10 @@ 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
+
+It also allows you to run `rake` to, respectively, generate a test app and run all tests.
 
 ## Development
 

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,56 @@
 # 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', "#{file_name}/app"
-      directory 'lib', "#{file_name}/lib"
-      directory 'bin', "#{file_name}/bin"
-      directory '.circleci', "#{file_name}/.circleci"
-      directory '.github', "#{file_name}/.github"
+      directory 'app', "#{path}/app"
+      directory 'lib', "#{path}/lib"
+      directory 'bin', "#{path}/bin"
+      directory '.circleci', "#{path}/.circleci"
+      directory '.github', "#{path}/.github"
 
       Dir["#{file_name}/bin/*"].each do |executable|
         make_executable executable
       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.erb', "#{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
-      end
+      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
 
-      def use_prefix(prefix)
-        @file_name = prefix + Thor::Util.snake_case(file_name) unless file_name =~ /^#{prefix}/
+        @root = File.dirname(path)
+        @path = File.join(@root, @file_name)
       end
 
       def make_executable(path)
@@ -56,6 +58,12 @@ module SolidusDevSupport
         executable = (path.stat.mode | 0o111)
         path.chmod(executable)
       end
+
+      attr_reader :root, :path, :file_name, :class_name
+    end
+
+    def self.source_root
+      "#{__dir__}/templates/extension"
     end
   end
 end

data/lib/solidus_dev_support/rake_tasks.rb

@@ -26,33 +26,32 @@ module SolidusDevSupport
 
     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
+        task :test_app do
+          Rake::Task['extension:test_app'].invoke
           cd root
         end
       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'

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: %w[extension:test_app 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,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 app_root = 'spec/dummy'
 
 unless File.exist? "#{app_root}/bin/rails"
@@ -9,5 +11,5 @@ unless File.exist? "#{app_root}/bin/rails"
   end
 end
 
-Dir.chdir 'spec/dummy'
+Dir.chdir app_root
 exec 'bin/rails', *ARGV

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

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

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Desantis
@@ -303,6 +303,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
 - bin/solidus
 - exe/solidus
@@ -315,6 +316,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