stall 0.1.0

data/db/migrate/20160122143748_create_stall_address_ownerships.rb

@@ -0,0 +1,17 @@
+class CreateStallAddressOwnerships < ActiveRecord::Migration
+  def change
+    create_table :stall_address_ownerships do |t|
+      t.references :address,     index: true
+      t.references :addressable, polymorphic: true
+      t.boolean    :billing,     default: false
+      t.boolean    :shipping,    default: false
+
+      t.timestamps null: false
+
+      t.index      [:addressable_id, :addressable_type],
+                   name: :index_address_ownerships_on_addressable_type_and_id
+
+      t.foreign_key :stall_addresses, column: :address_id
+    end
+  end
+end

data/db/migrate/20160124014144_create_stall_shipping_methods.rb

@@ -0,0 +1,10 @@
+class CreateStallShippingMethods < ActiveRecord::Migration
+  def change
+    create_table :stall_shipping_methods do |t|
+      t.string :name
+      t.string :identifier
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160124020313_create_stall_shipments.rb

@@ -0,0 +1,17 @@
+class CreateStallShipments < ActiveRecord::Migration
+  def change
+    create_table :stall_shipments do |t|
+      t.references  :cart,             index: true
+      t.references  :shipping_method,  index: true
+      t.monetize    :price,            currency: { present: false }
+      t.monetize    :eot_price,        currency: { present: false }
+      t.decimal     :vat_rate
+      t.datetime    :sent_at
+
+      t.timestamps  null: false
+    end
+
+    add_foreign_key :stall_shipments, :stall_product_lists, column: :cart_id
+    add_foreign_key :stall_shipments, :stall_shipping_methods, column: :shipping_method_id
+  end
+end

data/lib/generators/stall/checkout/step/step_generator.rb

@@ -0,0 +1,20 @@
+module Stall
+  module Checkout
+    class StepGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        template 'step.rb.erb', "lib/#{ file_path }.rb"
+      end
+
+      private
+
+      # Override provided file name to include checkout_wizard at the end and
+      # allow every NamedBase helpers to use that name
+      #
+      def file_name
+        @_file_name ||= [@file_name, 'checkout_step'].join('_')
+      end
+    end
+  end
+end

data/lib/generators/stall/checkout/step/templates/step.rb.erb

@@ -0,0 +1,2 @@
+class <%= class_name %> < Stall::Checkout::Step
+end

data/lib/generators/stall/checkout/wizard/templates/wizard.rb.erb

@@ -0,0 +1,3 @@
+class <%= class_name %> < Stall::Checkout::Wizard
+  steps :informations, :shipping_method, :payment_method, :payment
+end

data/lib/generators/stall/checkout/wizard/wizard_generator.rb

@@ -0,0 +1,20 @@
+module Stall
+  module Checkout
+    class WizardGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_template
+        template 'wizard.rb.erb', "lib/#{ file_path }.rb"
+      end
+
+      private
+
+      # Override provided file name to include checkout_wizard at the end and
+      # allow every NamedBase helpers to use that name
+      #
+      def file_name
+        @_file_name ||= [@file_name, 'checkout_wizard'].join('_')
+      end
+    end
+  end
+end

data/lib/generators/stall/install/install_generator.rb

@@ -0,0 +1,17 @@
+module Stall
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_migrations
+      rake 'stall_engine:install:migrations'
+    end
+
+    def copy_initializer
+      copy_file 'initializer.rb', 'config/initializers/stall.rb'
+    end
+
+    def copy_default_checkout_wizard
+      generate 'stall:wizard', 'default'
+    end
+  end
+end

data/lib/generators/stall/install/templates/initializer.rb

@@ -0,0 +1,47 @@
+Stall.configure do |config|
+  # Global default VAT rate, can be overrided by products
+  #
+  # config.vat_rate = BigDecimal.new('20.0')
+
+  # Defines the default number of decimals precision used in prices
+  #
+  # config.prices_precision = 2
+
+  # Default engine's controllers ancestor class
+  #
+  # config.application_controller_ancestor = '::ApplicationController'
+
+  # Default currency used in the app for money objects.
+  #
+  # Note : If you need multi currency support in your app, you'll have to ensure
+  # that you create your line items, carts and orders with the right currency
+  # set.
+  #
+  # param :default_currency, 'EUR'
+
+  # Defined the default checkout wizard used for checking carts out in the
+  # shop process.
+  #
+  # Checkout wizards are used to customize the checkout steps.
+  #
+  # A default one is generated on stall's installation and can be found in your
+  # app at : lib/default_checkout_wizard.rb
+  #
+  # config.default_checkout_wizard = 'DefaultCheckoutWizard'
+
+  # Default line items weight when added to cart and no weight is found on
+  # the sellable
+  #
+  # This allows for simply setting a weight here and not in each product
+  # to calculate shipping fees depending on the total cart weight
+  #
+  # config.default_product_weight = 0
+
+  # Allows configuring which countries are available for free shipping offers
+  #
+  # Accepts an array of country codes or a proc with a Stall::Address argument
+  #
+  # Defaults to nil, which means all countries are available
+  #
+  # config.shipping.free_shipping.available = nil
+end

data/lib/stall.rb

@@ -0,0 +1,38 @@
+require 'has_secure_token'
+require 'vertebra'
+require 'money-rails'
+require 'request_store'
+require 'haml-rails'
+require 'simple_form'
+require 'country_select'
+
+require 'stall/rails/routing_mapper'
+require 'stall/rails/currency_helper'
+require 'stall/engine'
+
+module Stall
+  extend ActiveSupport::Autoload
+
+  autoload :Sellable
+  autoload :Addressable
+
+  autoload :Checkout
+  autoload :Shipping
+
+  autoload :Routes
+  autoload :Config
+  autoload :Utils
+
+  def self.table_name_prefix
+    'stall_'
+  end
+
+  def self.config
+    @config ||= Stall::Config.new
+  end
+
+  def self.configure
+    yield config
+  end
+end
+

data/lib/stall/addressable.rb

@@ -0,0 +1,44 @@
+# Provide the common behavior for all models that need to own addresses,
+# for billing and shipping
+#
+module Stall
+  module Addressable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :address_ownerships, as: :addressable, dependent: :destroy
+      has_many :addresses, through: :address_ownerships
+      accepts_nested_attributes_for :address_ownerships, allow_destroy: true
+    end
+
+    def address_ownership_for(type)
+      address_ownerships.find do |ownership|
+        ownership.public_send(type)
+      end if [:shipping, :billing].include?(type.to_sym)
+    end
+
+    # Provide billing and shipping address fetching and assigning shortcuts by
+    # using the address ownerships
+    #
+    [:shipping, :billing].each do |type|
+      instance_variable_name = :"@#{ type }_address"
+
+      define_method(:"#{ type }_address=") do |address|
+        ownership = address_ownership_for(type) || address_ownerships.build(type => true)
+        ownership.address = address
+        ownership.save if persisted?
+        instance_variable_set(instance_variable_name, address)
+      end
+
+      define_method(:"#{ type }_address") do
+        if (address = instance_variable_get(instance_variable_name))
+          return address
+        end
+
+        if (ownership = address_ownership_for(type))
+          instance_variable_set(instance_variable_name, ownership.address)
+        end
+      end
+    end
+  end
+end

data/lib/stall/checkout.rb

@@ -0,0 +1,15 @@
+module Stall
+  module Checkout
+    extend ActiveSupport::Autoload
+
+    autoload :Wizard
+    autoload :Step
+
+    autoload :InformationsCheckoutStep
+    autoload :ShippingMethodCheckoutStep
+    autoload :PaymentMethodCheckoutStep
+    autoload :PaymentCheckoutStep
+
+    class WizardNotFoundError < StandardError; end
+  end
+end

data/lib/stall/checkout/informations_checkout_step.rb

@@ -0,0 +1,41 @@
+module Stall
+  module Checkout
+    class InformationsCheckoutStep < Stall::Checkout::Step
+      def prepare
+        ensure_customer
+        ensure_address(:billing)
+        ensure_address(:shipping)
+      end
+
+      def process
+        cart.assign_attributes(cart_params)
+        process_addresses
+        cart.save!
+      end
+
+      private
+
+      def ensure_customer
+        cart.build_customer unless cart.customer
+      end
+
+      def ensure_address(type)
+        unless cart.address_ownership_for(type)
+          ownership = cart.address_ownerships.build(type => true)
+          ownership.build_address
+        end
+      end
+
+      def process_addresses
+        unless params[:use_another_address_for_billing]
+          # Remove submitted billing address
+          billing_ownership = cart.address_ownership_for(:billing)
+          cart.address_ownerships.destroy(billing_ownership)
+          # Set shipping address as the billing one
+          shipping_ownership = cart.address_ownership_for(:shipping)
+          shipping_ownership.billing = true
+        end
+      end
+    end
+  end
+end

data/lib/stall/checkout/payment_checkout_step.rb

@@ -0,0 +1,6 @@
+module Stall
+  module Checkout
+    class PaymentCheckoutStep < Stall::Checkout::Step
+    end
+  end
+end

data/lib/stall/checkout/payment_method_checkout_step.rb

@@ -0,0 +1,6 @@
+module Stall
+  module Checkout
+    class PaymentMethodCheckoutStep < Stall::Checkout::Step
+    end
+  end
+end

data/lib/stall/checkout/shipping_method_checkout_step.rb

@@ -0,0 +1,20 @@
+module Stall
+  module Checkout
+    class ShippingMethodCheckoutStep < Stall::Checkout::Step
+      def prepare
+        cart.build_shipment unless cart.shipment
+      end
+
+      def process
+        super
+        calculate_shipping_fee!
+      end
+
+      private
+
+      def calculate_shipping_fee!
+        Stall::ShippingFeeCalculatorService.new(cart).call
+      end
+    end
+  end
+end

data/lib/stall/checkout/step.rb

@@ -0,0 +1,47 @@
+module Stall
+  module Checkout
+    class StepNotFoundError < StandardError; end
+
+    class Step
+      attr_reader :cart, :params
+
+      def initialize(cart, params)
+        @cart = cart
+        @params = params
+      end
+
+      # Allows for preparing to the cart for the current step before rendering
+      # the step's view
+      #
+      # Note : Meant to be overriden by subclasses
+      #
+      def prepare
+      end
+
+      def process
+        cart.update_attributes(cart_params)
+      end
+
+      def cart_params
+        params.require(:cart).permit!
+      end
+
+      # Handles conversion from an identifier to a checkout step class, allowing
+      # us to specify a list of symbols in our wizard's .step macro
+      #
+      def self.for(identifier)
+        name = identifier.to_s.camelize
+        step_name = [name, 'CheckoutStep'].join
+
+        step = Stall::Utils.try_load_constant(step_name) ||
+          Stall::Utils.try_load_constant(['Stall', 'Checkout', step_name.demodulize].join('::'))
+
+        return step if step
+
+        raise StepNotFoundError,
+          "No checkout step was found for #{ identifier }. You can generate " +
+          "it with `rails g stall:checkout:step #{ identifier }`"
+      end
+    end
+  end
+end

data/lib/stall/checkout/wizard.rb

@@ -0,0 +1,85 @@
+module Stall
+  module Checkout
+    class Wizard
+      class StepUndefinedError < StandardError; end
+
+      attr_reader :cart
+
+      class_attribute :_steps
+
+      def self.steps(*identifiers)
+        if identifiers.length > 0
+          self._steps = identifiers
+        else
+          _steps
+        end
+      end
+
+      def initialize(cart)
+        @cart = cart
+      end
+
+      def current_step
+        if (step_name = current_step_name)
+          Stall::Checkout::Step.for(step_name)
+        end
+      end
+
+      def current_step_name
+        if step?(cart.state)
+          cart.state
+        else
+          raise StepUndefinedError,
+            "The current carte state #{ cart.state } does not exist " +
+            "for the current #{ self.class.name } wizard, which has the " +
+            "following steps : #{ steps.join(', ') }."
+        end
+      end
+
+      def next_step_name
+        step_name_for(step_index + 1) if step_index && step_index < steps_count
+      end
+
+      def complete?
+        step_index && step_index >= steps_count - 1
+      end
+
+      def steps_count
+        @steps_count ||= steps.length
+      end
+
+      def validate_current_step!
+        cart.state = next_step_name
+        cart.save!
+      end
+
+      def self.route_key
+        name.gsub(/CheckoutWizard/, '').underscore.gsub('_', ' ').parameterize
+      end
+
+      def self.from_route_key(key)
+        Stall::Utils.try_load_constant(
+          [key.underscore.camelize, 'CheckoutWizard'].join
+        )
+      end
+
+      private
+
+      def steps
+        @steps ||= self.class.steps
+      end
+
+      def step_name_for(index)
+        steps[index]
+      end
+
+      def step_index
+        steps.index(cart.state)
+      end
+
+      def step?(state)
+        steps.include?(state)
+      end
+    end
+  end
+end