Solidus Zones By City

Allow city based zones.

Installation

Add solidus_zones_by_city to your Gemfile:

gem 'solidus_zones_by_city'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_zones_by_city:install

Usage

This gem add Spree::Locality model to store cities information and allow Spree::Zone to have Spree::Locality members.

In order to match city based zones you need to use Spree::Locality in your addresses. Easy to you, this gem associate Spree::Address and Spree::StockLocation to use Spree::Locality.

You only need to setup your cities information and update your frontend store accordingly.

Development

Testing the extension

First bundle your dependencies, then run bin/rake. bin/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 bin/rake extension:test_app.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:

require 'solidus_zones_by_city/factories'

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop

Updating the changelog

Before and after releases the changelog should be updated to reflect the up-to-date status of the project:

bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"

Releasing new versions

Your new extension version can be released using gem-release like this:

bundle exec gem bump -v VERSION --tag --push --remote origin && gem release

License

Copyright (c) 2020 [name of extension author], released under the New BSD License.