spree_zero_stock_products 2.0.0

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.ruby*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+before_script:
+  - "bundle exec rake test_app"
+script:
+  - "bundle exec rspec spec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  recipients:
+    - swrobel@gmail.com

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Stefan Wrobel
+
+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,49 @@
+SpreeZeroStockProducts [![Build Status](https://travis-ci.org/swrobel/spree_zero_stock_products.png?branch=2-0-stable)](https://travis-ci.org/swrobel/spree_zero_stock_products)
+======================
+
+Restore the `show_zero_stock_products` preference & related functionality in Spree 2.0+
+
+The preference defaults to true, which is the out-of-the-box behavior in Spree 2.0+
+
+Set it to `false` to avoid showing products with zero stock on any product listing/taxon pages.
+
+Installation
+------------
+
+Add spree_zero_stock_products to your Gemfile:
+
+```ruby
+gem 'spree_zero_stock_products'
+```
+
+Bundle your dependencies:
+
+```shell
+bundle
+```
+
+Set the preference in an intializer such as `config/initializers/spree.rb`:
+
+```ruby
+Spree.config do |config|
+  config.show_zero_stock_products = false # Default is true
+end
+```
+
+Profit.
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+License
+-------
+
+Copyright (c) 2013 Stefan Wrobel, released under the MIT License

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_zero_stock_products'
+
+  # use common:test_app intstead of extension:test_app
+  # because the extension version includes spree_frontend, which we don't need
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,13 @@
+# 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' }
+
+"2.1.x" => { :branch => "master" }
+"2.0.x" => { :branch => "2-0-stable" }

data/app/models/product_decorator.rb

@@ -0,0 +1,5 @@
+Spree::Product.class_eval do
+  add_search_scope :on_hand do
+    where("#{table_name}.id IN (SELECT product_id FROM #{Spree::Variant.table_name} v JOIN #{Spree::StockItem.table_name} i ON v.id = i.variant_id WHERE deleted_at IS NULL GROUP BY product_id HAVING SUM(count_on_hand) > 0)")
+  end
+end

data/app/models/search/base_decorator.rb

@@ -0,0 +1,12 @@
+Spree::Core::Search::Base.class_eval do
+
+protected
+  def get_base_scope
+    base_scope = Spree::Product.active
+    base_scope = base_scope.in_taxon(taxon) unless taxon.blank?
+    base_scope = get_products_conditions_for(base_scope, keywords)
+    base_scope = base_scope.on_hand unless Spree::Config[:show_zero_stock_products]
+    base_scope = add_search_scopes(base_scope)
+    base_scope
+  end
+end

data/app/models/taxon_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Taxon.class_eval do
+  def active_products
+    scope = products.active
+    scope = scope.on_hand unless Spree::Config[:show_zero_stock_products]
+    scope
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  show_out_of_stock_products: "Show out-of-stock products"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/lib/spree_zero_stock_products.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_zero_stock_products/engine'

data/lib/spree_zero_stock_products/engine.rb

@@ -0,0 +1,28 @@
+module SpreeZeroStockProducts
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_zero_stock_products'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer "spree.zero_stock_products.preferences", :before => :load_config_initializers do |app|
+      Spree::AppConfiguration.class_eval do
+        preference :show_zero_stock_products, :boolean, :default => true
+      end
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_zero_stock_products/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_zero_stock_products/factories'
+end

data/script/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_zero_stock_products/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/lib/search/base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Spree::Core::Search::Base do
+
+  before do
+    stock_location = create(:stock_location)
+    @product_with_stock = create(:product)
+    @product_out_of_stock = create(:product)
+
+    stock_location.stock_items.where(:variant_id => @product_with_stock.master.id).first.adjust_count_on_hand(10)
+    stock_location.stock_items.where(:variant_id => @product_out_of_stock.master.id).first.adjust_count_on_hand(0)
+  end
+
+  context "with show_zero_stock_products = FALSE" do
+
+    before do
+      Spree::Config[:show_zero_stock_products] = false
+    end
+
+    it "returns all products by default" do
+      params = { :per_page => "" }
+      searcher = Spree::Core::Search::Base.new(params)
+      searcher.retrieve_products.count.should == 1
+    end
+  end
+
+  context "with show_zero_stock_products = TRUE" do
+
+    before do
+      Spree::Config[:show_zero_stock_products] = true
+    end
+
+    it "returns all products by default" do
+      params = { :per_page => "" }
+      searcher = Spree::Core::Search::Base.new(params)
+      searcher.retrieve_products.count.should == 2
+    end
+  end
+end

data/spec/models/spree/product/scopes_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Product scopes" do
+
+  context "with scope on_hand" do
+    before do
+      stock_location = create(:stock_location)
+      @product_with_stock = create(:product)
+      @product_out_of_stock = create(:product)
+
+      stock_location.stock_items.where(:variant_id => @product_with_stock.master.id).first.adjust_count_on_hand(10)
+      stock_location.stock_items.where(:variant_id => @product_out_of_stock.master.id).first.adjust_count_on_hand(0)
+    end
+
+    it "includes a product with available stock" do
+      Spree::Product.on_hand.should include @product_with_stock
+    end
+
+    it "excludes a product without available stock" do
+      Spree::Product.on_hand.should_not include @product_out_of_stock
+    end
+  end
+end

data/spec/models/spree/taxon/taxon_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Spree::Taxon do
+
+  before do
+    stock_location = create(:stock_location)
+    @product_with_stock = create(:product)
+    @product_out_of_stock = create(:product)
+
+    stock_location.stock_items.where(:variant_id => @product_with_stock.master.id).first.adjust_count_on_hand(10)
+    stock_location.stock_items.where(:variant_id => @product_out_of_stock.master.id).first.adjust_count_on_hand(0)
+
+    @taxonomy = create(:taxonomy)
+    @root_taxon = @taxonomy.root
+
+    @parent_taxon = create(:taxon, :name => 'Parent', :taxonomy_id => @taxonomy.id, :parent => @root_taxon)
+    @child_taxon = create(:taxon, :name =>'Child 1', :taxonomy_id => @taxonomy.id, :parent => @parent_taxon)
+    @parent_taxon.reload # Need to reload for descendents to show up
+
+    @product_with_stock.taxons << @parent_taxon
+    @product_with_stock.taxons << @child_taxon
+    @product_out_of_stock.taxons << @parent_taxon
+    @product_out_of_stock.taxons << @child_taxon
+  end
+
+  context "with show_zero_stock_products = FALSE" do
+
+    before do
+      Spree::Config[:show_zero_stock_products] = false
+    end
+
+    it "includes a product with available stock" do
+      @parent_taxon.active_products.should include @product_with_stock
+    end
+
+    it "excludes a product without available stock" do
+      @parent_taxon.active_products.should_not include @product_out_of_stock
+    end
+  end
+
+  context "with show_zero_stock_products = TRUE" do
+
+    before do
+      Spree::Config[:show_zero_stock_products] = true
+    end
+
+    it "includes both products with and without stock" do
+      @parent_taxon.active_products.should include @product_with_stock
+      @parent_taxon.active_products.should include @product_out_of_stock
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in spree_core
+require 'spree/testing_support/factories'
+
+# Requires factories defined in lib/spree_zero_stock_products/factories.rb
+require 'spree_zero_stock_products/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a seperate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+end

data/spree_zero_stock_products.gemspec

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_zero_stock_products'
+  s.version     = '2.0.0'
+  s.summary     = 'Restore show_zero_stock_products functionality in Spree 2.0+'
+  s.description = 'Restore show_zero_stock_products functionality in Spree 2.0+'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Stefan Wrobel'
+  s.email     = 'swrobel@gmail.com'
+  s.homepage  = 'https://github.com/swrobel/spree_zero_stock_products'
+  s.license   = 'MIT'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '~> 2.0.0'
+
+  s.add_development_dependency 'database_cleaner', '< 1.1.0' # >= 1.1.0 is broken w/ SQLite3 https://github.com/bmabey/database_cleaner/issues/224
+  s.add_development_dependency 'factory_girl', '~> 4.2'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails',  '~> 2.13'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: spree_zero_stock_products
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 2.0.0
+platform: ruby
+authors:
+- Stefan Wrobel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+description: Restore show_zero_stock_products functionality in Spree 2.0+
+email: swrobel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- app/models/product_decorator.rb
+- app/models/search/base_decorator.rb
+- app/models/taxon_decorator.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/spree_zero_stock_products.rb
+- lib/spree_zero_stock_products/engine.rb
+- lib/spree_zero_stock_products/factories.rb
+- script/rails
+- spec/lib/search/base_spec.rb
+- spec/models/spree/product/scopes_spec.rb
+- spec/models/spree/taxon/taxon_spec.rb
+- spec/spec_helper.rb
+- spree_zero_stock_products.gemspec
+homepage: https://github.com/swrobel/spree_zero_stock_products
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Restore show_zero_stock_products functionality in Spree 2.0+
+test_files:
+- spec/lib/search/base_spec.rb
+- spec/models/spree/product/scopes_spec.rb
+- spec/models/spree/taxon/taxon_spec.rb
+- spec/spec_helper.rb
+has_rdoc: