planify 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 895a08ebad3001a3d2f93ac311c480fa4737c9d2
+  data.tar.gz: defff6ce05ca94f201d38ff14cb8c48401ded5ec
+SHA512:
+  metadata.gz: c33faa819fc593900eda98752c7531f4db1cfb2de3cef927c46af771a0910f6ce24f517e1a1ebf7d33ca5fc7f1fc286492d77487577f81e5b3d5db85aca0740c
+  data.tar.gz: be9e24e3f82f37c9ae085ae6c1b5eec7e65d205d72936e499d3c585038dd36c59361c26fbad2464c839e73fd14e45ef2fae991e45228a66306a3787875c13bfa

data/Gemfile

@@ -1,7 +1,9 @@
 source "https://rubygems.org"
 gemspec
 
-gem "rake"
+group :development, :test do
+  gem "rake"
+end
 
 group :test do
   gem "rspec", "~> 2.14"

data/README.md

@@ -1,4 +1,4 @@
-Planify [![Build Status](https://secure.travis-ci.org/maildropr/planify.png?branch=master)](http://travis-ci.org/maildropr/planify) [![Code Climate](https://codeclimate.com/github/maildropr/planify.png)](https://codeclimate.com/github/maildropr/planify) [![Coverage Status](https://coveralls.io/repos/maildropr/planify/badge.png)](https://coveralls.io/r/maildropr/planify)
+Planify [![Build Status](https://secure.travis-ci.org/maildropr/planify.png?branch=master)](http://travis-ci.org/maildropr/planify) [![Code Climate](https://codeclimate.com/github/maildropr/planify.png)](https://codeclimate.com/github/maildropr/planify) [![Coverage Status](https://coveralls.io/repos/maildropr/planify/badge.png)](https://coveralls.io/r/maildropr/planify) [![Gem Version](https://badge.fury.io/rb/planify.png)](http://badge.fury.io/rb/planify)
 ========
 
 Make subscription plans and enforce their limits with Planify.
@@ -47,9 +47,16 @@ Plans hold information about how many instances of a `Limitable` can be created,
 ```ruby
 # config/initializers/plans.rb
 Planify::Plans.define :starter do
+  price 5.00 # Costs 5 dollars
+  description "The perfect plan to get you started"
+
   max Widget, 100 # Can only create up to 100 widgets before needing to upgrade
 
-  feature :ajax_search
+  feature :ajax_search # This plan supports ajax search
+  enable_feature :live_reload # And live reloading
+
+  disable_feature :guest_account # But no guest accounts
+  feature :support_tickets, false # And no support tickets
 end
 ```
 
@@ -77,7 +84,7 @@ You can also assign user-specific overrides to plan limits and features:
 # This user has half the widgets and no ajax-search
 @user.has_plan :starter do
   max Widget, 50
-  feature :ajax_search, false
+  disable_feature :ajax_search
 end
 ```
 
@@ -90,10 +97,9 @@ After creating your Limitables, Plans, and User, you are ready to start enforcin
 
 def create
   @user = current_user
-  @widget = Widget.create(params[:widget])
 
-  if @user.can_create? @widget # User has not hit their Widget cap
-    @widget.save
+  if @user.can_create? Widget # User has not hit their Widget cap
+    @widget = Widget.create(params[:widget])
     @user.created :widget
   end
 end

data/lib/planify/plan.rb

@@ -24,10 +24,25 @@ module Planify
       @limits.get(limitable)
     end
 
+    # Defines a feature of this plan
+    # @param [String,Symbol] feature_name The name of the feature
+    # @param [Boolean] enabled Sets availability of the feature for this plan
     def feature(feature_name, enabled = true) 
       @features[feature_name.to_sym] = enabled
     end
 
+    # Enables a feature on this plan.
+    # @param [String,Symbol] feature_name The name of the feature to enable
+    def enable_feature(feature_name)
+      feature(feature_name, true)
+    end
+
+    # Disables a feature on this plan.
+    # @param [String,Symbol] feature_name The name of the feature to disable
+    def disable_feature(feature_name)
+      feature(feature_name, false)
+    end
+
     # Boolean method for determining if a certain feature is enabled in this plan
     # @param [String,Symbol] feature the feature to check
     # @return [Boolean] +true+ if +feature+ is enabled, +false+ if +feature+ is disabled or undefined.
@@ -42,6 +57,28 @@ module Planify
       !feature_enabled?(feature)
     end
 
+    # Sets or returns the price of this plan.
+    # When called without arguments, it returns the price.
+    # When called with arguments, the price is set to the first argument provided.
+    def price(*args)
+      unless args.empty?
+        @price = args.first
+      end
+      
+      @price ||= 0.00
+    end
+
+    # Sets or returns the description of this plan
+    # When called without arguments, it returns the description
+    # When called with arguments, the description is set to the first argument provided.
+    def description(*args)
+      unless args.empty?
+        @description = args.first
+      end
+
+      @description ||= nil
+    end
+
     # Returns a duplicate instance of this plan
     # @return [Planify::Plan] an exact copy of this plan
     def dup

data/lib/planify/plans.rb

@@ -3,6 +3,9 @@ module Planify
 
     @plans = ActiveSupport::HashWithIndifferentAccess.new
 
+    # Defines a new plan, evaluating the given block on the new plan instance.
+    # @param [String, Symbol] name The name of the plan
+    # @return [Planify::Plan] the new plan
     def self.define(name, &block)
       plan = Plan.new
       plan.instance_eval(&block) if block_given?
@@ -10,6 +13,10 @@ module Planify
       @plans[name] = plan
     end
 
+    # Gets a plan by name
+    # @param [String,Symbol] name The name of the plan
+    # @return [Planify::Plan] the plan represented by +name+
+    # @raise [ArgumentError] if a plan named +name+ is not defined
     def self.get(name)
       begin
         @plans.fetch(name)
@@ -18,10 +25,13 @@ module Planify
       end
     end
 
+    # Returns the list of plans
+    # @return [Array] an array of Planify::Plan instances
     def self.all
       @plans
     end
 
+    # Removes all currently defined plans
     def self.clear
       @plans.clear
     end

data/lib/planify/user.rb

@@ -19,12 +19,9 @@ module Planify
       plan_info = PlanInfo.new(name: plan_name)
 
       if block_given?
-        plan = plan.dup
         configuration = Planify::Plan.new
         configuration.instance_eval &block
 
-        plan.merge! configuration
-
         plan_info.limit_overrides = configuration.limits.all
         plan_info.feature_overrides = configuration.features
       end

data/lib/planify/version.rb

@@ -1,3 +1,3 @@
 module Planify
-  VERSION = [1, 0, 0].join(".")
+  VERSION = [1, 0, 1].join(".")
 end

data/spec/planify/integrations/rails_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+require "planify/integrations/rails"
+
+METHODS = [
+  :enforce_limit!,
+  :limit_exceeded!
+]
+
+module ActionController
+  class Base
+    def self.helper(*args); end
+  end
+end
+
+describe Planify::Integrations::Rails do
+  subject { ActionController::Base.send(:include, Planify::Integrations::Rails) }
+
+  describe ".included" do
+    it "it adds controller methods to ActionController::Base" do
+      METHODS.each do |method|
+        subject.should respond_to method
+      end
+    end
+  end
+
+  describe ".enforce_limit!" do
+    let(:user) { User.new }
+    before do
+      Planify::Plans.define :starter do
+        max Post, 1
+      end
+
+      user.has_plan :starter
+    end
+
+    context "user is over their quota" do
+      before { user.created Post }
+
+      it "calls limit_exceeded!" do
+        subject.should_receive(:limit_exceeded!)
+        subject.enforce_limit! user, Post
+      end
+    end
+
+    context "user is under their quota" do
+      it "returns nil" do
+        subject.should_not_receive(:limit_exceeded!)
+        subject.enforce_limit!(user, Post).should be_nil
+      end
+    end
+  end
+
+  describe ".limit_exceeded!" do
+    it "raises exception" do
+      expect { subject.limit_exceeded! }.to raise_error
+    end
+  end
+
+end

data/spec/planify/plan_spec.rb

@@ -34,6 +34,20 @@ describe Planify::Plan do
     end
   end
 
+  describe ".enable_feature" do
+    it "enables the named feature" do
+      subject.enable_feature(:live_reload)
+      subject.feature_enabled?(:live_reload).should be_true
+    end
+  end
+
+  describe ".disable_feature" do
+    it "disables the named feature" do
+      subject.disable_feature(:live_reload)
+      subject.feature_enabled?(:live_reload).should be_false
+    end
+  end
+
   describe ".feature_enabled?" do
     before { subject.feature(:ajax_search) }
 
@@ -82,6 +96,55 @@ describe Planify::Plan do
     end
   end
 
+
+  describe ".price" do
+    context "with arguments" do
+      it "sets the current price" do
+        subject.price(10.00)
+
+        subject.price.should == 10.00
+      end
+    end
+
+    context "without arguments" do
+      before { subject.price(15.00) }
+
+      it "returns the current price" do
+        subject.price.should == 15.00
+      end
+    end
+
+    context "when no price is set" do
+      it "returns zero" do
+        Planify::Plan.new.price.should == 0.00
+      end
+    end
+  end
+
+  describe ".description" do
+    context "with arguments" do
+      it "sets the plan description" do
+        subject.description "The best plan ever!"
+
+        subject.description.should == "The best plan ever!"
+      end
+    end
+
+    context "without arguments" do
+      before { subject.description("Plan Description") }
+
+      it "returns the plan description" do
+        subject.description.should == "Plan Description"
+      end
+    end
+
+    context "when no description is set" do
+      it "returns nil" do
+        Planify::Plan.new.description.should be_nil
+      end
+    end
+  end
+
   describe ".merge!" do
 
     let(:pro_plan) do

data/spec/planify/plans_spec.rb

@@ -46,6 +46,19 @@ describe Planify::Plans do
     end
   end
 
+  describe ".all" do
+    before { Planify::Plans.clear }
+
+    it "returns all defined plans" do
+      Planify::Plans.all.should be_empty
+      
+      Planify::Plans.define :plan1
+      Planify::Plans.define :plan2
+
+      Planify::Plans.all.size.should == 2
+    end
+  end
+
   describe ".clear" do
     before { Planify::Plans.define :starter }
 

data/spec/planify/util/class_helper_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Planify::ClassHelper do
+  subject { Object.new.extend(Planify::ClassHelper) }
+
+  describe ".normalize_class" do
+    context "with a class constant" do
+      it "returns a string representation" do
+        subject.normalize_class(Post).should == "Post"
+      end
+    end
+
+    context "with a class instance" do
+      it "returns a string representation of the instance's class" do
+        subject.normalize_class(Post.new).should == "Post"
+      end
+    end
+
+    context "with a module" do
+      it "returns a string representation of the module's name" do
+        module Foo; end
+        subject.normalize_class(Foo).should == "Foo"
+      end
+    end
+
+    context "with a string" do
+      context "string represents a constant name" do
+        it "returns itself" do
+          subject.normalize_class("Post").should == "Post"
+        end
+      end
+
+      context "string does not represent a constant name" do
+        it "raises NameError" do
+          expect { subject.normalize_class("Not::ARealClass") }.to raise_exception(NameError)
+        end
+      end
+    end
+
+    context "with a symbol" do
+      context "symbol represents a constant name" do
+        it "returns a string representation of the symbol" do
+          subject.normalize_class(:post).should == "Post"
+        end
+      end
+
+      context "symbol does not represent a constant name" do
+        it "raises NameError" do
+          expect { subject.normalize_class(:not_a_class) }.to raise_exception(NameError)
+        end
+      end
+    end
+
+
+  end
+end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: planify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Kyle Dayton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Mongoid plugin for managing subscription plans and features
@@ -72,51 +67,48 @@ files:
 - spec/config/mongoid.yml
 - spec/models/post.rb
 - spec/models/user.rb
+- spec/planify/integrations/rails_spec.rb
 - spec/planify/limitations_spec.rb
 - spec/planify/plan_overrides_spec.rb
 - spec/planify/plan_spec.rb
 - spec/planify/plans_spec.rb
 - spec/planify/user/plan_info_spec.rb
 - spec/planify/user_spec.rb
+- spec/planify/util/class_helper_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kdayton-/planify
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 654973981249883969
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 654973981249883969
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Mongoid plugin for managing subscription plans and features
 test_files:
 - spec/config/mongoid.yml
 - spec/models/post.rb
 - spec/models/user.rb
+- spec/planify/integrations/rails_spec.rb
 - spec/planify/limitations_spec.rb
 - spec/planify/plan_overrides_spec.rb
 - spec/planify/plan_spec.rb
 - spec/planify/plans_spec.rb
 - spec/planify/user/plan_info_spec.rb
 - spec/planify/user_spec.rb
+- spec/planify/util/class_helper_spec.rb
 - spec/spec_helper.rb