flagship 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5e0f2c9053b747cfc441a1e3ba8f31a5453d00d
-  data.tar.gz: ba52d5627d54d495773f47649bb8333a37793dbe
+SHA256:
+  metadata.gz: 60210addd43057e1808189582ab298a84f14bb70468c1685e676ceb5481a7a8a
+  data.tar.gz: 4f85d9c988e71f2d219938310990757869269cf31e84706e093640f0e07b1326
 SHA512:
-  metadata.gz: cb5353d961b9a00391af1e0e42028b9bc432772073743d0f4ebb291a91342a3f7aa99bd555b234fee50128bcd85ae9bd0daa44e8fb7ad86e3b502390f21c8c46
-  data.tar.gz: 8db9f8a90a544de056952bccc6ab0b88dd2189029b40d62c1320a40a0eb99f499a54e4a488a95879bada243f8e7532ea774a9920d85938b33c56c4895b284a56
+  metadata.gz: 43dd867d1d2a6de1433833709fdd9c251ee095fd088a0d4f024fc802d966067f24c80a4d0615202892663014c03f22ba295dacc4c55610982ed2d5f4316a3c9f
+  data.tar.gz: 45152c852249cfa8692da6c234f1d6f246ab30c1111c7458436ea8a99ab792077a0af4608570954bf9a4ea4ab2aff859a09e5067453d0867552acf68b7fc15e2

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 
 rvm:
-  - 2.2.5
-  - 2.3.3
-
-before_install: gem install bundler --no-document
+  - 2.2.10
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Change Log
 
+## [0.7.0] - 2020-05-01
+
+### Fixed
+
+- Make context thread safe [#32](https://github.com/yuya-takeyama/flagship/pull/32) ([@mtsmfm](https://github.com/mtsmfm))
+
+## [0.6.1] - 2017-05-17
+
+### Added
+
+- Add separated methods to clear state [#30](https://github.com/yuya-takeyama/flagship/pull/30)
+
+## [0.6.0] - 2017-05-15
+
+### Added
+
+- Add `Flagship.with_context` method to apply temporal changes to context variables [#26](https://github.com/yuya-takeyama/flagship/pull/26)
+- Now `Flagship.clear_state` clears context variables as well [#27](https://github.com/yuya-takeyama/flagship/pull/27)
+
+### Changed
+
+- Allow `Flagship.set_context` to set multiple variables at once using `Hash` [#25](https://github.com/yuya-takeyama/flagship/pull/25)
+
+## [0.5.0] - 2017-01-07
+
+- Documented about helper methods [#21](https://github.com/yuya-takeyama/flagship/pull/21)
+- Helper methods can be specified as a `Symbol` [#21](https://github.com/yuya-takeyama/flagship/pull/21)
+- Helper methods are extended [#22](https://github.com/yuya-takeyama/flagship/pull/22)
+
 ## [0.4.0] - 2016-12-23
 
 ### Added

data/README.md

@@ -62,6 +62,24 @@ Or you can set a method too.
 Flagship.set_context :current_user, method(:current_user)
 ```
 
+### Apply temporal changes to context variables
+
+Using `Flagship.with_context` method, you can override context variables temporarily.
+
+```rb
+class User
+  def enabled_features
+    Flagship.with_context current_user: self do
+      Flagship.features.enabled.map(&:key)
+    end
+  end
+end
+```
+
+It's useful when you implement a method using `Flagship` into some domain objects.
+
+By using this, values specified in the argument is overridden and other values are inherited.
+
 ### Extend flagset
 
 ```rb
@@ -147,6 +165,81 @@ Flagship.define :blog do
 end
 ```
 
+## Helper methods
+
+You can define helpers as normal methods with `def`. Methods can be used within blocks, procs, or as symbolic names for if statements to tidy up your code.
+
+```rb
+Flagship.define :blog do
+  def is_author(comment, user)
+    comment.author == user
+  end
+
+  def can_view_comment(context)
+    context.current_user.moderator?
+  end
+
+  enable :comment, if: :can_view_comment
+  enable :comment_deletion, if: ->(context) { is_author(context.comment, context.current_user) }
+end
+```
+
+To share helpers, you can simply include them as modules.
+
+```rb
+module FlagHelpers
+  def is_author(context)
+    context.comment.author == context.current_user
+  end
+end
+
+Flagship.define :development do
+  include FlagHelpers
+  enable :delete, if: :is_author
+end
+
+Flagship.define :production do
+  include FlagHelpers
+  enable :delete, if: :is_author
+end
+```
+
+And you can also extend helper methods from base flagset.
+
+```rb
+Flagship.define :base do
+  def is_author(context)
+    context.comment.author == context.current_user
+  end
+end
+
+Flagship.define :production do
+  enable :delete, if: :is_author
+end
+```
+
+### Testing
+
+#### RSpec
+
+It's recommended to clear state of `Flagship` before the suite and after the each tests.
+
+You can do it by configuring like below:
+
+```rb
+RSpec.configure do |config|
+  config.before(:suite) do
+    Flagship.clear_context
+    Flagship.clear_current_flagset
+  end
+
+  config.after(:each) do
+    Flagship.clear_context
+    Flagship.clear_current_flagset
+  end
+end
+```
+
 ## 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/flagship.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5.0"
 end

data/lib/flagship/context.rb

@@ -1,15 +1,16 @@
+require 'forwardable'
+
 class Flagship::Context
-  def initialize
-    @values = {}
-  end
+  extend Forwardable
+  def_delegators :current_values, :clear
 
   def __set(key, value)
-    @values[key.to_sym] = value
+    current_values[key.to_sym] = value
   end
 
   def method_missing(name, args = [], &block)
-    if @values.key?(name)
-      value = @values[name]
+    if current_values.key?(name)
+      value = current_values[name]
 
       if value.respond_to?(:call)
         value.call
@@ -22,6 +23,24 @@ class Flagship::Context
   end
 
   def respond_to_missing?(name, include_private = false)
-    @values.key?(name) or super
+    current_values.key?(name) or super
+  end
+
+  def with_values(new_values, &block)
+    original_values = current_values
+    self.current_values = current_values.dup.merge(new_values)
+    block.call
+  ensure
+    self.current_values = original_values
+  end
+
+  private
+
+  def current_values
+    Thread.current[:__flagship_context_values] ||= {}
+  end
+
+  def current_values=(new_values)
+    Thread.current[:__flagship_context_values] = new_values
   end
 end

data/lib/flagship/dsl.rb

@@ -11,14 +11,26 @@ class Flagship::Dsl
     @definition = block
     @base_tags = {}
 
+    if @base
+      @base.helper_methods.each do |method|
+        define_singleton_method(method.name, &method)
+      end
+    end
+
     instance_eval(&@definition)
 
-    @flagset = ::Flagship::Flagset.new(@key, @features, @base)
+    helper_methods = singleton_methods.map { |sym| method(sym) }
+    @flagset = ::Flagship::Flagset.new(@key, @features, @base, helper_methods)
   end
 
   def enable(key, opts = {})
     tags = opts.dup
     condition = tags.delete(:if)
+    # convert to proc
+    if condition.is_a?(Symbol)
+      sym = condition
+      condition = ->(context) { method(sym).call(context) }
+    end
 
     if condition
       @features[key] = ::Flagship::Feature.new(key, condition, @context, @base_tags.merge(tags))
@@ -49,4 +61,8 @@ class Flagship::Dsl
   def disabled?(key)
     @flagset.disabled?(key)
   end
+
+  def include(mod)
+    extend mod
+  end
 end

data/lib/flagship/flagset.rb

@@ -1,13 +1,14 @@
 class Flagship::Flagset
-  attr_reader :key
+  attr_reader :key, :helper_methods
 
   class UndefinedFlagError < ::StandardError; end
 
-  def initialize(key, features_hash, base = nil)
+  def initialize(key, features_hash, base = nil, helper_methods = [])
     @key = key
     @features = base ?
       extend_features(features_hash, base) :
       features_hash
+    @helper_methods = helper_methods
   end
 
   def enabled?(key)

data/lib/flagship/version.rb

@@ -1,3 +1,3 @@
 module Flagship
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

data/lib/flagship.rb

@@ -9,46 +9,71 @@ require "flagship/flagsets_container"
 module Flagship
   class NoFlagsetSelectedError < ::StandardError; end
 
-  def self.define(key, options = {}, &block)
-    context = self.default_context
-    base = options[:extend] ? self.get_flagset(options[:extend]) : nil
-    self.default_flagsets_container.add ::Flagship::Dsl.new(key, context, base, &block).flagset
-  end
+  class << self
+    def define(key, options = {}, &block)
+      context = self.default_context
+      base = options[:extend] ? self.get_flagset(options[:extend]) : nil
+      default_flagsets_container.add ::Flagship::Dsl.new(key, context, base, &block).flagset
+    end
 
-  def self.enabled?(key)
-    self.current_flagset.enabled?(key)
-  end
+    def enabled?(key)
+      current_flagset.enabled?(key)
+    end
 
-  def self.set_context(key, value)
-    self.default_context.__set(key, value)
-  end
+    def set_context(key_or_hash, value=nil)
+      if key_or_hash.is_a?(Hash)
+        key_or_hash.each { |k, v| default_context.__set(k, v) }
+      else
+        default_context.__set(key_or_hash, value)
+      end
+    end
 
-  def self.select_flagset(key)
-    @@current_flagset = self.default_flagsets_container.get(key)
-  end
+    def with_context(values, &block)
+      default_context.with_values values do
+        block.call
+      end
+    end
 
-  def self.features
-    self.current_flagset.features
-  end
+    def select_flagset(key)
+      @current_flagset = default_flagsets_container.get(key)
+    end
 
-  def self.get_flagset(key)
-    self.default_flagsets_container.get(key)
-  end
+    def features
+      current_flagset.features
+    end
 
-  def self.default_flagsets_container
-    @@default_flagsts_container ||= ::Flagship::FlagsetsContainer.new
-  end
+    def get_flagset(key)
+      default_flagsets_container.get(key)
+    end
 
-  def self.current_flagset
-    @@current_flagset or raise NoFlagsetSelectedError.new('No flagset is selected')
-  end
+    def default_flagsets_container
+      @default_flagsts_container ||= ::Flagship::FlagsetsContainer.new
+    end
 
-  def self.default_context
-    @@default_context ||= ::Flagship::Context.new
-  end
+    def current_flagset
+      @current_flagset or raise NoFlagsetSelectedError.new('No flagset is selected')
+    end
+
+    def default_context
+      @default_context ||= ::Flagship::Context.new
+    end
+
+    def clear_state
+      clear_flagsets_container
+      clear_current_flagset
+      clear_context
+    end
+
+    def clear_flagsets_container
+      @default_flagsts_container = nil
+    end
+
+    def clear_current_flagset
+      @current_flagset = nil
+    end
 
-  def self.clear_state
-    @@default_flagsts_container = nil
-    @@current_flagset = nil
+    def clear_context
+      @default_context && @default_context.clear
+    end
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: flagship
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yuya Takeyama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
@@ -82,7 +82,7 @@ homepage: https://github.com/yuya-takeyama/flagship
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ship/unship features using flags defined with declarative DSL
 test_files: []