fflags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 761ad83c7a15d759b09cee085312dbaffcb4d36a
+  data.tar.gz: 4b06c0f98e93e2376258790e106384d28d21e3c9
+SHA512:
+  metadata.gz: a24e7f9cabe15f525c5bb48b50729805b591dadd6074b8ce94e21ef01fcd8cc48a97f37a96780aa347285f5b141ea5be30afd230da61a354daef2b735e1c38b0
+  data.tar.gz: '082425d96b4c805f7df4350768ab786506c4bd0a6cc1f5d175b0f3b2b1b4f044543cfbf30f6fd799d8f95ea705784de3a5bb613e05672c46f332bc3225b20241'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in FFlags.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    fflags (0.1.0)
+      redis (~> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (3.0.7)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fflags!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Faizal Zakaria
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# FFlags
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fflags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fflags
+
+## Usage
+
+```ruby
+require 'socket'
+
+FFlags.config do |config|
+  config.key   = Socket.gethostname
+  config.flags = { new_view: true }
+end
+```
+
+Then in the code,
+
+```ruby
+# Verify if the flag is enabled
+FFlags.enabled?(:new_view)
+
+# Overwrite flag
+FFlags.toggle(:new_view)
+# or
+FFlags.set_flag(:new_view, false)
+
+# To reset, and get back to the default settings.
+FFlags.reset
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/faizalzakaria/fflags.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/fflags.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fflags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fflags'
+  spec.version       = FFlags::VERSION
+  spec.authors       = ['Faizal Zakaria']
+  spec.email         = ['fai@code3.io']
+
+  spec.summary       = 'Feature flags that can be override per instance'
+  spec.description   = 'Feature flags that can be override per instance'
+  spec.homepage      = 'https://faizalzakaria.github.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'redis', '~> 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/FFlags/version.rb

@@ -0,0 +1,3 @@
+module FFlags
+  VERSION = '0.1.0'.freeze
+end

data/lib/fflags.rb

@@ -0,0 +1,44 @@
+require 'fflags/version'
+require 'fflags/configuration'
+require 'fflags/api'
+
+# FFlags module
+module FFlags
+  module_function
+
+  def config
+    yield configuration
+  end
+
+  def flags
+    api.flags
+  end
+
+  def enabled?(flag_name)
+    api.enabled?(flag_name)
+  end
+
+  def set_flag(flag_name, bool)
+    api.set_flag(flag_name, bool)
+  end
+
+  def get_flag(flag_name)
+    api.get_flag(flag_name)
+  end
+
+  def toggle_flag(flag_name)
+    api.toggle_flag(flag_name)
+  end
+
+  def reset
+    api.reset
+  end
+
+  def api
+    @api ||= Api.new
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/fflags/api.rb

@@ -0,0 +1,46 @@
+require './lib/fflags/redis_client'
+
+module FFlags
+  # Api Class
+  class Api
+    def flags
+      FFlags.configuration.flags
+    end
+
+    def enabled?(flag_name)
+      get_flag(flag_name) == true
+    end
+
+    def set_flag(flag_name, bool)
+      client.set(key, flag_name, bool)
+    end
+
+    def get_flag(flag_name)
+      value = client.get(key, flag_name)
+      value = flags.dig(flag_name.to_sym) if value.nil?
+      truthy?(value)
+    end
+
+    def toggle_flag(flag_name)
+      set_flag(flag_name, !get_flag(flag_name))
+    end
+
+    def reset
+      client.reset(FFlags.configuration.key)
+    end
+
+    private
+
+    def truthy?(value)
+      value == true || value == 'true'
+    end
+
+    def key
+      FFlags.configuration.key
+    end
+
+    def client
+      RedisClient
+    end
+  end
+end

data/lib/fflags/configuration.rb

@@ -0,0 +1,19 @@
+module FFlags
+  # Configuration Class
+  class Configuration
+    attr_accessor :key, :redis_url, :debug, :flags
+
+    def initialize
+      set_default_values
+    end
+
+    private
+
+    def set_default_values
+      @key       = 'code3.io'
+      @redis_url = 'redis://127.0.0.1:6379'
+      @debug     = false
+      @flags     = {}
+    end
+  end
+end

data/lib/fflags/redis_client.rb

@@ -0,0 +1,26 @@
+require 'redis'
+
+module FFlags
+  # Redis Client
+  class RedisClient
+    class << self
+      def set(key, field, value)
+        client.hmset(key, field, value) == 'OK'
+      end
+
+      def get(key, field)
+        client.hget(key, field)
+      end
+
+      def reset(key)
+        client.del(key)
+      end
+
+      private
+
+      def client
+        @client ||= Redis.new(url: FFlags.configuration.redis_url)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fflags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Faizal Zakaria
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Feature flags that can be override per instance
+email:
+- fai@code3.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- fflags.gemspec
+- lib/FFlags/version.rb
+- lib/fflags.rb
+- lib/fflags/api.rb
+- lib/fflags/configuration.rb
+- lib/fflags/redis_client.rb
+homepage: https://faizalzakaria.github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Feature flags that can be override per instance
+test_files: []