can-do 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cdc01b713da704aca92b3bf3f7479b3acab2910
+  data.tar.gz: 6f526ea285fd00623b423faeba9d8f66b2712578
+SHA512:
+  metadata.gz: f890889c4cb09d3a2da84256acc35a0747c42358691cd98304b27f38f72947ad12bb25578d9a6e9cd6743c241d5171f3d66ee0da8f9807532db2590715af89d1
+  data.tar.gz: 51e3b27b2b563bc03662fd6eab2b16bd02ef08c9b1fadecb0a4e393abd052a65b4e4ef39560cf7e4410f48dbd4f23eba6e15b32733b39f7b98aea2d211b9828f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Blacklane GmbH
+
+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,76 @@
+# CanDo
+
+Flips your features based on a `config/features.yml` file or environment variables. No data store required.
+
+## Usage
+
+Add `can-do` to your Gemfile:
+
+```ruby
+# Gemfile
+
+gem "can-do", require: "can_do"
+```
+
+Inside the `config` folder relative to your working directory create a file called `features.yml`. Within this file,
+place your *default feature flags* within the `defaults` key. All available features should be listed here, together with
+their default values. Add *environment-specific* feature flags under the environment name.
+
+```
+# config/features.yml
+
+defaults:
+  some_feature: false
+  other_feature: true
+development:
+  some_feature: true
+production:
+  other_feature: false
+```
+
+Check if a feature is enabled by calling `CanDo.feature?(:some_feature)`:
+
+```ruby
+require "can_do"
+
+CanDo.feature?(:some_feature)
+```
+
+Or by using a block:
+
+```ruby
+require "can_do"
+
+CanDo.feature?(:some_feature) do
+  # This block is only evaluated if some_feature is enabled
+end
+```
+
+If a feature is not found, `CanDo::NotAFeature` is raised.
+
+## Environment variables
+
+You can use environment variables to flip your features. Environment variables **always take precedence** over anything
+within your `config/features.yml` file.
+
+```sh
+> RAILS_ENV=development rails console
+CanDo.feature?(:some_feature) => false
+
+> SOME_FEATURE=true RAILS_ENV=development rails console
+CanDo.feature?(:some_feature) => true
+
+> SOME_FEATURE=true RAILS_ENV=development rails console
+CanDo.feature?(:some_feature) => true
+
+> OTHER_FEATURE=true RAILS_ENV=production rails console
+CanDo.feature?(:other_feature) => true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/blacklane/can_do/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/can_do.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "can-do"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Florin Lipan"]
+  spec.email         = ["florin.lipan@blacklane.com"]
+
+  spec.summary       = %q{Simple feature flags.}
+  spec.description   = %q{Simple feature flags based on a YAML config file and/or environment variables.}
+  spec.homepage      = "https://github.com/blacklane/can-do"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+end

data/lib/can_do.rb

@@ -0,0 +1,73 @@
+require "singleton"
+require "yaml"
+
+# Flips your features based on a config/features.yml file or environment variables.
+# Environment variables always take precedence over the settings in your YAML file.
+#
+# @example config/features.yml
+#   defaults:
+#     some_feature: false
+#     other_feature: true
+#   development:
+#     some_feature: true
+#
+# @example test if a feature should be enabled
+#   > RAILS_ENV=development rails console
+#   CanDo.feature?(:some_feature) # => false
+#
+# @example overwrite setting with environment variable
+#   > SOME_FEATURE=true RAILS_ENV=development rails console
+#   CanDo.feature?(:some_feature) # => true
+#
+# @example call with a block
+#   CanDo.feature?(:some_feature) do
+#     # this block get's called if some_feature is enabled
+#   end
+#
+class CanDo
+  include Singleton
+
+  NotAFeature = Class.new(StandardError)
+
+  THE_TRUTH = /^(true|t|yes|y|1)$/i
+  DEFAULT_NAMESPACE = "defaults".freeze
+
+  attr_reader :features
+
+  def self.features
+    instance.features
+  end
+
+  def self.feature?(name, &block)
+    name     = name.to_s
+    env_name = name.upcase
+
+    fail NotAFeature.new(name) unless features.key?(name)
+
+    is_enabled =
+      if ENV.key?(env_name)
+        !!(ENV[env_name] =~ THE_TRUTH)
+       else
+         features[name] == true
+       end
+
+    # If no block is passed, return true or false
+    return is_enabled unless block_given?
+
+    # If a block is passed, return block or nil
+    yield if is_enabled
+  end
+
+  private
+
+  def initialize
+    yaml = File.read(File.expand_path("config/features.yml", Dir.pwd))
+    data = YAML.load(yaml)
+
+    @features = (data.fetch(DEFAULT_NAMESPACE, {})).merge(data.fetch(env, {}))
+  end
+
+  def env
+    ENV["RAILS_ENV"] || ENV["RACK_ENV"]
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: can-do
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florin Lipan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: Simple feature flags based on a YAML config file and/or environment variables.
+email:
+- florin.lipan@blacklane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- can_do.gemspec
+- lib/can_do.rb
+homepage: https://github.com/blacklane/can-do
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple feature flags.
+test_files: []
+has_rdoc: