flagship 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5e0f2c9053b747cfc441a1e3ba8f31a5453d00d
-  data.tar.gz: ba52d5627d54d495773f47649bb8333a37793dbe
+  metadata.gz: 8fb44a30b820db71bbf1edc824a3543a0e0f107e
+  data.tar.gz: 13d3196cd2ee42b7d1b7b6a4d9a09c966cf66e26
 SHA512:
-  metadata.gz: cb5353d961b9a00391af1e0e42028b9bc432772073743d0f4ebb291a91342a3f7aa99bd555b234fee50128bcd85ae9bd0daa44e8fb7ad86e3b502390f21c8c46
-  data.tar.gz: 8db9f8a90a544de056952bccc6ab0b88dd2189029b40d62c1320a40a0eb99f499a54e4a488a95879bada243f8e7532ea774a9920d85938b33c56c4895b284a56
+  metadata.gz: 3a564740caca6345d3190830913d9d4e3b2e1ea060312bd36471d65e68335506043c1568aa2f653241c028318bd03655aad4cecd3e2aade9552cf8f14f90f5a9
+  data.tar.gz: ba3b294b5bc9cf320b5210b7c54084107bee59c08e6107ac48ff958e9009dce6611dd7501ff6fe234ba60af82acbfbe956fb669c82f96e8e3471ab9b1b18b636

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [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

@@ -147,6 +147,59 @@ 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
+```
+
 ## 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.rb

@@ -9,46 +9,48 @@ 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
-
-  def self.enabled?(key)
-    self.current_flagset.enabled?(key)
-  end
-
-  def self.set_context(key, value)
-    self.default_context.__set(key, value)
-  end
-
-  def self.select_flagset(key)
-    @@current_flagset = self.default_flagsets_container.get(key)
-  end
-
-  def self.features
-    self.current_flagset.features
-  end
-
-  def self.get_flagset(key)
-    self.default_flagsets_container.get(key)
-  end
-
-  def self.default_flagsets_container
-    @@default_flagsts_container ||= ::Flagship::FlagsetsContainer.new
-  end
-
-  def self.current_flagset
-    @@current_flagset or raise NoFlagsetSelectedError.new('No flagset is selected')
-  end
-
-  def self.default_context
-    @@default_context ||= ::Flagship::Context.new
-  end
-
-  def self.clear_state
-    @@default_flagsts_container = nil
-    @@current_flagset = nil
+  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 enabled?(key)
+      current_flagset.enabled?(key)
+    end
+
+    def set_context(key, value)
+      default_context.__set(key, value)
+    end
+
+    def select_flagset(key)
+      @current_flagset = default_flagsets_container.get(key)
+    end
+
+    def features
+      current_flagset.features
+    end
+
+    def get_flagset(key)
+      default_flagsets_container.get(key)
+    end
+
+    def default_flagsets_container
+      @default_flagsts_container ||= ::Flagship::FlagsetsContainer.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
+      @default_flagsts_container = nil
+      @current_flagset = nil
+    end
   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.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flagship
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yuya Takeyama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ship/unship features using flags defined with declarative DSL