spree_product_reviews 1.0.0

data/config/locales/en.yml

@@ -0,0 +1,59 @@
+# 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:
+  spree:
+    review_approved: "Review approved successfully."
+    review_disapproved: "Review disapproved."
+    approve: "Approve"
+    approve: "Approve"
+    product_reviews: "Product Reviews"
+    new_product_review: "Leave a new product review"
+    review_title: "Review Title"
+    review_images: "Review Images"
+    product_review_rating: "Rating"
+    add_a_review_heading: "Leave a Review"
+    thanks_for_review_heading: "Thank you for your review! Your Review is Approved!"
+    thanks_for_review_heading_pending: "Thank you for your review! Your Review is waiting for Approval!"
+    add_a_review_text: "We value your feedback! Please leave a review for this product."
+    product_review:
+      flash_messages:
+        create:
+          success: "Your review has been submitted and is pending approval."
+          error: "There was an error submitting your review. Please try again."
+          failure: "There was an error submitting your review. Please try again."
+          approve: "Review approved successfully."
+        update:
+          success: "Your review has been updated."
+          error: "There was an error updating your review. Please try again."
+          failure: "There was an error updating your review. Please try again."
+    page_blocks:
+      reviews_summary: "Reviews"
+      product_review_form:
+        button_text_default: "Add your review"
+        placeholder_default: "Write your review here..."
+    page_sections:
+      product_reviews:
+        reviewed_by: "Reviewed by:"
+        pending_product_review_instructions: "Thanks for your review! It is currently pending approval."
+    admin:
+      page_sections:
+        product_reviews:
+          display_description: "If a user is not logged in, this section will not be displayed."
+          display_style:
+            label: "Display style"
+            inline: "Inline"
+            stacked: "Stacked"
+            heading_options: "Heading layout options"
+          heading_labels:
+            heading: "Heading labels"
+            no_review_yet: "Customer needs to review"
+            review_pending: "Customer's review is pending"
+            review_approved: "Customer's review was approved"
+          control_preferences:
+            label: "Control preferences"
+            allow_unverified_reviews: "Allow reviews for unverified purchase"
+            allow_unverified_reviews_enabled_description: "Enable to post reviews from any customer, without the verified badge."
+            allow_unverified_reviews_disabled_description: "Disable to limit reviews strictly to only verified buyers."
+          review_settings: "Review Settings"
+          upload_preferences: "Upload Settings"

data/config/routes.rb

@@ -0,0 +1,20 @@
+Spree::Core::Engine.add_routes do
+  namespace :admin do
+    resources :products do
+      resources :product_reviews, only: %i[index destroy edit update] do
+        member do
+          get :approve
+          get :disapprove
+          post :attach_image          # Attach images to review
+          delete :purge_images        # Delete selected images
+        end
+      end
+    end
+  end
+
+  resources :products, only: [] do
+    resources :product_reviews, only: %i[index new create]
+  end
+
+  get '/forbidden', to: 'spree/home#forbidden', as: :product_reviews_forbidden
+end

data/db/migrate/20250501173852_add_reviews.rb

@@ -0,0 +1,27 @@
+class AddReviews < ActiveRecord::Migration[7.2]
+  def change
+    unless table_exists?(:spree_product_reviews)
+      create_table :spree_product_reviews do |t|
+        t.references :product, null: false, foreign_key: { to_table: :spree_products }
+        t.references :user, null: false, foreign_key: { to_table: :spree_users }
+        t.references :variant, foreign_key: { to_table: :spree_variants }
+
+        t.integer :rating, null: false
+        t.string :title, null: false
+        t.string :review, null: false
+        t.string :product_name, null: false
+        t.datetime :purchase_date
+        t.string :ip_address, null: false
+        t.string :locale, null: false, default: "en"
+
+        t.boolean :approved, default: false, null: false
+        t.boolean :show_identifier, default: false, null: false
+
+        t.timestamps
+      end
+    end
+
+    add_index :spree_product_reviews, :product_id, name: "index_reviews_on_product_id" unless index_exists?(:spree_product_reviews, :product_id, name: "index_reviews_on_product_id")
+    add_index :spree_product_reviews, :variant_id, name: "index_reviews_on_variant_id" unless index_exists?(:spree_product_reviews, :variant_id, name: "index_reviews_on_variant_id")
+  end
+end

data/db/migrate/20250501174531_add_review_info_to_products.rb

@@ -0,0 +1,13 @@
+class AddReviewInfoToProducts < ActiveRecord::Migration[7.2]
+  def change
+    unless column_exists?(:spree_products, :average_rating)
+      add_column :spree_products, :average_rating, :decimal,
+                 precision: 7, scale: 5, default: 0.0, null: false
+    end
+
+    unless column_exists?(:spree_products, :review_count)
+      add_column :spree_products, :review_count, :integer,
+                 default: 0, null: false
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module SpreeProductReviews
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_product_reviews'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(
+          ask('Would you like to run the migrations now? [Y/n]')
+        )
+
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+
+      def add_reviews_page_block
+        say_status :spree_product_reviews, "Adding Reviews block to Product Details sections", :green
+
+        # Load app environment explicitly (important for generators)
+        require Rails.root.join("config/environment")
+
+        Spree::PageSection
+          .where(type: "Spree::PageSections::ProductDetails")
+          .find_each do |section|
+
+            next if section.blocks.exists?(
+              type: "Spree::PageBlocks::Products::Reviews"
+            )
+
+            section.blocks.create!(
+              type: "Spree::PageBlocks::Products::Reviews",
+              position: section.blocks.maximum(:position).to_i + 1
+            )
+          end
+      end
+    end
+  end
+end

data/lib/spree_product_reviews/configuration.rb

@@ -0,0 +1,13 @@
+module SpreeProductReviews
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+   # preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/lib/spree_product_reviews/engine.rb

@@ -0,0 +1,24 @@
+module SpreeProductReviews
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_product_reviews'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_product_reviews.environment', before: :load_config_initializers do |_app|
+      SpreeProductReviews::Config = SpreeProductReviews::Configuration.new
+    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_product_reviews/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.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_product_reviews/factories'
+end

data/lib/spree_product_reviews/version.rb

@@ -0,0 +1,8 @@
+module SpreeProductReviews
+  VERSION = "1.0.0".freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end
+

data/lib/spree_product_reviews.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_product_reviews/engine'
+require 'spree_product_reviews/version'
+require 'spree_product_reviews/configuration'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: spree_product_reviews
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Umesh Ravani
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: spree_auth_devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  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: faker
+  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'
+description: Product reviews and ratings system for Spree Commerce 5.x stores.
+email:
+- umeshravani98@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/spree/admin/product_reviews_controller.rb
+- app/controllers/spree/home_controller.rb
+- app/controllers/spree/product_reviews_controller.rb
+- app/models/spree/page_blocks/product_review_form.rb
+- app/models/spree/page_blocks/products/reviews.rb
+- app/models/spree/page_sections/add_a_review.rb
+- app/models/spree/page_sections/product_details_decorator.rb
+- app/models/spree/product_review.rb
+- app/models/spree/product_reviews_ability.rb
+- app/models/spree_product_reviews/spree/product_decorator.rb
+- app/models/spree_product_reviews/spree/product_review_decorator.rb
+- app/models/spree_product_reviews/spree/user_decorator.rb
+- app/views/spree/admin/page_blocks/forms/_product_review_form.html.erb
+- app/views/spree/admin/page_blocks/forms/_reviews.html.erb
+- app/views/spree/admin/page_sections/forms/_add_a_review.html.erb
+- app/views/spree/admin/product_reviews/_product_review.html.erb
+- app/views/spree/admin/product_reviews/_table.html.erb
+- app/views/spree/admin/product_reviews/edit.html.erb
+- app/views/spree/admin/product_reviews/index.html.erb
+- app/views/spree/admin/product_reviews/update.turbo_stream.erb
+- app/views/spree/page_blocks/products/reviews/_reviews.html.erb
+- app/views/spree/page_sections/_add_a_review.html.erb
+- app/views/spree/page_sections/_product_reviews.html.erb
+- app/views/spree/product_reviews/_form.html.erb
+- app/views/spree/product_reviews/_images.html.erb
+- app/views/spree/product_reviews/_pending.html.erb
+- app/views/spree/product_reviews/_review.html.erb
+- app/views/spree/products/_json_ld.html.erb
+- app/views/spree_product_reviews/admin/_product_reviews_dropdown.html.erb
+- app/views/themes/default/spree/page_sections/_product_details.html.erb
+- config/initializers/spree_product_reviews.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20250501173852_add_reviews.rb
+- db/migrate/20250501174531_add_review_info_to_products.rb
+- lib/generators/spree_product_reviews/install/install_generator.rb
+- lib/spree_product_reviews.rb
+- lib/spree_product_reviews/configuration.rb
+- lib/spree_product_reviews/engine.rb
+- lib/spree_product_reviews/factories.rb
+- lib/spree_product_reviews/version.rb
+homepage: https://github.com/umeshravani/spree_product_reviews
+licenses:
+- AGPL-3.0-or-later
+metadata:
+  source_code_uri: https://github.com/umeshravani/spree_product_reviews
+  changelog_uri: https://github.com/umeshravani/spree_product_reviews/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Spree Commerce Product Reviews Extension
+test_files: []