spree_myriad_options 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+log/*.log
+tmp/*
+spec/dummy

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@global

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,213 @@
+PATH
+  remote: .
+  specs:
+    spree_myriad_options (0.0.2)
+      spree_core (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    active_utils (1.0.3)
+      activesupport (>= 2.3.11)
+      i18n
+    activemerchant (1.20.4)
+      active_utils (>= 1.0.2)
+      activesupport (>= 2.3.11)
+      braintree (>= 2.0.0)
+      builder (>= 2.0.0)
+      i18n
+      json (>= 1.5.1)
+      money (<= 3.7.1)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    acts_as_list (0.1.4)
+    arel (3.0.2)
+    aws-sdk (1.3.9)
+      httparty (~> 0.7)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+      uuidtools (~> 2.1)
+    braintree (2.16.0)
+      builder (>= 2.0.0)
+    builder (3.0.0)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.2)
+      ffi (~> 1.0.6)
+    cocaine (0.2.1)
+    deface (0.9.1)
+      nokogiri (~> 1.5.0)
+      rails (~> 3.1)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.6.4)
+      activesupport (>= 2.3.9)
+    factory_girl_rails (1.7.0)
+      factory_girl (~> 2.6.0)
+      railties (>= 3.0.0)
+    ffaker (1.12.1)
+    ffi (1.0.11)
+    guard (1.0.2)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.11)
+      guard (>= 0.8.4)
+    highline (1.6.11)
+    hike (1.2.1)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.0)
+    journey (1.0.3)
+    jquery-rails (2.0.2)
+      railties (>= 3.2.0, < 5.0)
+      thor (~> 0.14)
+    json (1.7.3)
+    kaminari (0.13.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    money (3.7.1)
+      i18n (~> 0.4)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    nested_set (1.7.0)
+      activerecord (>= 3.0.0)
+      railties (>= 3.0.0)
+    nokogiri (1.5.3)
+    paperclip (2.7.0)
+      activerecord (>= 2.3.0)
+      activesupport (>= 2.3.2)
+      cocaine (>= 0.0.2)
+      mime-types
+    polyamorous (0.5.0)
+      activerecord (~> 3.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
+      bundler (~> 1.0)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    ransack (0.6.0)
+      actionpack (~> 3.0)
+      activerecord (~> 3.0)
+      polyamorous (~> 0.5.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rspec-rails (2.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.9.0)
+    rubyzip (0.9.8)
+    selenium-webdriver (2.20.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      multi_json (~> 1.0)
+      rubyzip
+    shoulda-matchers (1.0.0)
+    spree_core (1.1.1)
+      activemerchant (= 1.20.4)
+      acts_as_list (= 0.1.4)
+      aws-sdk (~> 1.3.4)
+      deface (>= 0.8.0)
+      ffaker (~> 1.12.0)
+      highline (= 1.6.11)
+      jquery-rails (~> 2.0.0)
+      kaminari (>= 0.13.0)
+      nested_set (= 1.7.0)
+      paperclip (~> 2.7)
+      rails (>= 3.2.2, <= 3.2.3)
+      ransack (~> 0.6.0)
+      state_machine (= 1.1.2)
+      stringex (~> 1.3.2)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    state_machine (1.1.2)
+    stringex (1.3.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    uuidtools (2.1.2)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  factory_girl_rails (~> 1.7)
+  ffaker
+  guard-rspec (~> 0.5.0)
+  rspec-rails (~> 2.9.0)
+  shoulda-matchers (~> 1.0.0)
+  spree_myriad_options!
+  sqlite3

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 [name of plugin creator]
+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 Spree 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,114 @@
+Spree Myriad Options
+==================
+
+This extension makes a few changes to the Spree data model and controller
+logic, to let you create Products with many Option Types/Values, but not have
+to maintain sets of Variants for each combination.
+
+In other words, if you have a store where Products have 5 user-selectable
+options, and each option has 10 potential values, and you want to offer every
+combination of those options to customers, in a default Spree installation your
+store admin would be faced with creating and maintaining 97,656,259 Variants -
+just for that product.
+
+This extension bypasses the LineItem/Variant/Option Value relationship to make
+that uneccessary. You just create the list of Option Types and Option Values
+normally in Spree, and associate those as needed to Products. A LineItem then
+has many OptionValue's directly, and only is tied to the 'master' variant for
+that product.
+
+Of course, with this extension, inventory is no longer tracked on a
+per-option-combination (Variant) basis. It is only tracked per-product (Master
+Variant).  The use case would assume that inventory is not important, or that
+products are manufactured to order.
+
+Changes to the Product add-to-cart form will list selections for each option as
+a set of radio buttons.
+
+In the admin, Option Values also get a new 'adder' field, which is added to the
+line item price when that option is selected and added to the cart.
+
+Option Values can also be set up by the admin with a "Customization Lines"
+numeric value, which may be useful for "Engraving Message" or similar
+user-entered text. This should result in the customer seeing the specified
+number of fields below each option value, which they can fill out as needed.
+There is as yet no validation on these user-generated values.
+
+
+Status
+======
+
+Version 0.1.0
+
+Tests complete and passing.
+
+Example
+=======
+
+Add to gemfile
+
+    gem 'spree_myriad_options', :git => 'git://github.com/sbeam/spree_myriad_options.git'
+
+Install
+
+    $ bundle
+    $ bundle exec rake railties:install:migrations FROM=spree_myriad_options
+    $ bundle exec rake db:migrate
+
+Restart Rails, and in your Products admin, add some Option Types and Values to
+a Product (and remove any Variants - only the invisible 'master' Variant should
+exist on a Product for this extension to affect it.
+
+Then in the Product detail page you should see sets of radio buttons for each
+configured option. Each cart/order view should display the selected options in
+the line item detail.
+
+Note, this extension might not jive with some others, like
+`spree_variant_options` (although it's a great extension, it still would
+require maintaining Variants for each option combination)
+
+Similar Gems
+------------
+
+You might also want to look at
+[spree_flexi_variants](https://github.com/jsqu99/spree_flexi_variants) which
+has similar goals, and more features than this. Since our needs were simpler,
+this was begun as a total rewrite that would simply provide a way around the
+Variant maintance problem in Spree, no more no less. There are now a few more
+features, but think of this as more a clean, well-tested blank-slate that can
+be built upon to meet your app's needs, rather than a turnkey install-and-go
+extension.
+
+TODO
+----
+
+  * replace simple `option_value.customization_lines` with Customization
+    classes, ie includable modules with field definitions and validation
+    callbacks
+  * (maybe) some JS to auto-update the price on the product detail form
+
+Contributions
+-------------
+
+feedback, ideas, reports, new features and fixes would be great. Fork and
+create a pull request. Patches should come with green tests.
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the
+specs to run against.
+
+in Spree 1.1.2+, you should be able to do this -
+
+    $ bundle
+    $ bundle exec rake test_app
+    $ bundle exec guard
+
+But, due to an issue with the dummy app generator and namespacing in
+Spree 1.1.1 (see https://github.com/spree/spree/issues/1580) you will need to
+create a barebones Spree site somewhere else and hook this engine to that for
+testing. See `spec/spec_helper.rb` and change the `path_to_test_store` value.
+
+Copyright (c) 2012 [Sam Beam, creator], released under the New BSD License
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree/core/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+spec = eval(File.read('spree_myriad_options.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc 'Release to gemcutter'
+task :release => :package do
+  require 'rake/gemcutter'
+  Rake::Gemcutter::Tasks.new(spec).define
+  Rake::Task['gem:push'].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_myriad_options'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,12 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+# Examples
+#
+# '1.2.x'  => { :branch => 'master' }
+# '1.1.x'  => { :branch => '1-1-stable' }
+# '1.0.x'  => { :branch => '1-0-stable' }
+# '0.70.x' => { :branch => '0-70-stable' }
+# '0.40.x' => { :tag => 'v1.0.0', :version => '1.0.0' }
+
+'1.1.x'  => { :branch => 'master' }

data/app/controllers/spree/orders_controller_decorator.rb

@@ -0,0 +1,31 @@
+Spree::OrdersController.class_eval do
+
+  # prepend to orders#populate to
+  # look for params[:options] and attach the option values
+  # to the add_variant call
+  def populate_with_options
+    @order = current_order(true)
+
+    if params[:options].present? && params[:variants]
+
+      params[:variants].each do |variant_id, quantity|
+        if variant = Spree::Variant.find(variant_id)
+          quantity = quantity.to_i
+
+          option_values = Spree::OptionValue.find(params[:options].values.map(&:to_i))
+
+          line_item = @order.add_variant(variant, quantity, option_values)
+
+          line_item.customizations = params[:customizations] if params[:customizations]
+        end
+      end
+
+      params.delete(:variants) # prevent populate_orig from adding again
+    end
+
+    populate_without_options
+  end
+
+  alias_method_chain :populate, :options
+
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,33 @@
+Spree::LineItem.class_eval do
+
+  has_many :line_item_option_values, :dependent => :destroy
+  has_many :option_values, :through => :line_item_option_values
+
+  alias_method :options, :line_item_option_values
+
+  def has_options?
+    self.option_values.length > 0
+  end
+
+  def copy_price
+    self.price = variant.price if variant && price.nil?
+
+    self.option_values.each do |val|
+      self.price += val.adder
+    end
+  end
+
+  def customizations= params
+    params.each do |option_value_id, val|
+      if option = self.options.find_by_option_value_id(option_value_id)
+        option.customization = val
+        option.save
+      end
+    end
+  end
+
+  def customizations
+    self.options.each_with_object({}) { |opt, h| h[opt.option_value_id] = opt.customization unless opt.customization.blank? }
+  end
+
+end

data/app/models/spree/line_item_option_value.rb

@@ -0,0 +1,27 @@
+module Spree
+  class LineItemOptionValue < ActiveRecord::Base
+    belongs_to :line_item
+    belongs_to :option_value, :class_name => 'Spree::OptionValue'
+
+    before_save :snapshot_option_values
+
+    serialize :customization
+
+    def customizable?
+      !self.option_value.customization_lines.blank?
+    end
+
+    private
+
+    def snapshot_option_values
+      if option_value
+        self.adder = option_value.adder
+        self.value_name = option_value.name
+        self.value_presentation = option_value.presentation
+        self.type_name = option_value.option_type.name
+        self.type_presentation = option_value.option_type.presentation
+      end
+    end
+
+  end
+end

data/app/models/spree/option_value_decorator.rb

@@ -0,0 +1,4 @@
+Spree::OptionValue.class_eval do
+  attr_accessible :adder, :customization_lines
+  has_many :line_item_option_values
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,30 @@
+Spree::Order.class_eval do
+
+  def contains? variant, options
+    options ||= []
+    line_items.detect { |line_item| line_item.variant_id == variant.id && line_item.option_values == options }
+  end
+
+
+  def add_variant variant, quantity=1, options=nil
+
+    current_item = contains?(variant, options)
+
+    if current_item
+      current_item.quantity += quantity
+      current_item.save
+    else
+      current_item = Spree::LineItem.new(:quantity => quantity)
+      current_item.variant = variant
+      current_item.price   = variant.price
+
+      current_item.option_values = options if options
+
+      self.line_items << current_item
+    end
+
+    current_item
+
+  end
+
+end

data/app/overrides/admin_option_value_fields.rb

@@ -0,0 +1,23 @@
+Deface::Override.new(:virtual_path => "spree/admin/option_types/_option_value_fields",
+                     :name => "admin_option_value_fields",
+                     :insert_after => "tr[data-hook=option_value] td.presentation",
+                     :partial => "spree/admin/option_types/option_value_adder_fields",
+                     :disabled => false)
+
+Deface::Override.new(:virtual_path => "spree/admin/option_types/edit",
+                     :name => "admin_option_value_header",
+                     :insert_after => "thead[data-hook=option_header] th:nth-child(2)",
+                     :text => '<th>Adder</th>',
+                     :disabled => false)
+
+Deface::Override.new(:virtual_path => "spree/admin/option_types/_option_value_fields",
+                     :name => "admin_option_value_customization_fields",
+                     :insert_after => "tr[data-hook=option_value] td.adder",
+                     :partial => "spree/admin/option_types/option_value_customization_fields",
+                     :disabled => false)
+
+Deface::Override.new(:virtual_path => "spree/admin/option_types/edit",
+                     :name => "admin_option_value_customization_header",
+                     :insert_after => "thead[data-hook=option_header] th:nth-child(3)",
+                     :text => '<th>Customization Lines</th>',
+                     :disabled => false)

data/app/overrides/admin_order_form_line_item_row.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(:virtual_path => "spree/admin/shared/_order_details",
+                     :name => "admin_order_details_line_item_row",
+                     :replace => "tr[data-hook=order_details_line_item_row] td:first-child", # replace the first <td> in the row only
+                     :partial => "spree/admin/order_details_line_item_row",
+                     :disabled => false)
+

data/app/overrides/cart_item_description.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/orders/_line_item",
+                     :name => "cart_item_description",
+                     :replace => "td[data-hook=cart_item_description]",
+                     :partial => "spree/orders/cart_item_description",
+                     :disabled => false)

data/app/overrides/order_item_description.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(:virtual_path => "spree/shared/_order_details",
+                     :name => "order_item_description",
+                     :replace => "td[data-hook=order_item_description]",
+                     :partial => "spree/shared/order_item_description",
+                     :disabled => false)
+

data/app/overrides/product_cart_form.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => "spree/products/_cart_form",
+                     :name => "cart_item_image",
+                     :insert_top => "div#inside-product-cart-form",
+                     :partial => "spree/products/product_cart_form",
+                     :disabled => false)

data/app/views/spree/admin/_order_details_line_item_row.html.erb

@@ -0,0 +1,6 @@
+<td width="300"><%= item.variant.product.name %>
+  <%= "(" + variant_options(item.variant) + ")" unless item.variant.option_values.empty? %>
+  <%- if item.has_options? %>
+    <%= render :partial => 'spree/shared/order_line_item_options', :locals => { :item => item } %>
+  <% end %>
+</td>

data/app/views/spree/admin/option_types/_option_value_adder_fields.html.erb

@@ -0,0 +1 @@
+  <td class="adder"><%= f.text_field :adder, :value => number_to_currency(f.object.adder, :unit => '') %></td>

data/app/views/spree/admin/option_types/_option_value_customization_fields.html.erb

@@ -0,0 +1,4 @@
+<td class="customization">
+  <%= f.number_field :customization_lines, :in => 0..20 %>
+</td>
+

data/app/views/spree/orders/_cart_item_description.html.erb

@@ -0,0 +1,11 @@
+<td data-hook="cart_item_description">
+
+  <h4><%= link_to variant.product.name, product_path(variant.product) %></h4>
+
+  <%= truncate(variant.product.description, :length => 100, :omission => "...") %>
+
+  <%- if line_item.has_options? %>
+    <%= render :partial => 'spree/shared/order_line_item_options', :locals => { :item => line_item } %>
+  <% end %>
+
+</td>