spree_variant_options 0.1.0.rc1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*
+public/tmp.html
+lib/dummy_hooks/after_migrate.rb
+test/dummy

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * 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 of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+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.

data/README.md

@@ -0,0 +1,129 @@
+Spree Variant Options
+=====================
+
+Spree Variant Options is a very simple spree extension that groups your variants by 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/1.jpg)
+
+#### After "Medium" is selected, "Medium Blue" is out of stock:
+
+![Spree Variant Options - Option Type/Value selected](http://spree-docs.s3.amazonaws.com/spree_variant_options/2.jpg)
+
+#### And after "Green" is selected:
+![Spree Variant Options - Variant Selcted](http://spree-docs.s3.amazonaws.com/spree_variant_options/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)...
+
+Spree Variant Options hasn't been released to rubygems so you'll have to install it from the source. Just add the following to your Gemfile:
+
+    gem 'spree_variant_options', :git => 'git://github.com/citrus/spree_variant_options.git'  
+  
+Now, bundle up with:
+
+    bundle
+
+Spree Variant Options doesn't require any rake tasks or generators, but you'll need include `app/views/products/_variant_options.html.erb` in your product show view.
+
+If you don't have a custom version of `_cart_form.html.erb` in your application, then don't worry about a thing, spree_variant_options will include the partial for you. Otherwise, just replace the entire `<% if @product.has_variants? %>` block with:
+
+    <%= render 'variant_options' %>
+
+
+Versions
+--------
+
+Spree Variant Options works on Spree 0.30.1 and above... Please let me know if you run into any issues.
+
+
+Testing
+-------
+
+Clone this repo to where you develop, bundle up, then run `dummier' to get the show started:
+
+    git clone git://github.com/citrus/spree_variant_options.git
+    cd spree_variant_options
+    bundle install
+    bundle exec dummier
+
+
+This will generate a fresh rails app in test/dummy, install spree & spree_variant_options, then migrate the test database. Sweet.
+
+
+### Spork + Cucumber
+
+To run the cucumber features, boot spork like this:
+
+    bundle exec spork
+
+Then, in another window, run:
+
+    cucumber --drb
+
+
+### Spork + Test::Unit
+    
+If you want to run shoulda tests, start spork with:
+
+    bundle exec spork TestUnit
+    #or 
+    bundle exec spork t
+        
+In another window, run all tests:
+
+    testdrb test/**/*_test.rb
+    
+Or just a specific test:
+
+    testdrb test/unit/supplier_test.rb
+  
+
+### No Spork
+
+If you don't want to spork, just use rake:
+
+    # cucumber/capybara
+    rake cucumber
+    
+    # test/unit
+    rake test
+    
+    # both
+    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:
+
+    git clone git://github.com/citrus/spree_variant_options.git
+    cd spree_variant_options
+    mv lib/dummy_hooks/after_migrate.rb.sample lib/dummy_hooks/after_migrate.rb
+    bundle install
+    bundle exec dummier
+    cd test/dummy
+    rails s
+    
+
+Contributors
+------------
+
+So far it's just me; Spencer Steffen. 
+
+If you'd like to help out feel free to fork and send me pull requests!
+
+
+License
+-------
+
+Copyright (c) 2011 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+#require 'rake'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+task :default => [ :test, :cucumber ]

data/Versionfile

@@ -0,0 +1,4 @@
+"0.60.x" => { :branch => "master" }
+"0.50.x" => { :branch => "master" }
+"0.40.x" => { :branch => "master" }
+"0.30.x" => { :branch => "master" }

data/app/models/product_decorator.rb

@@ -0,0 +1,27 @@
+Product.class_eval do
+
+  include ActionView::Helpers::NumberHelper
+
+  def option_values
+    option_types.map{|i| i.option_values }.flatten.uniq
+  end
+  
+  def grouped_option_values
+    option_values.group_by(&:option_type)
+  end
+  
+  def variant_options_hash  
+    return @variant_options_hash if @variant_options_hash
+    @variant_options_hash = Hash[grouped_option_values.map{ |type, values| 
+      [type.id.inspect, Hash[values.map{ |value|         
+        [value.id.inspect, Hash[variants.includes(:option_values).select{ |variant| 
+          variant.option_values.select{ |val| 
+            val.id == value.id && val.option_type_id == type.id 
+          }.length == 1 }.map{ |v| [ v.id, { :id => v.id, :count => v.count_on_hand, :price => number_to_currency(v.price) } ] }]
+        ]
+      }]]
+    }]
+    @variant_options_hash
+  end
+  
+end

data/app/views/products/_cart_form.html.erb

@@ -0,0 +1,32 @@
+<%= form_for :order, :url => populate_orders_url do |f| %>
+<%= hook :inside_product_cart_form do %>
+
+  <% if product_price(@product) %>
+    <%= hook :product_price do %>
+      <p class="prices">
+        <%= t("price") %>
+        <br />
+        <span class="price selling"><%= product_price(@product) %></span>
+      </p>
+    <% end %>
+  <% end %>
+
+  <%= render 'variant_options' %>
+    
+  <% if @product.has_stock? || Spree::Config[:allow_backorders] %>
+    <%= text_field_tag (@product.has_variants? ? :quantity : "variants[#{@product.master.id}]"),
+      1, :class => "title", :size => 3 %>
+    &nbsp;
+    <button type='submit' class='large primary'>
+      <%= image_tag('/images/add-to-cart.png') + t('add_to_cart') %>
+    </button>
+  <% else %>
+    <%= content_tag('strong', t('out_of_stock')) %>
+  <% end %>
+
+<% end %>
+<% end %>
+
+<% content_for :head do %>
+  <%= javascript_include_tag 'product' %>
+<% end %>

data/app/views/products/_variant_options.html.erb

@@ -0,0 +1,43 @@
+<% if @product.has_variants? %>
+  <div id="product-variants">
+    <h2><%= t('variants') %></h2>
+        
+    <% index = 0 %>
+    <% @product.grouped_option_values.each do |type, values| %>
+      <div id="<%= dom_id(type) %>" class="variant-options index-<%= index %>">
+        <h3 class="variant-option-type"><%= type.presentation %></h3>
+        <ul class="variant-option-values">
+        <% values.each do |value| %>
+          <% classes = ["option-value"] %>
+          <% if index == 0 %>
+            <% variants = @variants.select{|i| i.option_values.select{|j| j.option_type_id == type.id && j == value }.length == 1 } %>
+            <% if variants.empty? %>
+              <% classes << "unavailable" %>
+            <% else %>
+              <% classes << (variants.sum(&:count_on_hand) < 1 ? "out-of-stock" : "in-stock") %>
+            <% end %>
+          <% end %>
+          <li>       
+            <%= link_to content_tag(:span, value.presentation), "#", :title => value.presentation, :class => classes.join(" "), :rel => "#{type.id}-#{value.id}" %>
+          </li>
+        <% end %>
+          <li class="clear-option"><%= link_to "X", "#clear", :class => "clear-button clear-index-#{index}" %></li>
+          <li class="clear"></li>
+        </ul>
+      </div>
+      <% index += 1 %>
+    <% end %>
+    <%= hidden_field_tag "products[#{@product.id}]", "", :id => "variant_id", :class => "hidden" %>
+    <script type="text/javascript">
+    //<![CDATA[
+    	var variant_options = new VariantOptions(<%== @product.variant_options_hash.to_json %>);
+    //]]>
+    </script>
+    
+  </div>
+<% end%>
+
+<% content_for :head do %>
+  <%= stylesheet_link_tag 'variant_options' %>
+  <%= javascript_include_tag 'variant_options' %>
+<% end %>

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/features/step_definitions/variant_options.rb

@@ -0,0 +1,125 @@
+#===============================
+# Helpers
+
+def variant_by_descriptor(descriptor)
+  values = descriptor.split(" ")
+  values.map! { |word| OptionValue.find_by_presentation(word) rescue nil }.compact!
+  return if values.blank?
+  @product.variants.includes(:option_values).select{|i| i.option_value_ids.sort == values.map(&:id) }.first
+end
+
+
+#===============================
+# Givens
+
+Given /^I have a product( with variants)?$/ do |has_variants|
+  @product = Factory.create(has_variants ? :product_with_variants : :product)
+end
+
+Given /^the "([^"]*)" variant is out of stock$/ do |descriptor|
+  flunk unless @product
+  @variant = variant_by_descriptor(descriptor)
+  @variant.update_attributes(:count_on_hand => 0)
+end
+
+Given /^I have an? "([^"]*)" variant( for .*)?$/ do |descriptor, price|
+  price = price ? price.gsub(/[^\d\.]/, '').to_f : 10.00
+  values = descriptor.split(" ")
+  flunk unless @product && values.length == @product.option_types.length
+  @variant = variant_by_descriptor(descriptor)
+  return @variant if @variant
+  @product.option_type_ids.each_with_index do |otid, index|
+    word = values[index]
+    val = OptionValue.find_by_presentation(word) || Factory.create(:option_value, :option_type_id => otid, :presentation => word, :name => word.downcase) 
+    values[index] = val
+  end
+  @variant = Factory.create(:variant, :product => @product, :option_values => values, :price => price)
+  @product.reload
+end
+
+
+#===============================
+# Whens
+
+When /^I click the (current|first|last) clear button$/ do |parent|
+  link = case parent
+    when 'first'; find(".clear-index-0")
+    when 'last'; find(".clear-index-#{@product.option_types.length - 1}")
+    else find(".clear-button:last")
+  end
+  assert_not_nil link
+  link.click
+end
+
+#===============================
+# Thens
+
+Then /^the source should contain the options hash$/ do
+  assert source.include?("VariantOptions(#{@product.variant_options_hash.to_json})")
+end
+
+Then /^I should see (enabled|disabled)+ links for the ((?!option).*) option type$/ do |state, option_type|
+  enabled = state == "enabled"
+  option_type = case option_type
+    when "first";  @product.option_types.first;
+    when "second"; @product.option_types[1];
+    when "last";   @product.option_types.last;
+  end
+  assert_seen option_type.presentation, :within => "#option_type_#{option_type.id} h3.variant-option-type"
+  option_type.option_values.each do |value|
+    rel = "#{option_type.id}-#{value.id}"
+    link = find("#option_type_#{option_type.id} a[rel='#{option_type.id}-#{value.id}']")
+    assert_not_nil link
+    assert_equal value.presentation, link.text
+    assert_equal "#", link.native.attribute('href').last
+    assert_equal "option-value #{enabled ? 'in-stock' : 'locked'}", link.native.attribute('class')
+    assert_equal rel, link.native.attribute('rel') # obviously!
+  end  
+end
+
+Then /^I should have a hidden input for the selected variant$/ do
+  flunk unless @product
+  field = find("input[type=hidden]#variant_id")
+  assert_not_nil field
+  assert_equal "products[#{@product.id}]", field.native.attribute("name")
+  assert_equal "", field.native.attribute("value")
+end
+
+Then /^the add to cart button should be (enabled|disabled)?$/ do |state|
+  enabled = state == "enabled"
+  button = find("#cart-form button[type=submit]")
+  assert_equal !enabled, button.native.attribute("disabled") == "true"
+end
+
+Then /^I should see an (out-of|in)-stock link for "([^"]*)"$/ do |state, button|
+  in_stock = state == "in"
+  buttons = button.split(", ")
+  buttons.each do |button|
+    link = find_link(button)
+    assert_equal "option-value #{in_stock ? 'in' : 'out-of'}-stock", link.native.attribute("class")
+    assert_not_nil link
+  end
+end
+
+Then /^I should see "([^"]*)" selected within the (first|second|last) set of options$/ do |button, group|
+  parent = case group
+    when 'first'; '.variant-options.index-0'
+    when 'second'; '.variant-options.index-1'
+    when 'last'; ".variant-options.index-#{@product.option_values.length - 1}"
+  end
+  within parent do
+    link = find_link(button)
+    assert_not_nil link
+    assert link.native.attribute("class").include?("selected")
+  end
+end
+
+Then /^I should not see a selected option$/ do
+  assert_raises Capybara::ElementNotFound do
+    find(".option-value.selected")
+  end
+end
+
+Then /^I should be on the cart page$/ do
+  assert_equal cart_path, current_path
+end

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,138 @@
+require 'uri'
+require 'cgi'
+require File.expand_path("../../support/paths.rb", __FILE__)
+require File.expand_path("../../support/selectors.rb", __FILE__)
+
+def get_parent(parent)
+  case parent.sub(/^the\s/, '')
+    when "flash notice";  ".flash"
+    when "first set of options"; "#option_type_#{@product.option_types.first.id}"
+    when "second set of options"; "#option_type_#{@product.option_types[1].id}"
+    when "variant images label"; "#variant-images"
+    when "price"; ".prices .price"    
+    else "[set-your-parent] #{parent}"
+  end
+end
+
+
+#========================================================================
+# Givens
+
+Given /^I'm on the ((?!page).*) page$/ do |path|
+  path = "#{path.downcase.gsub(/\s/, '_')}_path".to_sym
+  begin 
+    visit send(path)
+  rescue 
+    puts "#{path} could not be found!"
+  end
+end
+
+Given /^I'm on the ((?!page).*) page for (.*)$/ do |path, id|
+  case id
+    when "the first product"
+      id = @product ||= Product.last
+  end
+  path = "#{path.downcase.gsub(/\s/, '_')}_path".to_sym
+  begin 
+    visit send(path, id)
+  rescue 
+    puts "#{path} could not be found!"
+  end
+end
+
+
+#========================================================================
+# Actions
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  # wtf button text spree!
+  button = "#popup_ok" if button == "OK"
+  click_button(button)
+end
+
+When /^I press "([^"]*)" in (.*)$/ do |button, parent|
+  # wtf button text spree!
+  button = "#popup_ok" if button == "OK"
+  within get_parent(parent) do
+    click_button(button)
+  end
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )follow "([^"]*)" within (.*)$/ do |link, parent|
+  within get_parent(parent) do
+    click_link(link)
+  end
+end
+
+
+When /^I wait for (\d+) seconds?$/ do |seconds|
+  sleep seconds.to_f
+end
+
+When /^I confirm the popup message$/ do
+  find_by_id("popup_ok").click
+end
+
+
+
+
+
+
+#========================================================================
+# Assertions
+
+Then /^I should see "([^"]*)"$/ do |text|
+  assert page.has_content?(text)
+end
+
+Then /^I should see "([^"]*)" in (.*)$/ do |text, parent|
+  within get_parent(parent) do
+    assert page.has_content?(text)
+  end
+end
+
+Then /^I should not see "([^"]*)"$/ do |text|
+  assert_not page.has_content?(text)
+end
+
+Then /^I should not see "([^"]*)" in (.*)$/ do |text, parent|
+  within get_parent(parent) do
+    assert_not page.has_content?(text)
+  end
+end
+
+Then /^"([^"]*)" should equal "([^"]*)"$/ do |field, value| 
+  assert_equal value, find_field(field).value 
+end 
+
+Then /^"([^"]*)" should have "([^"]*)" selected$/ do |field, value| 
+  field = find_field(field)
+  has_match = field.text =~ /#{value}/
+  has_match = field.value =~ /#{value}/ unless has_match
+  assert has_match
+end 
+
+
+#========================================================================
+# Forms
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+
+