profitable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd833a8b05f27ea248099d3965e9d491a13f90c51c0ad29aa524384d6b92ddce
-  data.tar.gz: 3b57ba527cc3ac287688222be53415d16f9bdf2635b07496883e50da3671e77f
+  metadata.gz: bf77ba92fb941bb21624c1f677bbfff37d874fefa06050e1fe6b395ae55ea3e2
+  data.tar.gz: 8d4cf7614e186d7082692faa36794916111205293a45aac055565c2e7923a24b
 SHA512:
-  metadata.gz: daf28e6f4a6da261bb56fce23abb8a0a4f417d2c637eff0c1d696abcd19ebd7f123a283eddffbf66509ef9edf08f4e2ca4e0d9818c64ee9b2f7a188c7dafd2ca
-  data.tar.gz: 982180e6b08385d430a3a7576d9e474ff96d108d086aec428272ca2d2399489eb663837efe85f0b03fe830350cab72ab25e264d498951fed1f4cef72c6231ccf
+  metadata.gz: 73c2251e3d2566b1d22f7319d179f9d8f1077dd70354add0fb8718232f094f613fd4aef048a0accbba8214d5ac4911497d4c6704199cf17470be6ed5ad485e06
+  data.tar.gz: 30abc5f18398a6e1553effc66b59407f43610a90a01448dae90dab8eeb74198921593c3e6cb8bea9b63cce14f9435eccb69a53c1d71912b9214392b3e7375e20

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # `profitable`
 
+## [0.2.1] - 2024-08-31
+
+- Add syntactic sugar for `estimated_valuation(at: "3x")`
+- Now `estimated_valuation` also supports `Numeric`-only inputs like `estimated_valuation(3)`, so that @pretzelhands can avoid writing 3 extra characters and we embrace actual syntactic sugar instead of "syntactic saccharine" (sic.)
+
 ## [0.2.0] - 2024-08-31
 
 - Initial production ready release

data/README.md

@@ -59,7 +59,7 @@ All methods return numbers that can be converted to a nicely-formatted, human-re
 - `Profitable.churned_mrr(in_the_last: 30.days)`: MRR lost due to churn in the specified period
 - `Profitable.average_revenue_per_customer`: Average revenue per customer (ARPC)
 - `Profitable.lifetime_value`: Estimated customer lifetime value (LTV)
-- `Profitable.estimated_valuation(multiplier = "3x")`: Estimated company valuation based on ARR
+- `Profitable.estimated_valuation(at: "3x")`: Estimated company valuation based on ARR
 
 ### Customer metrics
 
@@ -101,7 +101,10 @@ Profitable.churn(in_the_last: 3.months).to_readable # => "12%"
 Profitable.new_mrr(in_the_last: 24.hours).to_readable(2) # => "$123.45"
 
 # Get the estimated valuation at 5x ARR
-Profitable.estimated_valuation("5x").to_readable # => "$500,000"
+Profitable.estimated_valuation(at: "5x").to_readable # => "$500,000"
+
+# You can also pass the multiplier as a number, and/or ignore the "at:" keyword altogether
+Profitable.estimated_valuation(4.5).to_readable # => "$450,000"
 
 # Get the time to next MRR milestone
 Profitable.time_to_next_mrr_milestone.to_readable  # => "26 days left to $10,000 MRR"
@@ -128,24 +131,6 @@ Profitable.mrr # => 123456
 - `mrr_growth_rate`: This calculation compares the MRR at the start and end of the specified period. It assumes a linear growth rate over the period, which may not reflect short-term fluctuations. For more accurate results, consider using shorter periods or implementing a more sophisticated growth calculation method if needed.
 - `time_to_next_mrr_milestone`: This estimation is based on the current MRR and the recent growth rate. It assumes a constant growth rate, which may not reflect real-world conditions. The calculation may be inaccurate for very new businesses or those with irregular growth patterns.
 
-## Mount the `/profitable` dashboard
-
-We also provide a simple dashboard with good defaults to see your main business metrics.
-
-In your `config/routes.rb` file, mount the `profitable` engine:
-```ruby
-mount Profitable::Engine => '/profitable'
-```
-
-It's a good idea to make sure you're adding some sort of authentication to the `/profitable` route to avoid exposing sensitive information:
-```ruby
-authenticate :user, ->(user) { user.admin? } do
-  mount Profitable::Engine => '/profitable'
-end
-```
-
-You can now navigate to `/profitable` to see your app's business metrics like MRR, ARR, churn, etc.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/profitable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Profitable
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/profitable.rb

@@ -46,8 +46,9 @@ module Profitable
       NumericResult.new(calculate_recurring_revenue_percentage(in_the_last), :percentage)
     end
 
-    def estimated_valuation(multiplier = "3x")
-      NumericResult.new(calculate_estimated_valuation(multiplier))
+    def estimated_valuation(multiplier = 3, at: nil)
+      actual_multiplier = at || multiplier
+      NumericResult.new(calculate_estimated_valuation(actual_multiplier))
     end
 
     def total_customers
@@ -127,11 +128,26 @@ module Profitable
       (mrr.to_f * 12).round
     end
 
-    def calculate_estimated_valuation(multiplier = "3x")
-      multiplier = multiplier.to_s.gsub('x', '').to_f
+    def calculate_estimated_valuation(multiplier = 3)
+      multiplier = parse_multiplier(multiplier)
       (calculate_arr * multiplier).round
     end
 
+    def parse_multiplier(input)
+      case input
+      when Numeric
+        input.to_f
+      when String
+        if input.end_with?('x')
+          input.chomp('x').to_f
+        else
+          input.to_f
+        end
+      else
+        3.0 # Default multiplier if input is invalid
+      end.clamp(0.1, 100) # Ensure multiplier is within a reasonable range
+    end
+
     def calculate_churn(period = DEFAULT_PERIOD)
       start_date = period.ago
       total_subscribers_start = Pay::Subscription.active.where('created_at < ?', start_date).distinct.count('customer_id')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: profitable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - rameerez