spree_extension 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea37aba33dd351ffe375fceaff6409f542d094ce9e9faffaef0f8b408951642d
-  data.tar.gz: 5896f80c0bfaac20e6ceb4d5adb909b6b7bf45476131a733e76ccc09865ac382
+  metadata.gz: 67c781fe4a3f36f4bd053578c281d5bc99e4e5960f4ea43cccede5d45ccfb149
+  data.tar.gz: 12f93c0da0c64f95fb8489d8e5c30478148596fcd38ef2ad20b4da7b774f097e
 SHA512:
-  metadata.gz: 40c047eb47006dc1223caef4b38133cbe97e7f91f2d64717d382c0c84fb1f5fd8c645beb399db2d83ce7ca961bd15868a385aa8f01c13ccee29e2f6553d2c895
-  data.tar.gz: 56cff8bea2bb5c78289517a8f897030da73087db526b683e9939c72e86a80b7a1f76fa6c7579d0bbc03f3f86b0eee766473ebc68c04739b5985328907f7c83a8
+  metadata.gz: 63f2739a80d323367f976c9366b319b159db9feb48b7b2e233a2d2c83a98c5f31e37002b662ab5e79c9207cfae7a85e0c2c56357c127bbe51a4da3b796d60df4
+  data.tar.gz: 8d68d1f4038ec9a1d2b721407e40e82bb6b14d2ca1a27ed7ba1883965fb14da844c12a2f88d364f35b83c307357933e5094565c6e044584f36dda9d74efbd419

data/LICENSE.md

@@ -1,26 +1,21 @@
-Copyright (c) 2017-2019 Spark Solutions Sp. z o.o.
-All rights reserved.
+MIT License
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Copyright (c) 2017-present Vendo Connect Inc.
 
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    * Neither the name Spree nor the names of its contributors may be used to
-      endorse or promote products derived from this software without specific
-      prior written permission.
+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:
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+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,44 @@
+# Spree Extension
+
+[![Gem Version](https://badge.fury.io/rb/spree_extension.svg)](https://badge.fury.io/rb/spree_extension)
+
+CLI tool for generating and managing Spree Commerce extensions.
+
+## Installation
+
+```bash
+gem install spree_extension
+```
+
+## Usage
+
+### Create a new extension
+
+```bash
+spree-extension create my_extension
+```
+
+This creates a `spree_my_extension` directory with a complete extension scaffold including engine setup, tests, CI configuration, and more.
+
+### Check version
+
+```bash
+spree-extension version
+```
+
+## After generating
+
+```bash
+cd spree_my_extension
+bundle install
+bundle exec rake test_app
+bundle exec rspec
+```
+
+## Documentation
+
+For more information on developing Spree extensions, see the [Spree Developer Documentation](https://docs.spreecommerce.org/developer).
+
+## License
+
+Spree Extension is released under the [MIT License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+desc 'alias for :build to work with other spree gems'
+task gem: :build do
+end
+
+desc 'alias for :test_app to work with other spree gems'
+task :test_app do
+end

data/bin/spree-extension

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'spree_extension'

data/lib/generators/spree_extension/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module SpreeExtension
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Installs Spree Extension CLI binstub into your application'
+
+      def create_binstub
+        template 'bin/spree-extension', 'bin/spree-extension'
+        chmod 'bin/spree-extension', 0o755
+      end
+
+      def show_post_install_message
+        say_status :installed, 'bin/spree-extension'
+        say ''
+        say 'You can now run Spree Extension commands using:'
+        say '  bin/spree-extension version'
+        say '  bin/spree-extension create my_extension'
+        say ''
+      end
+    end
+  end
+end

data/lib/generators/spree_extension/install/templates/bin/spree-extension

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by the `bin/rails g spree_extension:install` command.
+# It loads your application's bundled version of spree_extension.
+#
+
+require 'bundler/setup'
+require 'spree_extension'

data/lib/spree_extension/extension.rb

@@ -0,0 +1,80 @@
+require 'active_support/core_ext/string/inflections'
+
+module SpreeExtension
+  class Extension < Thor::Group
+    include Thor::Actions
+
+    desc 'builds a spree extension'
+    argument :file_name, type: :string, desc: 'rails app_path', default: 'sample_extension'
+
+    source_root File.expand_path('templates/extension', __dir__)
+
+    def generate
+      use_prefix 'spree_'
+
+      empty_directory file_name
+
+      directory 'app',      "#{file_name}/app"
+      directory 'lib',      "#{file_name}/lib"
+      directory 'bin',      "#{file_name}/bin"
+      directory 'spec',     "#{file_name}/spec"
+
+      empty_directory "#{file_name}/app/models/#{file_name}"
+      empty_directory "#{file_name}/app/views/spree"
+      empty_directory "#{file_name}/app/controllers/spree/admin"
+      empty_directory "#{file_name}/app/controllers/#{file_name}"
+      empty_directory "#{file_name}/app/services/#{file_name}"
+      empty_directory "#{file_name}/app/serializers/spree/api/v3"
+      empty_directory "#{file_name}/app/serializers/spree/api/v3/admin"
+      empty_directory "#{file_name}/vendor/javascript"
+      empty_directory "#{file_name}/vendor/stylesheets"
+
+      chmod "#{file_name}/bin/rails", 0o755
+      chmod "#{file_name}/bin/importmap", 0o755
+
+      template 'extension.gemspec', "#{file_name}/#{file_name}.gemspec"
+      template 'Gemfile', "#{file_name}/Gemfile"
+      template 'gitignore', "#{file_name}/.gitignore"
+      template 'LICENSE.md', "#{file_name}/LICENSE.md"
+      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 'config/initializers/spree.rb', "#{file_name}/config/initializers/spree.rb"
+      template 'config/importmap.rb', "#{file_name}/config/importmap.rb"
+
+      template 'rspec', "#{file_name}/.rspec"
+      template '.github/workflows/tests.yml', "#{file_name}/.github/workflows/tests.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 Spree #{human_name} extension has been generated 🚀
+
+        Next steps:
+        * Read Spree Developer Documentation at: https://docs.spreecommerce.org/developer
+
+        #{'*' * 80}
+      }
+    end
+
+    no_tasks do
+      def class_name
+        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
+    end
+  end
+end

data/lib/spree_extension/templates/extension/.gem_release.yml

@@ -0,0 +1,3 @@
+bump:
+  file: "lib/<%= file_name %>/version.rb"
+

data/lib/spree_extension/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"

data/lib/spree_extension/templates/extension/.github/workflows/tests.yml

@@ -0,0 +1,107 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test-postgres:
+    name: "PostgreSQL"
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DB: postgres
+      DB_HOST: localhost
+      DB_USERNAME: postgres
+      DB_PASSWORD: postgres
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+
+      - name: Install libvips
+        run: sudo apt-get update && sudo apt-get install -y libvips-dev
+
+      - name: Create test app
+        run: bundle exec rake test_app
+
+      - name: Run tests
+        run: bundle exec rspec --format documentation
+
+  test-mysql:
+    name: "MySQL"
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: password
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DB: mysql
+      DB_HOST: 127.0.0.1
+      DB_USERNAME: root
+      DB_PASSWORD: password
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+
+      - name: Install libvips
+        run: sudo apt-get update && sudo apt-get install -y libvips-dev
+
+      - name: Create test app
+        run: bundle exec rake test_app
+
+      - name: Run tests
+        run: bundle exec rspec --format documentation
+
+  brakeman:
+    name: Brakeman
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+
+      - name: Run Brakeman
+        run: bundle exec brakeman --exit-on-warn --exit-on-error

data/lib/spree_extension/templates/extension/.rubocop.yml

@@ -0,0 +1,24 @@
+plugins:
+  - rubocop-rails
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 3.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
+
+Layout/LineLength:
+  Max: 150
+
+# DISABLED
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/lib/spree_extension/templates/extension/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# How to contribute
+
+Third-party patches are essential to any great open source project. We want
+to keep it as easy as possible to contribute changes that get things working
+in your environment. There are a few guidelines that we need contributors to
+follow so that we can have a chance of keeping on top of things.
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git branch
+    fix/master/my_contribution master` then checkout the new branch with `git
+    checkout fix/master/my_contribution`.  Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+    (#99999) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example.  This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the extensions repository.
+* Update any Github issues to mark that you have submitted code and are ready for it to be reviewed.
+  * Include a link to the pull request in the ticket
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/lib/spree_extension/templates/extension/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'rails-controller-testing'
+
+spree_opts = { github: 'spree/spree', branch: 'main' }
+gem 'spree', spree_opts
+gem 'spree_admin', spree_opts
+
+gem 'mysql2' if ENV['DB'] == 'mysql' || ENV['CI']
+gem 'pg' if ENV['DB'] == 'postgres' || ENV['CI']
+
+gem 'sqlite3', '>= 2.0'
+
+gem 'propshaft'
+
+gemspec

data/lib/spree_extension/templates/extension/LICENSE.md

@@ -0,0 +1,9 @@
+# LICENSE
+
+Copyright (c) <%= Time.now.year %> [name of plugin creator]
+
+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/lib/spree_extension/templates/extension/README.md

@@ -0,0 +1,59 @@
+# Spree <%= human_name %>
+
+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
+    bundle add <%= file_name %>
+    ```
+
+2. Run the install generator
+
+    ```ruby
+    bundle exec rails g <%= file_name %>:install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Developing
+
+1. Create a dummy app
+
+    ```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:
+
+```ruby
+require '<%= file_name %>/factories'
+```
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.

data/lib/spree_extension/templates/extension/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = '<%=file_name%>'
+  Rake::Task['extension:test_app'].invoke
+end

data/lib/spree_extension/templates/extension/app/assets/config/%file_name%_manifest.js.tt

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link <%= file_name %>/application.js
+//= link_tree ../../javascript/<%= file_name %>/controllers .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../../../vendor/stylesheets .css

data/lib/spree_extension/templates/extension/app/javascript/%file_name%/application.js.tt

@@ -0,0 +1,16 @@
+import '@hotwired/turbo-rails'
+import { Application } from '@hotwired/stimulus'
+
+let application
+
+if (typeof window.Stimulus === "undefined") {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}
+
+import <%= class_name %>Controller from '<%= file_name %>/controllers/<%= file_name %>_controller' 
+
+application.register('<%= file_name %>', <%= class_name %>Controller)

data/lib/spree_extension/templates/extension/app/javascript/%file_name%/controllers/%file_name%_controller.js.tt

@@ -0,0 +1,7 @@
+import { Controller } from '@hotwired/stimulus'
+
+export default class extends Controller {
+  connect() {
+    console.log('Hello, <%= class_name %>!')
+  }
+}

data/lib/spree_extension/templates/extension/app/jobs/%file_name%/base_job.rb.tt

@@ -0,0 +1,5 @@
+module <%= class_name %>
+  class BaseJob < Spree::BaseJob
+    queue_as <%= class_name %>.queue
+  end
+end

data/lib/spree_extension/templates/extension/bin/importmap

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails'
+
+require 'importmap-rails'
+require 'importmap/commands'

data/lib/spree_extension/templates/extension/bin/rails.tt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" from the root of your extension
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/<%= file_name -%>/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'