Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

update spree extension generator template

Damian Legawiec8aeceef4470c
diff --git a/cli/lib/spree_cli/extension.rb b/cli/lib/spree_cli/extension.rb
index f319c21478..0b31ee6f60 100644
--- a/cli/lib/spree_cli/extension.rb
+++ b/cli/lib/spree_cli/extension.rb
@@ -1,3 +1,5 @@
+require 'active_support/core_ext/string/inflections'
+
module SpreeCli
class Extension < Thor::Group
include Thor::Actions
@@ -17,6 +19,15 @@ module SpreeCli
directory 'bin', "#{file_name}/bin"
directory 'spec', "#{file_name}/spec"
+ empty_directory "#{file_name}/app/models/spree"
+ empty_directory "#{file_name}/app/models/#{file_name}"
+ empty_directory "#{file_name}/app/views/spree"
+ empty_directory "#{file_name}/app/views/#{file_name}"
+ empty_directory "#{file_name}/app/controllers/spree"
+ empty_directory "#{file_name}/app/controllers/#{file_name}"
+ empty_directory "#{file_name}/app/services/spree"
+ empty_directory "#{file_name}/app/services/#{file_name}"
+
chmod "#{file_name}/bin/rails", 0o755
template 'extension.gemspec', "#{file_name}/#{file_name}.gemspec"
@@ -29,17 +40,19 @@ module SpreeCli
template 'config/locales/en.yml', "#{file_name}/config/locales/en.yml"
template 'rspec', "#{file_name}/.rspec"
template '.circleci/config.yml', "#{file_name}/.circleci/config.yml"
+ template '.github/.dependabot.yml', "#{file_name}/.github/.dependabot.yml"
template '.rubocop.yml', "#{file_name}/.rubocop.yml"
+ template '.gem_release.yml', "#{file_name}/.gem_release.yml"
end
def final_banner
say %{
#{'*' * 80}
- Congrats, Your extension has been generated :rocket:
+ Congrats, Your Spree #{human_name} extension has been generated 🚀
Next steps:
- * Read Spree Developer Documentation at: https://docs.spreecommerce.org/developer/customization
+ * Read Spree Developer Documentation at: https://docs.spreecommerce.org/developer
#{'*' * 80}
}
@@ -50,6 +63,10 @@ module SpreeCli
Thor::Util.camel_case file_name
end
+ def human_name
+ file_name.to_s.gsub('spree_', '').humanize
+ end
+
def use_prefix(prefix)
@file_name = prefix + Thor::Util.snake_case(file_name) unless file_name =~ /^#{prefix}/
end
diff --git a/cli/lib/spree_cli/templates/extension/.circleci/config.yml b/cli/lib/spree_cli/templates/extension/.circleci/config.yml
index 0e35b5a983..f0c4614ed2 100644
--- a/cli/lib/spree_cli/templates/extension/.circleci/config.yml
+++ b/cli/lib/spree_cli/templates/extension/.circleci/config.yml
@@ -1,109 +1,97 @@
version: 2.1
defaults: &defaults
- parameters: &default_parameters
- ruby_image:
- type: string
- restore_cache_key_1:
- type: string
- default: 'spree-bundle-v10-ruby-3-3-{{ .Branch }}'
- restore_cache_key_2:
- type: string
- default: spree-bundle-v10-ruby-3-3
- save_cache_key:
- type: string
- default: "n"
- run_file_path:
- type: string
- rails_version:
- type: string
- default: '~> 7.0.0'
- store_artefacts:
- type: boolean
- default: false
environment: &environment
- CIRCLE_TEST_REPORTS: /tmp/test-results
- CIRCLE_ARTIFACTS: /tmp/test-artifacts
- BUNDLE_JOBS: 4
- BUNDLE_RETRY: 3
- BUNDLE_PATH: ~/spree/vendor/bundle
- RAILS_VERSION: << parameters.rails_version >>
+ CIRCLE_TEST_REPORTS: /tmp/test-results
+ CIRCLE_ARTIFACTS: /tmp/test-artifacts
+ BUNDLE_JOBS: 4
+ BUNDLE_RETRY: 3
+ BUNDLE_PATH: ~/spree/vendor/bundle
working_directory: ~/spree
docker:
- - image: &ruby_image << parameters.ruby_image >>
+ - image: &ruby_image cimg/ruby:3.3-browsers
+run_tests: &run_tests
+ <<: *defaults
+ steps:
+ - checkout
+ - restore_cache:
+ keys:
+ - spree-bundle-{{ .Branch }}
+ - spree-bundle
+ - run:
+ name: Add keyserver
+ command: sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4EB27DB2A3B88B8B
+ - run:
+ name: Install libvips
+ command: sudo apt-get update && sudo apt-get install libvips
+ - run:
+ name: Set bundle path
+ command: bundle config --local path vendor/bundle
+ - run:
+ name: Ensure bundle Install
+ command: |
+ bundle check || bundle install
+ - run:
+ name: Create test app
+ command: |
+ bundle exec rake test_app
+ - run:
+ name: Run Rspec
+ command: |
+ TESTFILES=$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+ bundle exec rspec --format documentation \
+ --format RspecJunitFormatter \
+ -o ~/rspec/rspec.xml \
+ -- ${TESTFILES}
+ - store_test_results:
+ path: ~/rspec
+ - store_artifacts:
+ path: tmp/capybara
jobs:
- run_test: &run_test
+ bundle:
<<: *defaults
- steps: &default_steps
+ steps:
- checkout
- - attach_workspace:
- at: /tmp
- restore_cache:
keys:
- - << parameters.restore_cache_key_1 >>
- - << parameters.restore_cache_key_2 >>
+ - spree-bundle-{{ .Branch }}
+ - spree-bundle
+ - run:
+ name: Add keyserver
+ command: sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4EB27DB2A3B88B8B
+ - run:
+ name: Install libvips
+ command: sudo apt-get update && sudo apt-get install libvips
- run:
- name: Allow executing given file
- command: chmod +x << parameters.run_file_path >>
+ name: Set bundle path
+ command: bundle config --local path vendor/bundle
- run:
- name: Run << parameters.run_file_path >> file
- command: bash << parameters.run_file_path >>
- - when:
- condition: << parameters.save_cache_key >>
- steps:
- - save_cache:
- key: << parameters.save_cache_key >>
- paths:
- - ~/spree/vendor/bundle
- - when:
- condition: << parameters.store_artefacts >>
- steps:
- - store_artifacts:
- path: /tmp/test-artifacts
- destination: test-artifacts
- - store_artifacts:
- path: /tmp/failed_tests
- destination: failed_tests
- - store_artifacts:
- path: /tmp/test-results
- destination: raw-test-output
- - store_test_results:
- path: /tmp/test-results
+ name: Bundle Install
+ command: |
+ bundle check || bundle install
+ - save_cache:
+ paths:
+ - vendor/bundle
+ key: spree-bundle-{{ checksum "Gemfile.lock" }}
- tests_postgres:
- <<: *run_test
- parallelism: << parameters.parallelism >>
- parameters:
- <<: *default_parameters
- postgres_image:
- type: string
- parallelism:
- type: integer
- default: 8
- environment:
+ tests_postgres: &tests_postgres
+ <<: *run_tests
+ environment: &postgres_environment
<<: *environment
DB: postgres
DB_HOST: localhost
DB_USERNAME: postgres
docker:
- image: *ruby_image
- - image: << parameters.postgres_image >>
+ - image: &postgres_image cimg/postgres:16.2
environment:
POSTGRES_USER: postgres
- tests_mysql:
- <<: *run_test
- parallelism: << parameters.parallelism >>
- parameters:
- <<: *default_parameters
- mysql_image:
- type: string
- parallelism:
- type: integer
- default: 8
- environment:
+ tests_mysql: &tests_mysql
+ <<: *run_tests
+ environment: &mysql_environment
<<: *environment
DB: mysql
DB_HOST: 127.0.0.1
@@ -112,25 +100,16 @@ jobs:
COVERAGE_DIR: /tmp/workspace/simplecov
docker:
- image: *ruby_image
- - image: << parameters.mysql_image >>
- command: [--default-authentication-plugin=mysql_native_password]
-
- send_test_coverage:
- <<: *defaults
- steps:
- - checkout
- - attach_workspace:
- at: /tmp/workspace
- - run:
- name: Merge coverage reports
- command:
- bundle check || bundle install &&
- bundle exec rake coverage:report
- - run:
- name: Allow executing given file
- command: chmod +x << parameters.run_file_path >>
- - run:
- name: Send test coverage
- command: bash << parameters.run_file_path >>
+ - image: &mysql_image cimg/mysql:8.0
-# create your workflows here
+workflows:
+ version: 2
+ main:
+ jobs:
+ - bundle
+ - tests_postgres:
+ requires:
+ - bundle
+ - tests_mysql:
+ requires:
+ - bundle
diff --git a/cli/lib/spree_cli/templates/extension/.gem_release.yml b/cli/lib/spree_cli/templates/extension/.gem_release.yml
new file mode 100644
index 0000000000..5bf0937fff
--- /dev/null
+++ b/cli/lib/spree_cli/templates/extension/.gem_release.yml
@@ -0,0 +1,3 @@
+bump:
+ file: "lib/<%= file_name %>/version.rb"
+
diff --git a/cli/lib/spree_cli/templates/extension/.github/.dependabot.yml b/cli/lib/spree_cli/templates/extension/.github/.dependabot.yml
new file mode 100644
index 0000000000..c496bc7ad0
--- /dev/null
+++ b/cli/lib/spree_cli/templates/extension/.github/.dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+ - package-ecosystem: "bundler" # See documentation for possible values
+ directory: "/" # Location of package manifests
+ schedule:
+ interval: "weekly"
diff --git a/cli/lib/spree_cli/templates/extension/Gemfile b/cli/lib/spree_cli/templates/extension/Gemfile
index 4cc6a2b6f4..92e0f8cce4 100644
--- a/cli/lib/spree_cli/templates/extension/Gemfile
+++ b/cli/lib/spree_cli/templates/extension/Gemfile
@@ -5,14 +5,21 @@ git_source(:github) do |repo_name|
"https://github.com/#{repo_name}.git"
end
+gem 'rails-controller-testing'
+
+spree_opts = { github: 'spree/spree', branch: 'main' }
+gem 'spree', spree_opts
+gem 'spree_emails', spree_opts
+
+gem 'spree_backend', github: 'spree/spree_backend', branch: 'main'
+gem 'spree_frontend', github: 'spree/spree_rails_frontend', branch: 'main'
+
if ENV['DB'] == 'mysql'
gem 'mysql2'
+elsif ENV['DB'] == 'postgres'
+ gem 'pg'
else
- gem 'pg', '~> 1.1'
+ gem 'sqlite3', '~> 1.4'
end
-gem 'spree', github: 'spree/spree', branch: 'main'
-# gem 'spree_backend', github: 'spree/spree_backend', branch: 'main'
-gem 'rails-controller-testing'
-
gemspec
diff --git a/cli/lib/spree_cli/templates/extension/README.md b/cli/lib/spree_cli/templates/extension/README.md
index 789d13ef71..dc2c189191 100644
--- a/cli/lib/spree_cli/templates/extension/README.md
+++ b/cli/lib/spree_cli/templates/extension/README.md
@@ -1,39 +1,40 @@
-# <%= class_name %>
+# Spree <%= human_name %>
-Introduction goes here.
+This is a <%= human_name %> extension for [Spree Commerce](https://spreecommerce.org), an open source e-commerce platform built with Ruby on Rails.
## Installation
1. Add this extension to your Gemfile with this line:
```ruby
- gem '<%= file_name %>'
+ bundle add <%= file_name %>
```
-2. Install the gem using Bundler
-
- ```ruby
- bundle install
- ```
-
-3. Copy & run migrations
+2. Copy & run migrations
```ruby
bundle exec rails g <%= file_name %>:install
```
-4. Restart your server
+3. Restart your server
If your server was running, restart it so that it can find the assets properly.
-## Testing
+## Developing
-First bundle your dependencies, then run `rake`. `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 `rake test_app`.
+1. Create a dummy app
-```shell
-bundle update
-bundle exec rake
-```
+ ```bash
+ bundle update
+ bundle exec rake test_app
+ ```
+
+2. Add your new code
+3. Run tests
+
+ ```bash
+ bundle exec rspec
+ ```
When testing your applications integration with this extension you may use it's factories.
Simply add this require statement to your spec_helper:
@@ -42,7 +43,7 @@ Simply add this require statement to your spec_helper:
require '<%= file_name %>/factories'
```
-## Releasing
+## Releasing a new version
```shell
bundle exec gem bump -p -t
diff --git a/cli/lib/spree_cli/templates/extension/extension.gemspec b/cli/lib/spree_cli/templates/extension/extension.gemspec
index 4aaba86a30..b43a59981b 100644
--- a/cli/lib/spree_cli/templates/extension/extension.gemspec
+++ b/cli/lib/spree_cli/templates/extension/extension.gemspec
@@ -7,9 +7,8 @@ require '<%= file_name %>/version'
Gem::Specification.new do |s|
s.platform = Gem::Platform::RUBY
s.name = '<%= file_name %>'
- s.version = <%= class_name %>.version
- s.summary = 'Add extension summary here'
- s.description = 'Add (optional) extension description here'
+ s.version = <%= class_name %>::VERSION
+ s.summary = "Spree Commerce <%= human_name %> Extension"
s.required_ruby_version = '>= 3.0'
s.author = 'You'
diff --git a/cli/lib/spree_cli/templates/extension/lib/%file_name%/configuration.rb.tt b/cli/lib/spree_cli/templates/extension/lib/%file_name%/configuration.rb.tt
index 13dd3cc84a..1dd2b0069c 100644
--- a/cli/lib/spree_cli/templates/extension/lib/%file_name%/configuration.rb.tt
+++ b/cli/lib/spree_cli/templates/extension/lib/%file_name%/configuration.rb.tt
@@ -2,9 +2,9 @@ module <%= class_name %>
class Configuration < Spree::Preferences::Configuration
# Some example preferences are shown below, for more information visit:
- # https://docs.spreecommerce.org/developer/customization
+ # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
- preference :enabled, :boolean, default: true
+ # preference :enabled, :boolean, default: true
# preference :dark_chocolate, :boolean, default: true
# preference :color, :string, default: 'Red'
# preference :favorite_number, :integer
diff --git a/cli/lib/spree_cli/templates/extension/lib/%file_name%/version.rb.tt b/cli/lib/spree_cli/templates/extension/lib/%file_name%/version.rb.tt
index 97402484ef..4d271eea83 100644
--- a/cli/lib/spree_cli/templates/extension/lib/%file_name%/version.rb.tt
+++ b/cli/lib/spree_cli/templates/extension/lib/%file_name%/version.rb.tt
@@ -1,11 +1,7 @@
module <%= class_name %>
VERSION = '0.0.1'.freeze
- module_function
-
- # Returns the version of the currently loaded <%= class_name %> as a
- # <tt>Gem::Version</tt>.
- def version
- Gem::Version.new VERSION
+ def gem_version
+ Gem::Version.new(VERSION)
end
end
diff --git a/cli/lib/spree_cli/templates/extension/lib/generators/%file_name%/install/install_generator.rb.tt b/cli/lib/spree_cli/templates/extension/lib/generators/%file_name%/install/install_generator.rb.tt
index 6415bbfc1d..d7236d10d2 100644
--- a/cli/lib/spree_cli/templates/extension/lib/generators/%file_name%/install/install_generator.rb.tt
+++ b/cli/lib/spree_cli/templates/extension/lib/generators/%file_name%/install/install_generator.rb.tt
@@ -10,7 +10,7 @@ module <%= class_name %>
def run_migrations
run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
if run_migrations
- run 'bundle exec rails db:migrate'
+ run 'bin/rails db:migrate'
else
puts 'Skipping rails db:migrate, don\'t forget to run it!'
end