e-commerce_shop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfcfc6dce34a2d0391f5fe5a61f51bbdb3feb53db94f5e1ed0553558060f8c55
+  data.tar.gz: d14e3a9a31ecfcf4e8a12a743c3da8949b1117c6b01a6a35f4f93e1fdd795f27
+SHA512:
+  metadata.gz: '08d822113ea118b9fb44e4e34b9a54f9b851ec554631fc2fe98591fbf2877f1597995db00a10d151a67f34888d5526ec69b42f1d1dc948fc1c6881038c3d5dc6'
+  data.tar.gz: eb0cc348671298af429aab074fb78801abad6e99e69627372b799664479f1ed8c286de1d841dbfda58b78f3d2a04c6a1487a8005b334633ee957ba619f37cb90

data/lib/generators/install_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Shop
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration
+        migration_template "create_carts.rb", "db/migrate/create_carts.rb"
+        migration_template "create_products.rb", "db/migrate/create_products.rb"
+        migration_template "create_variants.rb", "db/migrate/create_variants.rb"
+        migration_template "create_sizes.rb", "db/migrate/create_sizes.rb"
+        migration_template "create_cart_items.rb", "db/migrate/create_cart_items.rb"
+      end
+
+      def copy_models
+        template 'cart.rb', 'app/models/cart.rb'
+        template 'cart_item.rb', 'app/models/cart_item.rb'
+        template 'product.rb', 'app/models/product.rb'
+        template 'variant.rb', 'app/models/variant.rb'
+        template 'size.rb', 'app/models/size.rb'
+      end
+
+      def self.next_migration_number(path)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        end
+        @prev_migration_nr.to_s
+      end
+    end
+  end
+end

data/lib/shop/cart.rb

@@ -0,0 +1,42 @@
+module Shop
+  class Cart
+    attr_reader :user_id
+
+    def initialize(user_id)
+      @user_id = user_id
+      @cart = ::Cart.find_by(user_id: @user_id)
+    end
+
+    # Get Cart For User
+    def specific_user_cart
+      cart = ::Cart.where(user_id: @user_id)
+      if cart.present?
+        { message: 'Cart Found Successfully', cart: cart, status: :found }
+      else
+        { message: 'No Cart Found For This User', cart: nil, status: :not_found }
+      end
+    end
+
+    # Create Cart
+    def create
+      @cart = ::Cart.find_or_initialize_by(user_id: @user_id)
+      return { message: @cart.errors.full_messages, cart: nil, status: :unprocessable_entity } unless @cart.save
+
+      { message: 'Cart Created Successfully', cart: @cart, status: :created }
+    end
+
+    # Delete Cart
+    def delete
+      return { message: @cart.errors.full_messages, cart: @cart, status: :unprocessable_entity } unless @cart.destroy
+
+      { message: 'Cart Deleted Successfully', cart: nil, status: :deleted }
+    end
+
+    # Clear Cart
+    def clear
+      return { message: "Items Can't be destroyed", cart: @cart, status: :unprocessable_entity } unless @cart.cart_items.destroy_all && @cart.update(total_amount: 0.0)
+
+      { message: 'Cart Cleared Successfully', cart: @cart, status: :updated }
+    end
+  end
+end

data/lib/shop/cart_item.rb

@@ -0,0 +1,75 @@
+module Shop
+  class CartItem
+    attr_reader :cart_id, :product_id, :variant_id, :quantity, :size_id
+
+    def initialize(cart_id, product_id, variant_id, size_id = nil)
+      @cart = ::Cart.find_by(id: cart_id) if cart_id
+      @product = ::Product.find_by(id: product_id) if product_id
+      @variant = ::Variant.find_by(id: variant_id) if variant_id
+      @size = ::Size.find_by(id: size_id) if size_id
+    end
+
+    # Cart Items
+    def cart_items
+      cart_items = @cart.cart_items.order(created_at: :desc)
+      if cart_items.present?
+        { message: 'Cart Items Found Successfully', cart_items: cart_items, status: :found }
+      else
+        { message: 'No Cart Items Found', cart_items: nil, status: :not_found }
+      end
+    end
+
+    # Creates a new Cart Item
+    def create(quantity, amount)
+      return { message: 'Cart not found', cart_item: nil, status: :not_found } unless @cart
+
+      cart_item = ::CartItem.new(cart_id: @cart.id, product_id: @product.id, variant_id: @variant.id, size_id: @size.id, quantity: quantity, amount: amount)
+      if cart_item.save
+        update_cart_amount(amount, 'add')
+        { message: 'Item Added Successfully', cart_item: cart_item, status: :created }
+      else
+        { message: cart_item.errors.full_messages, cart_item: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Update Cart Item Quantity
+    def update_quantity(cart_item_id, quantity, amount, key)
+      return { message: 'Cart Item not found', cart_item: nil, status: :not_found } unless (cart_item = ::CartItem.find_by(id: cart_item_id))
+
+      quantity = key == 'add' ? +quantity : -quantity
+      new_amount = key == 'add' ? +amount : -amount
+      old_quantity = cart_item.quantity
+      old_amount = cart_item.amount
+      if cart_item.update(quantity: old_quantity + quantity, amount: old_amount + new_amount)
+        update_cart_amount(amount, key)
+        { message: "Item #{key.capitalize}ed Successfully", cart_item: cart_item, status: :updated }
+      else
+        { message: cart_item.errors.full_messages, cart_item: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Deletes the Cart Item
+    def delete(cart_item_id)
+      return { message: 'Cart Item not found', cart_item: nil, status: :not_found } unless (cart_item = ::CartItem.find_by(id: cart_item_id))
+
+      if cart_item.destroy
+        update_cart_amount(cart_item.amount, 'remove')
+        { message: 'Cart Item Deleted Successfully', cart_item: nil, status: :deleted }
+      else
+        { message: cart_item.errors.full_messages, cart_item: nil, status: :unprocessable_entity }
+      end
+    end
+
+    private
+
+    def update_cart_amount(amount, key)
+      previous_amount = @cart.total_amount
+      new_amount = if key == 'add'
+                     +amount
+                   else
+                     -amount
+                   end
+      @cart.update(total_amount: previous_amount + new_amount)
+    end
+  end
+end

data/lib/shop/product.rb

@@ -0,0 +1,52 @@
+module Shop
+  class Product
+    attr_reader :user_id, :name, :price, :description, :delivery_fee, :country
+
+    def initialize(user_id)
+      @user_id = user_id
+    end
+
+    # Specific User Products
+    def specific_user_products(order, q)
+      products = ::Product.where(user_id: @user_id).order(created_at: order)
+      products = products.where('LOWER(name) ILIKE :query OR LOWER(country) ILIKE :query', query: "%#{q.downcase}%") if q.present?
+      if products.present?
+        { message: 'Product Found Successfully', products: products, status: :found }
+      else
+        { message: 'No Product Found For This User', products: [], status: :not_found }
+      end
+    end
+
+    # Creates a new product
+    def create(name, price, description, delivery_fee, country)
+      product = ::Product.new(user_id: @user_id, name: , price: ,description: , delivery_fee: , country: )
+      if product.save
+        { message: 'Product Created Successfully', product: product, status: :created }
+      else
+        { message: product.errors.full_messages, product: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Updates an existing product
+    def update(product_hash, product_id)
+      return { message: 'Product not found', product: nil, status: :not_found } unless (product = ::Product.find_by(id: product_id))
+
+      if product.update(product_hash)
+        { message: 'Product Updated Successfully', product: product, status: :updated }
+      else
+        { message: product.errors.full_messages, product: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Deletes the product
+    def delete(product_id)
+      return { message: 'Product not found', product: nil, status: :not_found } unless (product = ::Product.find_by(id: product_id))
+
+      if product.destroy
+        { message: 'Product Deleted Successfully', product: nil, status: :deleted }
+      else
+        { message: product.errors.full_messages, product: nil, status: :unprocessable_entity }
+      end
+    end
+  end
+end

data/lib/shop/size.rb

@@ -0,0 +1,61 @@
+module Shop
+  class Size
+    attr_reader :variant_id,  :name, :short_form, :quantity
+
+    def initialize
+      super
+    end
+
+    # Specific Variant Sizes
+    def specific_variant_sizes(variant_id, order, q)
+      sizes = ::Size.where(variant_id: variant_id).order(created_at: order)
+      sizes = sizes.where('LOWER(name) ILIKE :query OR LOWER(short_name) ILIKE :query', query: "%#{q.downcase}%") if q.present?
+      if sizes.present?
+        { message: 'Sizes Found Successfully', sizes: sizes, status: :found }
+      else
+        { message: 'No Sizes Found For This Variant', sizes: nil, status: :not_found }
+      end
+    end
+
+    # Creates a Single Size
+    def create_single_size(variant_id, name, short_form, in_stock)
+      size = ::Size.new(variant_id: variant_id, name: name, short_form: short_form, in_stock: in_stock)
+      if size.save
+        { message: 'Size Created Successfully', size: size, status: :created }
+      else
+        { message: size.errors.full_messages, size: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Create Multiple Sizes
+    def create_multiple_sizes(multiple_sizes_array)
+      if ::Size.insert_all(multiple_sizes_array)
+        { message: 'Sizes Created Successfully', size: nil, status: :created }
+      else
+        { message: "Not Created", size: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Updates an existing Size
+    def update(size_id, size_hash)
+      return { message: 'Size not found', size: nil, status: :not_found } unless (@size = ::Size.find_by(id: size_id))
+
+      if @size.update(size_hash)
+        { message: 'Size Updated Successfully', size: @size, status: :updated }
+      else
+        { message: @size.errors.full_messages, size: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Deletes the Size
+    def delete(size_id)
+      return { message: 'Size not found', size: nil, status: :not_found } unless (@size = ::Size.find_by(id: size_id))
+
+      if @size.destroy
+        { message: 'Size Deleted Successfully', size: nil, status: :deleted }
+      else
+        { message: @variant.errors.full_messages, size: nil, status: :unprocessable_entity }
+      end
+    end
+  end
+end

data/lib/shop/variant.rb

@@ -0,0 +1,51 @@
+module Shop
+  class Variant
+    attr_reader :product_id, :variant_id, :name, :color
+
+    def initialize
+      super
+    end
+
+    def specific_product_variants(product_id, order, q)
+      variants = ::Variant.where(product_id: product_id).order(created_at: order)
+      variants = variants.where('LOWER(name) ILIKE :query OR LOWER(color) ILIKE :query ', query: "%#{q.downcase}%") if q.present?
+      if variants.present?
+        { message: 'Variants Found Successfully', variants: variants, status: :found }
+      else
+        { message: 'No Variants Found For This Product', variants: nil, status: :not_found }
+      end
+    end
+
+    # Creates a new Variant
+    def create(product_id, name, color)
+      variant = ::Variant.new(product_id: product_id, name: name, color: color)
+      if variant.save
+        { message: 'Variant Created Successfully', variant: variant, status: :created }
+      else
+        { message: variant.errors.full_messages, variant: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Updates an existing Variant
+    def update(variant_id, variant_hash)
+      return { message: 'Variant not found', variant: nil, status: :not_found } unless (variant =  ::Variant.find_by(id: variant_id))
+
+      if variant.update(variant_hash)
+        { message: 'Variant Updated Successfully', variant: variant, status: :updated }
+      else
+        { message: variant.errors.full_messages, variant: nil, status: :unprocessable_entity }
+      end
+    end
+
+    # Deletes the Variant
+    def delete(variant_id)
+      return { message: 'Variant not found', variant: nil, status: :not_found } unless (variant =  ::Variant.find_by(id: variant_id))
+
+      if variant.destroy
+        { message: 'Variant Deleted Successfully', variant: nil, status: :deleted }
+      else
+        { message: variant.errors.full_messages, variant: nil, status: :unprocessable_entity }
+      end
+    end
+  end
+end

data/lib/shop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Shop
+  VERSION = "0.1.0"
+end

data/sig/shop/cart.rbs

@@ -0,0 +1,14 @@
+module Shop
+  class Cart
+    attr_reader user_id: untyped
+
+    @cart: untyped
+    @user_id: untyped
+
+    def initialize: (Integer) -> { message: String, cart: Cart | nil, status: Symbol }
+    def clear: () -> { message: String, cart: Cart | nil, status: Symbol }
+    def create: () -> { message: String, cart: Cart | nil, status: Symbol }
+    def delete: () -> { message: String, cart: Cart | nil, status: Symbol }
+    def specific_user_cart: () -> { message: String, cart: Cart | nil, status: Symbol }
+  end
+end

data/sig/shop/cart_item.rbs

@@ -0,0 +1,24 @@
+module Shop
+  class CartItem
+    attr_reader cart_id: untyped
+    attr_reader product_id: untyped
+    attr_reader variant_id: untyped
+    attr_reader quantity: untyped
+    attr_reader size_id: untyped
+
+    @cart: untyped
+    @product: untyped
+    @variant: untyped
+    @size: untyped
+
+    def initialize: (Integer, Integer, Integer, nil | Integer) -> untyped
+    def cart_items: () -> { message: String, cart_item: Array[CartItem] | nil, status: Symbol }
+    def create: (Integer, Float) -> { message: String, cart_item: CartItem | nil, status: Symbol }
+    def delete: (Integer) -> { message: String, cart_item: CartItem | nil, status: Symbol }
+    def update_quantity: (Integer, Integer, Float, 'add' | 'remove') -> { message: String, cart_item: CartItem | nil, status: Symbol }
+
+    private
+
+    def update_cart_amount: -> untyped
+  end
+end

data/sig/shop/generators/install_generator.rbs

@@ -0,0 +1,7 @@
+module Shop
+  module Generators
+    class InstallGenerator
+      @prev_migration_nr: untyped
+    end
+  end
+end

data/sig/shop/product.rbs

@@ -0,0 +1,19 @@
+module Shop
+  class Product
+    attr_reader country: untyped
+    attr_reader delivery_fee: untyped
+    attr_reader description: untyped
+    attr_reader name: untyped
+    attr_reader price: untyped
+    attr_reader user_id: untyped
+
+    @product: untyped
+    @product_hash: Hash[untyped, untyped]
+
+    def initialize: (Integer) -> untyped
+    def create: (String, Float, String | nil, Float | nil, String | nil) -> { message: String, product: Product | nil, status: Symbol }
+    def specific_user_products: ((:asc | :desc), String | nil) -> { message: String, products: Array[Product] | nil, status: Symbol }
+    def update: (Hash[Symbol, Integer | String | Float], Integer) -> { message: String, product: Product | nil, status: Symbol }
+    def delete: (Integer) -> { message: String, product: Product | nil, status: Symbol }
+  end
+end

data/sig/shop/size.rbs

@@ -0,0 +1,18 @@
+module Shop
+  class Size
+    attr_reader name: untyped
+    attr_reader product_id: untyped
+    attr_reader quantity: untyped
+    attr_reader short_form: untyped
+    attr_reader variant_id: untyped
+
+    @variant: untyped
+    @size: untyped
+
+    def specific_variant_sizes: (Integer, (:asc | :desc), String | nil) -> { message: String, sizes: Array[Size] | nil, status: Symbol }
+    def create_single_size: (Integer | nil, String, String, Integer) -> { message: String, size: Size | nil, status: Symbol }
+    def create_multiple_sizes: (Array[Hash[Symbol, String | Float | Integer]]) -> { message: String, size: Size | nil, status: Symbol }
+    def delete: (Integer) -> { message: String, size: Size | nil, status: Symbol }
+    def update: (Integer, Hash[Symbol, Integer | Float | String]) -> { message: String, size: Size | nil, status: Symbol }
+  end
+end

data/sig/shop/variant.rbs

@@ -0,0 +1,16 @@
+module Shop
+  class Variant
+    attr_reader color: untyped
+    attr_reader name: untyped
+    attr_reader product_id: untyped
+    attr_reader variant_id: untyped
+
+    @product: untyped
+    @variant: untyped
+
+    def create: (Integer, String, String) -> { message: String, variant: Variant | nil, status: Symbol }
+    def specific_product_variants: (Integer, (:asc | :desc), String | nil) -> { message: String, variants: Array[Variant] | nil, status: Symbol }
+    def update: (Integer, Hash[Symbol, String | Float | Integer]) -> { message: String, variant: Variant | nil, status: Symbol }
+    def delete: (Integer) -> { message: String, variant: Variant | nil, status: Symbol }
+  end
+end

data/sig/shop.rbs

@@ -0,0 +1,4 @@
+module CartManagement
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,26 @@
+# spec/generators/install_generator_spec.rb
+require 'rails_helper'
+require "shop/generators/install_generator"
+
+RSpec.describe Shop::Generators::InstallGenerator, type: :generator do
+  destination File.expand_path('../../tmp/generators', __FILE__)
+
+  # Include the generator test case behavior
+  include Rails::Generators::TestCase::Behavior
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "generates a migration file" do
+    expect(destination_root).to have_structure {
+      directory("db") do
+        directory("migrate") do
+          migration_file = file(/.*create_carts.rb/)
+          expect(migration_file).to exist
+        end
+      end
+    }
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,23 @@
+# spec/rails_helper.rb
+
+# Require RSpec and any other necessary testing libraries
+# require "rspec/rails"
+require "shop"
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+
+RSpec.configure do |config|
+  # If you want to run your tests within a transaction, uncomment this line
+  # This will make tests faster by rolling back changes after each test
+  # config.use_transactional_fixtures = true
+
+  # Add additional requires or configurations here
+  # e.g., if you are using FactoryBot for factories
+  config.include FactoryBot::Syntax::Methods
+
+  # Configure how your tests are run
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"  # Path for fixture files
+  config.infer_spec_type_from_file_location!  # Automatically set test types based on file location
+  config.filter_rails_from_backtrace!  # Filter out Rails gems from backtrace
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# spec/spec_helper.rb
+
+# This file is generated by the `rspec --init` command.
+# It is a good idea to add `require 'rspec/expectations'` here.
+
+RSpec.configure do |config|
+  # Enables the `:focus` filter, allowing you to run only focused tests.
+  config.filter_run_when_matching :focus
+
+  # Run all examples in random order to surface order dependencies.
+  config.order = :random
+
+  # Print the seed used for random ordering.
+  Kernel.srand config.seed
+
+  # Enable the expectation syntax for more readable tests.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Enable the mock framework.
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # Disable RSpec's monkey patching of Kernel and Object.
+  config.disable_monkey_patching!
+
+  # Enable the use of `let` and `subject` outside of `describe` blocks.
+  config.include RSpec::Mocks::ExampleMethods
+
+  # Additional configurations can go here.
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: e-commerce_shop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fahadbutt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-24 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides a comprehensive solution for managing shopping carts,
+  products, and variants in e-commerce applications. It supports flexible product
+  creation, updates, and variant handling, along with efficient cart management functionality.
+email:
+- buttf5169@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/install_generator.rb
+- lib/shop/cart.rb
+- lib/shop/cart_item.rb
+- lib/shop/product.rb
+- lib/shop/size.rb
+- lib/shop/variant.rb
+- lib/shop/version.rb
+- sig/shop.rbs
+- sig/shop/cart.rbs
+- sig/shop/cart_item.rbs
+- sig/shop/generators/install_generator.rbs
+- sig/shop/product.rbs
+- sig/shop/size.rbs
+- sig/shop/variant.rbs
+- spec/generators/install_generator_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2
+    Thank you for installing Shop Gem!
+
+    To complete the installation, please run:
+
+        rails g shop:install
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+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: A gem to manage shopping carts, products, and variants with flexible and
+  customizable features for e-commerce platforms.
+test_files: []