safeword 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 744d30f815ed87f46a56511eea26c89f36a71d83
-  data.tar.gz: d8aab455c16f68cd2f0b563c782d814b09a09db6
+  metadata.gz: fdcc5aab7e93a02b4b28b779825285981514916d
+  data.tar.gz: 375d1ffacd53c00444905b906832537f0fd0894c
 SHA512:
-  metadata.gz: 19d44c5fb2d7ba942ded9f277d9cd3879000f9a75f45c0e04e2d6b4de01bfc3d75e5e46432c0a349f190957756d1b5786dfd88fe983f701f2f8b939fbf8d4008
-  data.tar.gz: 972b5aa3e02ccb38b1b429b15e92234aa4c6e28e2838807092b4a14b4a78b76bb3ac1ea8ac4e1448a342a3e4a0e1382faff0867b9ac97903bad04b72f7adea2d
+  metadata.gz: ac38a9a168cb32e396c93bea87e9b0f93265c8b259c6d0e67e445fef44f18d8aaf45a334acc4b42facd0e1b2ed089c812cd76bdeaf7b0a3b18bf723bc2bf47d0
+  data.tar.gz: de96362b1ea67321be8c3d7a4a922efe6c217dc36e008114d3d99d7779d8a65c9d032ca410c9f8755321d0a081d992774383c3dd2bbc13413104332d1dbf9ab1

data/README.md

@@ -40,7 +40,7 @@ safeword.enable
 safeword.enabled? # => true
 ```
 
-### Preventing code from running
+### Preventing code execution
 
 Instantiate a `Safeword` and pass your wrapped code in a block to its `use` method.
 
@@ -49,10 +49,32 @@ require 'safeword'
 
 safeword = Safeword.new
 safeword.use { puts 'start war' } #=> nothing happens
+```
+
+### Allowing code execution
+Call `#disable` on the safeword to allow subsequent calls to `use` to execute the provided code blocks:
+
+```ruby
+require 'safeword'
+
+safeword = Safeword.new
 safeword.disable
 safeword.use { puts 'drop bomb' } #=> drop bomb
 ```
 
+### Instantiating a disabled safeword
+Safewords are enabled by default, but can be disabled during initialization:
+
+```ruby
+require 'safeword'
+
+safe = Safeword.new
+safe.enabled? #=> true
+
+unsafe = Safeword.new(enabled: false)
+unsafe.enabled? #=> false
+```
+
 ### Chaining methods
 
 The methods `enable`, `disable` and `use` return the word itself, so you can chain multiple calls together:

data/lib/safeword.rb

@@ -4,7 +4,7 @@ require 'safeword/blocker'
 # Encapsulates the logic of the gem.
 module Safeword
   # Instantiates a +Blocker+.
-  def self.new
-    Blocker.new
+  def self.new(enabled: true)
+    Blocker.new(enabled: enabled)
   end
 end

data/lib/safeword/blocker.rb

@@ -1,29 +1,62 @@
 module Safeword
   # Decides whether blocks of code are executed or not.
   class Blocker
+    #
     # Instantiates an enabled blocker.
-    def initialize
-      @enabled = true
+    #
+    # @param [Boolean] enabled Whether the blocker is enabled or not.
+    def initialize(enabled: true)
+      @enabled = enabled
     end
 
     # Whether the blocker is enabled or not. Enabled blockers prevent blocks of code from being executed.
+    #
+    # @example Verifying if a blocker is enabled
+    #   blocker.enable
+    #   blocker.enabled? #=> true
+    #   blocker.disable
+    #   blocker.enabled? #=> false
+    #
+    # @return +true+ if the blocker is enabled, +false+ otherwise.
     def enabled?
       @enabled
     end
 
     # Enables the blocker, preventing blocks of code from being executed.
+    #
+    # @example Enabling a blocker
+    #   blocker.enable
+    #   blocker.use { puts 'I wont be executed' } #=> nothing happens
+    #
+    # @return +self+
     def enable
       @enabled = true
       self
     end
 
     # Disables the blocker, allowing blocks of code to be executed.
+    #
+    # @example Disabling a blocker
+    #   blocker.disable
+    #   blocker.use { puts 'I will be executed' } #=> I will be executed
+    #
+    # @return +self+
     def disable
       @enabled = false
       self
     end
 
     # Ignores the provided block of code if enabled. Executes it otherwise.
+    #
+    # @example Ignoring a block of code when enabled
+    #   blocker.enable
+    #   blocker.use { puts 'I wont be executed' } #=> nothing happens
+    #
+    # @example Executing a block of code when disabled
+    #   blocker.disable
+    #   blocker.use { puts 'I will be executed' } #=> I will be executed
+    #
+    # @return +self+
     def use
       yield unless enabled?
       self

data/lib/safeword/version.rb

@@ -1,3 +1,3 @@
 module Safeword
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safeword
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler