solidus_dev_support 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32f68913bee63209a6d6dd22002a39bc228b5413205487c5437cf17a98446e48
+  data.tar.gz: 27f0f341b2d37ddfd9795a151eed63bd1a5396b01d8e5ff779643d7a54833d74
+SHA512:
+  metadata.gz: e4ed196776b2f7d34fb2e50e08db666e6d3252008892236e237da41505b14f93bff81057249bc923dcd3b346323cc163d41284f50c3e18123c8882b6083d9770
+  data.tar.gz: ca477403957a8e3a4535dd951b52b186ef6e287cd115cb752d043050bad10db6a886b6ae905ba9958e149bf2cbaf8e2dbb11506fb59aaefe9fc7be8479fa089d

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+Fixes #XXX.
+
+## Summary
+
+<!-- Describe what you have changed in this PR. -->
+
+## Checklist
+
+- [ ] I have structured the commits for clarity and conciseness.
+- [ ] I have added relevant automated tests for this change.
+- [ ] I have added an entry to the changelog for this change.

data/.github/stale.yml

@@ -0,0 +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
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# 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
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop-https---relaxed-ruby-style-rubocop-yml

@@ -0,0 +1,174 @@
+# 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
+

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+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
+
+- 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
+
+### Changed
+
+- Disabled all `Metrics` cops except for `LineLength`
+- Set `Layout/AlignArguments` cop to `with_fixed_indentation`
+- Disabled `Layout/MultilineOperationIndentation` cop
+- Renamed the project to SolidusDevSupport (was SolidusExtensionDevTools)
+
+### Fixed
+
+- Fixed Chrome not starting in headless mode
+
+## [0.1.1] - 2019-11-11
+
+### Fixed
+
+- Fixed `rails_helper` not working due to `SolidusDevSupport` not being available
+
+## [0.1.0] - 2019-11-11
+
+Initial release.
+
+[Unreleased]: https://github.com/solidusio-contrib/solidus_dev_support/compare/v0.1.1...HEAD
+[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/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in solidus_dev_support.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nebulab Srls
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# solidus_dev_support
+
+This is a collection of tools for developing Solidus extensions.
+
+## Installation
+
+Add this gem as a development dependency of your extension:
+
+```ruby
+spec.add_development_dependency 'solidus_dev_support'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+## Usage
+
+### RSpec helpers
+
+This gem provides some useful helpers for RSpec to setup an extension's test environment easily.
+
+Add this to your extension's `spec/spec_helper.rb`:
+
+```ruby
+require 'solidus_dev_support/rspec/feature_helper'
+```
+
+This helper loads configuration needed to run extension feature specs correctly, setting up Capybara
+and configuring a Rails test application to precompile assets before the first feature spec.
+
+`feature_helper` builds on top of `rails_helper`, which you can also use a standalone helper if you
+want:
+
+```ruby
+require 'solidus_dev_support/rspec/rails_helper'
+```
+
+This will include the Rails and Solidus-related RSpec configuration, such as authorization helpers,
+Solidus factories, URL helpers, and other helpers to easily work with Solidus.
+
+`rails_helper`, in turn, builds on top of `spec_helper`, which is responsible for setting up a
+basic RSpec environment:
+
+```ruby
+require 'solidus_dev_support/rspec/spec_helper'
+```
+
+### Code coverage
+
+The gem also includes a SimpleCov configuration that will send your test coverage information
+directly to Codecov.io. Simply add this at the top of your `spec/spec_helper.rb`:
+
+```ruby
+require 'solidus_dev_support/rspec/coverage'
+```
+
+**Note: Make sure to add this at the VERY TOP of your spec_helper, otherwise you'll get skewed
+coverage reports!**
+
+If your extension is in a public repo and being tested on Travis or CircleCI, there's nothing else
+you need to do! If your setup is more complex, look at the
+[SimpleCov](https://github.com/colszowka/simplecov)
+and [codecov-ruby](https://github.com/codecov/codecov-ruby) docs.
+
+### RuboCop configuration
+
+solidus_dev_support includes a default [RuboCop](https://github.com/rubocop-hq/rubocop)
+configuration for Solidus extensions. Currently, this is based on
+[Relaxed Ruby Style](https://relaxed.ruby.style) with a few customizations, but in the future we
+plan to provide custom cops to ensure your extension follows established Solidus best practices.
+
+We strongly recommend including the RuboCop configuration in your extension. All you have to do is
+add this to your `.rubocop.yml`:
+
+```yaml
+require:
+  - solidus_dev_support/rubocop
+```
+
+You can now run RuboCop with:
+
+```console
+$ bundle exec rubocop
+```
+
+### Changelog generator
+
+Generating a changelog for your extension is possible by running this command:
+
+```console
+$ CHANGELOG_GITHUB_TOKEN="«your-40-digit-github-token»" bundle exec github_changelog_generator github_username/github_project
+```
+
+This generates a `CHANGELOG.md`, with pretty Markdown formatting.
+
+For further instructions please read the [GitHub Changelog Generator documentation](https://github.com/github-changelog-generator/github-changelog-generator#usage).
+
+### Release management
+
+By installing solidus_dev_support, you also get
+[`gem release`](https://github.com/svenfuchs/gem-release), which you can use to automatically manage
+releases for your gem.
+
+For instance, you can run the following to release a new minor version:
+
+```console
+gem bump --version minor --tag --release
+```
+
+The above command will:
+
+* bump the gem version to the next minor;
+* commit the change and push it to `upstream/master`;
+* create a Git tag;
+* push the tag to the `upstream` remote;
+* release the new version on RubyGems.
+
+You can refer to
+[`gem release`'s documentation](https://github.com/svenfuchs/gem-release/blob/master/README.md) for
+further configuration and usage instructions.
+
+### Rake tasks
+
+Put this in your `Rakefile`:
+
+```rb
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to 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
+will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/solidus_dev_support.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).