emi_calculator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9be6a670978ef42888bdcbbc970480a8693e5f6c41c55590ec6182ba5afcf95
+  data.tar.gz: 6113d40fc91eef4606cab7579061c933592f7e01cb163285eeacf77e91bc2554
+SHA512:
+  metadata.gz: b4a78c76af107d0eea333f53686c0fa5c87d40fc007ffe7f374e84c87c40e7d830494c9a8590fddcd7ad3450c7d054c6417d1f3bcea864cd4c36e416e3fb5b84
+  data.tar.gz: c44fb389484527d0008cb20c5472ae1c2ed1072ccdbdd7b9ac78a7efad554af6157b051bd3cb4be18b80f402224e9ea213a125920c3726fdf8fb8e206fe4f8e7

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in emi_calculator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    emi_calculator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    rake (13.3.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  emi_calculator!
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.4.12

data/README.md

@@ -0,0 +1,138 @@
+# 💰 EmiCalculator
+
+A lightweight Ruby gem for calculating **Loan EMIs**, **Total Interest**, and **Amortization Schedules** with ease.
+
+---
+
+## 🚀 Features
+
+- 🧮 Calculate monthly EMI (Equated Monthly Installment)
+- 💵 Get total payment and total interest
+- 📅 Generate detailed amortization schedules
+- 🧑‍💻 Easy to integrate with Rails or standalone Ruby projects
+- ✅ Tested with RSpec
+
+---
+
+## 📦 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emi_calculator'
+```
+Then execute
+```ruby
+$ bundle install
+```
+
+Or Install Directly
+```ruby
+$ gem install emi_calculator
+```
+## 🧮 Usage
+```ruby
+require 'emi_calculator'
+
+calculator = EmiCalculator::Calculator.new(
+  principal: 500_000,      # Loan amount
+  annual_rate: 10,         # Annual interest rate (in %)
+  tenure_months: 60        # Loan period in months
+)
+
+calculator.emi
+# => 10624.45
+
+
+calculator.total_payment
+# => 637467.0
+
+calculator.total_interest
+# => 137467.0
+
+
+schedule = calculator.amortization_schedule
+
+schedule.first(3)
+# => [
+#   {:month=>1, :emi=>10624.45, :interest=>4166.67, :principal=>6457.78, :balance=>493542.22},
+#   {:month=>2, :emi=>10624.45, :interest=>4112.85, :principal=>6511.60, :balance=>487030.62},
+#   {:month=>3, :emi=>10624.45, :interest=>4058.59, :principal=>6565.86, :balance=>480464.76}
+# ]
+
+```
+
+## 🧰 Development
+
+Run the following to set up your local environment:
+```ruby
+$ bin/setup
+```
+
+You can open an interactive console with:
+```ruby
+$ bin/console
+```
+
+To install this gem locally:
+```ruby
+$ bundle exec rake install
+```
+
+To release a new version:
+```ruby
+$ bundle exec rake release
+```
+
+This will:
+
+Build the .gem file
+
+Create a new Git tag
+
+Push commits and the tag
+
+Publish the gem to RubyGems.org
+
+## 📘 Example Project
+```ruby
+require 'emi_calculator'
+
+loan = EmiCalculator::Calculator.new(
+  principal: 250000,
+  annual_rate: 8.5,
+  tenure_months: 36
+)
+
+puts "Monthly EMI: ₹#{loan.emi}"
+puts "Total Payment: ₹#{loan.total_payment}"
+puts "Total Interest: ₹#{loan.total_interest}"
+```
+## 🤝 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/<your-username>/emi_calculator
+.
+
+Fork it
+```
+Create your feature branch (git checkout -b my-new-feature)
+
+Commit your changes (git commit -am 'Add new feature')
+
+Push to the branch (git push origin my-new-feature)
+
+Create a new Pull Request
+```
+## 🧑‍💼 Author
+```
+Ravi Shankar Singhal
+Senior Backend Developer — Ruby on Rails
+📧 ravi.singhal2308@gmail.com
+
+🌐 https://github.com/RaviShankarSinghal
+```
+## 🪪 License
+
+The gem is available as open source under the terms of the MIT License
+.
+---

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/emi_calculator.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/emi_calculator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "emi_calculator"
+  spec.version = EmiCalculator::VERSION
+  spec.authors = ["Ravi Shankar Singhal"]
+  spec.email = ["ravi.singhal2308@gmail.com"]
+
+  spec.summary = "A simple Ruby gem to calculate loan EMI (Equated Monthly Installment)."
+  spec.description = "This gem provides methods to calculate EMI, total interest, and total payment amount for a given loan principal, interest rate, and tenure."
+  spec.homepage = "https://github.com/RaviShankarSinghal/emi_calculator"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/RaviShankarSinghal/emi_calculator"
+  spec.metadata["changelog_uri"] = "https://github.com/RaviShankarSinghal/emi_calculator/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/emi_calculator/calculator.rb

@@ -0,0 +1,53 @@
+module EmiCalculator
+  class Calculator
+    attr_reader :principal, :annual_rate, :tenure_months
+
+    def initialize(principal:, annual_rate:, tenure_months:)
+      @principal = principal.to_f
+      @annual_rate = annual_rate.to_f
+      @tenure_months = tenure_months.to_i
+    end
+
+    def monthly_rate
+      annual_rate/ 12/ 100
+    end
+
+    def emi
+      r = monthly_rate
+      n = tenure_months
+      p = principal
+
+      return 0.00 if r.zero? || n.zero?
+
+      rate = p * r * ((1+r)**n) / (((1+r)**n) - 1)
+      rate.round(2)
+    end
+
+    def total_payment
+      emi * tenure_months
+    end
+
+    def total_interest
+      total_payment - principal
+    end
+
+    def amortization_schedule
+      schedule = []
+      balance = principal
+      r = monthly_rate
+      (1..tenure_months).each do |month|
+        interest = balance * r
+        principal_component = emi - interest
+        balance -= principal_component
+        schedule << {
+          month: month,
+          emi: emi.round(3),
+          interest: interest.round(3),
+          principal: principal_component.round(3),
+          balance: balance.positive? ? balance.round(3) : 0.000
+        }
+      end
+      schedule
+    end
+  end
+end

data/lib/emi_calculator/version.rb

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

data/lib/emi_calculator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "emi_calculator/version"
+require_relative "emi_calculator/calculator"
+
+module EmiCalculator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/emi_calculator.rbs

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: emi_calculator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ravi Shankar Singhal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-17 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides methods to calculate EMI, total interest, and total
+  payment amount for a given loan principal, interest rate, and tenure.
+email:
+- ravi.singhal2308@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- emi_calculator.gemspec
+- lib/emi_calculator.rb
+- lib/emi_calculator/calculator.rb
+- lib/emi_calculator/version.rb
+- sig/emi_calculator.rbs
+homepage: https://github.com/RaviShankarSinghal/emi_calculator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RaviShankarSinghal/emi_calculator
+  source_code_uri: https://github.com/RaviShankarSinghal/emi_calculator
+  changelog_uri: https://github.com/RaviShankarSinghal/emi_calculator/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: 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 simple Ruby gem to calculate loan EMI (Equated Monthly Installment).
+test_files: []