flipper-ui 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6588ef43bcee1f02024cf32085148eae82ffa9f4
-  data.tar.gz: fd986a24960b953f56510bb5b96a18373276f628
+  metadata.gz: 25aa2745af2e31218cbd4b27af8193e58737cf9d
+  data.tar.gz: cdda6a59fe7edcbdc5b06be258d2d685a2796636
 SHA512:
-  metadata.gz: b4f66474ac658466d3a2a87e67f8c4168935457e1a62d9da3cb8d9891ec50864956cb5a800529bc757a1f879ba943da691c62b5565dffbbd2e32ad1e584a1bf6
-  data.tar.gz: f0ca4057925cb29dcd2b08116751b71900037cf6319520056a1f5da7a5ef0b559c93e8d84ff36127c0bb8742cd4ee06443f68bea3d47ad52d8bf48de4ca0b2f9
+  metadata.gz: c834961bc28b80d3890bcb150ef26a9dffc2f7450acb5d0f2dc6e49d5be0f13bbf435c49916a1c08adf6c1944e1100500cf49f00d147b6a28d5f05bd97ed4399
+  data.tar.gz: 505af952e52ec8ccba2b37368c1fb84fcde104308d09a666f5479769677d6453edeea3088f70f74f49c4241a19f52eaa985f02f4c6400124b6b6a38cb5abc2ea

data/docs/ui/README.md

@@ -107,7 +107,6 @@ Minimal example for Rack:
 # config.ru
 
 require 'flipper-ui'
-require 'flipper/adapters/memory'
 
 adapter = Flipper::Adapters::Memory.new
 flipper = Flipper.new(adapter)

data/examples/ui/basic.ru

@@ -14,6 +14,7 @@ $:.unshift(lib_path)
 
 require "flipper-ui"
 require "flipper/adapters/pstore"
+require "active_support/notifications"
 
 Flipper.register(:admins) { |actor|
   actor.respond_to?(:admin?) && actor.admin?
@@ -24,10 +25,11 @@ Flipper.register(:early_access) { |actor|
 }
 
 # Setup logging of flipper calls.
-$logger = Logger.new(STDOUT)
-require "active_support/notifications"
-require "flipper/instrumentation/log_subscriber"
-Flipper::Instrumentation::LogSubscriber.logger = $logger
+if ENV["LOG"] == "1"
+  $logger = Logger.new(STDOUT)
+  require "flipper/instrumentation/log_subscriber"
+  Flipper::Instrumentation::LogSubscriber.logger = $logger
+end
 
 adapter = Flipper::Adapters::PStore.new
 flipper = Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
@@ -42,6 +44,7 @@ flipper = Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
 # flipper[:secrets].enable_group :early_access
 # flipper[:logging].enable_percentage_of_time 5
 # flipper[:new_cache].enable_percentage_of_actors 15
+# flipper["a/b"].add
 
 run Flipper::UI.app(flipper) { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"

data/flipper-ui.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
+require File.expand_path('../lib/flipper/metadata', __FILE__)
 
 flipper_ui_files = lambda do |file|
   file =~ %r{(docs|examples|flipper)[\/-]ui}
@@ -18,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'flipper-ui'
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
+  gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'rack', '>= 1.4', '< 3'
   gem.add_dependency 'rack-protection', '>= 1.5.3', '< 2.1.0'

data/lib/flipper/ui.rb

@@ -9,8 +9,6 @@ end
 require 'rack/protection'
 
 require 'flipper'
-require 'flipper/middleware/setup_env'
-require 'flipper/middleware/memoizer'
 require 'flipper/ui/middleware'
 require 'flipper/ui/configuration'
 

data/lib/flipper/ui/action.rb

@@ -6,6 +6,16 @@ require 'json'
 module Flipper
   module UI
     class Action
+      module FeatureNameFromRoute
+        def feature_name
+          @feature_name ||= begin
+            match = request.path_info.match(self.class.route_regex)
+            match ? match[:feature_name] : nil
+          end
+        end
+        private :feature_name
+      end
+
       extend Forwardable
 
       VALID_REQUEST_METHOD_NAMES = Set.new([
@@ -21,7 +31,17 @@ module Flipper
       #
       # Returns nothing.
       def self.route(regex)
-        @regex = regex
+        @route_regex = regex
+      end
+
+      # Internal: Does this action's route match the path.
+      def self.route_match?(path)
+        path.match(route_regex)
+      end
+
+      # Internal: The regex that matches which routes this action will work for.
+      def self.route_regex
+        @route_regex || raise("#{name}.route is not set")
       end
 
       # Internal: Initializes and runs an action for a given request.
@@ -34,11 +54,6 @@ module Flipper
         new(flipper, request).run
       end
 
-      # Internal: The regex that matches which routes this action will work for.
-      def self.regex
-        @regex || raise("#{name}.route is not set")
-      end
-
       # Private: The path to the views folder.
       def self.views_path
         @views_path ||= Flipper::UI.root.join('views')

data/lib/flipper/ui/action_collection.rb

@@ -12,7 +12,7 @@ module Flipper
 
       def action_for_request(request)
         @action_classes.detect do |action_class|
-          request.path_info =~ action_class.regex
+          action_class.route_match?(request.path_info)
         end
       end
     end

data/lib/flipper/ui/actions/actors_gate.rb

@@ -6,11 +6,12 @@ module Flipper
   module UI
     module Actions
       class ActorsGate < UI::Action
-        route %r{features/[^/]*/actors/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)/actors/?\Z}
 
         def get
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
           breadcrumb 'Home', '/'
@@ -22,8 +23,7 @@ module Flipper
         end
 
         def post
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           value = params['value'].to_s.strip
 
           if Util.blank?(value)

data/lib/flipper/ui/actions/add_feature.rb

@@ -5,7 +5,7 @@ module Flipper
   module UI
     module Actions
       class AddFeature < UI::Action
-        route %r{features/new/?\Z}
+        route %r{\A/features/new/?\Z}
 
         def get
           unless Flipper::UI.configuration.feature_creation_enabled

data/lib/flipper/ui/actions/boolean_gate.rb

@@ -5,11 +5,12 @@ module Flipper
   module UI
     module Actions
       class BooleanGate < UI::Action
-        route %r{features/[^/]*/boolean/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)/boolean/?\Z}
 
         def post
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
           if params['action'] == 'Enable'

data/lib/flipper/ui/actions/feature.rb

@@ -5,10 +5,11 @@ module Flipper
   module UI
     module Actions
       class Feature < UI::Action
-        route %r{features/[^/]*/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)\Z}
 
         def get
-          feature_name = Rack::Utils.unescape(request.path.split('/').last)
           @feature = Decorators::Feature.new(flipper[feature_name])
           @page_title = "#{@feature.key} // Features"
           @percentages = [0, 1, 5, 10, 15, 25, 50, 75, 100]
@@ -30,7 +31,6 @@ module Flipper
             halt view_response(:feature_removal_disabled)
           end
 
-          feature_name = Rack::Utils.unescape(request.path.split('/').last)
           feature = flipper[feature_name]
           feature.remove
           redirect_to '/features'

data/lib/flipper/ui/actions/features.rb

@@ -6,7 +6,7 @@ module Flipper
   module UI
     module Actions
       class Features < UI::Action
-        route %r{features/?\Z}
+        route %r{\A/features/?\Z}
 
         def get
           @page_title = 'Features'

data/lib/flipper/ui/actions/groups_gate.rb

@@ -5,11 +5,12 @@ module Flipper
   module UI
     module Actions
       class GroupsGate < UI::Action
-        route %r{features/[^/]*/groups/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)/groups/?\Z}
 
         def get
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
           breadcrumb 'Home', '/'
@@ -21,8 +22,7 @@ module Flipper
         end
 
         def post
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           value = params['value'].to_s.strip
 
           if Flipper.group_exists?(value)

data/lib/flipper/ui/actions/home.rb

@@ -5,7 +5,7 @@ module Flipper
   module UI
     module Actions
       class Home < UI::Action
-        route %r{/?\Z}
+        route %r{\A/?\Z}
 
         def get
           redirect_to '/features'

data/lib/flipper/ui/actions/percentage_of_actors_gate.rb

@@ -5,11 +5,12 @@ module Flipper
   module UI
     module Actions
       class PercentageOfActorsGate < UI::Action
-        route %r{features/[^/]*/percentage_of_actors/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)/percentage_of_actors/?\Z}
 
         def post
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
           begin

data/lib/flipper/ui/actions/percentage_of_time_gate.rb

@@ -5,11 +5,12 @@ module Flipper
   module UI
     module Actions
       class PercentageOfTimeGate < UI::Action
-        route %r{features/[^/]*/percentage_of_time/?\Z}
+        include FeatureNameFromRoute
+
+        route %r{\A/features/(?<feature_name>.*)/percentage_of_time/?\Z}
 
         def post
-          feature_name = Rack::Utils.unescape(request.path.split('/')[-2])
-          feature = flipper[feature_name.to_sym]
+          feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
           begin

data/lib/flipper/ui/middleware.rb

@@ -17,13 +17,12 @@ module Flipper
 
         # UI
         @action_collection.add UI::Actions::AddFeature
-        @action_collection.add UI::Actions::Feature
         @action_collection.add UI::Actions::ActorsGate
         @action_collection.add UI::Actions::GroupsGate
         @action_collection.add UI::Actions::BooleanGate
         @action_collection.add UI::Actions::PercentageOfTimeGate
         @action_collection.add UI::Actions::PercentageOfActorsGate
-        @action_collection.add UI::Actions::Gate
+        @action_collection.add UI::Actions::Feature
         @action_collection.add UI::Actions::Features
 
         # Static Assets/Files

data/lib/flipper/ui/views/feature.erb

@@ -14,7 +14,7 @@
         </h4>
         <div class="card-body">
           <p>
-            <% if @feature.on? %>
+            <% if @feature.boolean_value %>
               The feature is enabled for <strong>everyone</strong>. Disable this feature with one click.
             <% else %>
               Enable or disable this feature for <strong>everyone</strong> with one click.
@@ -24,7 +24,7 @@
           <form action="<%= script_name %>/features/<%= @feature.key %>/boolean" method="post">
             <%== csrf_input_tag %>
 
-            <% unless @feature.on? %>
+            <% unless @feature.boolean_value %>
               <button type="submit" name="action" value="Enable" class="btn btn-danger" data-toggle="tooltip" title="Enable for everyone">Enable</button>
             <% end %>
 

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.15.0'.freeze
+  VERSION = '0.16.0'.freeze
 end

data/spec/flipper/ui/actions/actors_gate_spec.rb

@@ -27,6 +27,21 @@ RSpec.describe Flipper::UI::Actions::ActorsGate do
     end
   end
 
+  describe 'GET /features/:feature/actors with slash in feature name' do
+    before do
+      get 'features/a/b/actors'
+    end
+
+    it 'responds with success' do
+      expect(last_response.status).to be(200)
+    end
+
+    it 'renders add new actor form' do
+      form = '<form action="/features/a/b/actors" method="post" class="form-inline">'
+      expect(last_response.body).to include(form)
+    end
+  end
+
   describe 'POST /features/:feature/actors' do
     context 'enabling an actor' do
       let(:value) { 'User:6' }

data/spec/flipper/ui/actions/feature_spec.rb

@@ -107,4 +107,24 @@ RSpec.describe Flipper::UI::Actions::Feature do
       expect(last_response.body).to include('Percentage of Actors')
     end
   end
+
+  describe 'GET /features/:feature with slash in feature name' do
+    before do
+      get '/features/a/b'
+    end
+
+    it 'responds with success' do
+      expect(last_response.status).to be(200)
+    end
+
+    it 'renders template' do
+      expect(last_response.body).to include('a/b')
+      expect(last_response.body).to include('Enable')
+      expect(last_response.body).to include('Disable')
+      expect(last_response.body).to include('Actors')
+      expect(last_response.body).to include('Groups')
+      expect(last_response.body).to include('Percentage of Time')
+      expect(last_response.body).to include('Percentage of Actors')
+    end
+  end
 end

data/spec/flipper/ui/decorators/feature_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'flipper/adapters/memory'
 
 RSpec.describe Flipper::UI::Decorators::Feature do
   let(:source)  { {} }

data/spec/flipper/ui/decorators/gate_spec.rb

@@ -1,5 +1,4 @@
 require 'helper'
-require 'flipper/adapters/memory'
 require 'flipper/ui/decorators/gate'
 
 RSpec.describe Flipper::UI::Decorators::Gate do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +103,6 @@ files:
 - lib/flipper/ui/actions/feature.rb
 - lib/flipper/ui/actions/features.rb
 - lib/flipper/ui/actions/file.rb
-- lib/flipper/ui/actions/gate.rb
 - lib/flipper/ui/actions/groups_gate.rb
 - lib/flipper/ui/actions/home.rb
 - lib/flipper/ui/actions/percentage_of_actors_gate.rb
@@ -259,7 +258,6 @@ files:
 - spec/flipper/ui/actions/feature_spec.rb
 - spec/flipper/ui/actions/features_spec.rb
 - spec/flipper/ui/actions/file_spec.rb
-- spec/flipper/ui/actions/gate_spec.rb
 - spec/flipper/ui/actions/groups_gate_spec.rb
 - spec/flipper/ui/actions/home_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb
@@ -272,7 +270,8 @@ files:
 homepage: https://github.com/jnunemaker/flipper
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/jnunemaker/flipper/blob/master/Changelog.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -301,7 +300,6 @@ test_files:
 - spec/flipper/ui/actions/feature_spec.rb
 - spec/flipper/ui/actions/features_spec.rb
 - spec/flipper/ui/actions/file_spec.rb
-- spec/flipper/ui/actions/gate_spec.rb
 - spec/flipper/ui/actions/groups_gate_spec.rb
 - spec/flipper/ui/actions/home_spec.rb
 - spec/flipper/ui/actions/percentage_of_actors_gate_spec.rb

data/lib/flipper/ui/actions/gate.rb

@@ -1,39 +0,0 @@
-require 'flipper/ui/action'
-require 'flipper/ui/decorators/feature'
-
-module Flipper
-  module UI
-    module Actions
-      class Gate < UI::Action
-        route %r{features/[^/]*/[^/]*/?\Z}
-
-        def post
-          feature_name, gate_name = request.path.split('/').pop(2)
-                                           .map(&Rack::Utils.method(:unescape))
-          update_gate_method_name = "update_#{gate_name}"
-
-          feature = flipper[feature_name.to_sym]
-          @feature = Decorators::Feature.new(feature)
-
-          if respond_to?(update_gate_method_name, true)
-            send(update_gate_method_name, feature)
-          else
-            update_gate_method_undefined(gate_name)
-          end
-
-          redirect_to "/features/#{@feature.key}"
-        end
-
-        private
-
-        # Private: Returns error response that gate update method is not defined.
-        def update_gate_method_undefined(gate_name)
-          error = Rack::Utils.escape(
-            "#{gate_name.inspect} gate does not exist therefore it cannot be updated."
-          )
-          redirect_to("/features/#{@feature.key}?error=#{error}")
-        end
-      end
-    end
-  end
-end

data/spec/flipper/ui/actions/gate_spec.rb

@@ -1,37 +0,0 @@
-require 'helper'
-
-RSpec.describe Flipper::UI::Actions::Gate do
-  let(:token) do
-    if Rack::Protection::AuthenticityToken.respond_to?(:random_token)
-      Rack::Protection::AuthenticityToken.random_token
-    else
-      'a'
-    end
-  end
-  let(:session) do
-    { :csrf => token, 'csrf' => token, '_csrf_token' => token }
-  end
-
-  describe 'POST /features/:feature/non-existent-gate' do
-    before do
-      post '/features/search/non-existent-gate',
-           { 'authenticity_token' => token },
-           'rack.session' => session
-    end
-
-    it 'responds with redirect' do
-      expect(last_response.status).to be(302)
-    end
-
-    # rubocop:disable Metrics/LineLength
-    it 'escapes error message' do
-      expect(last_response.headers['Location']).to eq('/features/search?error=%22non-existent-gate%22+gate+does+not+exist+therefore+it+cannot+be+updated.')
-    end
-    # rubocop:enable Metrics/LineLength
-
-    it 'renders error in template' do
-      follow_redirect!
-      expect(last_response.body).to match(/non-existent-gate.*gate does not exist/)
-    end
-  end
-end