spree_restriction 1.2.3

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@spree_restriction"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

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,28 @@
+SpreeRestriction
+================
+
+Spree extension for adding visibility restriction by roles to products.
+
+Installation
+------------
+
+Add the following line to your Gemfile :
+
+    gem 'spree_restriction'
+    
+And then execute the following commands at the root of your application :
+
+    bundle # to update the installed gems
+    rails g spree_restriction:install # to install the extension's migrations and other files into your application
+
+Usage
+=====
+
+In the admin mode, go to a product and select a role in the Restriction field (at the very bottom of the page). Click update and then logout. Notice that the product is not visible anymore when the required role is not logged in.
+
+Testing
+-------
+
+I did not implemented any rspec testing yet.
+
+Copyright (c) 2012 [name of extension creator], released under the New BSD License

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/core/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_restriction'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,11 @@
+# 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' }
+

data/app/controllers/admin_products_controller_decorator.rb

@@ -0,0 +1,9 @@
+Spree::Admin::ProductsController.class_eval do
+  def load_data
+    @taxons = Spree::Taxon.order(:name)
+    @option_types =  Spree::OptionType.order(:name)
+    @tax_categories =  Spree::TaxCategory.order(:name)
+    @shipping_categories =  Spree::ShippingCategory.order(:name)
+    @roles =  Spree::Role.order(:name)
+  end
+end

data/app/controllers/home_controller_decorator.rb

@@ -0,0 +1,8 @@
+Spree::HomeController.class_eval do
+  def index
+    params[:user_id] = try_spree_current_user.id if try_spree_current_user
+    @searcher = Spree::Config.searcher_class.new(params)
+    @products = @searcher.retrieve_products
+    respond_with(@products)
+  end
+end

data/app/controllers/products_controller_decorator.rb

@@ -0,0 +1,8 @@
+Spree::ProductsController.class_eval do
+  def index
+    params[:user_id] = try_spree_current_user.id if try_spree_current_user
+    @searcher =  Spree::Config.searcher_class.new(params)
+    @products = @searcher.retrieve_products
+    respond_with(@products)
+  end
+end

data/app/controllers/taxons_controller_decorator.rb

@@ -0,0 +1,12 @@
+Spree::TaxonsController.class_eval do
+  def show
+    @taxon =  Spree::Taxon.find_by_permalink!(params[:id])
+    return unless @taxon
+
+    params[:user_id] = try_spree_current_user.id if try_spree_current_user
+    @searcher = Spree::Config.searcher_class.new(params.merge(:taxon => @taxon.id))
+    @products = @searcher.retrieve_products
+
+    respond_with(@taxon)
+  end
+end

data/app/helpers/products_helper_decorator.rb

@@ -0,0 +1,12 @@
+Spree::Admin::ProductsHelper.class_eval do
+  def roles_for(product)
+    options = @roles.map do |role|
+      selected = product.roles.include?(role)
+      content_tag(:option,
+                  :value    => role.id,
+                  :selected => ('selected' if selected)) do
+        role.name
+      end
+    end.join("").html_safe
+  end
+end

data/app/lib/base_decorator.rb

@@ -0,0 +1,23 @@
+Spree::Core::Search::Base.class_eval do
+  def get_base_scope
+    roles = @properties[:user_id] ? Spree::User.find(@properties[:user_id]).spree_roles.dup : []
+    base_scope = Spree::Product.active
+    base_scope = base_scope.by_roles(roles)
+    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
+
+  def prepare(params)
+    @properties[:taxon] = params[:taxon].blank? ? nil : Spree::Taxon.find(params[:taxon])
+    @properties[:keywords] = params[:keywords]
+    @properties[:search] = params[:search]
+
+    per_page = params[:per_page].to_i
+    @properties[:per_page] = per_page > 0 ? per_page : Spree::Config[:products_per_page]
+    @properties[:page] = (params[:page].to_i <= 0) ? 1 : params[:page].to_i
+    @properties[:user_id] = params[:user_id]
+  end
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,18 @@
+Spree::Product.class_eval do
+  attr_accessible :role_ids
+
+  has_and_belongs_to_many :roles, :join_table => 'spree_restrictions'
+    
+  scope :by_roles, lambda{ |user_roles| 
+    if(user_roles.include?(Spree::Role.find_by_name('admin')))
+      where('1=1')
+    else
+      where('spree_products.id IN (
+        SELECT p.id FROM spree_products p LEFT JOIN spree_restrictions r ON r.product_id = p.id WHERE r.product_id IS NULL
+      )
+      OR spree_products.id IN (
+        SELECT p.id FROM spree_products p JOIN spree_restrictions r ON r.product_id = p.id WHERE role_id IN (?)
+      )', user_roles.collect{|role|role.id}.join(','))
+    end
+  }
+end

data/app/models/role_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Role.class_eval do
+  has_and_belongs_to_many :products, :join_table => 'spree_restrictions'
+end

data/app/overrides/add_restriction_to_admin.rb

@@ -0,0 +1,12 @@
+Deface::Override.new(:virtual_path => "spree/admin/products/_form",
+                     :name => "admin_product_restriction",
+                     :insert_top => "[data-hook='admin_product_form_additional_fields']",
+                     :locals => {:stars => 3, :edit_enabled => true},
+                     :text => '<h2><%= t(:restriction_label) %></h2>
+                     <div data-hook="admin_product_restrictions">
+                                 <%= f.field_container :restrictions do %>
+    <%= f.label :role_ids, t(:restriction_description) %><br />
+      <%= f.select :role_ids, roles_for(@product), {}, :class => "select2", :multiple => true %>
+    <% end %>
+  </div>',
+                     :disabled => false)

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  restriction_label: "Restriction"
+  restriction_description: "Restrict visibility to these roles"

data/config/routes.rb

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

data/db/migrate/20120926201604_add_restrictions.rb

@@ -0,0 +1,9 @@
+class AddRestrictions < ActiveRecord::Migration
+  def change
+    create_table :spree_restrictions do |t|
+      t.integer :product_id, :references => :spree_products
+      t.integer :role_id, :references => :spree_roles
+    end
+    add_index :spree_restrictions, ["product_id", "role_id"]
+  end
+end

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

@@ -0,0 +1,19 @@
+module SpreeRestriction
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_restriction'
+      end
+
+      def run_migrations
+         res = ask 'Would you like to run the migrations now? [Y/n]'
+         if res == '' || res.downcase == 'y'
+           run 'bundle exec rake db:migrate'
+         else
+           puts 'Skipping rake db:migrate, don\'t forget to run it!'
+         end
+      end
+    end
+  end
+end

data/lib/spree_restriction/engine.rb

@@ -0,0 +1,22 @@
+module SpreeRestriction
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_restriction'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    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_restriction.rb

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

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_restriction/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+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/core/testing_support/factories'
+require 'spree/core/url_helpers'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::Core::UrlHelpers
+
+  # == 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
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/spree_restriction.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_restriction'
+  s.version     = '1.2.3'
+  s.summary     = 'Spree extension for adding visibility restriction by roles to products.'
+  s.description = 'Spree extension for adding visibility restriction by roles to products.'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author    = 'Yanick Landry (Nurun)'
+  s.email     = 'yanick.landry@nurun.com'
+  # s.homepage  = 'http://www.spreecommerce.com'
+
+  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', '~> 1.2'
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: spree_restriction
+version: !ruby/object:Gem::Version
+  version: 1.2.3
+  prerelease: 
+platform: ruby
+authors:
+- Yanick Landry (Nurun)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Spree extension for adding visibility restriction by roles to products.
+email: yanick.landry@nurun.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- app/controllers/admin_products_controller_decorator.rb
+- app/controllers/home_controller_decorator.rb
+- app/controllers/products_controller_decorator.rb
+- app/controllers/taxons_controller_decorator.rb
+- app/helpers/products_helper_decorator.rb
+- app/lib/base_decorator.rb
+- app/models/product_decorator.rb
+- app/models/role_decorator.rb
+- app/overrides/add_restriction_to_admin.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20120926201604_add_restrictions.rb
+- lib/generators/spree_restriction/install/install_generator.rb
+- lib/spree_restriction.rb
+- lib/spree_restriction/engine.rb
+- script/rails
+- spec/spec_helper.rb
+- spree_restriction-1.2.1.gem
+- spree_restriction-1.2.2.gem
+- spree_restriction.gemspec
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Spree extension for adding visibility restriction by roles to products.
+test_files:
+- spec/spec_helper.rb