flipper-ui 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535c19177c80d64f3874e491e6822ffe5cb82f8414e0ec71d29351cba342437f
-  data.tar.gz: a793c3179f888f8a5f427a40ec61cef1387ca09aa5fda81fd88d48ee00685ae1
+  metadata.gz: dd4963986e65fb20081d23374099f2a054df7e78a81e2571ad3640831b7d0d81
+  data.tar.gz: b94fc64dcf6752a2951c8c03bd6161c46e4850f206ebb049f4aa8b0a5b20e881
 SHA512:
-  metadata.gz: 1732f43d892f4cdff1731488c746099449ca11866d6cf0ba5382c68ff1ed7cc6039b9bd7744fe20602e0a9f74cf470ea2923d5258e639c19e591318a385ccc87
-  data.tar.gz: 737ae2c852886ec20a19a63ef5c9df628155c0301f30460ccf608f02e93c20a9caa6dbde7ef52d53275c798ab06cc63bdc55023a2ad6b955ae026a655f0f9558
+  metadata.gz: c46dbab449279c506b9d5ce1d2869392b8e4f0f6b8dab59b527b64a2acf25504cb5fb3e8af2e2601176f0f7c026afdf547196d197d4d0cfad0031e8a26f270bc
+  data.tar.gz: 95ed1aefbe02cdac6f8e938107a00a41e2e8754fa20351fa35948942557746d863d542c52b3993846828ce327b52aa4c151e1422997baea0e8099ff4c3580988

data/docs/ui/README.md

@@ -109,7 +109,7 @@ Minimal example for Rack:
 ```ruby
 # config.ru
 
-require 'flipper-ui'
+require 'flipper/ui'
 
 adapter = Flipper::Adapters::Memory.new
 flipper = Flipper.new(adapter)

data/examples/ui/authorization.ru

@@ -0,0 +1,84 @@
+#
+# Usage:
+#   bundle exec rackup examples/ui/authorization.ru -p 9999
+#   bundle exec shotgun examples/ui/authorization.ru -p 9999
+#   http://localhost:9999/
+#
+require 'bundler/setup'
+require "logger"
+
+require "flipper/ui"
+require "flipper/adapters/pstore"
+require "active_support/notifications"
+
+Flipper.register(:admins) { |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+}
+
+Flipper.register(:early_access) { |actor|
+  actor.respond_to?(:early?) && actor.early?
+}
+
+# Setup logging of flipper calls.
+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)
+
+Flipper::UI.configure do |config|
+  # config.banner_text = 'Production Environment'
+  # config.banner_class = 'danger'
+  config.feature_creation_enabled = true
+  config.feature_removal_enabled = true
+  # config.show_feature_description_in_list = true
+  config.descriptions_source = lambda do |_keys|
+    {
+      "search_performance_another_long_thing" => "Just to test feature name length.",
+      "gauges_tracking" => "Should we track page views with gaug.es.",
+      "unused" => "Not used.",
+      "suits" => "Are suits necessary in business?",
+      "secrets" => "Secrets are lies.",
+      "logging" => "Log all the things.",
+      "new_cache" => "Like the old cache but newer.",
+      "a/b" => "Why would someone use a slash? I don't know but someone did. Let's make this really long so they regret using slashes. Please don't use slashes.",
+    }
+  end
+end
+
+# Example middleware to allow reading the Flipper UI but nothing else.
+class FlipperReadOnlyMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+
+    if request.get?
+      @app.call(env)
+    else
+      [401, {}, ["You can only look"]]
+    end
+  end
+end
+
+# You can uncomment these to get some default data:
+# flipper[:search_performance_another_long_thing].enable
+# flipper[:gauges_tracking].enable
+# flipper[:unused].disable
+# flipper[:suits].enable_actor Flipper::Actor.new('1')
+# flipper[:suits].enable_actor Flipper::Actor.new('6')
+# flipper[:secrets].enable_group :admins
+# flipper[:secrets].enable_group :early_access
+# flipper[:logging].enable_percentage_of_time 5
+# flipper[:new_cache].enable_percentage_of_actors 15
+# flipper["something/slashed"].add
+
+run Flipper::UI.app(flipper) { |builder|
+  builder.use Rack::Session::Cookie, secret: "_super_secret"
+  builder.use FlipperReadOnlyMiddleware
+}

data/examples/ui/basic.ru

@@ -1,20 +1,16 @@
 #
 # Usage:
-#   bundle exec rackup examples/ui/basic.ru -p 9999
-#   bundle exec shotgun examples/ui/basic.ru -p 9999
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/ui/basic.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/ui/basic.ru -p 9999
+#
 #   http://localhost:9999/
 #
-require "pp"
-require "logger"
-require "pathname"
-
-root_path = Pathname(__FILE__).dirname.join("..").expand_path
-lib_path  = root_path.join("lib")
-$:.unshift(lib_path)
-
-require "flipper-ui"
+require 'bundler/setup'
+require "flipper/ui"
 require "flipper/adapters/pstore"
-require "active_support/notifications"
 
 Flipper.register(:admins) { |actor|
   actor.respond_to?(:admin?) && actor.admin?
@@ -24,21 +20,12 @@ Flipper.register(:early_access) { |actor|
   actor.respond_to?(:early?) && actor.early?
 }
 
-# Setup logging of flipper calls.
-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)
-
 Flipper::UI.configure do |config|
   # config.banner_text = 'Production Environment'
   # config.banner_class = 'danger'
   config.feature_creation_enabled = true
   config.feature_removal_enabled = true
+  config.cloud_recommendation = true
   # config.show_feature_description_in_list = true
   config.descriptions_source = lambda do |_keys|
     {
@@ -66,6 +53,6 @@ end
 # flipper[:new_cache].enable_percentage_of_actors 15
 # flipper["a/b"].add
 
-run Flipper::UI.app(flipper) { |builder|
+run Flipper::UI.app { |builder|
   builder.use Rack::Session::Cookie, secret: "_super_secret"
 }

data/lib/flipper/ui/configuration.rb

@@ -26,6 +26,10 @@ module Flipper
       # won't see a videoclip of Taylor Swift when there aren't any features
       attr_accessor :fun
 
+      # Public: Tired of seeing the awesome message about Cloud? Set this to
+      # false and it will go away. Defaults to true.
+      attr_accessor :cloud_recommendation
+
       # Public: What should show up in the form to add actors. This can be
       # different per application since flipper_id's can be whatever an
       # application needs. Defaults to "a flipper id".
@@ -60,6 +64,7 @@ module Flipper
         @feature_creation_enabled = true
         @feature_removal_enabled = true
         @fun = true
+        @cloud_recommendation = true
         @add_actor_placeholder = "a flipper id"
         @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
         @show_feature_description_in_list = false

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

@@ -1,5 +1,5 @@
 <% if @show_blank_slate %>
-  <div class="jumbotron text-center">
+  <div class="jumbotron text-center m-0">
     <% if Flipper::UI.configuration.fun %>
       <h4>But I've got a blank space baby...</h4>
       <p>And I'll flip your features.</p>

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

@@ -35,6 +35,21 @@
       <div>
         <%== yield %>
       </div>
+
+      <% if Flipper::UI.configuration.cloud_recommendation %>
+        <div class="d-flex justify-content-center mt-5">
+          <div class="row" style="max-width: 350px;">
+            <div class="col-auto d-flex align-items-center">
+              <a href="https://www.flippercloud.io/?utm_source=oss&utm_medium=ui&utm_campaign=spread_the_love">
+                <img src="<%= script_name %>/images/logo.png" width="50" />
+              </a>
+            </div>
+            <div class="col text-muted p-0">
+              <small>For support, audit history, finer-grained permissions, multi-environment sync, and all your projects in one place check out <a href="https://www.flippercloud.io/?utm_source=oss&utm_medium=ui&utm_campaign=spread_the_love">Flipper&nbsp;Cloud</a>.</small>
+            </div>
+          </div>
+        </div>
+      <% end %>
     </div>
 
     <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.2'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/spec/flipper/ui/configuration_spec.rb

@@ -59,6 +59,17 @@ RSpec.describe Flipper::UI::Configuration do
     end
   end
 
+  describe "#cloud_recommendation" do
+    it "has default value" do
+      expect(configuration.cloud_recommendation).to eq(true)
+    end
+
+    it "can be updated" do
+      configuration.cloud_recommendation = false
+      expect(configuration.cloud_recommendation).to eq(false)
+    end
+  end
+
   describe "#feature_removal_enabled" do
     it "has default value" do
       expect(configuration.feature_removal_enabled).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-ui
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +96,7 @@ files:
 - docs/ui/images/description.png
 - docs/ui/images/feature.png
 - docs/ui/images/features.png
+- examples/ui/authorization.ru
 - examples/ui/basic.ru
 - flipper-ui.gemspec
 - lib/flipper-ui.rb