myco_pricing_engine 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27d95967f5eacfaa6e16e3f6b4baaf660f216703c2a4f59d55ec64fb28887459
-  data.tar.gz: 5d4c32234de86b8107cedeab0947af8e295ec6c871285556dc573bc7abf9b4f1
+  metadata.gz: 6f5824035436e46227cf1d8ead9027b8d2da05668ba855cf288cb78e598e9a8b
+  data.tar.gz: 6e2637000fa652fe9e1ec71f850c4a5c7469a2488c914158e05521690df32f2d
 SHA512:
-  metadata.gz: 5d9f6571b3d16677a2ed488e143ea9b31d3c0bc85d7e6161cb693178f999aa8bf77f62a4a1b71d49db7b46d0bddb742aaeb3b11e5c485fd4bf20dfc7fc7af7ee
-  data.tar.gz: 60e1dd8ad8dd8144b117411d9ef010a91a96134b4647289a80fadd4804d3b693acaf6cd321fd16e41fc6bced83fcb1b423412df522604d2bc416f2a0f07f1d3e
+  metadata.gz: d48d2684e8ec09138c745271d0e842dd2696747a40c05823d4fffefe7d6365fc70bc16671e474455c47a73b94f2d93b8d196c7fc0deab03bc705bb76cea9aac5
+  data.tar.gz: 416c1573f5c171501cbde75948c79b6f28d30141cddc2bb56f8a7a436222b4dcc7f79db0c10c5c3cd5ddd22105f82f8e0737039e1be5b8c4b2aafc100f474fff

data/.github/workflows/rubyonrails.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@78c01b705fd9d5ad960d432d3a0cfa341d50e410 # v1.179.1
+        with:
+          ruby-version: 3.2.0
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 mrmalvi
+
+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

@@ -1,119 +1,123 @@
-# MycoPricingEngine
+# 🚀 Myco Pricing Engine – Rails Engine for Pricing Utilities
 
-MycoPricingEngine is a Ruby gem for handling **pricing calculations, loan/EMI computations, and financial preference management** in Rails applications. It provides a flexible engine for modeling pricing rules, calculating interest, and managing dynamic preferences per entity.
+[![Gem Version](https://badge.fury.io/rb/myco_pricing_engine.svg)](https://rubygems.org/gems/myco_pricing_engine)
+[![Build Status](https://github.com/your-username/myco_pricing_engine/actions/workflows/ci.yml/badge.svg)](https://github.com/your-username/myco_pricing_engine/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
-## Installation
+**Myco Pricing Engine** is an open-source **Rails engine** that provides utilities for pricing calculations and automation.
+It helps developers integrate pricing logic, split EMIs, and manage financial calculations in Rails applications.
 
-You can install the gem by adding it to your application's Gemfile:
+👉 [RubyGems page](https://rubygems.org/gems/myco_pricing_engine) |
+👉 [Source code on GitHub](https://github.com/your-username/myco_pricing_engine)
+
+---
+
+## ✨ Features
+- ⚡ Automatic pricing calculations
+- 🔢 EMI and interest rate utilities
+- 🧩 Easily integratable with Rails apps
+
+---
+
+## 📦 Installation
+
+Add this line to your Rails app `Gemfile`:
 
 ```ruby
 gem 'myco_pricing_engine'
 ```
 
-Then execute:
+Then install the gem:
 
 ```bash
 bundle install
 ```
 
-Or install it manually:
+Or install manually:
 
 ```bash
 gem install myco_pricing_engine
 ```
 
-## Usage
+## 🚀 Usage
 
-### 1. Including Pricing Engine in Rails Models
+### Automatic Features
+- Pricing calculations for products, EMI breakdown, and financial summaries.
 
+### Manual Usage
 ```ruby
-class Loan < ApplicationRecord
-  include MycoPricingEngine::Calculator
-
-  # Example: calculate EMI
-  def monthly_emi
-    MycoPricingEngine::Calculator.compute_emi(principal, rate_of_interest, tenure)
-  end
-end
-```
-
-### 2. Managing Preferences
-
-The gem supports dynamic preferences using `SerialPreference`:
+user = User.new(loyalty_points: 1200) # Active Record/Openstruct
+
+# Optional configuration
+config = {
+  loyalty_threshold: 1000,   # Points required for loyalty discount
+  loyalty_discount: 0.10,    # 10% discount
+  tax_rate: 0.18,            # 18% tax
+  coupons: {                 # Coupon codes
+    "SAVE50" => 50,          # Fixed discount
+    "NEW10"  => 0.10         # Percentage discount
+  }
+}
+
+# Initialize calculator
+calc = MycoPricingEngine::Calculator.new(
+  base_price: 1000,
+  user: user,
+  options: { coupon: "SAVE50" },
+  config: config
+)
+
+# Calculate final price
+puts calc.final_price
+# => 1062.0
 
-```ruby
-class DummyClass < ApplicationRecord
-  include SerialPreference::HasSerialPreferences
-
-  preferences do
-    boolean :taxable, default: true
-    string  :vat_no
-    integer :max_invoice_items, default: 100
-  end
-end
-
-d = DummyClass.new
-d.taxable?           # => true
-d.vat_no = "ABC123"
-d.max_invoice_items   # => 100
 ```
 
-### 3. Supported Rails Versions
-
-MycoPricingEngine supports:
+---
 
-- Rails 4.x → 7.x
-- ActiveRecord 4.x → 8.x
-- Ruby 2.7+ → 3.4
+## 🧪 Development & Testing
 
-### 4. Development
-
-Clone the repository and set up dependencies:
+Clone and setup:
 
 ```bash
-git clone https://github.com/mrmalvi/myco_pricing_engine.git
+git clone https://github.com/your-username/myco_pricing_engine.git
 cd myco_pricing_engine
-bin/setup
-```
-
-Run the console to experiment:
-
-```bash
-bin/console
+bundle install
 ```
 
-Run tests:
+Run specs:
 
 ```bash
 bundle exec rspec
 ```
 
-To install the gem locally:
+Build gem locally:
 
 ```bash
 bundle exec rake install
 ```
 
-To release a new version:
+Release a version:
 
 ```bash
-# Update the version in lib/myco_pricing_engine/version.rb
 bundle exec rake release
 ```
 
-This will create a git tag, push commits, and push the gem to RubyGems.org.
+---
 
-## Contributing
+## 🤝 Contributing
 
-Bug reports and pull requests are welcome! Please open issues or PRs on [GitHub](https://github.com/mrmalvi/myco_pricing_engine).
+Contributions, bug reports, and pull requests are welcome!
+See [issues](https://github.com/your-username/myco_pricing_engine/issues).
 
-Before contributing, ensure all tests pass:
+---
 
-```bash
-bundle exec rspec
-```
+## 📜 License
+
+Released under the [MIT License](LICENSE.txt).
 
-## License
+---
 
-This gem is released under the MIT License. See [LICENSE](LICENSE) for details.
+### 📈 SEO Keywords
+*Rails engine, Ruby gem, pricing utilities, EMI calculation, Rails financial gem, Myco Pricing Engine*
 

data/lib/myco_pricing_engine/calculator.rb

@@ -13,9 +13,23 @@ module MycoPricingEngine
 
     def final_price
       price = base_price
+
+      # Apply discounts
       price -= loyalty_discount(price)
+      price -= early_bird_discount(price)
+
+      # Add tax
       price += tax(price)
-      price -= coupon_discount(price)
+
+      # Apply coupons (after tax)
+      price -= coupon_discounts(price)
+
+      # Add delivery/service fee
+      price += delivery_fee
+
+      # Apply caps
+      price = apply_price_caps(price)
+
       price.round(2)
     end
 
@@ -23,36 +37,93 @@ module MycoPricingEngine
 
     def default_config
       {
-        loyalty_threshold: 1000,
-        loyalty_discount: 0.10,
+        # Loyalty
+        loyalty_levels: {
+          silver:   { threshold: 500,  discount: 0.05 },
+          gold:     { threshold: 1000, discount: 0.10 },
+          platinum: { threshold: 2000, discount: 0.20 }
+        },
+
+        # Tax
         tax_rate: 0.18,
-        coupons: {}
+
+        # Coupons
+        coupons: {},
+
+        # Early bird
+        early_bird_deadline: nil, # Date or Time
+        early_bird_discount: 0.10,
+
+        # Fees
+        delivery_fee: 0.0,
+
+        # Caps
+        min_price: 0.0,
+        max_price: Float::INFINITY
       }
     end
 
+    # ---------------------
+    # Discounts
+    # ---------------------
     def loyalty_discount(price)
       return 0 unless user.respond_to?(:loyalty_points)
 
-      if user.loyalty_points > config[:loyalty_threshold]
-        price * config[:loyalty_discount]
-      else
-        0
+      discount = 0
+      config[:loyalty_levels].each_value do |level|
+        if user.loyalty_points >= level[:threshold]
+          discount = level[:discount]
+        end
+      end
+
+      price * discount
+    end
+
+    def coupon_discounts(price)
+      return 0 unless options[:coupons].is_a?(Array)
+
+      options[:coupons].sum do |code|
+        next 0 unless config[:coupons].key?(code)
+
+        discount_value = config[:coupons][code]
+        if discount_value.is_a?(Numeric) && discount_value <= 1.0
+          price * discount_value
+        else
+          discount_value
+        end
       end
     end
 
+    def early_bird_discount(price)
+      deadline = config[:early_bird_deadline]
+      return 0 unless deadline && current_time <= deadline
+
+      price * config[:early_bird_discount]
+    end
+
+    # ---------------------
+    # Fees & Tax
+    # ---------------------
     def tax(price)
       price * config[:tax_rate]
     end
 
-    def coupon_discount(price)
-      coupon_code = options[:coupon]
-      return 0 unless coupon_code && config[:coupons].key?(coupon_code)
+    def delivery_fee
+      config[:delivery_fee].to_f
+    end
+
+    # ---------------------
+    # Caps
+    # ---------------------
+    def apply_price_caps(price)
+      [[price, config[:min_price]].max, config[:max_price]].min
+    end
 
-      discount_value = config[:coupons][coupon_code]
-      if discount_value.is_a?(Numeric) && discount_value <= 1.0
-        price * discount_value
+    def current_time
+      if defined?(Time.zone) && Time.zone
+        Time.current
       else
-        discount_value
+        Time.now
       end
     end
   end

data/lib/myco_pricing_engine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MycoPricingEngine
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/myco_pricing_engine.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require "active_support/all"
 require "myco_pricing_engine/calculator"
 
 module MycoPricingEngine

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myco_pricing_engine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - mrmalvi
@@ -73,6 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubyonrails.yml"
+- ".ruby-version"
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/myco_pricing_engine.rb