cookie_flag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 204f38b746d648087ae9cc7674d93accb8f78249
+  data.tar.gz: 967ef333d53e7665d255a4da196c3b1d020a8b1a
+SHA512:
+  metadata.gz: 11bc366710c50c21397832c3f261b01fec1b71481aab75e322b3bcde227340e0e4b043a7d7cbe1795353536f9f834e9bf6018fa9f82513c256ada2593db05bde
+  data.tar.gz: 1302efc1606bdfe0a18fa3b2f98c99fba9d16cf41362a776258e0c2c7a2393e7d92e5a9719cadd5707cbe2ff455fc3716fb511412ba2778e2bc61760c88a0829

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cookie_flag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shota Iguchi
+
+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,26 @@
+# CookieFlag
+
+Cookie based feature flags implementation for Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cookie_flag'
+```
+
+And then execute:
+
+```shell
+$ bundle
+$ bundle exec rails generate cookie_flag:install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iguchi1124/cookie_flag.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "cookie_flag"
+
+# 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(__FILE__)

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/cookie_flag.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cookie_flag/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cookie_flag"
+  spec.version       = CookieFlag::VERSION
+  spec.author        = "Shota Iguchi"
+  spec.email         = "shota-iguchi@cookpad.com"
+
+  spec.summary       = "Cookie based feature flags implementation for Rails."
+  spec.homepage      = "https://github.com/iguchi1124/cookie_flag"
+  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 "activesupport", ">= 4.2"
+  spec.add_development_dependency "railties", ">= 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cookie_flag.rb

@@ -0,0 +1,15 @@
+require 'cookie_flag/configuration'
+require 'cookie_flag/railtie'
+require "cookie_flag/version"
+
+module CookieFlag
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/cookie_flag/configuration.rb

@@ -0,0 +1,9 @@
+module CookieFlag
+  class Configuration
+    attr_accessor :name
+
+    def initialize
+      @name = 'cookie_flag'
+    end
+  end
+end

data/lib/cookie_flag/helper.rb

@@ -0,0 +1,33 @@
+require 'cookie_flag/unavailable_error'
+
+module CookieFlag
+  module Helper
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :feature_available?
+    end
+
+    module ClassMethods
+      def feature(feature_name)
+        before_action -> {
+          unless feature_available?(feature_name)
+            raise UnavailableError
+          end
+        }
+      end
+    end
+
+    private
+
+    def feature_available?(feature_name)
+      feature_flags[feature_name].present? &&
+        cookies.has_key?(feature_name) &&
+        cookies[feature_name] == feature_flags[feature_name]
+    end
+
+    def feature_flags
+      @feature_flags ||= Rails.application.config_for(CookieFlag.config.name).with_indifferent_access
+    end
+  end
+end

data/lib/cookie_flag/railtie.rb

@@ -0,0 +1,13 @@
+require 'cookie_flag/helper'
+
+module CookieFlag
+  class Railtie < Rails::Railtie
+    config.action_dispatch.rescue_responses.merge!('CookieFlag::UnavailableError' => :not_found)
+
+    initializer 'cookie_flag' do
+      ActiveSupport.on_load(:action_controller) do
+        include CookieFlag::Helper if to_s != 'ActionController::API'
+      end
+    end
+  end
+end

data/lib/cookie_flag/unavailable_error.rb

@@ -0,0 +1,4 @@
+module CookieFlag
+  class UnavailableError < StandardError
+  end
+end

data/lib/cookie_flag/version.rb

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

data/lib/generators/cookie_flag/install_generator.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module CookieFlag
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __dir__)
+
+    def install
+      copy_file "cookie_flag.yml", "config/cookie_flag.yml"
+    end
+  end
+end

data/lib/generators/templates/cookie_flag.yml

@@ -0,0 +1,9 @@
+default: &default
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cookie_flag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shota Iguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: shota-iguchi@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cookie_flag.gemspec
+- lib/cookie_flag.rb
+- lib/cookie_flag/configuration.rb
+- lib/cookie_flag/helper.rb
+- lib/cookie_flag/railtie.rb
+- lib/cookie_flag/unavailable_error.rb
+- lib/cookie_flag/version.rb
+- lib/generators/cookie_flag/install_generator.rb
+- lib/generators/templates/cookie_flag.yml
+homepage: https://github.com/iguchi1124/cookie_flag
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Cookie based feature flags implementation for Rails.
+test_files: []