solidus_dev_support 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f68913bee63209a6d6dd22002a39bc228b5413205487c5437cf17a98446e48
-  data.tar.gz: 27f0f341b2d37ddfd9795a151eed63bd1a5396b01d8e5ff779643d7a54833d74
+  metadata.gz: a3823487a717fb97e853499a6e68ad405e443ae3f0b16bdfc4c11ab97dd31670
+  data.tar.gz: fa21213f5c4726ecaed62f37cff358774c1b09d1f9ad850e16f94e6d2b937722
 SHA512:
-  metadata.gz: e4ed196776b2f7d34fb2e50e08db666e6d3252008892236e237da41505b14f93bff81057249bc923dcd3b346323cc163d41284f50c3e18123c8882b6083d9770
-  data.tar.gz: ca477403957a8e3a4535dd951b52b186ef6e287cd115cb752d043050bad10db6a886b6ae905ba9958e149bf2cbaf8e2dbb11506fb59aaefe9fc7be8479fa089d
+  metadata.gz: a80b12e5e9a84e3b0ff6476c3f887277b3acc53ce9c79910679b22d791639ce7d74a1f6ca8a7c2d6550ee64ac1866420c08c1c892ac965a2a89fee053d62c504
+  data.tar.gz: 493cfb3d42a71d111c90ccdad26095010d660f78f5748e25f86518918689b2e0524425caa710e3d9e144b881e022650ae4a3ff13781e6923d994bf499ab9f895

data/.gitignore

@@ -10,3 +10,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+/spec/tmp/

data/.rubocop.yml

@@ -1,2 +1,11 @@
 inherit_from:
   - https://relaxed.ruby.style/rubocop.yml
+
+AllCops:
+  Exclude:
+    - tmp/**/*
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "**/bin/*"
+    - "**/exe/*"

data/CHANGELOG.md

@@ -9,6 +9,22 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### 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
+
+### Changed
+
+- Updated solidus_support to 0.4.0 for Zeitwerk and Rails 6 compatibility
+
+### Removed
+
+- Removed solidus_support as a dependency
+
+## [0.2.0] - 2019-12-16
+
+### Added
+
 - Adopted [Apparition](https://github.com/twalpole/apparition) as the deafult JS driver for Capybara
 - Fixed window size to 1920x1080px in feature specs
 - Added [Stale](https://github.com/apps/stale) to automatically mark GitHub issues as stale
@@ -34,6 +50,7 @@ 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.1.1...HEAD
+[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

data/README.md

@@ -1,6 +1,11 @@
 # solidus_dev_support
 
-This is a collection of tools for developing Solidus extensions.
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_dev_support.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_dev_support)
+
+This gem contains common development functionality for Solidus extensions.
+
+If you're looking for runtime tools instead, look at
+[solidus_support](https://github.com/solidusio/solidus_support).
 
 ## Installation
 
@@ -18,6 +23,17 @@ $ bundle
 
 ## Usage
 
+### Extension generator
+
+This gem provides a generator for Solidus extensions. To use it, simply run:
+
+```console
+$ solidus extension my_awesome_extension
+```
+
+This will generate the basic extension structure, already configured to use all the shiny helpers
+in solidus_dev_support.
+
 ### RSpec helpers
 
 This gem provides some useful helpers for RSpec to setup an extension's test environment easily.
@@ -107,7 +123,7 @@ 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 --version minor --tag --release
 ```
 
 The above command will:
@@ -124,7 +140,7 @@ further configuration and usage instructions.
 
 ### Rake tasks
 
-Put this in your `Rakefile`:
+To install extension-related Rake tasks, add this to your `Rakefile`:
 
 ```rb
 require 'solidus_dev_support/rake_tasks'
@@ -133,6 +149,14 @@ SolidusDevSupport::RakeTasks.install
 task default: 'extension:specs'
 ```
 
+(If your extension used the legacy extension Rakefile, then you should completely replace its
+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
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run

data/bin/setup

@@ -1,8 +1,20 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils # rubocop:disable Style/MixinUsage
 
-bundle install
+GEM_ROOT = File.expand_path('..', __dir__)
 
-# Do any other automated setup that you need to do here
+def system(*args)
+  puts "$ #{args.size == 1 ? args.first : args.shelljoin}"
+  super
+end
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+cd GEM_ROOT
+
+puts "\n== Installing Ruby dependencies =="
+system! %{gem install bundler --conservative}
+system! %{bundle check || bundle install}

data/bin/solidus

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+load "#{__dir__}/../exe/solidus"

data/exe/solidus

@@ -3,8 +3,7 @@
 
 require 'optparse'
 
-require 'solidus_dev_support'
-require 'solidus_dev_support/extension'
+require 'solidus_dev_support/version'
 
 Options = Struct.new(:name)
 
@@ -46,6 +45,8 @@ if ARGV.first == 'extension' || ARGV.first == 'e'
     exit 1
   end
 
+  require 'solidus_dev_support'
+  require 'solidus_dev_support/extension'
   SolidusDevSupport::Extension.start
 else
   Parser.parse(ARGV)

data/lib/solidus_dev_support.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "solidus_support"
 require "solidus_dev_support/version"
 
 module SolidusDevSupport
@@ -9,7 +8,7 @@ module SolidusDevSupport
   class << self
     def reset_spree_preferences_deprecated?
       first_version_without_reset = Gem::Requirement.new('>= 2.9')
-      first_version_without_reset.satisfied_by?(SolidusSupport.solidus_gem_version)
+      first_version_without_reset.satisfied_by?(Spree.solidus_gem_version)
     end
   end
 end

data/lib/solidus_dev_support/extension.rb

@@ -2,6 +2,7 @@
 
 require 'thor'
 require 'thor/group'
+require 'pathname'
 
 module SolidusDevSupport
   class Extension < Thor::Group
@@ -23,6 +24,10 @@ module SolidusDevSupport
       directory '.circleci', "#{file_name}/.circleci"
       directory '.github', "#{file_name}/.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"
@@ -45,6 +50,12 @@ module SolidusDevSupport
       def use_prefix(prefix)
         @file_name = prefix + Thor::Util.snake_case(file_name) unless file_name =~ /^#{prefix}/
       end
+
+      def make_executable(path)
+        path = Pathname(path)
+        executable = (path.stat.mode | 0o111)
+        path.chmod(executable)
+      end
     end
   end
 end

data/lib/solidus_dev_support/rubocop/config.yml

@@ -180,6 +180,7 @@ require:
   - rubocop-performance
 
 AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
     - spec/dummy/**/*
     - vendor/**/*

data/lib/solidus_dev_support/templates/extension/Gemfile

@@ -20,6 +20,4 @@ else
   gem 'sqlite3'
 end
 
-gem 'solidus_dev_support', github: 'solidusio-contrib/solidus_dev_support'
-
 gemspec

data/lib/solidus_dev_support/templates/extension/Rakefile

@@ -18,7 +18,7 @@ rescue LoadError # rubocop:disable Lint/HandleExceptions
   # no rspec available
 end
 
-task :first_run do # rubocop:disable Rails/RakeEnvironment
+task :first_run do
   if Dir['spec/dummy'].empty?
     Rake::Task[:test_app].invoke
     Dir.chdir('../../')
@@ -26,7 +26,7 @@ task :first_run do # rubocop:disable Rails/RakeEnvironment
 end
 
 desc 'Generates a dummy app for testing'
-task :test_app do # rubocop:disable Rails/RakeEnvironment
+task :test_app do
   ENV['LIB_NAME'] = '<%=file_name%>'
   Rake::Task['extension:test_app'].invoke
 end

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

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "<%= file_name %>"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+app_root = 'spec/dummy'
+
+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
+end
+
+Dir.chdir 'spec/dummy'
+exec 'bin/rails', *ARGV

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

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+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.erb

@@ -4,20 +4,34 @@ $:.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.name = '<%= file_name %>'
+  s.version = <%= class_name %>::VERSION
+  s.summary = 'TODO'
   s.description = 'TODO'
-  s.license     = 'BSD-3-Clause'
+  s.license = 'BSD-3-Clause'
 
-  # s.author    = 'You'
-  # s.email     = 'you@example.com'
-  # s.homepage  = 'http://www.example.com'
+  # s.author = 'You'
+  # s.email = 'you@example.com'
+  # s.homepage = 'http://www.example.com'
 
-  s.files = Dir["{app,config,db,lib}/**/*", 'LICENSE', 'Rakefile', 'README.md']
+  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' # Set Solidus version
+  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

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

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 require 'solidus_core'
+require 'solidus_support'
+
 require '<%=file_name%>/engine'

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

@@ -1,22 +1,18 @@
 # frozen_string_literal: true
 
+require 'spree/core'
+
 module <%= class_name %>
   class Engine < Rails::Engine
-    require 'spree/core'
+    include SolidusSupport::EngineExtensions::Decorators
+
     isolate_namespace Spree
+
     engine_name '<%= file_name %>'
 
     # use rspec for tests
     config.generators do |g|
       g.test_framework :rspec
     end
-
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
-    end
-
-    config.to_prepare(&method(:activate).to_proc)
   end
 end

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

@@ -5,7 +5,6 @@ inherit_gem:
   solidus_dev_support: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
   Exclude:
     - spec/dummy/**/*
     - vendor/**/*

data/lib/solidus_dev_support/version.rb

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

data/solidus_dev_support.gemspec

@@ -43,7 +43,6 @@ Gem::Specification.new do |spec|
   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 'solidus_support', '~> 0.3.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apparition
@@ -254,20 +254,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: solidus_support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -318,6 +304,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/solidus
 - exe/solidus
 - lib/solidus_dev_support.rb
 - lib/solidus_dev_support/extension.rb
@@ -339,7 +326,9 @@ files:
 - lib/solidus_dev_support/templates/extension/app/assets/javascripts/spree/frontend/%file_name%.js
 - lib/solidus_dev_support/templates/extension/app/assets/stylesheets/spree/backend/%file_name%.css
 - lib/solidus_dev_support/templates/extension/app/assets/stylesheets/spree/frontend/%file_name%.css
-- lib/solidus_dev_support/templates/extension/bin/rails.tt
+- lib/solidus_dev_support/templates/extension/bin/console.tt
+- lib/solidus_dev_support/templates/extension/bin/rails
+- 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

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

@@ -1,7 +0,0 @@
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
-
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/<%= file_name -%>/engine', __FILE__)
-
-require 'rails/all'
-require 'rails/engine/commands'