solidus_user_roles 2.0.0

data/bin/sandbox

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+
+set -e
+test -z "${DEBUG+empty_string}" || set -x
+
+test "$DB" = "sqlite" && export DB="sqlite3"
+
+if [ -z "$SOLIDUS_BRANCH" ]
+then
+  echo "~~> Use 'export SOLIDUS_BRANCH=[main|v3.2|...]' to control the Solidus branch"
+  SOLIDUS_BRANCH="main"
+fi
+echo "~~> Using branch $SOLIDUS_BRANCH of solidus"
+
+if [ -z "$SOLIDUS_FRONTEND" ]
+then
+  echo "~~> Use 'export SOLIDUS_FRONTEND=[solidus_frontend|solidus_starter_frontend]' to control the Solidus frontend"
+  SOLIDUS_FRONTEND="solidus_frontend"
+fi
+echo "~~> Using branch $SOLIDUS_FRONTEND as the solidus frontend"
+
+extension_name="solidus_user_roles"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox \
+  --database="${DB:-sqlite3}" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$SOLIDUS_BRANCH'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate solidus:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=true \
+  --payment-method=none \
+  --frontend=${SOLIDUS_FRONTEND} \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install --auto-run-migrations
+unbundled bundle exec rails generate ${extension_name}:install --auto-run-migrations
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🧪 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+# 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:
+  hello: "Hello world"
+  spree:
+    new_user_role: New User Role
+    back_to_roles_list: Back to Roles List
+    permissions: Permissions
+    user_roles: User Roles
+    editing_user_role: Editing User Role
+    display_permissions: Display Permissions
+    management_permissions: Management Permissions
+    admin:
+      tab:
+        roles: Roles

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :roles
+  end
+end

data/db/migrate/20160406142441_create_spree_permission_sets.rb

@@ -0,0 +1,9 @@
+class CreateSpreePermissionSets < SolidusSupport::Migration[4.2]
+  def change
+    create_table :spree_permission_sets do |t|
+      t.string :name
+      t.string :set
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160406142933_create_spree_roles_permissions.rb

@@ -0,0 +1,9 @@
+class CreateSpreeRolesPermissions < SolidusSupport::Migration[4.2]
+  def change
+    create_table :spree_role_permissions do |t|
+      t.references :role
+      t.references :permission_set
+      t.timestamps null: false
+    end
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::PermissionSets::Base.subclasses.each do |permission|
+  Spree::PermissionSet.create(name: permission.to_s.split('PermissionSets::').last, set: permission.to_s)
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusUserRoles
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path('templates', __dir__)
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_user_roles.rb'
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_user_roles'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+SolidusUserRoles.configure do |config|
+  # TODO: Remember to change this with the actual preferences you have implemented!
+  # config.sample_preference = 'sample_value'
+end

data/lib/solidus_user_roles/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SolidusUserRoles
+  class Configuration
+    # Define here the settings for this extension, e.g.:
+    #
+    # attr_accessor :my_setting
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_user_roles/engine.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+module SolidusUserRoles
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_user_roles'
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.load_custom_permissions
+      # Ensure both tables exist before assigning permissions
+      if (ActiveRecord::Base.connection.tables & ['spree_roles', 'spree_permission_sets']).to_a.length == 2
+        ::Spree::Role.non_base_roles.each do |role|
+          ::Spree::Config.roles.assign_permissions role.name, role.permission_sets_constantized
+        end
+      end
+    rescue ActiveRecord::NoDatabaseError
+      warn "No database available, skipping role configuration"
+    rescue ActiveRecord::StatementInvalid => e
+      warn "Skipping role configuration: #{e.message}"
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')).sort.each do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      return if Rails.env.test?
+
+      SolidusUserRoles::Engine.load_custom_permissions
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_user_roles/testing_support/factories.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :permission_set, class: Spree::PermissionSet do
+    name { 'ProductManagement' }
+    set { 'Spree::PermissionSets::ProductManagement' }
+  end
+end

data/lib/solidus_user_roles/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusUserRoles
+  VERSION = '2.0.0'
+end

data/lib/solidus_user_roles.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'solidus_user_roles/configuration'
+require 'solidus_user_roles/version'
+require 'solidus_user_roles/engine'

data/lib/tasks/load_seeds.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :solidus_user_roles do
+  desc "Loads seed data."
+  task load_seeds: :environment do
+    Spree::PermissionSets::Base.subclasses.each do |permission|
+      Spree::PermissionSet.find_or_create_by(name: permission.to_s.split('PermissionSets::').last, set: permission.to_s)
+    end
+  end
+end

data/solidus_user_roles.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_user_roles/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_user_roles'
+  spec.version = SolidusUserRoles::VERSION
+  spec.authors = ['Allison Reilly']
+  spec.email = 'acreilly3@gmail.com'
+
+  spec.summary = 'Advanced user roles for Solidus.'
+  spec.description = 'Advanced user roles for Solidus.'
+  spec.homepage = 'http://boomer.digital'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_user_roles'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_user_roles/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 3', '< 4') # rubocop:disable Gemspec/RequiredRubyVersion
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'solidus_core', ['>= 3', '< 5']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.6'
+end

data/spec/controllers/spree/admin/roles_controller_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Spree::Admin::RolesController do
+  stub_authorization!
+  let(:role) { create(:role) }
+  let(:permission_set) { create(:permission_set) }
+
+  describe "#index" do
+    subject { get :index }
+
+    it { is_expected.to be_successful }
+  end
+
+  describe "#new" do
+    subject { get :new }
+
+    it { is_expected.to be_successful }
+  end
+
+  describe "#edit" do
+    subject { get :edit, params: { id: role.id } }
+
+    it { is_expected.to be_successful }
+  end
+
+  describe "#create" do
+    subject(:request) { post :create, params: params }
+
+    let(:params) do
+      {
+        role: {
+          name: "TEST #{rand(10_000)}",
+          permission_set_ids: [permission_set.id]
+        }
+      }
+    end
+
+    it { is_expected.to redirect_to(spree.admin_roles_path) }
+
+    it "expect @role to eq the role being updated" do
+      expect(assigns(:role)).to eq(@role) # rubocop:disable RSpec/InstanceVariable
+    end
+
+    it "updates the permission sets" do
+      expect{ request }.to change(Spree::Role, :count).by(1)
+    end
+
+    it "updates the RoleConfiguration" do
+      expect{ request }.to change { Spree::Config.roles.roles.count }.by(1)
+    end
+  end
+
+  describe "#update" do
+    subject(:request) { put :update, params: params }
+
+    let(:params) do
+      {
+        id: role.to_param,
+        role: {
+          name: role.name,
+          permission_set_ids: [permission_set.id]
+        }
+      }
+    end
+
+    it { is_expected.to redirect_to(spree.admin_roles_path) }
+
+    it "expect @role to eq the role being updated" do
+      expect(assigns(:role)).to eq(@role) # rubocop:disable RSpec/InstanceVariable
+    end
+
+    it "updates the permission sets" do
+      expect{ request }.to change { role.reload.permission_sets.count }.by(1)
+    end
+  end
+
+  describe "#destroy" do
+    subject { put :destroy, params: { id: role.to_param } }
+
+    it { is_expected.to have_http_status(:found) }
+  end
+end

data/spec/models/spree/permission_set_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Spree::PermissionSet, type: :model do
+  it { is_expected.to have_many :role_permissions }
+  it { is_expected.to have_many(:roles).through(:role_permissions) }
+  it { is_expected.to validate_presence_of :name }
+end

data/spec/models/spree/role_permission_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Spree::RolePermission, type: :model do
+  it { is_expected.to belong_to :role }
+  it { is_expected.to belong_to :permission_set }
+end

data/spec/models/spree/role_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Spree::Role, type: :model do
+  let(:role) {
+    role = build(:role)
+    role.permission_sets << create(:permission_set)
+    role
+  }
+
+  it { is_expected.to have_many :role_permissions }
+  it { is_expected.to have_many(:permission_sets).through(:role_permissions) }
+  it { is_expected.to validate_uniqueness_of(:name).ignoring_case_sensitivity }
+
+  describe "#assign_permissions" do
+    it 'creates new Spree::RoleConfiguration::Role' do
+      expect { role.save }.to change { Spree::Config.roles.roles.count }.by(1)
+    end
+
+    it 'updates the existing Spree::RoleConfiguration::Role' do
+      role.save
+      role.permission_sets << create(:permission_set, name: 'test', set: 'Spree::PermissionSets::ProductDisplay')
+
+      expect { role.save }.to change { Spree::Config.roles.roles[role.name].permission_sets.count }.from(1).to(2)
+    end
+  end
+
+  describe "#destroy" do
+    let(:role) { create(:role) }
+
+    before do
+      role.permission_sets << create(:permission_set)
+      role.save
+    end
+
+    it "destroys all associated role permissions" do
+      role_permission = role.role_permissions.first
+
+      role.destroy
+      aggregate_failures do
+        expect{ described_class.find(role.id) }.to raise_error(ActiveRecord::RecordNotFound)
+        expect{ Spree::RolePermission.find(role_permission.id) }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+# Create the dummy app if it's still missing.
+dummy_env = "#{__dir__}/dummy/config/environment.rb"
+system 'bin/rake extension:test_app' unless File.exist? dummy_env
+require dummy_env
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
+
+# Requires factories defined in Solidus core and this extension.
+# See: lib/solidus_user_roles/testing_support/factories.rb
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusUserRoles::Engine)
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end

data/spec/support/shoulda.rb

@@ -0,0 +1,8 @@
+require 'shoulda/matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: solidus_user_roles
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Allison Reilly
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solidus_dev_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Advanced user roles for Solidus.
+email: acreilly3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".github/stale.yml"
+- ".github_changelog_generator"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/spree/admin/roles_controller.rb
+- app/decorators/models/solidus_user_roles/spree/role_decorator.rb
+- app/models/spree/permission_set.rb
+- app/models/spree/permission_sets/role_management.rb
+- app/models/spree/role_permission.rb
+- app/overrides/user_sub_menu.rb
+- app/views/spree/admin/roles/_form.html.erb
+- app/views/spree/admin/roles/edit.html.erb
+- app/views/spree/admin/roles/index.html.erb
+- app/views/spree/admin/roles/new.html.erb
+- bin/console
+- bin/rails
+- bin/rails-engine
+- bin/rails-sandbox
+- bin/rake
+- bin/sandbox
+- bin/setup
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20160406142441_create_spree_permission_sets.rb
+- db/migrate/20160406142933_create_spree_roles_permissions.rb
+- db/seeds.rb
+- lib/generators/solidus_user_roles/install/install_generator.rb
+- lib/generators/solidus_user_roles/install/templates/initializer.rb
+- lib/solidus_user_roles.rb
+- lib/solidus_user_roles/configuration.rb
+- lib/solidus_user_roles/engine.rb
+- lib/solidus_user_roles/testing_support/factories.rb
+- lib/solidus_user_roles/version.rb
+- lib/tasks/load_seeds.rake
+- solidus_user_roles.gemspec
+- spec/controllers/spree/admin/roles_controller_spec.rb
+- spec/models/spree/permission_set_spec.rb
+- spec/models/spree/role_permission_spec.rb
+- spec/models/spree/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/shoulda.rb
+homepage: http://boomer.digital
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: http://boomer.digital
+  source_code_uri: https://github.com/solidusio-contrib/solidus_user_roles
+  changelog_uri: https://github.com/solidusio-contrib/solidus_user_roles/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Advanced user roles for Solidus.
+test_files:
+- spec/controllers/spree/admin/roles_controller_spec.rb
+- spec/models/spree/permission_set_spec.rb
+- spec/models/spree/role_permission_spec.rb
+- spec/models/spree/role_spec.rb
+- spec/spec_helper.rb
+- spec/support/shoulda.rb