myco_pricing_engine 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d392274767ced10357628ce5bc50e2ac989e63a77dceecc690a403b4576caa8
-  data.tar.gz: 8a2bc24fe07f259d263ac2733d293e271e4155b9e48055d1fa6cc133fff6f833
+  metadata.gz: 6f5824035436e46227cf1d8ead9027b8d2da05668ba855cf288cb78e598e9a8b
+  data.tar.gz: 6e2637000fa652fe9e1ec71f850c4a5c7469a2488c914158e05521690df32f2d
 SHA512:
-  metadata.gz: 927a55f82120995128ba152ea726e3c57cc9e720e27680f6ed1def73a61657c2a0010fcda52b237b54e916522332ba6b0787d9d331044e961187eb1cf8b8cc39
-  data.tar.gz: a722070da98de99179f48e8a916250f7e41e2cc1bbb9120da359146210da3b99d695cc8a2a2a2fd3a976656992c6f8a2bec883fc045761b710bfff1feeda539e
+  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,35 +1,123 @@
-# MycoPricingEngine
+# 🚀 Myco Pricing Engine – Rails Engine for Pricing Utilities
 
-TODO: Delete this and the text below, and describe your gem
+[![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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/myco_pricing_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
+**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.
 
-## Installation
+👉 [RubyGems page](https://rubygems.org/gems/myco_pricing_engine) |
+👉 [Source code on GitHub](https://github.com/your-username/myco_pricing_engine)
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+---
 
-Install the gem and add to the application's Gemfile by executing:
+## ✨ 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 install the gem:
+
+```bash
+bundle install
+```
+
+Or install manually:
+
+```bash
+gem install myco_pricing_engine
+```
+
+## 🚀 Usage
+
+### Automatic Features
+- Pricing calculations for products, EMI breakdown, and financial summaries.
+
+### Manual Usage
+```ruby
+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
+
+```
+
+---
+
+## 🧪 Development & Testing
+
+Clone and setup:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+git clone https://github.com/your-username/myco_pricing_engine.git
+cd myco_pricing_engine
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Run specs:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle exec rspec
 ```
 
-## Usage
+Build gem locally:
+
+```bash
+bundle exec rake install
+```
+
+Release a version:
+
+```bash
+bundle exec rake release
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions, bug reports, and pull requests are welcome!
+See [issues](https://github.com/your-username/myco_pricing_engine/issues).
 
-TODO: Write usage instructions here
+---
 
-## Development
+## 📜 License
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Released under the [MIT License](LICENSE.txt).
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+---
 
-## Contributing
+### 📈 SEO Keywords
+*Rails engine, Ruby gem, pricing utilities, EMI calculation, Rails financial gem, Myco Pricing Engine*
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/myco_pricing_engine.

data/lib/myco_pricing_engine/calculator.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module MycoPricingEngine
+  class Calculator
+    attr_reader :base_price, :user, :options, :config
+
+    def initialize(base_price:, user:, options: {}, config: {})
+      @base_price = base_price
+      @user       = user
+      @options    = options
+      @config     = default_config.merge(config)
+    end
+
+    def final_price
+      price = base_price
+
+      # Apply discounts
+      price -= loyalty_discount(price)
+      price -= early_bird_discount(price)
+
+      # Add tax
+      price += tax(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
+
+    private
+
+    def default_config
+      {
+        # 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: {},
+
+        # 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)
+
+      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 delivery_fee
+      config[:delivery_fee].to_f
+    end
+
+    # ---------------------
+    # Caps
+    # ---------------------
+    def apply_price_caps(price)
+      [[price, config[:min_price]].max, config[:max_price]].min
+    end
+
+    def current_time
+      if defined?(Time.zone) && Time.zone
+        Time.current
+      else
+        Time.now
+      end
+    end
+  end
+end

data/lib/myco_pricing_engine/version.rb

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

data/lib/myco_pricing_engine.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
-
-require_relative "myco_pricing_engine/version"
-require_relative "myco_pricing_engine/calculator"
+require "active_support/all"
+require "myco_pricing_engine/calculator"
 
 module MycoPricingEngine
   class Error < StandardError; end

metadata

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