solidus_dev_support 1.5.0 → 2.2.0

data/lib/solidus_dev_support/rspec/rails_helper.rb

@@ -67,14 +67,17 @@ RSpec.configure do |config|
   rescue NameError => e
     class ZeitwerkNameError < NameError; end
 
-    message = <<~WARN
-      Zeitwerk raised the following error when trying to eager load your extension:
-
-      #{if e.message =~ /expected file .*? to define constant [\w:]+/
+    error_message =
+      if e.message =~ /expected file .*? to define constant [\w:]+/
         e.message.sub(/expected file #{Regexp.escape(File.expand_path('../..', Rails.root))}./, "expected file ")
       else
         e.message
-      end}
+      end
+
+    message = <<~WARN
+      Zeitwerk raised the following error when trying to eager load your extension:
+
+      #{error_message}
 
       This most likely means that your extension's file structure is not
       compatible with the Zeitwerk autoloader.

data/lib/solidus_dev_support/rubocop/config.yml

@@ -1,203 +1,82 @@
-# Relaxed.Ruby.Style
-## Version 2.4
-
-Style/Alias:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylealias
-
-Style/AsciiComments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
-
-Style/BeginBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
-
-Style/BlockDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
-
-Style/CommentAnnotation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
-
-Style/Documentation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledocumentation
-
-Layout/DotPosition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
-
-Style/DoubleNegation:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
-
-Style/EndBlock:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleendblock
-
-Style/FormatString:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleformatstring
-
-Style/IfUnlessModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
-
-Style/Lambda:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylelambda
-
-Style/ModuleFunction:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
-
-Style/MultilineBlockChain:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
-
-Style/NegatedIf:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
-
-Style/NegatedWhile:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
-
-Style/NumericPredicate:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylenumericpredicate
-
-Style/ParallelAssignment:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
-
-Style/PerlBackrefs:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
-
-Style/Semicolon:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
-
-Style/SignalException:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
-
-Style/SingleLineBlockParams:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
-
-Style/SingleLineMethods:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
-
-Layout/SpaceInsideParens:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
-
-Style/SpecialGlobalVars:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
-
-Style/StringLiterals:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
-
-Style/TrailingCommaInArguments:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
-
-Style/SymbolArray:
-  Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
-
-Style/WhileUntilModifier:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
-
-Style/WordArray:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#stylewordarray
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
-
-Lint/AssignmentInCondition:
-  Enabled: false
-  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
-
-Metrics/AbcSize:
-  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:
-  Enabled: false
-
-# Our overrides after this point:
-
-require:
-  - rubocop-rspec
-  - rubocop-rails
-  - rubocop-performance
-
-AllCops:
-  TargetRubyVersion: 2.5
-  Exclude:
-    - spec/dummy/**/*
-    - sandbox/**/*
-    - vendor/**/*
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: true
-  Max: 100
-
-RSpec/ExampleLength:
-  Enabled: false
-
-Layout/AlignArguments:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/MultilineOperationIndentation:
-  Enabled: false
+require: ["rubocop-rspec", "rubocop-rails", "rubocop-performance"]
+
+AllCops: {TargetRubyVersion: 2.5, Exclude: ["spec/dummy/**/*", "sandbox/**/*", "vendor/**/*"]}
+
+Layout/ArgumentAlignment: {EnforcedStyle: with_fixed_indentation}
+Layout/DotPosition: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutdotposition"}
+Layout/EmptyLinesAroundAttributeAccessor: {Enabled: true}
+Layout/FirstArgumentIndentation: {EnforcedStyle: "consistent"}
+Layout/FirstArrayElementIndentation: {EnforcedStyle: "consistent"}
+Layout/LineLength: {Enabled: true, Max: 120}
+Layout/MultilineOperationIndentation: {Enabled: false}
+Layout/SpaceAroundMethodCallOperator: {Enabled: true}
+Layout/SpaceBeforeBlockBraces: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutspacebeforeblockbraces"}
+Layout/SpaceInsideParens: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#layoutspaceinsideparens"}
+Lint/AmbiguousRegexpLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#lintambiguousregexpliteral"}
+Lint/AssignmentInCondition: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#lintassignmentincondition"}
+Lint/DeprecatedOpenSSLConstant: {Enabled: true}
+Lint/MixedRegexpCaptureTypes: {Enabled: true}
+Lint/RaiseException: {Enabled: true}
+Lint/StructNewOverride: {Enabled: true}
+Metrics/AbcSize: {Enabled: false}
+Metrics/BlockLength: {Enabled: false}
+Metrics/BlockNesting: {Enabled: false}
+Metrics/ClassLength: {Enabled: false}
+Metrics/CyclomaticComplexity: {Enabled: false}
+Metrics/MethodLength: {Enabled: false}
+Metrics/ModuleLength: {Enabled: false}
+Metrics/ParameterLists: {Enabled: false}
+Metrics/PerceivedComplexity: {Enabled: false}
+Performance/AncestorsInclude: {Enabled: true}
+Performance/BigDecimalWithNumericArgument: {Enabled: true}
+Performance/RedundantSortBlock: {Enabled: true}
+Performance/RedundantStringChars: {Enabled: true}
+Performance/ReverseFirst: {Enabled: true}
+Performance/SortReverse: {Enabled: true}
+Performance/Squeeze: {Enabled: true}
+Performance/StringInclude: {Enabled: true}
+RSpec/DescribeClass: {Exclude: ["spec/features/**/*"]} # Feature specs are not describing any class or module.
+RSpec/ExampleLength: {Enabled: false}
+Style/AccessorGrouping: {Enabled: true}
+Style/Alias: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylealias"}
+Style/AsciiComments: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleasciicomments"}
+Style/BeginBlock: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylebeginblock"}
+Style/BisectedAttrAccessor: {Enabled: true}
+Style/BlockDelimiters: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleblockdelimiters"}
+Style/CommentAnnotation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylecommentannotation"}
+Style/Documentation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styledocumentation"}
+Style/DoubleNegation: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styledoublenegation"}
+Style/EndBlock: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleendblock"}
+Style/ExponentialNotation: {Enabled: true}
+Style/FormatString: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleformatstring"}
+Style/FrozenStringLiteralComment: {Exclude: ["spec/**/*", "db/migrate/**/*", "bin/**/*"]}
+Style/HashEachMethods: {Enabled: true}
+Style/HashTransformKeys: {Enabled: true}
+Style/HashTransformValues: {Enabled: true}
+Style/IfUnlessModifier: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleifunlessmodifier"}
+Style/Lambda: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylelambda"}
+Style/ModuleFunction: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylemodulefunction"}
+Style/MultilineBlockChain: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylemultilineblockchain"}
+Style/NegatedIf: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenegatedif"}
+Style/NegatedWhile: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenegatedwhile"}
+Style/NumericPredicate: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylenumericpredicate"}
+Style/ParallelAssignment: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleparallelassignment"}
+Style/PercentLiteralDelimiters: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylepercentliteraldelimiters"}
+Style/PerlBackrefs: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styleperlbackrefs"}
+Style/RedundantAssignment: {Enabled: true}
+Style/RedundantFetchBlock: {Enabled: true}
+Style/RedundantRegexpCharacterClass: {Enabled: true}
+Style/RedundantRegexpEscape: {Enabled: true}
+Style/Semicolon: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesemicolon"}
+Style/SignalException: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesignalexception"}
+Style/SingleLineBlockParams: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesinglelineblockparams"}
+Style/SingleLineMethods: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylesinglelinemethods"}
+Style/SlicingWithRange: {Enabled: true}
+Style/SpecialGlobalVars: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylespecialglobalvars"}
+Style/StringLiterals: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylestringliterals"}
+Style/SymbolArray: {Enabled: false, StyleGuide: "http://relaxed.ruby.style/#stylesymbolarray"}
+Style/TrailingCommaInArguments: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainarguments"}
+Style/TrailingCommaInArrayLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainarrayliteral"}
+Style/TrailingCommaInHashLiteral: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#styletrailingcommainhashliteral"}
+Style/WhileUntilModifier: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylewhileuntilmodifier"}
+Style/WordArray: {Enabled: false, StyleGuide: "https://relaxed.ruby.style/#stylewordarray"}

data/lib/solidus_dev_support/solidus_command.rb

@@ -2,6 +2,7 @@
 
 require 'thor'
 require 'solidus_dev_support/extension'
+require 'spree/core/version'
 
 module SolidusDevSupport
   class SolidusCommand < Thor
@@ -13,9 +14,15 @@ module SolidusDevSupport
     desc 'e', 'Manage solidus extensions (shortcut for "extension")'
     subcommand 'e', Extension
 
+    desc 'version', 'Displays solidus_dev_support version'
+    def version
+      puts "Solidus version #{Spree.solidus_gem_version}"
+      puts "Solidus Dev Support version #{SolidusDevSupport::VERSION}"
+    end
+    map ['-v', '--version'] => :version
+
     def self.exit_on_failure?
       true
     end
   end
 end
-

data/lib/solidus_dev_support/templates/extension/.circleci/config.yml

@@ -16,12 +16,18 @@ jobs:
     executor: solidusio_extensions/mysql
     steps:
       - solidusio_extensions/run-tests
+  lint-code:
+    executor: solidusio_extensions/sqlite-memory
+    steps:
+      - solidusio_extensions/lint-code
 
 workflows:
   "Run specs on supported Solidus versions":
     jobs:
       - run-specs-with-postgres
       - run-specs-with-mysql
+      - lint-code
+
   "Weekly run specs against master":
     triggers:
       - schedule:

data/lib/solidus_dev_support/templates/extension/.github/stale.yml

@@ -1,17 +1,17 @@
 # Number of days of inactivity before an issue becomes stale
 daysUntilStale: 60
 # Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
+daysUntilClose: false
 # Issues with these labels will never be considered stale
 exemptLabels:
   - pinned
   - security
 # Label to use when marking an issue as stale
-staleLabel: wontfix
+staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable
 markComment: >
   This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
+  recent activity. It might be closed if no further activity occurs. Thank you
   for your contributions.
 # Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false
+closeComment: false

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

@@ -0,0 +1 @@
+# Changelog

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

@@ -1,6 +1,9 @@
-# <%= class_name %>
+# <%= class_name.gsub(/(?<=[^A-Z])([A-Z])/, ' \1') %>
 
-[Explain what your extension does.] 
+[![CircleCI](https://circleci.com/gh/<%= repo %>.svg?style=shield)](https://circleci.com/gh/<%= repo %>)
+[![codecov](https://codecov.io/gh/<%= repo %>/branch/master/graph/badge.svg)](https://codecov.io/gh/<%= repo %>)
+
+<!-- Explain what your extension does. -->
 
 ## Installation
 
@@ -13,13 +16,12 @@ gem '<%= file_name %>'
 Bundle your dependencies and run the installation generator:
 
 ```shell
-bundle
-bundle exec rails g <%= file_name %>:install
+bin/rails generate <%= file_name %>:install
 ```
 
 ## Usage
 
-[Explain how to use your extension once it's been installed.]
+<!-- Explain how to use your extension once it's been installed. -->
 
 ## Development
 
@@ -30,7 +32,6 @@ app if it does not exist, then it will run specs. The dummy app can be regenerat
 `bin/rake extension:test_app`.
 
 ```shell
-bundle
 bin/rake
 ```
 
@@ -55,7 +56,7 @@ the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands t
 
 Here's an example:
 
-```shell
+```
 $ bin/rails server
 => Booting Puma
 => Rails 6.0.2.1 application starting in development
@@ -63,14 +64,21 @@ $ bin/rails server
 Use Ctrl-C to stop
 ```
 
-### Releasing new versions
+### Updating the changelog
 
-Your new extension version can be released using `gem-release` like this:
+Before and after releases the changelog should be updated to reflect the up-to-date status of
+the project:
 
 ```shell
-bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
 ```
 
+### Releasing new versions
+
+Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
+
 ## License
 
 Copyright (c) <%= Time.now.year %> [name of extension author], released under the New BSD License.

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

@@ -5,7 +5,7 @@ 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
+    system "#{__dir__}/sandbox" or begin
       warn 'Automatic creation of the sandbox app failed'
       exit 1
     end