flagship 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9f85fb317ee229493f115ec7c65647e75660a0f
+  data.tar.gz: 449021917bc8f499d51ae96a20eb76c3192bfcc3
+SHA512:
+  metadata.gz: faffff4c99df31cf5b2e4addc170fe651274917b3d093fd6fdb84917dacbfc677b904fe0f336ae6238084acf62e356700a8b9243193ef8972a845e5f132006f3
+  data.tar.gz: d4d2b1cf9e573615f92616e71a1f29800f0dad42819724a9a97961b24e853b16357b5d5e260f25399ba80027b3542ea1d0517a60e37a968b2f47ca54505d9c97

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --require=spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 2.2.5
+  - 2.3.1
+
+before_install: gem install bundler --no-document

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flagship.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuya Takeyama
+
+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,102 @@
+# :flags: Flagship :ship:
+
+Ship/unship features using flags defined with declarative DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flagship'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flagship
+
+## Usage
+
+### Define and use a flagset
+
+```rb
+Flagship.define :app do
+  enable  :stable_feature
+  enable  :experimental_feature, if: ->(context) { context.current_user.staff? }
+  disable :deprecate_feature
+end
+
+Flagship.set_flagset(:app)
+```
+
+### Branch with a flag
+
+```rb
+if Flagship.enabled?(:some_feature)
+  # Implement the feature here
+end
+```
+
+### Set context variables
+
+Both of below can be called as `context.foo` from `:if` block.
+
+```rb
+# Set a value
+Flagship.set_context :foo, 'FOO'
+
+# Set a lambda
+Flagship.set_context :foo, ->(context) { 'FOO' }
+```
+
+Or you can set a method too.
+
+```rb
+Flagship.set_method :current_user, method(:current_user)
+```
+
+### Extend flagset
+
+```rb
+Flagship.define :common do
+  enable :stable_feature
+end
+
+Flagship.define :development, extend: :common do
+  enable :experimental_feature
+end
+
+Flagship.define :production, extend: :common do
+  disable :experimental_feature
+end
+
+if Rails.env.production?
+  Flagset.set_flagset(:production)
+else
+  Flagset.set_flagset(:development)
+end
+```
+
+### Override flag with ENV
+
+You can override flags with ENV named `FLAG_***`.
+
+Assuming that there is a flag `:foo`, you can override it with ENV `FLAGSHIP_FOO=1`.
+
+## 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.
+
+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/yuya-takeyama/flagship.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flagship"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flagship.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flagship/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flagship"
+  spec.version       = Flagship::VERSION
+  spec.authors       = ["Yuya Takeyama"]
+  spec.email         = ["sign.of.the.wolf.pentagram@gmail.com"]
+
+  spec.summary       = %q{Ship/unship features using flags defined with declarative DSL}
+  spec.description   = %q{Ship/unship features using flags defined with declarative DSL}
+  spec.homepage      = "https://github.com/yuya-takeyama/flagship"
+  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_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

@@ -0,0 +1,27 @@
+class Flagship::Context
+  def initialize
+    @values = {}
+  end
+
+  def __set(key, value)
+    @values[key.to_sym] = value
+  end
+
+  def method_missing(name, args = [], &block)
+    if @values.key?(name)
+      value = @values[name]
+
+      if value.respond_to?(:call)
+        value.call
+      else
+        value
+      end
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(name, include_private = false)
+    @values.key?(name) or super
+  end
+end

data/lib/flagship/dsl.rb

@@ -0,0 +1,30 @@
+class Flagship::Dsl
+  class InvalidOptionError < ::StandardError; end
+
+  def initialize(key, context, base = nil, &block)
+    @key = key
+    @context = context
+    @base = base
+    @flags = {}
+    @definition = block
+  end
+
+  def enable(key, opts = {})
+    if opts[:if]
+      @flags[key] = opts[:if]
+    else
+      @flags[key] = true
+    end
+  end
+
+  def disable(key, opts = {})
+    raise InvalidOptionError.new("Option :if is not available for #disable") if opts[:if]
+
+    @flags[key] = false
+  end
+
+  def flagset
+    instance_eval(&@definition)
+    ::Flagship::Flagset.new(@key, @flags, @context, @base)
+  end
+end

data/lib/flagship/flagset.rb

@@ -0,0 +1,34 @@
+class Flagship::Flagset
+  attr_reader :key, :flags
+
+  class UndefinedFlagError < ::StandardError; end
+
+  def initialize(key, flags, context, base = nil)
+    @key = key
+    @flags = base ? base.flags.merge(flags) : flags
+    @context = context
+  end
+
+  def enabled?(key, if: nil)
+    raise UndefinedFlagError.new("The flag :#{key} is not defined") unless @flags.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]
+
+    if flag.respond_to?(:call)
+      !!@flags[key].call(@context)
+    else
+      !!@flags[key]
+    end
+  end
+end

data/lib/flagship/flagsets_container.rb

@@ -0,0 +1,20 @@
+class Flagship::FlagsetsContainer
+  class DuplicatedFlagsetError < ::StandardError; end
+  class UndefinedFlagsetError < ::StandardError; end
+
+  def initialize
+    @flagsets = {}
+  end
+
+  def add(flagset)
+    raise DuplicatedFlagsetError.new("Flagset :#{flagset.key} already exists") if @flagsets.key? flagset.key
+
+    @flagsets[flagset.key] = flagset
+  end
+
+  def get(key)
+    raise UndefinedFlagsetError.new("Flagset :#{key} does not exist") unless @flagsets.key? key
+
+    @flagsets[key]
+  end
+end

data/lib/flagship/version.rb

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

data/lib/flagship.rb

@@ -0,0 +1,48 @@
+require "flagship/version"
+require "flagship/context"
+require "flagship/dsl"
+require "flagship/flagset"
+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.set_flagset(key)
+    @@current_flagset = self.default_flagsets_container.get(key)
+  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
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: flagship
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuya Takeyama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-30 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
+  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.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Ship/unship features using flags defined with declarative DSL
+email:
+- sign.of.the.wolf.pentagram@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flagship.gemspec
+- lib/flagship.rb
+- lib/flagship/context.rb
+- lib/flagship/dsl.rb
+- lib/flagship/flagset.rb
+- lib/flagship/flagsets_container.rb
+- lib/flagship/version.rb
+homepage: https://github.com/yuya-takeyama/flagship
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ship/unship features using flags defined with declarative DSL
+test_files: []