features_toggle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 001cdabf19c99f78ad7af9c3205aa8492cbf929d
+  data.tar.gz: b649f567270a24adcaf6d930b822bff815df907f
+SHA512:
+  metadata.gz: b90910058d8ed7a7be54298af555237bdc38c247c37d63ee7a71a7df68ddc7178a8bda512f3af0cb840db8c47cf3129c7609d2d4bf5d8402b7bd5cd1489082b9
+  data.tar.gz: 4968878d44820f9eb8d98d497cc4de88c9ad51ea3a1b1a1209a637f7f2c49be6e28189cbd405b807afb177ef3b160bd9f31bfd1c16909750c09658c295942ebb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tien Le
+
+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/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FeatureToggle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/feature_toggle/application.js

@@ -0,0 +1,12 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//

data/app/assets/javascripts/feature_toggle/features.js

@@ -0,0 +1,15 @@
+$(function() {
+  $(document).on('click', '.feature-table .checkbox', function(e) {
+    var $el = $(e.target);
+
+    $.ajax({
+      type: "POST",
+      url: window.toggleFeaturePath,
+      data: {
+        "feature": $el.data('feature-name'),
+        "state": $el.data('state-name'),
+        "enable": $el.is(':checked')
+      }
+    });
+  });
+});

data/app/assets/stylesheets/feature_toggle/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ */

data/app/assets/stylesheets/feature_toggle/features.css

@@ -0,0 +1,124 @@
+.checkbox {
+  position: relative;
+  top: -0.375rem;
+  margin: 0 1rem 0 0;
+  cursor: pointer;
+}
+.checkbox:before {
+  -webkit-transition: all 0.3s ease-in-out;
+  -moz-transition: all 0.3s ease-in-out;
+  transition: all 0.3s ease-in-out;
+  content: "";
+  position: absolute;
+  left: 0;
+  top: -0.225rem;
+  z-index: 1;
+  width: 2rem;
+  height: 2rem;
+  border: 2px solid #e2e2e2;
+}
+.checkbox:checked:before {
+  -webkit-transform: rotate(-45deg);
+  -moz-transform: rotate(-45deg);
+  -ms-transform: rotate(-45deg);
+  -o-transform: rotate(-45deg);
+  transform: rotate(-45deg);
+  height: 1rem;
+  border-color: #009688;
+  border-top-style: none;
+  border-right-style: none;
+}
+.checkbox:after {
+  content: "";
+  position: absolute;
+  top: -0.225rem;
+  left: 0;
+  width: 2.0rem;
+  height: 2.0rem;
+  background: #fff;
+  cursor: pointer;
+}
+
+.button--round {
+  -webkit-transition: 0.3s background ease-in-out;
+  -moz-transition: 0.3s background ease-in-out;
+  transition: 0.3s background ease-in-out;
+  width: 2rem;
+  height: 2rem;
+  background: #5677fc;
+  border-radius: 50%;
+  box-shadow: 0 0.125rem 0.3125rem 0 rgba(0, 0, 0, 0.25);
+  color: #fff;
+  text-decoration: none;
+  text-align: center;
+}
+.button--round i {
+  font-size: 1rem;
+  line-height: 220%;
+  vertical-align: middle;
+}
+.button--round:hover {
+  background: #3b50ce;
+}
+
+.button--sticky {
+  position: fixed;
+  right: 2rem;
+  top: 16rem;
+}
+
+.content {
+  -webkit-animation-duration: 0.4s;
+  animation-duration: 0.4s;
+  -webkit-animation-fill-mode: both;
+  animation-fill-mode: both;
+  -webkit-animation-name: slideUp;
+  animation-name: slideUp;
+  -webkit-animation-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
+  animation-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
+}
+
+@-webkit-keyframes slideUp {
+  0% {
+    -webkit-transform: translateY(6.25rem);
+    transform: translateY(6.25rem);
+  }
+  100% {
+    -webkit-transform: translateY(0);
+    transform: translateY(0);
+  }
+}
+@keyframes slideUp {
+  0% {
+    -webkit-transform: translateY(6.25rem);
+    transform: translateY(6.25rem);
+  }
+  100% {
+    -webkit-transform: translateY(0);
+    transform: translateY(0);
+  }
+}
+
+.feature-table {
+  display: table;
+  border-collapse: collapse;
+
+}
+.feature-table p.desc {
+  font-size: small;
+  color: gray;
+}
+.feature-table-row { display: table-row; }
+.feature-table-cell {
+  display: table-cell;
+  padding: 10px;
+  border: 1px solid #ddd;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+.feature-table-cell-tl {
+  border-top: 0;
+  border-left: 0;
+}
+

data/app/controllers/feature_toggle/application_controller.rb

@@ -0,0 +1,9 @@
+module FeatureToggle
+  class ApplicationController < ::ApplicationController
+    layout (FeatureToggle.configuration.layout || 'application')
+
+    if FeatureToggle.configuration.authentication_method
+      before_filter FeatureToggle.configuration.authentication_method
+    end
+  end
+end

data/app/controllers/feature_toggle/features_controller.rb

@@ -0,0 +1,17 @@
+require_dependency "feature_toggle/application_controller"
+
+module FeatureToggle
+  class FeaturesController < ApplicationController
+    def index
+      @features = Feature.all.to_a
+    end
+
+    def toggle
+      feature = Feature.where(feature: params[:feature], state: params[:state]).first_or_initialize
+      feature.enable = (params[:enable] == 'true')
+      feature.save
+
+      render nothing: true
+    end
+  end
+end

data/app/helpers/feature_toggle/application_helper.rb

@@ -0,0 +1,20 @@
+module FeatureToggle
+  module ApplicationHelper
+    def method_missing(method, *args, &block)
+      if (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) && main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+
+    def turn_on_feature?(feature, state)
+      @features.find do |f|
+        f.feature == feature.name.to_s &&
+        f.state == state.name.to_s &&
+        f.enable?
+      end
+    end
+
+  end
+end

data/app/helpers/feature_toggle/features_helper.rb

@@ -0,0 +1,7 @@
+module FeatureToggle
+  module FeaturesHelper
+    def feature?(name)
+      FeatureToggle.on?(name, self)
+    end
+  end
+end

data/app/models/feature_toggle/feature.rb

@@ -0,0 +1,4 @@
+module FeatureToggle
+  class Feature < ActiveRecord::Base
+  end
+end

data/app/views/feature_toggle/features/_feature.html.erb

@@ -0,0 +1,18 @@
+<div class='feature-table-row'>
+  <div class='feature-table-cell'>
+    <strong><%= feature.name %></strong>
+    <p class='desc'><%= feature.desc %></p>
+  </div>
+
+  <% FeatureToggle.states.each do |state| %>
+    <div class='feature-table-cell'>
+      <input type="checkbox" class="checkbox" data-feature-name="<%= feature.name %>" data-state-name="<%= state.name %>" value="1" <%= 'checked' if turn_on_feature?(feature, state) %>>&nbsp;</input>
+    </div>
+  <% end %>
+</div>
+
+<% if feature.childrens && feature.childrens.size > 0 %>
+  <% feature.childrens.each do |feature| %>
+    <%= render partial: 'feature', locals: { feature: feature } %>
+  <% end %>
+<% end %>

data/app/views/feature_toggle/features/index.html.erb

@@ -0,0 +1,23 @@
+<%= javascript_include_tag "feature_toggle/features" %>
+<%= stylesheet_link_tag "feature_toggle/features" %>
+
+<div class='feature-table'>
+  <div class='feature-table-row'>
+    <div class='feature-table-cell feature-table-cell-tl'>&nbsp;</div>
+
+    <% FeatureToggle.states.each do |state| %>
+      <div class='feature-table-cell'>
+        <strong><%= state.name %></strong>
+        <p class='desc'><%= state.desc %></p>
+      </div>
+    <% end %>
+  </div>
+
+  <% FeatureToggle.features.each do |feature| %>
+    <%= render partial: 'feature', locals: { feature: feature } %>
+  <% end %>
+</div>
+
+<script>
+  window.toggleFeaturePath = "<%= toggle_features_path %>";
+</script>

data/config/routes.rb

@@ -0,0 +1,8 @@
+FeatureToggle::Engine.routes.draw do
+  resources :features, only: [:index] do
+    collection do
+      post :toggle
+    end
+  end
+  root :to => "features#index"
+end

data/db/migrate/20160222162323_create_feature_toggle_features.rb

@@ -0,0 +1,13 @@
+class CreateFeatureToggleFeatures < ActiveRecord::Migration
+  def change
+    create_table :feature_toggle_features do |t|
+      t.string :feature
+      t.string :state
+      t.boolean :enable, default: false
+
+      t.timestamps null: false
+    end
+
+    add_index :feature_toggle_features, :feature
+  end
+end

data/lib/feature_toggle.rb

@@ -0,0 +1,31 @@
+require "feature_toggle/engine"
+require 'feature_toggle/syntax'
+require 'ostruct'
+
+module FeatureToggle
+  extend Syntax
+
+  def self.setup(&block)
+    yield configuration
+  end
+
+  def self.states
+    @states ||= []
+  end
+
+  def self.features
+    @features ||= []
+  end
+
+  def self.configuration
+    @config ||= OpenStruct.new
+  end
+
+  def self.on?(feature, state_context)
+    enable_state_names = Feature.where(feature: feature, enable: true).pluck(:state)
+    enable_states = states.select {|state| enable_state_names.include?(state.name.to_s) }
+    enable_states.any? do |state|
+      state_context.instance_eval &state.value
+    end
+  end
+end

data/lib/feature_toggle/engine.rb

@@ -0,0 +1,15 @@
+module FeatureToggle
+  class Engine < ::Rails::Engine
+    isolate_namespace FeatureToggle
+
+    initializer "feature_toggle", before: :load_config_initializers do |app|
+      config.paths["db/migrate"].expanded.each do |expanded_path|
+        Rails.application.config.paths["db/migrate"] << expanded_path
+      end
+    end
+
+    initializer :assets do |config|
+      Rails.application.config.assets.precompile += %w{ feature_toggle/features.css feature_toggle/features.js }
+    end
+  end
+end

data/lib/feature_toggle/syntax.rb

@@ -0,0 +1,54 @@
+require 'feature_toggle/syntax/feature'
+require 'feature_toggle/syntax/state'
+
+module FeatureToggle
+  module Syntax
+    def define(&block)
+      DSL.run(block)
+    end
+
+    class DSL
+      def self.run(block)
+        new.instance_eval(&block)
+      end
+
+      def feature(name, &block)
+        self.features << Feature.new(name, block)
+      end
+
+      def state(name, &block)
+        self.states << State.new(name, block)
+      end
+
+      protected
+
+      def states
+        FeatureToggle.states
+      end
+
+      def features
+        FeatureToggle.features
+      end
+    end
+  end
+end
+
+#FeatureToggle.define do
+  #feature :employee_file do
+    #desc"Access employee file"
+
+    #feature :create
+    #feature :delete
+  #end
+
+  #state :premium,
+    #desc "Premium user"
+    #value { current_user.paid? }
+  #end
+
+  #state :free do
+    #desc "Trial user"
+
+    #current_user.free?
+  #end
+#end