piggybak_variants 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+PiggybakVariants Gem (Engine)
+========
+
+Advanced variant support for Piggybak.
+
+
+TODO
+========
+
+* Notes specified in variant.rb
+
+
+Copyright
+========
+
+Copyright (c) 2012 End Point. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PiggybakVariants'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/piggybak_variants/piggybak_variants.js

@@ -0,0 +1,32 @@
+$(function() {
+	$('.variant_options input[type=radio]').click(function() { piggybak_variants.toggle_variant_form(); });
+	piggybak_variants.toggle_variant_form();	
+});
+
+var piggybak_variants = {
+	toggle_variant_form: function() {	
+		$('.unavailable, .all_selected').hide();
+		var all_selected = true;
+		var selected = new Array();
+		$.each($('.option'), function(i, j) {
+			var option_id = $(j).attr('id');
+			if($('input[name=' + option_id + ']:checked').length) {
+				selected.push($('input[name=' + option_id + ']:checked').val());
+			} else {
+				all_selected = false;	
+			}
+		});
+		var selected_key = selected.join('_');
+		if(all_selected && variant_map[selected_key]) {
+			$('.variant_options form').show();
+			$('#sellable_id').val(variant_map[selected_key].id);
+			$('#variant_price span').html(variant_map[selected_key].price);
+		} else if(all_selected) { // if all selected and not available
+			$('.variant_options form').hide();
+			$('.unavailable').show();
+		} else { // if not all selected
+			$('.all_selected').show();
+			$('.variant_options form').hide();
+		}
+	}
+};

data/app/assets/stylesheets/piggybak_variants/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/controllers/piggybak_variants/application_controller.rb

@@ -0,0 +1,4 @@
+module PiggybakVariants
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/piggybak_variants_helper.rb

@@ -0,0 +1,17 @@
+module PiggybakVariantsHelper
+  def variant_cart_form(object)
+    render "piggybak_variants/cart/form", :object => object
+  end
+
+  def options_for_klass(klass)
+    options = ::PiggybakVariants::OptionConfiguration.find_all_by_klass(klass).collect { |oc| oc.option }
+  end
+
+  def variant_map(object)
+    map = {}
+    object.variants.available.each do |variant|
+      map[variant.option_values.collect { |ov| ov.id }.join('_')] = { :id => variant.piggybak_sellable.id, :price => number_to_currency(variant.piggybak_sellable.price) }
+    end
+    map.to_json
+  end
+end

data/app/models/piggybak_variants/option.rb

@@ -0,0 +1,17 @@
+module PiggybakVariants
+  class Option < ActiveRecord::Base
+    self.table_name = "options"
+
+    attr_accessible :name, :position
+    has_many :option_values
+    has_many :option_configurations
+
+    default_scope :order => "position ASC"
+
+    accepts_nested_attributes_for :option_values, :allow_destroy => true
+    attr_accessible :option_values_attributes, :allow_destroy => true
+
+    accepts_nested_attributes_for :option_configurations, :allow_destroy => true
+    attr_accessible :option_configurations_attributes, :allow_destroy => true
+  end
+end

data/app/models/piggybak_variants/option_configuration.rb

@@ -0,0 +1,18 @@
+module PiggybakVariants
+  class OptionConfiguration < ActiveRecord::Base
+    self.table_name = "option_configurations"
+
+    VARIANT_CLASSES = []
+
+    attr_accessible :klass, :option_id
+    belongs_to :option
+
+    def klass_enum
+      VARIANT_CLASSES
+    end
+
+    def admin_label
+      self.klass
+    end
+  end
+end

data/app/models/piggybak_variants/option_value.rb

@@ -0,0 +1,15 @@
+module PiggybakVariants
+  class OptionValue < ActiveRecord::Base
+    self.table_name = "option_values"
+
+    attr_accessible :name, :position
+    has_and_belongs_to_many :variants
+    belongs_to :option, :inverse_of => :option_values
+
+    default_scope :order => "position ASC"
+
+    def admin_label
+      "#{self.option.name}: #{self.name}"
+    end
+  end
+end

data/app/models/piggybak_variants/variant.rb

@@ -0,0 +1,36 @@
+module PiggybakVariants
+  class Variant < ActiveRecord::Base
+    self.table_name = "variants"
+
+    acts_as_sellable
+    belongs_to :item, :polymorphic => true
+    has_and_belongs_to_many :option_values
+
+    scope :available, joins(:piggybak_sellable).where("sellables.active IS TRUE AND (sellables.quantity > 0 OR sellables.unlimited_inventory IS TRUE)") 
+    validate :option_value_validation
+
+    def admin_label
+      "#{self.piggybak_sellable.sku}: #{self.piggybak_sellable.price}"
+    end
+
+    def option_value_validation
+      # TODO: Figure out why this validation is only being called sometime
+      # TODO: Add verification to prevent duplicate option value sets
+
+      klass = self.item.class
+      options = ::PiggybakVariants::OptionConfiguration.find_all_by_klass(klass).collect { |oc| oc.option }
+      error = false
+      options.each do |option|
+        matching_option_values = self.option_values.select { |ov| ov.option == option }.size
+        if matching_option_values > 1
+          self.errors.add(:option_values, "You must have only option value for #{option.name}")
+          error = true
+        elsif matching_option_values < 1 
+          self.errors.add(:option_values, "You must have one option value for #{option.name}")
+          error = true
+        end
+      end 
+      self.errors.add(:base, "Option value errors") if error
+    end
+  end
+end

data/app/views/piggybak_variants/cart/_form.html.erb

@@ -0,0 +1,29 @@
+<% if object.reflections.keys.include?(:variants) -%>
+	<%= javascript_include_tag "piggybak_variants/piggybak_variants" %>
+
+	<script type="text/javascript">
+		var variant_map = <%= raw variant_map(object) %>;
+	</script>
+
+	<div class="variant_options">
+		<% options_for_klass(object.class).each do |option| -%>
+		<div class="option" id="option_<%= option.id %>">
+		<h4><%= option.name %></h4>
+		<% option.option_values.each do |option_value| -%>
+			<input type="radio" name="option_<%= option.id %>" value="<%= option_value.id %>" />
+			<%= option_value.name %><br />
+		<% end -%>
+		<br />
+		</div>
+		<% end -%>
+		<span class="all_selected">You must select an choice from each option.</span>
+		<span class="unavailable">This combination is not available.</span>
+		<%= form_tag piggybak.cart_add_url do -%>
+		<input type="hidden" id="sellable_id" name="sellable_id" />
+		<div id="variant_price">Price: <span></span></div>
+		<label for="quantity">Quantity</label>
+		<%= text_field_tag :quantity, 1 %>
+		<%= submit_tag "Add to Cart", :id => "submit" %>
+		<% end -%>
+	</div>
+<% end -%>

data/app/views/rails_admin/main/_option_values.html.haml

@@ -0,0 +1,12 @@
+:ruby
+  column_type_dom_id = form.dom_id(field).sub(field.method_name.to_s, "")
+  attr = column_type_dom_id.gsub("frame_variants_attributes", '').gsub(/^_/, '[').gsub(/_$/, ']')
+
+= #TODO: Add JavaScript to limit selectors here
+
+- options_for_klass(@object.class).each do |option|
+  %h5= option.name
+  - option.option_values.each do |option_value|
+    %p
+      = check_box_tag "frame[variants_attributes]#{attr}[option_value_ids][]", option_value.id, form.object.option_values.include?(option_value), :style => "margin:-2px 5px 0px 0px;"
+      %span= option_value.name

data/config/routes.rb

@@ -0,0 +1,2 @@
+PiggybakVariants::Engine.routes.draw do
+end

data/db/migrate/20121015144538_create_new_variants.rb

@@ -0,0 +1,13 @@
+class CreateNewVariants < ActiveRecord::Migration
+  def up
+    create_table :variants, :force => true do |t|
+      t.integer :item_id, :null => false
+      t.string :item_type, :null => false
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :variants
+  end
+end

data/db/migrate/20121016150359_create_options.rb

@@ -0,0 +1,13 @@
+class CreateOptions < ActiveRecord::Migration
+  def up
+    create_table :options, :force => true do |t|
+      t.string :name
+      t.integer :position
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :options
+  end
+end

data/db/migrate/20121016153016_create_option_values.rb

@@ -0,0 +1,14 @@
+class CreateOptionValues < ActiveRecord::Migration
+  def up
+    create_table :option_values, :force => true do |t|
+      t.integer :option_id
+      t.string :name
+      t.integer :position
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :options_values
+  end
+end

data/db/migrate/20121016161156_create_option_values_variants.rb

@@ -0,0 +1,12 @@
+class CreateOptionValuesVariants < ActiveRecord::Migration
+  def up
+    create_table :option_values_variants, :id => false do |t|
+      t.integer :option_value_id
+      t.integer :variant_id
+    end
+  end
+
+  def down
+    drop_table :option_values_variants
+  end
+end

data/db/migrate/20121022205428_create_option_configurations.rb

@@ -0,0 +1,13 @@
+class CreateOptionConfigurations < ActiveRecord::Migration
+  def up
+    create_table :option_configurations, :force => true do |t|
+      t.string :klass, :null => false
+      t.references :option, :null => false
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :option_assignments
+  end
+end

data/lib/acts_as_sellable_with_variants.rb

@@ -0,0 +1,18 @@
+module Piggybak
+  module ActsAsSellableWithVariants
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_sellable_with_variants
+        has_many :variants, :dependent => :destroy, :class_name => "::PiggybakVariants::Variant", :as => :item
+
+        accepts_nested_attributes_for :variants, :allow_destroy => true
+        attr_accessible :variants_attributes #, :allow_destroy => true
+
+        ::PiggybakVariants::OptionConfiguration::VARIANT_CLASSES << self.to_s
+      end      
+    end
+  end
+end
+
+::ActiveRecord::Base.send :include, Piggybak::ActsAsSellableWithVariants

data/lib/piggybak_variants.rb

@@ -0,0 +1,5 @@
+require "piggybak_variants/engine"
+require "acts_as_sellable_with_variants"
+
+module PiggybakVariants
+end

data/lib/piggybak_variants/engine.rb

@@ -0,0 +1,81 @@
+module PiggybakVariants
+  class Engine < ::Rails::Engine
+    isolate_namespace PiggybakVariants
+   
+    config.to_prepare do 
+      ApplicationController.class_eval do
+        helper :piggybak_variants
+      end
+      RailsAdmin::ApplicationController.class_eval do
+        helper :piggybak_variants
+      end
+    end
+
+    initializer "piggybak_variants.precompile_hook" do |app|
+      app.config.assets.precompile += ['piggybak_variants/piggybak_variants.js']
+    end
+  
+    initializer "piggybak.rails_admin_config" do |app|
+      RailsAdmin.config do |config|
+        config.model PiggybakVariants::OptionConfiguration do
+          visible false
+          object_label_method :admin_label
+          label "Classes with Option"
+          edit do
+            field :klass
+          end
+        end
+
+        config.model PiggybakVariants::OptionValue do
+          visible false
+          object_label_method :admin_label
+          edit do
+            field :name
+            field :position
+          end
+        end
+
+        config.model PiggybakVariants::Option do
+          navigation_label "Variants"
+          list do
+            field :name
+            field :position
+            field :option_values
+            field :option_configurations do
+              label "Classes with Option"
+            end
+          end
+          edit do
+            field :name
+            field :position
+            field :option_configurations do
+              label "Classes with Option"
+              active true
+            end
+            field :option_values do
+              active true
+            end
+          end
+        end
+        
+        config.model PiggybakVariants::Variant do
+          object_label_method :admin_label
+          show do
+            field :option_values do
+              visible true
+            end
+          end
+          edit do
+            field :option_values do
+              partial "option_values"
+              help "An option value for each option must be selected"
+            end
+            field :piggybak_sellable do
+              active true
+            end
+          end
+        end
+      end
+    end
+  end
+end