plan_features 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f6d3f70ba4ccec42364f9cd047fc528fd65359f672a8d4ab432814db65d6130
-  data.tar.gz: 9de014c4f152137a0263ad2287916f2d53579c5b1d0d1fb23bb177b5b3277186
+  metadata.gz: 500cb4693e7ccbe5af5b6ac882c5e0ef6e26a954be886c50727fe321df182e8b
+  data.tar.gz: f79ec09d1598fc35f9ad7bc2cf24a69ae6f743c6f2b64f64f14e8676e43473d6
 SHA512:
-  metadata.gz: 5d8b556b708ff38f4604742a2ba679e4569a373211d9b772fc43d991b3f009eb68bf8becbde16dfc2b8b677224298345b12ffaa0644306110e620c77300d632a
-  data.tar.gz: d40d30f4b668650bf7bb5effa19096292fb7adf1c8d64e4f1be5a3780b4467310c2fc8b920b4d5abe2a9e35503cad3ede1a2cbdc0b7a401e0cc1383d9f01d8b2
+  metadata.gz: 50a50907f7408157ebf2a1a6fbc0e75223294b8b3795ad6eb61c28236da9cd2dda6f1766e852ea9c894c2f37433fc12d72f33d077e9a1b506466ea81c0462bfd
+  data.tar.gz: 4bd1b29a1a5701738e08f547736fa3d8dc22f57652c978aaa5ce796910f83f7abf0ca0e627e34287cc4fecb394f47f8a959d1cddcb74877edd88931bec2ece5b

data/README.md

@@ -1,10 +1,118 @@
 # PlanFeatures
-Short description and motivation.
+
+This is a gem for Rails to help you with which features are available for which plans in your paid app.
+
+The idea is that you have a set of plans and each plan has a set of features. We want an easy way to list all available
+plans and their features and we want the ability to inherit features from previous plans. Let's say you have a Free plan
+with Feature A and Feature B. When you upgrade to the Paid plan which gives you Feature C and Feature D we still want the
+checks for Feature A and Feature B to return true.
 
 ## Usage
-How to use my plugin.
+
+Create a new file `config/plans.yml` or whatever and create a new initializer `config/initializers/plan_features.rb` with:
+
+```
+PlanFeatures.configure do |config|
+  config.plans_file_path = Rails.root.join("config", "plans.yml")
+end
+```
+
+## Plan configuration
+
+Your `plans.yml` could look something like this:
+
+```
+free:
+  name: "Free"
+  features:
+    feature_a:
+      description: "Feature A"
+    feature_b:
+      description: "Feature B"
+
+paid:
+  name: "Paid"
+  features:
+    feature_c:
+      description: "Feature C"
+    feature_d:
+      description: "Feature D"
+  prices:
+    monthly:
+      product: STRIPE_ID
+      amount: 500
+```
+
+This sets up two plans where the `free` plan has the features A and B and the paid plan has the features C and D.
+
+## Feature inheritance from previous plans
+
+We wouldn't want the paid user to lose access to the features from the Free plan. So let's go ahead and set the previous plan
+on the `paid` plan definition to `free`:
+
+```
+  paid:
+    name: "Paid"
+    previous: free
+  features:
+    # features from the above example
+```
+
+Now it'll inherit the features defined in the Free plan.
+
+We can check if a feature is available in our code:
+
+```
+plan = PricingFeatures::Pricing.find_by_identifier(:paid)
+plan.has_feature?(:feature_c)
+# => true
+```
+
+## Features with limits
+
+Sometimes features aren't just boolean features. You might be able to create "posts", but on the free plan you can only create 2, but on the paid plan you can create let's say 50. We can define that like so:
+
+```
+free:
+  name: "Free"
+  features:
+    posts:
+      description: "2 posts"
+      limit: 2
+
+paid:
+  name: "Paid"
+  features:
+    posts:
+      description: "50 posts"
+      limit: 50
+```
+
+In your code you can check for the limit of a feature with:
+
+```
+free_plan = PlanFeatures::Pricing.find_by_identifier(:free)
+free_plan.limit_for(:posts)
+# => 2
+
+paid_plan = PlanFeatures::Pricing.find_by_identifier(:paid)
+paid_plan.limit_for(:posts)
+# => 50
+```
+
+### Metadata
+
+You can add metadata to a plan by using the `metadata` key. Example:
+
+```
+paid:
+  name: "Paid"
+  metadata:
+    popular: true
+```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +120,21 @@ gem "plan_features"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install plan_features
 ```
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/plan_features/feature.rb

@@ -2,7 +2,7 @@ module PricingFeatures
   class Feature
     include ActiveModel::Model
 
-    attr_accessor :description, :amount, :hidden
+    attr_accessor :identifier, :description, :limit, :hidden
 
     alias_method :hidden?, :hidden
   end

data/lib/plan_features/pricing.rb

@@ -2,16 +2,14 @@ require_relative "feature"
 
 module PlanFeatures
   class Pricing
-    attr_accessor :name, :plan_identifier, :interval, :stripe_id, :features, :prices, :previous, :popular
+    attr_accessor :name, :plan_identifier, :interval, :stripe_id, :features, :prices, :previous, :metadata
 
     include ActiveModel::Model
 
     def self.boosts
-     @boosts ||= begin
-      if File.exist?(Rails.root.join("config", "account_boosts.yml"))
+      @boosts ||= if File.exist?(Rails.root.join("config", "account_boosts.yml"))
         YAML.load_file(Rails.root.join("config", "account_boosts.yml"))
       end
-     end
     end
 
     def self.find_by_identifier(id)
@@ -31,11 +29,11 @@ module PlanFeatures
       @all_plans ||= YAML.load_file(::PlanFeatures.configuration.plans_file_path).map do |plan, attributes|
         Pricing.new(
           plan_identifier: plan,
-          popular: attributes["popular"],
           name: attributes["name"],
           features: attributes["features"],
           prices: attributes["prices"],
-          previous: attributes["previous"]
+          previous: attributes["previous"],
+          metadata: attributes["metadata"]&.with_indifferent_access,
         )
       end
     end
@@ -64,8 +62,8 @@ module PlanFeatures
       end
     end
 
-    def amount_for(feature)
-      features.dig(feature.to_s, "amount")
+    def limit_for(feature)
+      features.dig(feature.to_s, "limit")
     end
 
     def free?
@@ -76,27 +74,11 @@ module PlanFeatures
       prices&.any?
     end
 
-    def pricing_id(interval = "monthly")
-      if interval == "monthly"
-        monthly_pricing_id
-      else
-        yearly_pricing_id
-      end
-    end
-
     def pricing_id(name: :monthly)
       return nil if prices.nil?
       prices[name.to_s]["product"]
     end
 
-    def monthly_pricing_id
-      pricing_id(name: :monthly)
-    end
-
-    def yearly_pricing_id
-      pricing_id(name: :yearly)
-    end
-
     def price(name: :monthly)
       return nil if prices.nil?
       prices[name.to_s]["amount"] / 100
@@ -110,11 +92,12 @@ module PlanFeatures
     def display_features
       features.map do |identifier, attributes|
         PricingFeatures::Feature.new(
+          identifier: identifier,
           description: attributes["description"],
-          amount: attributes["amount"],
-          hidden: attributes["hidden"],
+          limit: attributes["limit"],
+          hidden: attributes["hidden"]
         )
-      end.compact.filter{|f| !f.hidden? }
+      end.compact.filter { |f| !f.hidden? }
     end
   end
 end

data/lib/plan_features/version.rb

@@ -1,3 +1,3 @@
 module PlanFeatures
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_features
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jesper Christiansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails