solidus_dev_support 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e564494d205d3ad1b785d19a2755125c0b22ddae03f485ae2ff136ed6a84fbcf
-  data.tar.gz: 9f6d4d0d80bcc84c14e0c49ae6d8aff768a41318a08b22281923b670ac2c8e60
+  metadata.gz: 1fd0df647df1542408d2fbcdd5776d3f68cc8b83ab35d37a38fd242b42631299
+  data.tar.gz: 613fde5e9f9b26eb3e477d0b80a6da98936a388e5f604f2f22d191fe7eaa049d
 SHA512:
-  metadata.gz: eeac780a3f6da8740951d1798c1543b6bc4a7def6b9ec5841ccd7600163f5c08c52d26bc5606d006f723666c68f74c78eac71eb6f63830354f736445f4418e9d
-  data.tar.gz: aa0b8514fac3724ab7272af5fe2675ef9eb1aa1d859b8b2ebaf20616efbfad948b3b3a069ed7f553b34310691c2739b675759311167b971f644f894cacab47db
+  metadata.gz: 2af8807191b0fbbaa35acbe9d031c367e75949cd7e66603f826cc2eb4f928e1deef86599c0992f36c34ac7ed18b7a71a9fc2fd5fedf6d8e144af4075fe459f98
+  data.tar.gz: de34c8168e0118e1949b2fe1c2dbda6a9b5791d5c30651f5541fb50ddd2d129685c34d57b9dc3b19aa7590165bc56cb6af3db57b7871060398a11d9c57e6839d

data/CHANGELOG.md

@@ -7,7 +7,23 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
-## [1.3.0]
+## [1.4.0]
+
+### Added
+
+- Added a "Usage" section to the default readme
+
+### Changed
+
+- Restored `bin/rails` and renamed the context specific bins to `bin/rails-engine` and `bin/rails-sandbox`
+- Adjusted the readme structure with better formatting and grammar
+- Moved the RuboCop `AllCops/Exclude` statement back to the internal configuration 
+
+### Deprecated
+
+- Deprecated `bin/r` in favor of `bin/rails-engine` and `bin/sandbox_rails` in favor of `bin/rails-sandbox`
+
+## [1.3.0] - 2020-05-22
 
 ### Added
 
@@ -23,13 +39,13 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Removed Stale from the default extension configuration
 
-## [1.2.0]
+## [1.2.0] - 2020-04-24
 
 ### Changed
 
 - Updated the extension template with the latest modifications
 
-## [1.1.0]
+## [1.1.0] - 2020-03-06
 
 ### Added
 
@@ -176,7 +192,8 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Initial release.
 
-[Unreleased]: https://github.com/solidusio/solidus_dev_support/compare/v1.3.0...HEAD
+[Unreleased]: https://github.com/solidusio/solidus_dev_support/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/solidusio/solidus_dev_support/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/solidusio/solidus_dev_support/compare/v1.2.0...v1.3.0
 [1.2.0]: https://github.com/solidusio/solidus_dev_support/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/solidusio/solidus_dev_support/compare/v1.0.1...v1.1.0

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/sandbox_rails` executable that will
+installed. Using solidus_dev_support your extension will have a `bin/rails-sandbox` executable that will
 operate on a _sandbox_ app (creating it if necessary).
 
-The path for the sandbox app is `./sandbox` and `bin/sandbox_rails` will forward any Rails command
+The path for the sandbox app is `./sandbox` and `bin/rails-sandbox` will forward any Rails command
 to `sandbox/bin/rails`.
 
 Example:
 
 ```bash
-$ bin/sandbox_rails server
+$ bin/rails-sandbox server
 => Booting Puma
 => Rails 6.0.2.1 application starting in development
 * Listening on tcp://127.0.0.1:3000
@@ -80,15 +80,20 @@ 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
+Your extension will have a `bin/rails-engine` 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
+$ bin/rails-engine generate migration AddStoreIdToProducts
 ```
 
+### The `bin/rails` shortcut
+
+For convenience a `bin/rails` executable is also provided that will run everything but generators on the sandbox application. Generators will instead be processed in the context of the extension.
+
+
 ### RSpec helpers
 
 This gem provides some useful helpers for RSpec to setup an extension's test environment easily.

data/lib/solidus_dev_support/rubocop/config.yml

@@ -183,6 +183,7 @@ AllCops:
   TargetRubyVersion: 2.5
   Exclude:
     - spec/dummy/**/*
+    - sandbox/**/*
     - vendor/**/*
 
 Metrics/BlockLength:

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

@@ -1,10 +1,8 @@
-<%= class_name %>
-<%= "=" * class_name.size %>
+# <%= class_name %>
 
-Introduction goes here.
+[Explain what your extension does.] 
 
-Installation
-------------
+## Installation
 
 Add <%= file_name %> to your Gemfile:
 
@@ -19,10 +17,17 @@ bundle
 bundle exec rails g <%= file_name %>:install
 ```
 
-Testing
--------
+## Usage
 
-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`.
+[Explain how to use your extension once it's been installed.]
+
+## Development
+
+### Testing the extension
+
+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
@@ -42,14 +47,13 @@ Simply add this require statement to your spec_helper:
 require '<%= file_name %>/factories'
 ```
 
-Sandbox app
------------
+## Running the sandbox
 
-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`.
+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 commands to
+`sandbox/bin/rails`.
 
-Example:
+Here's an example:
 
 ```shell
 $ bin/rails server
@@ -59,8 +63,7 @@ $ bin/rails server
 Use Ctrl-C to stop
 ```
 
-Releasing
----------
+### Releasing new versions
 
 Your new extension version can be released using `gem-release` like this:
 
@@ -68,4 +71,6 @@ Your new extension version can be released using `gem-release` like this:
 bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
 ```
 
-Copyright (c) <%= Time.now.year %> [name of extension creator], released under the New BSD License
+## License
+
+Copyright (c) <%= Time.now.year %> [name of extension author], released under the New BSD License.

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+warn %{
+DEPRECATION: bin/r has been replaced by bin/rails-engine, please use that
+command instead.
+}.strip
+
+exec "#{__dir__}/rails-engine"

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

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

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

@@ -0,0 +1,16 @@
+#!/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 # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/lib/solidus_dev_support/templates/extension/bin/sandbox_rails

@@ -1,18 +1,8 @@
 #!/usr/bin/env ruby
 
-# frozen_string_literal: true
+warn %{
+DEPRECATION: bin/sandbox_rails has been replaced by bin/rails-sandbox, please
+use that command instead.
+}.strip
 
-app_root = 'sandbox'
-
-unless File.exist? "#{app_root}/bin/rails"
-  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 app_root
-exec 'bin/rails', *ARGV
+exec "#{__dir__}/rails-engine"

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

@@ -1,7 +1,2 @@
 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.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_dev_support
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Alessandro Desantis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apparition
@@ -282,7 +282,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - alessandrodesantis@nebulab.it
 executables:
@@ -330,7 +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/r.tt
+- lib/solidus_dev_support/templates/extension/bin/r
+- lib/solidus_dev_support/templates/extension/bin/rails
+- lib/solidus_dev_support/templates/extension/bin/rails-engine.tt
+- lib/solidus_dev_support/templates/extension/bin/rails-sandbox
 - 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
@@ -357,7 +360,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/solidusio/solidus_dev_support
   source_code_uri: https://github.com/solidusio/solidus_dev_support
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -373,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Development tools for Solidus extensions.
 test_files: []