flipper-ui 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 287ca4de5728ae295a451e19f1daf54d24caa66c
-  data.tar.gz: 7ce801bbfb74119adb2fbbdaa951b91365710382
+  metadata.gz: 6588ef43bcee1f02024cf32085148eae82ffa9f4
+  data.tar.gz: fd986a24960b953f56510bb5b96a18373276f628
 SHA512:
-  metadata.gz: e75f14c2b6eb333719a420d95f27ecabe42dce4ad624145538c84545942c3b6b9457a00bd941a4430bddf5a26918a8d74440c6be5792d60d727266cd0aa8d57d
-  data.tar.gz: 69ed93ab1893bd4fec27656db5dda9728830089c4f4708b318c1d23e584d19ca03e1ce53c2bab4e930fafc653e55fa80dcf5f1c2ea6cfc612ef814c2b776aebd
+  metadata.gz: b4f66474ac658466d3a2a87e67f8c4168935457e1a62d9da3cb8d9891ec50864956cb5a800529bc757a1f879ba943da691c62b5565dffbbd2e32ad1e584a1bf6
+  data.tar.gz: f0ca4057925cb29dcd2b08116751b71900037cf6319520056a1f5da7a5ef0b559c93e8d84ff36127c0bb8742cd4ee06443f68bea3d47ad52d8bf48de4ca0b2f9

data/lib/flipper/ui.rb

@@ -17,27 +17,26 @@ require 'flipper/ui/configuration'
 module Flipper
   module UI
     class << self
-      # Public: If you set this, the UI will always have a first breadcrumb that
-      # says "App" which points to this href. The href can be a path (ie: "/")
-      # or full url ("https://app.example.com/").
-      attr_accessor :application_breadcrumb_href
+      # These three configuration options have been moved to Flipper::UI::Configuration
+      deprecated_configuration_options = %w(application_breadcrumb_href
+                                            feature_creation_enabled
+                                            feature_removal_enabled)
+      deprecated_configuration_options.each do |attribute_name|
+        send(:define_method, "#{attribute_name}=".to_sym) do
+          raise ConfigurationDeprecated, "The UI configuration for #{attribute_name} has " \
+            "deprecated. This configuration option has moved to Flipper::UI::Configuration"
+        end
 
-      # Public: Is feature creation allowed from the UI? Defaults to true. If
-      # set to false, users of the UI cannot create features. All feature
-      # creation will need to be done through the configured flipper instance.
-      attr_accessor :feature_creation_enabled
-
-      # Public: Is feature deletion allowed from the UI? Defaults to true. If
-      # set to false, users won't be able to delete features from the UI.
-      attr_accessor :feature_removal_enabled
+        send(:define_method, attribute_name.to_sym) do
+          raise ConfigurationDeprecated, "The UI configuration for #{attribute_name} has " \
+            "deprecated. This configuration option has moved to Flipper::UI::Configuration"
+        end
+      end
 
       # Public: Set attributes on this instance to customize UI text
       attr_reader :configuration
     end
 
-    self.feature_creation_enabled = true
-    self.feature_removal_enabled = true
-
     def self.root
       @root ||= Pathname(__FILE__).dirname.expand_path.join('ui')
     end

data/lib/flipper/ui/action.rb

@@ -65,8 +65,8 @@ module Flipper
         @code = 200
         @headers = { 'Content-Type' => 'text/plain' }
         @breadcrumbs =
-          if Flipper::UI.application_breadcrumb_href
-            [Breadcrumb.new('App', Flipper::UI.application_breadcrumb_href)]
+          if Flipper::UI.configuration.application_breadcrumb_href
+            [Breadcrumb.new('App', Flipper::UI.configuration.application_breadcrumb_href)]
           else
             []
           end

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

@@ -8,7 +8,7 @@ module Flipper
         route %r{features/new/?\Z}
 
         def get
-          unless Flipper::UI.feature_creation_enabled
+          unless Flipper::UI.configuration.feature_creation_enabled
             status 403
 
             breadcrumb 'Home', '/'

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

@@ -21,7 +21,7 @@ module Flipper
         end
 
         def delete
-          unless Flipper::UI.feature_removal_enabled
+          unless Flipper::UI.configuration.feature_removal_enabled
             status 403
 
             breadcrumb 'Home', '/'

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

@@ -23,7 +23,7 @@ module Flipper
         end
 
         def post
-          unless Flipper::UI.feature_creation_enabled
+          unless Flipper::UI.configuration.feature_creation_enabled
             status 403
 
             breadcrumb 'Home', '/'

data/lib/flipper/ui/configuration.rb

@@ -12,6 +12,20 @@ module Flipper
       attr_accessor :banner_text,
                     :banner_class
 
+      # Public: If you set this, the UI will always have a first breadcrumb that
+      # says "App" which points to this href. The href can be a path (ie: "/")
+      # or full url ("https://app.example.com/").
+      attr_accessor :application_breadcrumb_href
+
+      # Public: Is feature creation allowed from the UI? Defaults to true. If
+      # set to false, users of the UI cannot create features. All feature
+      # creation will need to be done through the configured flipper instance.
+      attr_accessor :feature_creation_enabled
+
+      # Public: Is feature deletion allowed from the UI? Defaults to true. If
+      # set to false, users won't be able to delete features from the UI.
+      attr_accessor :feature_removal_enabled
+
       VALID_BANNER_CLASS_VALUES = %w(
         danger
         dark
@@ -31,6 +45,8 @@ module Flipper
         @delete = Option.new("Danger Zone", "Deleting a feature removes it from the list of features and disables it for everyone.") # rubocop:disable Metrics/LineLength
         @banner_text = nil
         @banner_class = 'danger'
+        @feature_creation_enabled = true
+        @feature_removal_enabled = true
       end
 
       def banner_class=(value)

data/lib/flipper/ui/middleware.rb

@@ -16,7 +16,6 @@ module Flipper
         @action_collection = ActionCollection.new
 
         # UI
-        @action_collection.add UI::Actions::Features
         @action_collection.add UI::Actions::AddFeature
         @action_collection.add UI::Actions::Feature
         @action_collection.add UI::Actions::ActorsGate
@@ -25,6 +24,7 @@ module Flipper
         @action_collection.add UI::Actions::PercentageOfTimeGate
         @action_collection.add UI::Actions::PercentageOfActorsGate
         @action_collection.add UI::Actions::Gate
+        @action_collection.add UI::Actions::Features
 
         # Static Assets/Files
         @action_collection.add UI::Actions::File

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

@@ -229,7 +229,7 @@
     </div>
   </div>
 
-  <% if Flipper::UI.feature_removal_enabled %>
+  <% if Flipper::UI.configuration.feature_removal_enabled %>
   <div class="row">
     <div class="col">
       <div class="card border-danger">

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

@@ -1,3 +1,3 @@
 <div class="alert alert-danger">
-  Feature creation is disabled. To enable, you'll need to set <code>Flipper::UI.feature_creation_enabled = true</code> wherever flipper is running from.
+  Feature creation is disabled. To enable, you'll need to set <code>Flipper::UI.configuration.feature_creation_enabled = true</code> wherever flipper is running from.
 </div>

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

@@ -1,3 +1,3 @@
 <div class="alert alert-danger">
-  Feature removal from the UI is disabled. To enable, you'll need to set <code>Flipper::UI.feature_removal_enabled = true</code> wherever flipper is running from.
+  Feature removal from the UI is disabled. To enable, you'll need to set <code>Flipper::UI.configuration.feature_removal_enabled = true</code> wherever flipper is running from.
 </div>

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

@@ -35,7 +35,7 @@
             </li>
           <% end %>
           <li class="ml-auto">
-            <%- if Flipper::UI.feature_creation_enabled -%>
+            <%- if Flipper::UI.configuration.feature_creation_enabled -%>
               <a class="btn btn-sm btn-light" href="<%= script_name %>/features/new">Add Feature</a>
             <%- end -%>
           </li>

data/lib/flipper/version.rb

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

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

@@ -3,13 +3,13 @@ require 'helper'
 RSpec.describe Flipper::UI::Actions::AddFeature do
   describe 'GET /features/new with feature_creation_enabled set to true' do
     before do
-      @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled
-      Flipper::UI.feature_creation_enabled = true
+      @original_feature_creation_enabled = Flipper::UI.configuration.feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = true
       get '/features/new'
     end
 
     after do
-      Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = @original_feature_creation_enabled
     end
 
     it 'responds with success' do
@@ -24,13 +24,13 @@ RSpec.describe Flipper::UI::Actions::AddFeature do
 
   describe 'GET /features/new with feature_creation_enabled set to false' do
     before do
-      @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled
-      Flipper::UI.feature_creation_enabled = false
+      @original_feature_creation_enabled = Flipper::UI.configuration.feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = false
       get '/features/new'
     end
 
     after do
-      Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = @original_feature_creation_enabled
     end
 
     it 'returns 403' do

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

@@ -32,11 +32,11 @@ RSpec.describe Flipper::UI::Actions::Feature do
     context 'when feature_removal_enabled is set to false' do
       around do |example|
         begin
-          @original_feature_removal_enabled = Flipper::UI.feature_removal_enabled
-          Flipper::UI.feature_removal_enabled = false
+          @original_feature_removal_enabled = Flipper::UI.configuration.feature_removal_enabled
+          Flipper::UI.configuration.feature_removal_enabled = false
           example.run
         ensure
-          Flipper::UI.feature_removal_enabled = @original_feature_removal_enabled
+          Flipper::UI.configuration.feature_removal_enabled = @original_feature_removal_enabled
         end
       end
 
@@ -87,4 +87,24 @@ RSpec.describe Flipper::UI::Actions::Feature do
       expect(last_response.body).to include('Percentage of Actors')
     end
   end
+
+  describe 'GET /features/:feature with _features in feature name' do
+    before do
+      get '/features/search_features'
+    end
+
+    it 'responds with success' do
+      expect(last_response.status).to be(200)
+    end
+
+    it 'renders template' do
+      expect(last_response.body).to include('search_features')
+      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/actions/features_spec.rb

@@ -33,15 +33,15 @@ RSpec.describe Flipper::UI::Actions::Features do
     let(:feature_name) { 'notifications_next' }
 
     before do
-      @original_feature_creation_enabled = Flipper::UI.feature_creation_enabled
-      Flipper::UI.feature_creation_enabled = feature_creation_enabled
+      @original_feature_creation_enabled = Flipper::UI.configuration.feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = feature_creation_enabled
       post '/features',
            { 'value' => feature_name, 'authenticity_token' => token },
            'rack.session' => session
     end
 
     after do
-      Flipper::UI.feature_creation_enabled = @original_feature_creation_enabled
+      Flipper::UI.configuration.feature_creation_enabled = @original_feature_creation_enabled
     end
 
     context 'feature_creation_enabled set to true' do

data/spec/flipper/ui/configuration_spec.rb

@@ -69,4 +69,37 @@ RSpec.describe Flipper::UI::Configuration do
         .to raise_error(Flipper::InvalidConfigurationValue)
     end
   end
+
+  describe "#application_breadcrumb_href" do
+    it "has default value" do
+      expect(configuration.application_breadcrumb_href).to eq(nil)
+    end
+
+    it "can be updated" do
+      configuration.application_breadcrumb_href = 'http://www.myapp.com'
+      expect(configuration.application_breadcrumb_href).to eq('http://www.myapp.com')
+    end
+  end
+
+  describe "#feature_creation_enabled" do
+    it "has default value" do
+      expect(configuration.feature_creation_enabled).to eq(true)
+    end
+
+    it "can be updated" do
+      configuration.feature_creation_enabled = false
+      expect(configuration.feature_creation_enabled).to eq(false)
+    end
+  end
+
+  describe "#feature_removal_enabled" do
+    it "has default value" do
+      expect(configuration.feature_removal_enabled).to eq(true)
+    end
+
+    it "can be updated" do
+      configuration.feature_removal_enabled = false
+      expect(configuration.feature_removal_enabled).to eq(false)
+    end
+  end
 end

data/spec/flipper/ui_spec.rb

@@ -11,6 +11,7 @@ RSpec.describe Flipper::UI do
   let(:session) do
     { :csrf => token, 'csrf' => token, '_csrf_token' => token }
   end
+  let(:configuration) { described_class.configuration }
 
   describe 'Initializing middleware with flipper instance' do
     let(:app) { build_app(flipper) }
@@ -59,91 +60,24 @@ RSpec.describe Flipper::UI do
     expect(last_response.headers['Location']).to eq('/features/refactor-images')
   end
 
-  it 'does not have an application_breadcrumb_href by default' do
-    expect(described_class.application_breadcrumb_href).to be(nil)
-  end
-
-  context 'with application_breadcrumb_href not set' do
-    before do
-      @original_application_breadcrumb_href = described_class.application_breadcrumb_href
-      described_class.application_breadcrumb_href = nil
-    end
-
-    after do
-      described_class.application_breadcrumb_href = @original_application_breadcrumb_href
-    end
-
-    it 'does not add App breadcrumb' do
-      get '/features'
-      expect(last_response.body).not_to include('<a href="/myapp">App</a>')
+  describe "application_breadcrumb_href" do
+    it "raises an exception since it is deprecated" do
+      expect { described_class.application_breadcrumb_href }
+        .to raise_error(Flipper::ConfigurationDeprecated)
     end
   end
 
-  context 'with application_breadcrumb_href set' do
-    before do
-      @original_application_breadcrumb_href = described_class.application_breadcrumb_href
-      described_class.application_breadcrumb_href = '/myapp'
-    end
-
-    after do
-      described_class.application_breadcrumb_href = @original_application_breadcrumb_href
-    end
-
-    it 'does add App breadcrumb' do
-      get '/features'
-      expect(last_response.body).to include('<a href="/myapp">App</a>')
+  describe "feature_creation_enabled" do
+    it "raises an exception since it is deprecated" do
+      expect { described_class.feature_creation_enabled }
+        .to raise_error(Flipper::ConfigurationDeprecated)
     end
   end
 
-  context 'with application_breadcrumb_href set to full url' do
-    before do
-      @original_application_breadcrumb_href = described_class.application_breadcrumb_href
-      described_class.application_breadcrumb_href = 'https://myapp.com/'
-    end
-
-    after do
-      described_class.application_breadcrumb_href = @original_application_breadcrumb_href
-    end
-
-    it 'does add App breadcrumb' do
-      get '/features'
-      expect(last_response.body).to include('<a href="https://myapp.com/">App</a>')
-    end
-  end
-
-  it 'sets feature_creation_enabled to true by default' do
-    expect(described_class.feature_creation_enabled).to be(true)
-  end
-
-  context 'with feature_creation_enabled set to true' do
-    before do
-      @original_feature_creation_enabled = described_class.feature_creation_enabled
-      described_class.feature_creation_enabled = true
-    end
-
-    it 'has the add_feature button' do
-      get '/features'
-      expect(last_response.body).to include('Add Feature')
-    end
-
-    after do
-      described_class.feature_creation_enabled = @original_feature_creation_enabled
-    end
-  end
-
-  context 'with feature_creation_enabled set to false' do
-    before do
-      @original_feature_creation_enabled = described_class.feature_creation_enabled
-      described_class.feature_creation_enabled = false
-    end
-
-    it 'does not have the add_feature button' do
-      get '/features'
-      expect(last_response.body).not_to include('Add Feature')
-    end
-
-    after do
-      described_class.feature_creation_enabled = @original_feature_creation_enabled
+  describe "feature_removal_enabled" do
+    it "raises an exception since it is deprecated" do
+      expect { described_class.feature_removal_enabled }
+        .to raise_error(Flipper::ConfigurationDeprecated)
     end
   end
 
@@ -177,5 +111,135 @@ RSpec.describe Flipper::UI do
         end
       end
     end
+
+    describe "application_breadcrumb_href" do
+      it 'does not have an application_breadcrumb_href by default' do
+        expect(configuration.application_breadcrumb_href).to be(nil)
+      end
+
+      context 'with application_breadcrumb_href not set' do
+        before do
+          @original_application_breadcrumb_href = configuration.application_breadcrumb_href
+          configuration.application_breadcrumb_href = nil
+        end
+
+        after do
+          configuration.application_breadcrumb_href = @original_application_breadcrumb_href
+        end
+
+        it 'does not add App breadcrumb' do
+          get '/features'
+          expect(last_response.body).not_to include('<a href="/myapp">App</a>')
+        end
+      end
+
+      context 'with application_breadcrumb_href set' do
+        before do
+          @original_application_breadcrumb_href = configuration.application_breadcrumb_href
+          configuration.application_breadcrumb_href = '/myapp'
+        end
+
+        after do
+          configuration.application_breadcrumb_href = @original_application_breadcrumb_href
+        end
+
+        it 'does add App breadcrumb' do
+          get '/features'
+          expect(last_response.body).to include('<a href="/myapp">App</a>')
+        end
+      end
+
+      context 'with application_breadcrumb_href set to full url' do
+        before do
+          @original_application_breadcrumb_href = configuration.application_breadcrumb_href
+          configuration.application_breadcrumb_href = 'https://myapp.com/'
+        end
+
+        after do
+          configuration.application_breadcrumb_href = @original_application_breadcrumb_href
+        end
+
+        it 'does add App breadcrumb' do
+          get '/features'
+          expect(last_response.body).to include('<a href="https://myapp.com/">App</a>')
+        end
+      end
+    end
+
+    describe "feature_creation_enabled" do
+      it 'sets feature_creation_enabled to true by default' do
+        expect(configuration.feature_creation_enabled).to be(true)
+      end
+
+      context 'with feature_creation_enabled set to true' do
+        before do
+          @original_feature_creation_enabled = configuration.feature_creation_enabled
+          configuration.feature_creation_enabled = true
+        end
+
+        it 'has the add_feature button' do
+          get '/features'
+          expect(last_response.body).to include('Add Feature')
+        end
+
+        after do
+          configuration.feature_creation_enabled = @original_feature_creation_enabled
+        end
+      end
+
+      context 'with feature_creation_enabled set to false' do
+        before do
+          @original_feature_creation_enabled = configuration.feature_creation_enabled
+          configuration.feature_creation_enabled = false
+        end
+
+        it 'does not have the add_feature button' do
+          get '/features'
+          expect(last_response.body).not_to include('Add Feature')
+        end
+
+        after do
+          configuration.feature_creation_enabled = @original_feature_creation_enabled
+        end
+      end
+    end
+
+    describe "feature_removal_enabled" do
+      it 'sets feature_removal_enabled to true by default' do
+        expect(configuration.feature_removal_enabled).to be(true)
+      end
+
+      context 'with feature_removal_enabled set to true' do
+        before do
+          @original_feature_removal_enabled = configuration.feature_removal_enabled
+          configuration.feature_removal_enabled = true
+        end
+
+        it 'has the add_feature button' do
+          get '/features/test'
+          expect(last_response.body).to include('Delete')
+        end
+
+        after do
+          configuration.feature_removal_enabled = @original_feature_removal_enabled
+        end
+      end
+
+      context 'with feature_removal_enabled set to false' do
+        before do
+          @original_feature_removal_enabled = configuration.feature_removal_enabled
+          configuration.feature_removal_enabled = false
+        end
+
+        it 'does not have the add_feature button' do
+          get '/features/test'
+          expect(last_response.body).not_to include('Delete')
+        end
+
+        after do
+          configuration.feature_removal_enabled = @original_feature_removal_enabled
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -289,7 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.4.5.4
 signing_key: 
 specification_version: 4
 summary: UI for the Flipper gem