solidus_dev_support 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f56dae194c8b778da9182c440ef9e3114dd3fc85f95884199c4809eda2d902e3
-  data.tar.gz: e8b766266ff7d54e13f706fb0a57682cb4578f834b79ef50d89b401ae1728304
+  metadata.gz: ba24e6dd743046ef4acfa3d5a9f1fe1308f4d2ff5175ca6ace8b537529e4309d
+  data.tar.gz: 0716f96e176e807aa910408e62b930da5719cd7bc2703b03a1a764230f90b76c
 SHA512:
-  metadata.gz: 0db6603ab2abbda31d662be42a9195031a4e6f810e16d4735942189593ac3cae15c526e962f5162a0efb2b5f4412df6f446da6379e03c9e4753fcaf6a73ad75f
-  data.tar.gz: ecffb2ae71fc3188152defc95d8cf0ca3a9a1a26472bc5d6195aa3593e63bdb0804e09be1fa49a9d5d042917a9302c49e968d04d2d7b11dc1679e7a823e44733
+  metadata.gz: 1b9bf1dc55fb744fe1f0aa39ef72a01bb6abc3429530d1b11122afdf71b8ff135e1be280465077f68590eb84c505588cb258602e8ce36ede76511a5008dc075d
+  data.tar.gz: f73be0985dc2937ffd5380019834b578533f31e014c6d22296c0b52b04e4bee12d2b3c8747ddb6114115e8f1c03afe3880bb6ec4befbe63d01da2aa42a337963

data/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- Made Git ignore `sandbox` in generated extensions
+- Added support for specifying `SOLIDUS_BRANCH` in the sandbox
+
+### Changed
+
+- Split `bin/rails` into `bin/r` and `bin/sandbox_rails`
+
+### Fixed
+
+- Fixed the sandbox Gemfile not including Solidus
+
 ## [1.0.1] - 2020-02-17
 
 ### Fixed

data/README.md

@@ -50,16 +50,16 @@ 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
+installed. Using solidus_dev_support your extension will have a `bin/sandbox_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
+The path for the sandbox app is `./sandbox` and `bin/sandbox_rails` will forward any Rails command
 to `sandbox/bin/rails`.
 
 Example:
 
 ```bash
-$ bin/rails server
+$ bin/sandbox_rails server
 => Booting Puma
 => Rails 6.0.2.1 application starting in development
 * Listening on tcp://127.0.0.1:3000
@@ -69,6 +69,25 @@ Use Ctrl-C to stop
 #### Rebuilding the sandbox app
 
 To rebuild the sandbox app just remove the `./sandbox` folder or run `bin/sandbox`.
+You can control the DB adapter and Solidus version used with the sandbox by providing
+the `DB` and `SOLIDUS_BRANCH` env variables.
+
+```bash
+DB=[postgres|mysql|sqlite] SOLIDUS_BRANCH=<BRANCH-NAME> bin/sandbox
+```
+
+By default we use sqlite3 and the master branch.
+
+### Rails generators
+
+Your extension will have a `bin/r` executable that you can use for generating models, migrations
+etc. It's the same as the default `rails` command in Rails engines.
+
+Example:
+
+```bash
+$ bin/r generate migration AddStoreIdToProducts
+```
 
 ### RSpec helpers
 

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

@@ -22,13 +22,19 @@ bundle exec rails g <%= file_name %>:install
 Testing
 -------
 
-First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+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
 ```
 
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
 When testing your application's integration with this extension you may use its factories.
 Simply add this require statement to your spec_helper:
 
@@ -36,6 +42,23 @@ Simply add this require statement to your spec_helper:
 require '<%= file_name %>/factories'
 ```
 
+Sandbox app
+-----------
+
+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`.
+
+Example:
+
+```shell
+$ 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
+```
+
 Releasing
 ---------
 

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

@@ -0,0 +1,13 @@
+#!/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/<%=file_name%>/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'

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

@@ -18,6 +18,13 @@ sqlite|'')
   ;;
 esac
 
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
 extension_name="<%= file_name %>"
 
 # Stay away from the bundler env of the containing extension.
@@ -42,12 +49,13 @@ fi
 
 cd ./sandbox
 cat <<RUBY >> Gemfile
-
-gem '$extension_name', path: '..'
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
 gem 'solidus_auth_devise', '>= 2.1.0'
 gem 'rails-i18n'
 gem 'solidus_i18n'
 
+gem '$extension_name', path: '..'
+
 group :test, :development do
   platforms :mri do
     gem 'pry-byebug'
@@ -69,4 +77,7 @@ unbundled bundle exec rails generate solidus:auth:install
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
 echo "🚀 This app is intended for test purposes."

data/lib/solidus_dev_support/templates/extension/gitignore

@@ -14,3 +14,4 @@ pkg
 *.swp
 spec/dummy
 spec/examples.txt
+/sandbox

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spree/core'
+require '<%= file_name %>'
 
 module <%= class_name %>
   class Engine < Rails::Engine

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

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

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

data/lib/solidus_dev_support/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apparition
@@ -330,9 +330,10 @@ files:
 - 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/console.tt
-- lib/solidus_dev_support/templates/extension/bin/rails
+- lib/solidus_dev_support/templates/extension/bin/r.tt
 - lib/solidus_dev_support/templates/extension/bin/rake
 - lib/solidus_dev_support/templates/extension/bin/sandbox.tt
+- lib/solidus_dev_support/templates/extension/bin/sandbox_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