chirrin-chirrion 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51615f2cbc75d3a5f704e5eb80aac5c825316c52
-  data.tar.gz: e5d4a90d70fd0e6c187cf893d755a679461c97b0
+  metadata.gz: 8d34f28e02a066217d57127952a738c16a063633
+  data.tar.gz: 2e994e2b1944278d18d92d14d2b58b9eeec512ca
 SHA512:
-  metadata.gz: bab0c8e38c586f48566afa67cd4b59341f3096f92c859fbbf648587d115d6eba14582c92f29369137c40252c27037d0168d61221397119431e8408bebf473d0c
-  data.tar.gz: 1af39714ae15971d3c576d038365b427010f4baf6fac77b0f24c6aed7851a2ba74c57759519a386cad806a2d57fb6731e1ccf74846f1ae9a1ecd4ec3c8dbb8b0
+  metadata.gz: 4b24a43447ce15121881e6aaecaf294a4d984ebb07af6abb594825e50cbe4dc8ef2e8bc456d0a54417ffbfb2ceddc50ecde6a494695388099d6e357d61c79722
+  data.tar.gz: abc8efa436aa6f7e91a32fec113b2652a7e5aeb4ef6f974d53be90115ffe92bd2aa5b28eacc9bccb6af0038ab340744354b3e13324c3c694eb48f60bdd2c2d0b

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+All notable changes of the project you will find here.
+
+## [0.2.0] - 2015-03-30
+### Changed
+- Redis adaper inside of the module ChirrinChirrion::DatabaseAdapters
+- Redis adaper changed to manage togles inside a Hash.
+- Now is possible to define a description for the toggle, which can let other people know what this toggle does
+- Way to register toggles, but keep them inactives.
+
+## [0.1.0] - 2015-03-23
+### Changed
+- First release of the gem.
+- Simple way to add and remove toggles. Toggles in the Redis database are active, and are inactive if there is no toggle in the database.
+  methods to check if toggle is active, inactive or give procs to gem defines which proc will be executed when the toggle is active and inactive.

data/README.md

@@ -7,7 +7,7 @@ Where there is a magic object which the the key word 'chirrin' gives a new thing
 
 ## Intall
 
-   gem install chirrin-Chirrion
+   gem install chirrin-chirrion
 
 ## How to use
 
@@ -15,13 +15,14 @@ Where there is a magic object which the the key word 'chirrin' gives a new thing
 
 ```ruby
 require 'chirrin-chirrion'
-redis_adapter = RedisAdapter.new
+redis_connection = Redis.new
+redis_adapter    = RedisAdapter.new(redis_connection)
 ChirrinChirrion.config(database_adapter: redis_adapter)
 ```
 
 ### Adding a toggle
 ```ruby
-ChirrinChirrion.add_toggle('new_user_register_validation')
+ChirrinChirrion.add_toggle('new_user_register_validation', {active: true, description: 'When this is active, gender, age and phone number are not required'})
 ```
 
 ### Removing a toggle
@@ -29,6 +30,16 @@ ChirrinChirrion.add_toggle('new_user_register_validation')
 ChirrinChirrion.remove_toggle('new_user_register_validation')
 ```
 
+### Making a toggle active
+```ruby
+ChirrinChirrion.chirrin('new_user_register_validation')
+```
+
+### Making a toggle inactive
+```ruby
+ChirrinChirrion.chirrion('new_user_register_validation')
+```
+
 ### Using a toggle with if else
 ```ruby
 if ChirrinChirrion.chirrin?('new_user_register_validation')

data/chirrin-chirrion.gemspec

@@ -22,8 +22,12 @@ Gem::Specification.new do |spec|
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   end
 
+  #Development dependencies
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2.0'
   spec.add_development_dependency 'redis', '~> 3.2.1'
+  
+  #Runtime dependencies
+  spec.add_runtime_dependency 'json', '~> 1.8.2'
 end

data/lib/chirrin-chirrion.rb

@@ -1,31 +1,94 @@
-require "chirrin-chirrion/version"
-require "chirrin-chirrion/database_adapters/redis_adapter"
+require 'chirrin-chirrion/version'
+require 'chirrin-chirrion/errors'
+require 'chirrin-chirrion/database_adapters/redis_adapter'
+require 'json'
 
 module ChirrinChirrion
+
+  # Defines the configuration for Chirrin Chirrion.
+  # The config are:
+  #  - database_adapter, an adapter which wrap the database management to provide the correct service
+  #
+  # redis_connection = Redis.new
+  # redis_adapter    = RedisAdapter.new(redis_connection)
+  # ChirrinChirrion.config(database_adapter: redis_adapter)
+  #
   def self.config(options)
     @database_adapter = options[:database_adapter]
   end
 
+  # Private mehtod which returns the Chirrin Chirrion config
+  #
   def self.database_adapter
     @database_adapter
   end
 
-  def self.add_toggle(toggle_name)
-    database_adapter.add_toggle(toggle_name)
+  # Adds a toggle to the database
+  #
+  # ChirrinChirrion.add_toggle('my_active_feature')
+  # ChirrinChirrion.add_toggle('my_inactive_feature')
+  #
+  def self.add_toggle(toggle_name, toggle_info = {})
+    database_adapter.add_toggle(toggle_name, toggle_info)
   end
 
+  # Removes a toggle from the database
+  #
+  # ChirrinChirrion.remove_toggle('my_active_feature')
+  # ChirrinChirrion.remove_toggle('my_inactive_feature')
+  #
   def self.remove_toggle(toggle_name)
     database_adapter.remove_toggle(toggle_name)
   end
 
+  # Makes a toggle active (the toggle must already be registered)
+  #
+  # ChirrinChirrion.chirrin('my_inactive_feature')
+  # ChirrinChirrion.chirrin?('my_inactive_feature') #=> true
+  #
+  def self.chirrin(toggle_name)
+    database_adapter.activate(toggle_name)
+  end
+
+  # Makes a toggle inactive
+  #
+  # ChirrinChirrion.chirrion('my_active_feature')
+  # ChirrinChirrion.chirrion?('my_active_feature') #=> false
+  #
+  def self.chirrion(toggle_name)
+    database_adapter.inactivate(toggle_name)
+  end
+
+  # Checks if a toggle active (the toggle must already be registered)
+  #
+  # ChirrinChirrion.chirrin?('my_active_feature') #=> true
+  # ChirrinChirrion.chirrin?('my_inactive_feature') #=> false
+  # ChirrinChirrion.chirrin?('my_unregistered_toggle') #=> false
+  #
   def self.chirrin?(toggle_name)
-    database_adapter.exists?(toggle_name)
+    database_adapter.active?(toggle_name)
   end
 
+  # Checks if a toggle inactive
+  #
+  # ChirrinChirrion.chirrion?('my_active_feature') #=> false
+  # ChirrinChirrion.chirrion?('my_inactive_feature') #=> true
+  # ChirrinChirrion.chirrin?('my_unregistered_toggle') #=> true
+  #
   def self.chirrion?(toggle_name)
-    !chirrin?(toggle_name)
+    database_adapter.inactive?(toggle_name)
   end
 
+  # Executes determinated action if the toggle chirrin, if not executes another achtion
+  #
+  # ChirrinChirrion.chirrin('mult_for_2')
+  # ten_numbers            = (1..10).to_a
+  # actiction_for_chirrin  = lambda { ten_numbers.map{|number| number * 2 } }
+  # actiction_for_chirrion = lambda { ten_numbers.map{|number| number * 4 } }
+  # ChirrinChirrion.chirrin_chirrion('mult_for_2', action_for_chirrin, action_for_chirrion) #=> [4, 8, 12, 16, 20, 24, 28, 32, 36, 40]
+  # ChirrinChirrion.chirrin('mult_for_2')
+  # ChirrinChirrion.chirrin_chirrion('mult_for_2', action_for_chirrin, action_for_chirrion) #=> [2, 4, 6, 8, 10, 12, 14, 16, 18, 20]
+  #
   def self.chirrin_chirrion(toggle_name, for_chirrin, for_chirrion)
     if chirrin?(toggle_name)
       for_chirrin.respond_to?(:call) ? for_chirrin.call : for_chirrin

data/lib/chirrin-chirrion/database_adapters/redis_adapter.rb

@@ -1,20 +1,86 @@
-class RedisAdapter
-  attr_reader :redis_database
-  private :redis_database
+module ChirrinChirrion
+  module DatabaseAdapters
+    class RedisAdapter
+      TOGGLES_HASH_KEY = 'chirrin-chirrion-toggles'
+      attr_reader :redis_database
+      private :redis_database
 
-  def initialize(redis_database)
-    @redis_database = redis_database
-  end
+      def initialize(redis_database)
+        @redis_database = redis_database
+      end
 
-  def add_toggle(toggle_name)
-    redis_database.set(toggle_name, 't').eql?('OK')
-  end
+      # Adds a toggle to the database:
+      #
+      # redis_adapter.add_toggle('my_active_feature', {active: true, description: 'What other people must know to understand what this toggle activates'})
+      # redis_adapter.add_toggle('my_inactive_feature', {description: 'What other people must know to understand what this toggle activates'})
+      # redis_adapter.add_toggle('my_inactive_feature')
+      #
+      def add_toggle(toggle_name, toggle_info = {})
+        toggle_info[:active] ||= false
+        redis_database.hset(TOGGLES_HASH_KEY, toggle_name, toggle_info.to_json)
 
-  def remove_toggle(toggle_name)
-    redis_database.del(toggle_name).eql?(1)
-  end
+        true
+      end
+
+      # Removes a toggle from the database:
+      #
+      # redis_adapter.remove_toggle('my_active_feature')
+      # redis_adapter.remove_toggle('my_inactive_feature')
+      #
+      def remove_toggle(toggle_name)
+        redis_database.hdel(TOGGLES_HASH_KEY, toggle_name)
+
+        true
+      end
+
+      # Makes a toggle, existent or not, active:
+      #
+      # redis_adapter.activate('my_feature')
+      #
+      def activate(toggle_name)
+        toggle_info = get_toggle_info(toggle_name)
+        raise ChirrinChirrion::Errors::ToggleNotFound, "The toggle #{toggle_name} was not found" unless toggle_info
+        toggle_info['active'] = true
+
+        redis_database.hset(TOGGLES_HASH_KEY, toggle_name, toggle_info.to_json)
+
+        true
+      end
+
+      # Makes a toggle, existent or not, iactive:
+      #
+      # redis_adapter.inactivate('my_feature')
+      #
+      def inactivate(toggle_name)
+        toggle_info = get_toggle_info(toggle_name)
+        raise ChirrinChirrion::Errors::ToggleNotFound, "The toggle #{toggle_name} was not found" unless toggle_info
+        toggle_info['active'] = false
+
+        redis_database.hset(TOGGLES_HASH_KEY, toggle_name, toggle_info.to_json)
+
+        true
+      end
+
+      def active?(toggle_name)
+        toggle_info = redis_database.hget(TOGGLES_HASH_KEY, toggle_name)
+        return false unless toggle_info
+        toggle_info = JSON.parse(toggle_info)
+
+        toggle_info['active'].eql?(true)
+      end
+
+      def inactive?(toggle_name)
+        !active?(toggle_name)
+      end
+
+      private
+
+      def get_toggle_info(toggle_name)
+        toggle_info = redis_database.hget(TOGGLES_HASH_KEY, toggle_name)
+        return nil unless toggle_info
 
-  def exists?(toggle_name)
-    redis_database.get(toggle_name).eql?('t')
+        JSON.parse(toggle_info)
+      end
+    end
   end
 end

data/lib/chirrin-chirrion/errors.rb

@@ -0,0 +1,5 @@
+module ChirrinChirrion
+  module Errors
+    ToggleNotFound = Class.new(RuntimeError)
+  end
+end

data/lib/chirrin-chirrion/version.rb

@@ -1,3 +1,3 @@
 module ChirrinChirrion
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chirrin-chirrion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruno Vicenzo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 description: Chirrin for the new code apears, Chirrion for the new code desapears
   (by Chapolim)
 email:
@@ -77,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -86,6 +101,7 @@ files:
 - chirrin-chirrion.gemspec
 - lib/chirrin-chirrion.rb
 - lib/chirrin-chirrion/database_adapters/redis_adapter.rb
+- lib/chirrin-chirrion/errors.rb
 - lib/chirrin-chirrion/version.rb
 homepage: https://github.com/bvicenzo/chirrin-chirrion
 licenses: []