myco_pricing_engine 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d392274767ced10357628ce5bc50e2ac989e63a77dceecc690a403b4576caa8
-  data.tar.gz: 8a2bc24fe07f259d263ac2733d293e271e4155b9e48055d1fa6cc133fff6f833
+  metadata.gz: 27d95967f5eacfaa6e16e3f6b4baaf660f216703c2a4f59d55ec64fb28887459
+  data.tar.gz: 5d4c32234de86b8107cedeab0947af8e295ec6c871285556dc573bc7abf9b4f1
 SHA512:
-  metadata.gz: 927a55f82120995128ba152ea726e3c57cc9e720e27680f6ed1def73a61657c2a0010fcda52b237b54e916522332ba6b0787d9d331044e961187eb1cf8b8cc39
-  data.tar.gz: a722070da98de99179f48e8a916250f7e41e2cc1bbb9120da359146210da3b99d695cc8a2a2a2fd3a976656992c6f8a2bec883fc045761b710bfff1feeda539e
+  metadata.gz: 5d9f6571b3d16677a2ed488e143ea9b31d3c0bc85d7e6161cb693178f999aa8bf77f62a4a1b71d49db7b46d0bddb742aaeb3b11e5c485fd4bf20dfc7fc7af7ee
+  data.tar.gz: 60e1dd8ad8dd8144b117411d9ef010a91a96134b4647289a80fadd4804d3b693acaf6cd321fd16e41fc6bced83fcb1b423412df522604d2bc416f2a0f07f1d3e

data/README.md

@@ -1,35 +1,119 @@
 # MycoPricingEngine
 
-TODO: Delete this and the text below, and describe your gem
-
-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.
+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.
 
 ## Installation
 
-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.
+You can install the gem by adding it to your application's Gemfile:
+
+```ruby
+gem 'myco_pricing_engine'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it manually:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install myco_pricing_engine
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### 1. Including Pricing Engine in Rails Models
+
+```ruby
+class Loan < ApplicationRecord
+  include MycoPricingEngine::Calculator
+
+  # Example: calculate EMI
+  def monthly_emi
+    MycoPricingEngine::Calculator.compute_emi(principal, rate_of_interest, tenure)
+  end
+end
+```
 
-## Development
+### 2. Managing Preferences
+
+The gem supports dynamic preferences using `SerialPreference`:
+
+```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
+```
 
-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.
+### 3. Supported Rails Versions
 
-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).
+MycoPricingEngine supports:
+
+- Rails 4.x → 7.x
+- ActiveRecord 4.x → 8.x
+- Ruby 2.7+ → 3.4
+
+### 4. Development
+
+Clone the repository and set up dependencies:
+
+```bash
+git clone https://github.com/mrmalvi/myco_pricing_engine.git
+cd myco_pricing_engine
+bin/setup
+```
+
+Run the console to experiment:
+
+```bash
+bin/console
+```
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+To install the gem locally:
+
+```bash
+bundle exec rake install
+```
+
+To release a new 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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/myco_pricing_engine.
+Bug reports and pull requests are welcome! Please open issues or PRs on [GitHub](https://github.com/mrmalvi/myco_pricing_engine).
+
+Before contributing, ensure all tests pass:
+
+```bash
+bundle exec rspec
+```
+
+## License
+
+This gem is released under the MIT License. See [LICENSE](LICENSE) for details.
+

data/lib/myco_pricing_engine/calculator.rb

@@ -0,0 +1,59 @@
+# 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
+      price -= loyalty_discount(price)
+      price += tax(price)
+      price -= coupon_discount(price)
+      price.round(2)
+    end
+
+    private
+
+    def default_config
+      {
+        loyalty_threshold: 1000,
+        loyalty_discount: 0.10,
+        tax_rate: 0.18,
+        coupons: {}
+      }
+    end
+
+    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
+      end
+    end
+
+    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)
+
+      discount_value = config[:coupons][coupon_code]
+      if discount_value.is_a?(Numeric) && discount_value <= 1.0
+        price * discount_value
+      else
+        discount_value
+      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.1"
 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 "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.1
 platform: ruby
 authors:
 - mrmalvi
@@ -76,6 +76,7 @@ files:
 - 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