flagship 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9f85fb317ee229493f115ec7c65647e75660a0f
-  data.tar.gz: 449021917bc8f499d51ae96a20eb76c3192bfcc3
+  metadata.gz: 152c5eda261cabe740a9ffc0b42c86aa43f98365
+  data.tar.gz: ffe613bc7a54e1f473570705b30a36fca4dbbfac
 SHA512:
-  metadata.gz: faffff4c99df31cf5b2e4addc170fe651274917b3d093fd6fdb84917dacbfc677b904fe0f336ae6238084acf62e356700a8b9243193ef8972a845e5f132006f3
-  data.tar.gz: d4d2b1cf9e573615f92616e71a1f29800f0dad42819724a9a97961b24e853b16357b5d5e260f25399ba80027b3542ea1d0517a60e37a968b2f47ca54505d9c97
+  metadata.gz: 12fee08a5382b52a4dd31dbaecebfdd454204167c6520370cf7481e3dba517b115a1cd84942cf81e72b1eff20d12ddce61c51e78be31cee4a9bd90c80fb92452
+  data.tar.gz: a9b877654a436dc9fe154c8849d6fbc3afcef2db6e713a35f71fbc0af7afdd02d00e32dd50fad070464e2db337f5b5f45587ef4e84088af438d474e10abc63dd

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+
+## [0.2.0] - 2016-11-14
+
+### Added
+
+- `Flagship.features` method to fetch all `Flagship::Feature`
+- Tagging
+- `Flagship.select_flagset` instead of `Flagship.set_flagset`
+
+### Deprecated
+
+- `Flagship.set_flagset` method
+
+## [0.1.0] - 2016-10-30
+
+### Added
+
+- Initial release

data/README.md

@@ -29,7 +29,7 @@ Flagship.define :app do
   disable :deprecate_feature
 end
 
-Flagship.set_flagset(:app)
+Flagship.select_flagset(:app)
 ```
 
 ### Branch with a flag
@@ -55,7 +55,7 @@ Flagship.set_context :foo, ->(context) { 'FOO' }
 Or you can set a method too.
 
 ```rb
-Flagship.set_method :current_user, method(:current_user)
+Flagship.set_context :current_user, method(:current_user)
 ```
 
 ### Extend flagset
@@ -74,18 +74,44 @@ Flagship.define :production, extend: :common do
 end
 
 if Rails.env.production?
-  Flagset.set_flagset(:production)
+  Flagship.select_flagset(:production)
 else
-  Flagset.set_flagset(:development)
+  Flagship.select_flagset(:development)
 end
 ```
 
 ### Override flag with ENV
 
-You can override flags with ENV named `FLAG_***`.
+You can override flags with ENV named `FLAGSHIP_***`.
 
 Assuming that there is a flag `:foo`, you can override it with ENV `FLAGSHIP_FOO=1`.
 
+### Fetch all features
+
+```rb
+Flagship.features
+# => Array of Flagship::Feature
+
+Flagship.features.map(&:key)
+# => Array key of enabled features
+```
+
+### Categorize features with tags
+
+```rb
+Flagship.define :blog do
+  enable :post
+  enable :comment, communication: true
+  enable :trackback, communication: true
+end
+
+Flagship.select_flagset(:blog)
+
+# Fetch keys of enabled communication features
+Flagship.features.select{ |feature| feature.tags[:communication] && feature.enabled? }.map(&:key)
+# => [:comment, :trackback]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/flagship/dsl.rb

@@ -5,26 +5,29 @@ class Flagship::Dsl
     @key = key
     @context = context
     @base = base
-    @flags = {}
+    @features = {}
     @definition = block
   end
 
   def enable(key, opts = {})
-    if opts[:if]
-      @flags[key] = opts[:if]
+    opts = opts.dup
+    condition = opts.delete(:if)
+
+    if condition
+      @features[key] = ::Flagship::Feature.new(key, condition, @context, opts)
     else
-      @flags[key] = true
+      @features[key] = ::Flagship::Feature.new(key, true, @context, opts)
     end
   end
 
   def disable(key, opts = {})
     raise InvalidOptionError.new("Option :if is not available for #disable") if opts[:if]
 
-    @flags[key] = false
+    @features[key] = ::Flagship::Feature.new(key, false, @context, opts)
   end
 
   def flagset
     instance_eval(&@definition)
-    ::Flagship::Flagset.new(@key, @flags, @context, @base)
+    ::Flagship::Flagset.new(@key, @features, @base)
   end
 end

data/lib/flagship/feature.rb

@@ -0,0 +1,29 @@
+class Flagship::Feature
+  attr_reader :key, :tags
+
+  def initialize(key, enabled, context, tags = {})
+    @key = key
+    @enabled = enabled
+    @context = context
+    @tags = tags
+  end
+
+  def enabled?
+    env = ENV['FLAGSHIP_' + key.to_s.upcase]
+
+    if env
+      case env.downcase
+      when '1', 'true'
+        return true
+      when '0', 'false', ''
+        return false
+      end
+    end
+
+    if @enabled.respond_to?(:call)
+      !!@enabled.call(@context)
+    else
+      !!@enabled
+    end
+  end
+end

data/lib/flagship/flagset.rb

@@ -1,34 +1,23 @@
 class Flagship::Flagset
-  attr_reader :key, :flags
+  attr_reader :key
 
   class UndefinedFlagError < ::StandardError; end
 
-  def initialize(key, flags, context, base = nil)
+  def initialize(key, features_hash, base = nil)
     @key = key
-    @flags = base ? base.flags.merge(flags) : flags
-    @context = context
+    @features = base ?
+      base.features.map{ |f| [f.key, f] }.to_h.merge(features_hash) :
+      features_hash
   end
 
-  def enabled?(key, if: nil)
-    raise UndefinedFlagError.new("The flag :#{key} is not defined") unless @flags.key? key
+  def enabled?(key)
+    raise UndefinedFlagError.new("The flag :#{key} is not defined") unless @features.key? key
 
-    env = ENV['FLAGSHIP_' + key.to_s.upcase]
 
-    if env
-      case env.downcase
-      when '1', 'true'
-        return true
-      when '0', 'false', ''
-        return false
-      end
-    end
-
-    flag = @flags[key]
+    @features[key].enabled?
+  end
 
-    if flag.respond_to?(:call)
-      !!@flags[key].call(@context)
-    else
-      !!@flags[key]
-    end
+  def features
+    @features.map { |key, feature| feature }
   end
 end

data/lib/flagship/version.rb

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

data/lib/flagship.rb

@@ -1,6 +1,7 @@
 require "flagship/version"
 require "flagship/context"
 require "flagship/dsl"
+require "flagship/feature"
 require "flagship/flagset"
 require "flagship/flagsets_container"
 
@@ -21,10 +22,20 @@ module Flagship
     self.default_context.__set(key, value)
   end
 
-  def self.set_flagset(key)
+  def self.select_flagset(key)
     @@current_flagset = self.default_flagsets_container.get(key)
   end
 
+  # Deprecated: Use select_flagset
+  def self.set_flagset(key)
+    warn "[DEPRECATION] `set_flagset` is deprecated.  Please use `select_flagset` instead."
+    self.select_flagset(key)
+  end
+
+  def self.features
+    self.current_flagset.features
+  end
+
   def self.get_flagset(key)
     self.default_flagsets_container.get(key)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flagship
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuya Takeyama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2016-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -72,6 +73,7 @@ files:
 - lib/flagship.rb
 - lib/flagship/context.rb
 - lib/flagship/dsl.rb
+- lib/flagship/feature.rb
 - lib/flagship/flagset.rb
 - lib/flagship/flagsets_container.rb
 - lib/flagship/version.rb