https://github.com/kinduff/spree_variant_options

Last synced: 4 months ago
JSON representation

Host: GitHub
URL: https://github.com/kinduff/spree_variant_options
Owner: kinduff
License: bsd-3-clause
Created: 2014-09-24T17:40:31.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2014-09-24T20:33:28.000Z (almost 12 years ago)
Last Synced: 2025-02-22T21:43:40.501Z (over 1 year ago)
Size: 4.54 MB
Stars: 0
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[ ![Codeship Status for deseretbook/spree_variant_options](https://codeship.io/projects/e0401320-e04b-0131-fce5-3a1d3d24338d/status?branch=master)](https://codeship.io/projects/25125)

Spree Variant Options is a very simple spree extension that replaces the radio-button variant selection with groups of option types and values. To get a better idea let's let a few images do the explaining.

#### When no selection has been made:
![Spree Variant Options - No selection](http://spree-docs.s3.amazonaws.com/spree_variant_options/v0.3.1/1.jpg)

#### After "Large" is selected, "Large Blue" is out of stock:

![Spree Variant Options - Option Type/Value selected](http://spree-docs.s3.amazonaws.com/spree_variant_options/v0.3.1/2.jpg)

#### And after "Green" is selected:
![Spree Variant Options - Variant Selcted](http://spree-docs.s3.amazonaws.com/spree_variant_options/v0.3.1/3.jpg)

To see it in action, follow the steps for "Demo" below.

------------------------------------------------------------------------------
Installation
------------------------------------------------------------------------------

If you don't already have an existing Spree site, [click here](https://gist.github.com/946719) then come back later... You can also read the Spree docs [here](http://spreecommerce.com/documentation/getting_started.html)...

To install Spree Variant Options, just add the following to your Gemfile:

```ruby
gem 'spree_variant_options'
```

If you're on an older version of Spree, please reference the [Versionfile](https://github.com/citrus/spree_variant_options/blob/master/Versionfile) for your Spree version.

Now, bundle up with:

```bash
bundle
```

Next, run the install generator to copy the necessary migration to your project and migrate your database:

```bash
rails g spree_variant_options:install
rake db:migrate
```

------------------------------------------------------------------------------
Configuration Options
------------------------------------------------------------------------------

Spree Variant Options comes with some handy options:

- allow_select_outofstock (default : false)
When using extension like ([spree_wishlist](https://github.com/spree/spree_wishlist)), you might want to allow your customer to add out of stock product by selecting out of stock variant options :
```erb
<%= form_for Spree::WishedProduct.new, :html => {:"data-form-type" => "variant"} do |f| %>
<%= f.hidden_field :variant_id, :value => @product.master.id %>

<%= t(:add_to_wishlist) %>

<% end %>
```
By setting allow_select_outofstock to true, when an user selects variant options it will automatically update any form's input variant_id with an data-form-type="variant" attribute.

- default_instock (default: false)
If this is option is set to true, it will automatically preselect in-stock variant options.

These configuration options can be set in a config/initializers/spree_variant_options.rb file for example :
```ruby
SpreeVariantOptions::VariantConfig.allow_select_outofstock = true
SpreeVariantOptions::VariantConfig.default_instock = true
```

### Storage options
Like in spree core there is support for storage of images on S3.
Storage on S3 is enabled with the same configuration as in spree core.

Example: config/initializers/spree.rb

```ruby
Spree.config do |config|
config.use_s3 = true
config.s3_bucket =
config.s3_access_key =
config.s3_secret =
end
```

------------------------------------------------------------------------------
Versions
------------------------------------------------------------------------------

Spree Variant Options is compatible with Spree 0.30.x through 2.0.x. Please reference `Versionfile` for more details.

------------------------------------------------------------------------------
Testing
------------------------------------------------------------------------------

Clone this repo to where you develop, bundle up, then run `rake test_app' to get the show started:

```bash
git clone git://github.com/citrus/spree_variant_options.git
cd spree_variant_options
bundle install
bundle exec rake test_app

# cucumber/capybara
bundle exec rake cucumber

# test/unit
bundle exec rake test

# both
bundle exec rake
```

POW!

------------------------------------------------------------------------------
Demo
------------------------------------------------------------------------------

You can easily use the test/dummy app as a demo of spree_variant_options. Just `cd` to where you develop and run:

```bash
git clone git://github.com/citrus/spree_variant_options.git
cd spree_variant_options
bundle install
bundle exec rake test_app
cd test/dummy
rails s
```

------------------------------------------------------------------------------
Contributors
------------------------------------------------------------------------------

* Spencer Steffen ([@citrus](https://github.com/citrus))
* Stéphane Bounmy ([@sbounmy](https://github.com/sbounmy))
* Dan Morin ([@danmorin](https://github.com/danmorin))
* Richard Brown ([@rbrown](https://github.com/rbrown))
* [@baracek](https://github.com/baracek)
* [@Numerico](https://github.com/Numerico)

If you'd like to help out feel free to fork and send me pull requests!

------------------------------------------------------------------------------
License
------------------------------------------------------------------------------

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/kinduff/spree_variant_options

Awesome Lists containing this project

README