solidus_dev_support 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe993c357db63da319ab7b482eabd1ab7ceedf0a1f83d1f851f4eda2a195b4a
-  data.tar.gz: 0b63c3d1e43bd550057bfa6e713dd995626f97f69ed319dd8b331f3391e08557
+  metadata.gz: de90c411c336bc81c47f733d981c94bd1ab190b67ac4f3d4150137939d80e334
+  data.tar.gz: 5fc688becf3ee554bd58ed6c1b93ffc1d780d99ef49965e1820a09ee735cb148
 SHA512:
-  metadata.gz: a021a1a433d58aafba6b5e795e190a6d16cbe58f10a11906a4a0039faa6bf80e3cab2819091e85df725e53c623689e7e5ef5e4e8af82c5865cb7fcd1f8153b2c
-  data.tar.gz: 5bc26377586f11f2ac750251adf044aa62c11be97b9edb2037ae4463cbd3be080bcb8418571ae9c0b5321f3273739310ab3678a10c9f48349db6880e84e8929a
+  metadata.gz: 0d2309d00fc65e1883f45a8d197a9b8da364da2f9752a9cdf0dab4fe15907ed71bdde00d16c981623ebdf6e7a48accd1c6384a8abe22a6fce90ec06a3fa13e30
+  data.tar.gz: b219aa253dc28f0d899c3fd336918d5b5a55074829e3b66ad30b29b261e37621cc5c89c7fd59275b47515adfb7c2ea5f7b5ad7fe115c12939ffdadda711f6a28

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

@@ -7,11 +7,21 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### 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
 

data/README.md

@@ -47,6 +47,29 @@ In case of conflicting files, you will be prompted for an action. You can overwr
 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.
@@ -174,7 +197,7 @@ This will provide the following tasks:
 If your extension requires the `test_app` to be always recreated you can do so by running:
 
 ```rb
-bundle exec rake extension:test_app extension:specs
+bin/rake extension:test_app extension:specs
 ```
 
 ## Development
@@ -183,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/lib/solidus_dev_support/extension.rb

@@ -22,16 +22,11 @@ module SolidusDevSupport
       directory '.circleci', "#{path}/.circleci"
       directory '.github', "#{path}/.github"
 
-      %w[
-        bin/console
-        bin/rails
-        bin/setup
-      ].each do |bin|
-        template bin, "#{path}/#{bin}"
-        make_executable "#{path}/#{bin}"
+      Dir["#{path}/bin/*"].each do |bin|
+        make_executable bin
       end
 
-      template 'extension.gemspec.erb', "#{path}/#{file_name}.gemspec"
+      template 'extension.gemspec', "#{path}/#{file_name}.gemspec"
       template 'Gemfile', "#{path}/Gemfile"
       template 'gitignore', "#{path}/.gitignore"
       template 'gem_release.yml.tt', "#{path}/.gem_release.yml"
@@ -56,6 +51,56 @@ module SolidusDevSupport
 
         @root = File.dirname(path)
         @path = File.join(@root, @file_name)
+
+        @gemspec = existing_gemspec || default_gemspec
+      end
+
+      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)
@@ -64,7 +109,7 @@ module SolidusDevSupport
         path.chmod(executable)
       end
 
-      attr_reader :root, :path, :file_name, :class_name
+      attr_reader :root, :path, :file_name, :class_name, :gemspec
     end
 
     def self.source_root

data/lib/solidus_dev_support/rake_tasks.rb

@@ -21,6 +21,7 @@ module SolidusDevSupport
 
     def install
       install_test_app_task
+      install_dev_app_task
       install_rspec_task
     end
 
@@ -47,6 +48,14 @@ module SolidusDevSupport
       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'
 

data/lib/solidus_dev_support/templates/extension/Gemfile

@@ -26,5 +26,8 @@ end
 gemspec
 
 # 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'
+# 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/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/bin/rails

@@ -2,12 +2,15 @@
 
 # frozen_string_literal: true
 
-app_root = 'spec/dummy'
+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
 

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

@@ -5,4 +5,4 @@ set -vx
 
 gem install bundler --conservative
 bundle update
-bundle exec rake clobber
+bin/rake clobber

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusDevSupport
-  VERSION = "0.6.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.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apparition
@@ -331,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