simple_toggle 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4f76487f261fb67eeddd262b27b04e5597f7008
-  data.tar.gz: 57389c4ae6e41d977c88d0279f2c5f1388ce12ec
+  metadata.gz: 8c0fcd9bb34ba840541ae2ffd182a71b5e93591f
+  data.tar.gz: 62c0d69e57343f133edd62392d4518691e2c78b6
 SHA512:
-  metadata.gz: 4d7051867b0471a28ee30157c3f907e58629dc45b65c1a7625829aaf0dac64b2adc1320078f748fe579677f3a25b2949a6703ce1909252df3dc53f0032c366f6
-  data.tar.gz: 0479f06b0375ac5f2b78958c72e4175cb1e9d0f35e50cab912998f63d6d123a2758eb574425a10231440a53c56ae3ab86d4d481388991975ca695313cd366eb0
+  metadata.gz: 718feee2d61a37e296c4bcbc741e350f3a5cfda9009b5d3d2b06010587bbd454c0e117a84fda73ec9f14bb28dec1aa0a1d0dd669cb12bf92b711239ecb5f8f07
+  data.tar.gz: b8321cb29809d3d2b3ccde9904bb235e2feab33c366097a9e51a5815cb85353d084afea25b0b9ba219ab6a31d0ce7ce2ad9f255e94f2ae732e8f3c16073d7717

data/README.md

@@ -1,5 +1,5 @@
-# FeatureFlag
-
+# SimpleToggle
+    
 TODO: Write a gem description
 
 ## Installation

data/lib/simple_toggle.rb

@@ -1,21 +1,63 @@
-require "rails"
-require "simple_toggle/version"
+require 'rails'
+require 'simple_toggle/version'
 require 'active_record'
 
 module SimpleToggle
+
+  # SimpleToggle raises +SimpleToggleError+
+  class SimpleToggleError < StandardError; end
+
+  # SimpleToggle - A simple framework for feature toggles.
+  #
+  # SimpleToggle provides feature toggle function that allow a developer to enable or disable
+  # code in an environment without deploying code. This decouples the deployment of the code
+  # from the delivery of the feature.
+  #
+  # A toggle is a simple ActiveRecord model that can be created, modified, or destroyed
+  # like any other. The toggle will grant access to blocks of code if the given record
+  # exists and is active.
+  #
+  # ==== Create a toggle
+  #
+  #   SimpleToggle::Toggle.create name: :active_feature, active: true
+  #
   class Toggle < ActiveRecord::Base
     self.table_name = 'simple_toggle_toggles'
 
+    # Execute the given block if the given +feature+ exists and #active? returns true.
+    #
+    #   SimpleToggle::Toggle.when_active(:active_feature) { puts 'feature is active' }
+    #     # feature is active
+    #     # => nil
+    #   SimpleToggle::Toggle.when_active(:inactive_feature) { puts 'feature is active' }
+    #     # => nil
+    #   SimpleToggle::Toggle.when_active(:missing_feature) { puts 'feature is active' }
+    #     # => nil
+    #
     def self.when_active(feature)
       yield if Toggle.active?(feature)
     end
 
+    # Raises an exception if +feature+ does not exist.
+    #
+    #   SimpleToggle::Toggle.require(:missing_feature)
+    #     # raises SimpleToggle::SimpleToggleError
     def self.require(feature)
-      raise unless Toggle.active?(feature)
+      raise SimpleToggle::ToggleError.new('Feature does not exist') unless Toggle.active?(feature)
     end
 
+    # Checks whether a given `feature` is active. To be considered active, a
+    # toggle must be both present and active.
+    #
+    #
+    #   SimpleToggle::Toggle.active?(:active_feature)
+    #     # => true
+    #   SimpleToggle::Toggle.active?(:inactive_feature)
+    #     # => false
+    #   SimpleToggle::Toggle.active?(:missing_feature)
+    #     # => false
     def self.active?(feature)
-      toggle = Toggle.where(name: feature, active: true).first
+      !!Toggle.where(name: feature, active: true).first
     end
   end
 

data/lib/simple_toggle/version.rb

@@ -1,3 +1,3 @@
 module SimpleToggle
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_toggle
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Trevor Oke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -113,11 +113,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple ActivceRecord based feature toggle for ruby/rails.
 test_files:
 - spec/lib/simple_toggle_spec.rb
 - spec/spec_helper.rb
-has_rdoc: