spree_cli 4.7.3 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf183bdea00f8cec04707bd3166b9dd6bf2c084b605b4306c60bcd3b0f640bee
-  data.tar.gz: 00e6d882ccab3c70aa5135950b3fc3dc1f9f3196c18a4c99c83264b5086a6e89
+  metadata.gz: 18fb886a96dc4546bf239aacc6db85066316b9dfa812f81277d19c1d92c93bc1
+  data.tar.gz: 9cd24b274c6a89779889253500b6b30e6e6e72c2c061f41edbfe3c609d9b9899
 SHA512:
-  metadata.gz: dd62a09e00c1115f8ad51f4f98360328a814fd4b72918e822789d5728b6c9494f49663b7d1db7fc83c7851bd878cd0fcd18613bcda0e32db325006232e7c8e59
-  data.tar.gz: 81200aa08f8004b4c0db9ee6141209d1017d803c9ca786f513d34dac5c0552a84ef3bf831ac654089be3580d898adfbe2f0b74e783089ba6a12bd39fa68921e4
+  metadata.gz: f4860fb9857945bc5cdc4e0f779021ae90143fb03d3010f7f6cd49108870119587fd9bc6ba53dd704df14b775f2da20a3983dc74d532656bbbdae5a1e572456a
+  data.tar.gz: 1e408fff5fa42e74f09ed8dd3c4c05bd99a020b951424353c313a1d897c70c3d48f09ed1acfa7c484bd0183760df399a632a4dcdff0f8f8fedf39ed8fd97d899

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2015, Spree Commerce, Inc. and other contributors
+Copyright (c) 2007-2024, Spree Commerce, Inc., Spark Solutuons Sp. z o.o. and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/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"
@@ -28,19 +39,20 @@ module SpreeCli
       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 'travis.yml', "#{file_name}/.travis.yml"
+      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://dev-docs.spreecommerce.org/customization
-        * Start your extension at: https://dev-docs.spreecommerce.org/extensions/extensions
+        * Read Spree Developer Documentation at: https://docs.spreecommerce.org/developer
 
         #{'*' * 80}
       }
@@ -51,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

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

@@ -0,0 +1,115 @@
+version: 2.1
+
+defaults: &defaults
+  environment: &environment
+    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 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:
+  bundle:
+    <<: *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: Bundle Install
+          command: |
+            bundle check || bundle install
+      - save_cache:
+          paths:
+            - vendor/bundle
+          key: spree-bundle-{{ checksum "Gemfile.lock" }}
+
+  tests_postgres: &tests_postgres
+    <<: *run_tests
+    environment: &postgres_environment
+      <<: *environment
+      DB: postgres
+      DB_HOST: localhost
+      DB_USERNAME: postgres
+    docker:
+      - image: *ruby_image
+      - image: &postgres_image cimg/postgres:16.2
+        environment:
+          POSTGRES_USER: postgres
+
+  tests_mysql: &tests_mysql
+    <<: *run_tests
+    environment: &mysql_environment
+      <<: *environment
+      DB: mysql
+      DB_HOST: 127.0.0.1
+      DB_USERNAME: root
+      COVERAGE: true
+      COVERAGE_DIR: /tmp/workspace/simplecov
+    docker:
+      - image: *ruby_image
+      - image: &mysql_image cimg/mysql:8.0
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - bundle
+      - tests_postgres:
+          requires:
+            - bundle
+      - tests_mysql:
+          requires:
+            - bundle

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

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

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

data/lib/spree_cli/templates/extension/Gemfile

@@ -5,8 +5,21 @@ git_source(:github) do |repo_name|
   "https://github.com/#{repo_name}.git"
 end
 
-gem 'spree', github: 'spree/spree', branch: 'main'
-# gem 'spree_backend', github: 'spree/spree', branch: 'main'
 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 'sqlite3', '~> 1.4'
+end
+
 gemspec

data/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

data/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'

data/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://dev-docs.spreecommerce.org/internals/preferences
+   # 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

data/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

data/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

data/spree_cli.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.metadata = {
     "bug_tracker_uri"   => "https://github.com/spree/spree/issues",
     "changelog_uri"     => "https://github.com/spree/spree/releases/tag/v#{s.version}",
-    "documentation_uri" => "https://dev-docs.spreecommerce.org/",
+    "documentation_uri" => "https://docs.spreecommerce.org/",
     "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
   }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cli
 version: !ruby/object:Gem::Version
-  version: 4.7.3
+  version: 4.8.0
 platform: ruby
 authors:
 - Chris Mar
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -41,6 +41,9 @@ files:
 - bin/spree_cli
 - lib/spree_cli.rb
 - lib/spree_cli/extension.rb
+- lib/spree_cli/templates/extension/.circleci/config.yml
+- lib/spree_cli/templates/extension/.gem_release.yml
+- lib/spree_cli/templates/extension/.github/.dependabot.yml
 - lib/spree_cli/templates/extension/.rubocop.yml
 - lib/spree_cli/templates/extension/CONTRIBUTING.md
 - lib/spree_cli/templates/extension/Gemfile
@@ -66,16 +69,15 @@ files:
 - lib/spree_cli/templates/extension/rspec
 - lib/spree_cli/templates/extension/spec/.rubocop.yml
 - lib/spree_cli/templates/extension/spec/spec_helper.rb
-- lib/spree_cli/templates/extension/travis.yml
 - spree_cli.gemspec
 homepage: https://spreecommerce.org
 licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.7.3
-  documentation_uri: https://dev-docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.7.3
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.8.0
+  documentation_uri: https://docs.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.8.0
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/spree_cli/templates/extension/travis.yml

@@ -1,37 +0,0 @@
-os: linux
-dist: bionic
-
-addons:
-  apt:
-    sources:
-      - google-chrome
-    packages:
-      - google-chrome-stable
-
-services:
-  - mysql
-  - postgresql
-
-language: ruby
-
-rvm:
-  - 2.7
-  - 3.0
-
-env:
-  - DB=mysql
-  - DB=postgres
-
-before_install:
-  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
-
-before_script:
-  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
-  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
-  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
-  - unzip chromedriver_linux64.zip -d ~/bin
-  - nvm install 16
-
-script:
-  - bundle exec rake test_app
-  - bundle exec rspec