flipper-ui 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c01a5710e8e8c432d0fa8bfd515b75ff75303fdfae89a03a17fd2d0d93506497
-  data.tar.gz: 36727960c77afaaf1232575824d1c24cf06e1e56bbd59b302e1c0c0f0b9a0031
+  metadata.gz: a12462296a49980315b89c5292f35db1ee3725103f9f5d74bfad27b46566847d
+  data.tar.gz: c18ce3fbdda93706f31a9216133e3f7db0b8fdc653734e9f5c53e58b737535c6
 SHA512:
-  metadata.gz: 163424980f5684d3ba00682fef0b3b50a2bd565f45751bf3f7daa06af8cfd5b1246ea4a76d509edd8a0bdf9d136a7ab583369db8e7578bc07eb903fa5d3949bb
-  data.tar.gz: c54c31ebe8cceb4859abfa9feaefb38eed81f6d1396fda01baccc561bbf4cc3f20fd6c9807ae27d3888ef7343cf3ce95e693ffbaffd3ec267b69271c4c877e34
+  metadata.gz: 3abfd1c41c26090ab35f4d140eb016b2a3537563f6e5bf31b230dc8187d22f7ae8c2955a255d08c33a6f5f06c38a17b917db022997f3a4f1b9f48a7e27b060db
+  data.tar.gz: a24a6e6e614e42f36fcbba8d072cab5cc0dab7cef19dac2199925566e79b76ba091bc043741dcf13fd8a2e0dbc683540e1160853c2c4193e7ef825c60a645ae1

data/examples/ui/basic.ru

@@ -46,6 +46,8 @@ Flipper::UI.configure do |config|
       '6' => '<a href="https://opensoul.org">Brandon</a>',
     }
   end
+
+  config.application_href = "https://example.com"
 end
 
 # You can uncomment these to get some default data:
@@ -63,5 +65,6 @@ end
 use Rack::Reloader
 
 run Flipper::UI.app { |builder|
+  builder.use Rack::Reloader, 1
   builder.use Rack::Session::Cookie, secret: "_super_secret"
 }

data/flipper-ui.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'rack', '>= 1.4', '< 4'
-  gem.add_dependency 'rack-protection', '>= 1.5.3', '<= 4.0.0'
+  gem.add_dependency 'rack-protection', '>= 1.5.3', '<5.0.0'
+  gem.add_dependency 'rack-session', '>= 1.0.2', '< 3.0.0'
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
   gem.add_dependency 'erubi', '>= 1.0.0', '< 2.0.0'
   gem.add_dependency 'sanitize', '< 7'

data/lib/flipper/ui/action.rb

@@ -27,24 +27,7 @@ module Flipper
                                              'delete'.freeze,
                                            ]).freeze
 
-      SOURCES = {
-        bootstrap_css: {
-          src: '/css/bootstrap-4.6.0.min.css'.freeze,
-          hash: 'sha384-B0vP5xmATw1+K9KRQjQERJvTumQW0nPEzvF6L/Z6nronJ3oUOFUFpCjEUQouq2+l'.freeze
-        }.freeze,
-        jquery_js: {
-          src: '/js/jquery-3.6.0.slim.js'.freeze,
-          hash: 'sha256-HwWONEZrpuoh951cQD1ov2HUK5zA5DwJ1DNUXaM6FsY='.freeze
-        }.freeze,
-        popper_js: {
-          src: '/js/popper-1.12.9.min.js'.freeze,
-          hash: 'sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q'.freeze
-        }.freeze,
-        bootstrap_js: {
-          src: '/js/bootstrap-4.6.0.min.js'.freeze,
-          hash: 'sha384-+YQ4JLhjyBLPDQt//I+STsc9iw4uQqACwlvpslubQzn4u2UU2UFM80nGisd026JF'.freeze
-        }.freeze
-      }.freeze
+      SOURCES = JSON.parse(File.read(File.expand_path('sources.json', __dir__))).freeze
       CONTENT_SECURITY_POLICY = <<-CSP.delete("\n")
         default-src 'none';
         img-src 'self';
@@ -110,12 +93,6 @@ module Flipper
         @request = request
         @code = 200
         @headers = {Rack::CONTENT_TYPE => 'text/plain'}
-        @breadcrumbs =
-          if Flipper::UI.configuration.application_breadcrumb_href
-            [Breadcrumb.new('App', Flipper::UI.configuration.application_breadcrumb_href)]
-          else
-            []
-          end
       end
 
       # Public: Runs the request method for the provided request.
@@ -219,16 +196,6 @@ module Flipper
         end
       end
 
-      # Public: Add a breadcrumb to the trail.
-      #
-      # text - The String text for the breadcrumb.
-      # href - The String href for the anchor tag (optional). If nil, breadcrumb
-      #        is assumed to be the end of the trail.
-      def breadcrumb(text, href = nil)
-        breadcrumb_href = href.nil? ? href : "#{script_name}#{href}"
-        @breadcrumbs << Breadcrumb.new(text, breadcrumb_href)
-      end
-
       # Private
       def view_with_layout(&block)
         view :layout, &block
@@ -252,6 +219,16 @@ module Flipper
         request.env['SCRIPT_NAME']
       end
 
+      # Internal: Generate urls relative to the app's script name.
+      #
+      #   url_for("feature")             # => "http://localhost:9292/flipper/feature"
+      #   url_for("/thing")              # => "http://localhost:9292/thing"
+      #   url_for("https://example.com") # => "https://example.com"
+      #
+      def url_for(*parts)
+        URI.join(request.base_url, script_name + '/', *parts).to_s
+      end
+
       # Private
       def views_path
         self.class.views_path
@@ -279,11 +256,6 @@ module Flipper
       # to inform people of that fact.
       def render_read_only
         status 403
-
-        breadcrumb 'Home', '/'
-        breadcrumb 'Features', '/features'
-        breadcrumb 'Noooooope'
-
         halt view_response(:read_only)
       end
 
@@ -296,19 +268,23 @@ module Flipper
       end
 
       def bootstrap_css
-        SOURCES[:bootstrap_css]
+        asset_hash "/css/bootstrap.min.css"
       end
 
       def bootstrap_js
-        SOURCES[:bootstrap_js]
+        asset_hash "/js/bootstrap.min.js"
       end
 
       def popper_js
-        SOURCES[:popper_js]
+        asset_hash "/js/popper.min.js"
       end
 
-      def jquery_js
-        SOURCES[:jquery_js]
+      def asset_hash(src)
+        v = ENV["RACK_ENV"] == "development" ? Time.now.to_i : Flipper::VERSION
+        {
+          src: "#{src}?v=#{v}",
+          hash: SOURCES[src]
+        }
       end
     end
   end

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

@@ -13,12 +13,6 @@ module Flipper
         def get
           feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
-
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key, "/features/#{@feature.key}"
-          breadcrumb 'Add Actor'
-
           view_response :add_actor
         end
 

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

@@ -12,18 +12,9 @@ module Flipper
 
           unless Flipper::UI.configuration.feature_creation_enabled
             status 403
-
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-            breadcrumb 'Noooooope'
-
             halt view_response(:feature_creation_disabled)
           end
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb 'Add'
-
           view_response :add_feature
         end
       end

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

@@ -18,10 +18,6 @@ module Flipper
           @page_title = "#{@feature.key} // Features"
           @percentages = [0, 1, 5, 10, 25, 50, 100]
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key
-
           view_response :feature
         end
 
@@ -31,9 +27,6 @@ module Flipper
           unless Flipper::UI.configuration.feature_removal_enabled
             status 403
 
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-
             halt view_response(:feature_removal_disabled)
           end
 

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

@@ -29,9 +29,6 @@ module Flipper
 
           @show_blank_slate = @features.empty?
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features'
-
           view_response :features
         end
 
@@ -41,10 +38,6 @@ module Flipper
           unless Flipper::UI.configuration.feature_creation_enabled
             status 403
 
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-            breadcrumb 'Noooooope'
-
             halt view_response(:feature_creation_disabled)
           end
 

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

@@ -13,11 +13,6 @@ module Flipper
           feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key, "/features/#{@feature.key}"
-          breadcrumb 'Add Group'
-
           view_response :add_group
         end
 

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

@@ -10,9 +10,6 @@ module Flipper
         def get
           @page_title = 'Settings'
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Settings'
-
           view_response :settings
         end
       end

data/lib/flipper/ui/configuration.rb

@@ -13,10 +13,20 @@ module Flipper
       # (feature_creation_enabled and feature_removal_enabled).
       attr_accessor :read_only
 
-      # Public: If you set this, the UI will always have a first breadcrumb that
+      # Public: If you set this, the UI will always have a first nav item 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
+      attr_accessor :application_href
+      alias_method :application_breadcrumb_href, :application_href
+      alias_method :application_breadcrumb_href=, :application_href=
+
+      # Public: An array of nav items to show. By default "Features" and
+      # "Settings" are shown, but you can add your own. Each item must have
+      # a `:title` and `:href` key:
+      #
+      #   config.nav_items << { title: "Custom", href: "/custom/page" }
+      #
+      attr_accessor :nav_items
 
       # Public: Is feature creation allowed from the UI? Defaults to true. If
       # set to false, users of the UI cannot create features. All feature
@@ -97,6 +107,10 @@ module Flipper
         @confirm_fully_enable = false
         @confirm_disable = true
         @read_only = false
+        @nav_items = [
+          { title: "Features", href: "features" },
+          { title: "Settings", href: "settings" },
+        ]
       end
 
       def using_descriptions?