spree_cli 5.3.0.rc2 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa8a6afe78433a09e56376aa079e00a947d9a8507596bc27d808599ea22657ca
-  data.tar.gz: b6de6215aa2e342e98169a71dafd9cdefa8990da1152f02a1b7ef55cc731b7ad
+  metadata.gz: b60223cb0e1f940e26e62b146848802c5c2fc143d5e0d7fe85b53c438feef4e3
+  data.tar.gz: 0c4d4843744afc6a8fb84c30a63b4339ffb171b4d46d6a46ca7aceefcf7ba10d
 SHA512:
-  metadata.gz: c85c2025ce0807d17c238db0ff86a66850b4196d1dff597a4fa5c72f77327046826191ca412d999b96f1a5101cb88c63a5be496b2c2335a6c64db878e1f4001d
-  data.tar.gz: '04198188f1438d59b05acbb5dd100da89a864532c3dae727223911ab5650efd356c41709d8e50f18d9ea5b0b310be354e38ae7a6eaaa6e0ace8c98313ed5a3bb'
+  metadata.gz: 6791bebe3544fa5fe81ee4f73997461415ccb5590e1df394028e9cac895e155f0fe37772a46bdc25e024f4eeb230da2350b61f48a005e1f23c05ad4f3217b60f
+  data.tar.gz: d771f82b6c72fc95b9e5c31c6b08a0100f878ea85194577b44253a63a5aa137e2d4658ca18592cf3f808dd9bc1087ffcb0e8f2909cc96eb4ec017552fd41e143

data/README.md

@@ -1,11 +1,182 @@
-Spree CLI
-===============
+# Spree CLI
 
-Command line utility to create new Spree extensions
+[![Gem Version](https://badge.fury.io/rb/spree_cli.svg)](https://badge.fury.io/rb/spree_cli)
 
-To build a new Spree Extension, you can run
-```ruby
+Spree CLI is a command-line tool for Spree Commerce developers, providing generators and utilities for creating Spree extensions and managing Spree projects.
+
+## Installation
+
+This gem is included in every Spree installation.
+
+For global installation (to generate extensions outside of a Spree project):
+
+```bash
+gem install spree_cli
+```
+
+## Commands
+
+### Create New Extension
+
+Generate a new Spree extension with all the necessary boilerplate:
+
+```bash
 spree extension my_extension
 ```
 
-This will create a brand new project with all the developer tools and gems needed to developer your extension.
+This creates a new directory `spree_my_extension` with:
+
+```
+spree_my_extension/
+├── app/
+│   ├── models/
+│   ├── controllers/
+│   └── views/
+├── lib/
+│   ├── spree_my_extension.rb
+│   ├── spree_my_extension/
+│   │   └── engine.rb
+│   └── generators/
+├── config/
+│   ├── routes.rb
+│   └── locales/
+├── db/
+│   └── migrate/
+├── spec/
+├── Gemfile
+├── spree_my_extension.gemspec
+├── README.md
+└── LICENSE
+```
+
+### Extension Options
+
+```bash
+# Create extension with specific options
+spree extension my_extension --path=/custom/path
+
+# View help
+spree help extension
+```
+
+## Extension Development
+
+After creating an extension:
+
+```bash
+cd spree_my_extension
+
+# Install dependencies
+bundle install
+
+# Create test application
+bundle exec rake test_app
+
+# Run tests
+bundle exec rspec
+
+# Build gem
+gem build spree_my_extension.gemspec
+```
+
+### Extension Structure
+
+Generated extensions follow Spree conventions:
+
+```ruby
+# lib/spree_my_extension/engine.rb
+module SpreeMyExtension
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_my_extension'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer 'spree_my_extension.environment', before: :load_config_initializers do |_app|
+      SpreeMyExtension::Config = SpreeMyExtension::Configuration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end
+```
+
+### Adding Models
+
+```ruby
+# app/models/spree/my_model.rb
+module Spree
+  class MyModel < Spree.base_class
+    # Model implementation
+  end
+end
+```
+
+### Adding Controllers
+
+```ruby
+# app/controllers/spree/admin/my_models_controller.rb
+module Spree
+  module Admin
+    class MyModelsController < ResourceController
+      # Controller implementation
+    end
+  end
+end
+```
+
+### Adding Migrations
+
+```bash
+cd spree_my_extension
+bin/rails g migration CreateSpreeMyModels
+```
+
+## Publishing Extensions
+
+1. Update version in `lib/spree_my_extension/version.rb`
+2. Update `CHANGELOG.md`
+3. Build and publish:
+
+```bash
+gem build spree_my_extension.gemspec
+gem push spree_my_extension-1.0.0.gem
+```
+
+## Usage
+
+### In a Spree Application
+
+Add your extension to the application's Gemfile:
+
+```ruby
+gem 'spree_my_extension', '~> 1.0'
+```
+
+Run installation:
+
+```bash
+bundle install
+bin/rails g spree_my_extension:install
+```
+
+## Documentation
+
+- [Extension Development Guide](https://docs.spreecommerce.org/developer/extending-spree/extensions)
+- [Creating Extensions Tutorial](https://docs.spreecommerce.org/developer/tutorials/extensions)
+- [Spree Extensions Directory](https://spreecommerce.org/extensions)
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests
+5. Submit a pull request

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cli
 version: !ruby/object:Gem::Version
-  version: 5.3.0.rc2
+  version: 5.3.0
 platform: ruby
 authors:
 - Chris Mar
@@ -85,9 +85,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0.rc2
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.3.0
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.3.0.rc2
+  source_code_uri: https://github.com/spree/spree/tree/v5.3.0
 rdoc_options: []
 require_paths:
 - lib