solidus_dev_support 0.2.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_dev_support"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/solidus

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+
+require 'solidus_dev_support'
+require 'solidus_dev_support/extension'
+
+Options = Struct.new(:name)
+
+class Parser
+  class << self
+    def parse(args)
+      options.parse!(args)
+    end
+
+    def options
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: solidus [[extension extension_name] | [-h] [-v]]'
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+        end
+
+        opts.on(
+          '-v',
+          '--version',
+          "Prints the current version: #{SolidusDevSupport::VERSION}"
+        ) do
+          puts SolidusDevSupport::VERSION
+        end
+      end
+    end
+  end
+end
+
+# Print help if no options are supplied
+ARGV << '--help' unless ARGV.first
+
+if ARGV.first == 'extension' || ARGV.first == 'e'
+  ARGV.shift
+
+  unless ARGV.first
+    puts 'An extension must have a name!'
+    puts `solidus -h`
+    exit 1
+  end
+
+  SolidusDevSupport::Extension.start
+else
+  Parser.parse(ARGV)
+end

data/lib/solidus_dev_support.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "solidus_support"
+require "solidus_dev_support/version"
+
+module SolidusDevSupport
+  class Error < StandardError; end
+
+  class << self
+    def reset_spree_preferences_deprecated?
+      first_version_without_reset = Gem::Requirement.new('>= 2.9')
+      first_version_without_reset.satisfied_by?(SolidusSupport.solidus_gem_version)
+    end
+  end
+end

data/lib/solidus_dev_support/extension.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'thor/group'
+
+module SolidusDevSupport
+  class Extension < Thor::Group
+    include Thor::Actions
+
+    desc 'builds a solidus extension'
+    argument :file_name, type: :string, desc: 'rails app_path', default: '.'
+
+    source_root File.expand_path('templates/extension', __dir__)
+
+    def generate
+      use_prefix 'solidus_'
+
+      empty_directory file_name
+
+      directory 'app', "#{file_name}/app"
+      directory 'lib', "#{file_name}/lib"
+      directory 'bin', "#{file_name}/bin"
+      directory '.circleci', "#{file_name}/.circleci"
+      directory '.github', "#{file_name}/.github"
+
+      template 'extension.gemspec.erb', "#{file_name}/#{file_name}.gemspec"
+      template 'Gemfile', "#{file_name}/Gemfile"
+      template 'gitignore', "#{file_name}/.gitignore"
+      template 'gem_release.yml.tt', "#{file_name}/.gem_release.yml"
+      template 'LICENSE', "#{file_name}/LICENSE"
+      template 'Rakefile', "#{file_name}/Rakefile"
+      template 'README.md', "#{file_name}/README.md"
+      template 'config/routes.rb', "#{file_name}/config/routes.rb"
+      template 'config/locales/en.yml', "#{file_name}/config/locales/en.yml"
+      template 'rspec', "#{file_name}/.rspec"
+      template 'spec/spec_helper.rb.tt', "#{file_name}/spec/spec_helper.rb"
+      template 'rubocop.yml', "#{file_name}/.rubocop.yml"
+    end
+
+    no_tasks do
+      def class_name
+        Thor::Util.camel_case file_name
+      end
+
+      def use_prefix(prefix)
+        @file_name = prefix + Thor::Util.snake_case(file_name) unless file_name =~ /^#{prefix}/
+      end
+    end
+  end
+end

data/lib/solidus_dev_support/rake_tasks.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'pathname'
+
+module SolidusDevSupport
+  class RakeTasks
+    include Rake::DSL
+
+    def self.install(*args)
+      new(*args).tap(&:install)
+    end
+
+    def initialize(root: Dir.pwd)
+      @root = Pathname(root)
+      @test_app_path = @root.join(ENV['DUMMY_PATH'] || 'spec/dummy')
+      @gemspec = Bundler.load_gemspec(@root.glob("{,*}.gemspec").first)
+    end
+
+    attr_reader :test_app_path, :root, :gemspec
+
+    def install
+      install_test_app_task
+      install_rspec_task
+    end
+
+    def install_test_app_task
+      require 'rake/clean'
+      ::CLOBBER.include test_app_path
+
+      ENV['DUMMY_PATH'] = test_app_path.to_s
+      ENV['LIB_NAME'] = gemspec.name
+      require 'spree/testing_support/extension_rake'
+
+      namespace :extension do
+        directory ENV['DUMMY_PATH'] do
+          Rake::Task['extension:test_app']
+
+          # We need to go back to the gem root since extension:test_app changes
+          # the working directory to be the dummy app.
+          cd root
+        end
+      end
+    end
+
+    def install_rspec_task
+      namespace :extension do
+        require 'rspec/core/rake_task'
+        ::RSpec::Core::RakeTask.new(:specs, [] => FileList[ENV['DUMMY_PATH']]) do |t|
+          # Ref: https://circleci.com/docs/2.0/configuration-reference#store_test_results
+          # Ref: https://github.com/solidusio/circleci-orbs-extensions#test-results-rspec
+          if ENV['TEST_RESULTS_PATH']
+            t.rspec_opts =
+              "--format progress " \
+              "--format RspecJunitFormatter  --out #{ENV['TEST_RESULTS_PATH']}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_dev_support/rspec/coverage.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# A SimpleCov and Codecov configuration to track code coverage in your extension
+#
+# Include it AT THE TOP of your spec/spec_helper.rb:
+#
+#     require 'solidus_dev_support/rspec/coverage'
+#
+# Note that things may not work properly if you don't include this at the very top!
+#
+
+require 'simplecov'
+SimpleCov.start('rails') do
+  add_filter %r{^/lib/generators/.*/install/install_generator.rb}
+  add_filter %r{^/lib/.*/factories.rb}
+  add_filter %r{^/lib/.*/version.rb}
+end
+
+if ENV['CI']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end

data/lib/solidus_dev_support/rspec/feature_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# A basic feature_helper to be included as the starting point for extensions
+#
+# Can be required from an extension's spec/feature_helper.rb
+#
+#     require 'solidus_dev_support/rspec/feature_helper'
+#
+
+require 'solidus_dev_support/rspec/rails_helper'
+
+require 'capybara-screenshot/rspec'
+require 'capybara/apparition'
+
+Capybara.javascript_driver = (ENV['CAPYBARA_DRIVER'] || :apparition).to_sym
+Capybara.default_max_wait_time = 10
+Capybara.server = :puma, { Silent: true } # A fix for rspec/rspec-rails#1897
+
+Capybara.register_driver :apparition do |app|
+  Capybara::Apparition::Driver.new(app, window_size: [1920, 1080])
+end
+
+require 'spree/testing_support/capybara_ext'
+
+RSpec.configure do |config|
+  config.when_first_matching_example_defined(type: :feature) do
+    config.before :suite do
+      # Preload assets
+      if Rails.application.respond_to?(:precompiled_assets)
+        Rails.application.precompiled_assets
+      else
+        # For older sprockets 2.x
+        Rails.application.config.assets.precompile.each do |asset|
+          Rails.application.assets.find_asset(asset)
+        end
+      end
+    end
+  end
+end

data/lib/solidus_dev_support/rspec/rails_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# A basic rails_helper to be included as the starting point for extensions
+#
+# Can be required from an extension's spec/rails_helper.rb
+#
+#     require 'solidus_dev_support/rspec/rails_helper'
+#
+
+require 'solidus_dev_support/rspec/spec_helper'
+require 'solidus_dev_support'
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'factory_bot_rails'
+require 'ffaker'
+
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/preferences'
+require 'spree/testing_support/controller_requests'
+require 'solidus_dev_support/testing_support/preferences'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+
+  config.include FactoryBot::Syntax::Methods
+
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  config.include Spree::TestingSupport::ControllerRequests, type: :controller
+
+  config.include Spree::TestingSupport::Preferences
+  config.include SolidusDevSupport::TestingSupport::Preferences
+
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.before do
+    ActiveJob::Base.queue_adapter = :test
+  end
+
+  # Around each spec check if it is a Javascript test and switch between using
+  # database transactions or not where necessary.
+  config.around(:each) do |example|
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+
+    DatabaseCleaner.cleaning do
+      reset_spree_preferences unless SolidusDevSupport.reset_spree_preferences_deprecated?
+
+      example.run
+    end
+  end
+
+  config.include ActiveJob::TestHelper
+end

data/lib/solidus_dev_support/rspec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# A basic spec_helper to be included as the starting point for extensions
+#
+# Can be required from an extension's spec/spec_helper.rb
+#
+#     require 'solidus_dev_support/rspec/spec_helper'
+#
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.mock_with :rspec
+  config.color = true
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = 'random'
+
+  config.raise_errors_for_deprecations!
+
+  config.example_status_persistence_file_path = "./spec/examples.txt"
+
+  Kernel.srand config.seed
+end

data/lib/solidus_dev_support/rubocop.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SolidusDevSupport
+  module RuboCop
+    CONFIG_PATH = "#{__dir__}/rubocop/config.yml"
+
+    def self.inject_defaults!
+      config = ::RuboCop::ConfigLoader.load_file(CONFIG_PATH)
+      puts "configuration from #{CONFIG_PATH}" if ::RuboCop::ConfigLoader.debug?
+      config = ::RuboCop::ConfigLoader.merge_with_default(config, CONFIG_PATH, unset_nil: false)
+      ::RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+    end
+  end
+end
+
+SolidusDevSupport::RuboCop.inject_defaults!

data/lib/solidus_dev_support/rubocop/config.yml

@@ -0,0 +1,201 @@
+# 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:
+  Exclude:
+    - spec/dummy/**/*
+    - 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