flipper-ui 0.16.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71eccacf760968860d08a08de30d86c435314c3a
-  data.tar.gz: 9e6a0d87e9158c108dbf7c80fbf663576899fcf3
+SHA256:
+  metadata.gz: bfa566d9ce94dadf56643f0f8effcd75795dc478e8098a91374fa20b612d772c
+  data.tar.gz: 0423fa89225c97f21cfe5bc851b43c8d13dbe930764989a8255cd61ab23bdada
 SHA512:
-  metadata.gz: 5790f438fba84b3a34301fc004fab83f6609c249026438639395781b474848e2c57f38aa612a5864e6365b5e2e853b00a7c72c96c69e6b9074e37fd5e55da44b
-  data.tar.gz: ed1011c894f34b0ebd3ff87a06ed5687428c7ba8d76466d8e18a49ccfc595716eae65afdb6f2b54786ebde372f8ad367b6bea079773da00977d155d06d9b2d64
+  metadata.gz: b65bcd93a19db4a5807f6ef4900d99ec9e8bf3232e569d0e5c27d4ad54b294657055448d5b45ee68bc66b9bf03a5810c090b210adf1de7501ea3bd61cdbd4c39
+  data.tar.gz: 52c3fbade80bc667eed46f94059d65f84c1e46330a456dda768c6cbc5e807b0681bb5d8952e88fde8b4dae992009ac559c5073073987bfdc581b55ca75482790

data/docs/ui/README.md

@@ -5,9 +5,11 @@ UI for the [Flipper](https://github.com/jnunemaker/flipper) gem.
 ## Screenshots
 
 Viewing list of features:
+
 ![features](images/features.png)
 
 Viewing an individual feature:
+
 ![feature](images/feature.png)
 
 ## Installation
@@ -37,14 +39,15 @@ YourRailsApp::Application.routes.draw do
 end
 ```
 
-If you'd like to lazy load flipper, you can pass a block instead:
+If you'd like to lazy load flipper, you can instead pass a block to initialize it:
 
 ```ruby
 # config/routes.rb
 YourRailsApp::Application.routes.draw do
   flipper_block = lambda {
     # some flipper initialization here, for example:
-    # YourRailsApp.flipper
+    adapter = Flipper::Adapters::Memory.new
+    Flipper.new(adapter)
   }
   mount Flipper::UI.app(flipper_block) => '/flipper'
 end
@@ -95,7 +98,7 @@ end
 # config/routes.rb
 
 constraints CanAccessFlipperUI do
-  mount Flipper::UI.app(flipper) => '/flipper'
+  mount Flipper::UI.app(Flipper) => '/flipper'
 end
 ```
 
@@ -126,32 +129,30 @@ See [examples/ui/basic.ru](https://github.com/jnunemaker/flipper/blob/master/exa
 
 ### Configuration
 
-Flipper UI can be customized via `configure`, which yields a configuration instance for setting the text on the five main sections of the UI feature view.
+Flipper UI can be customized via `configure`, which yields a configuration instance.
 
-* `config.actors`
-* `config.groups`
-* `config.percentage_of_actors`
-* `config.percentage_of_time`
-* `config.delete`
+#### Description
 
-Each of these methods returns a [Flipper::UI::Option](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/ui/configuration/option.rb) that responds to `title=`, `description=` as seen below.
+We can associate a `description` for each `feature` by providing a descriptions source:
 
-*e.g. customzing the percentage_of_actors and delete sections' titles and descriptions*
 ```ruby
 Flipper::UI.configure do |config|
-  config.percentage_of_actors.title = "My Custom Title"
-  config.percentage_of_actors.description = "My custom description"
+  config.descriptions_source = ->(keys) do
+    # descriptions loaded from YAML file or database (postgres, mysql, etc)
+    # return has to be hash of {String key => String description}
+  end
 
-  config.delete.title = "BE VERY CAREFUL!"
-  config.delete.description = "YOU'VE BEEN WARNED!"
+  # Defaults to false. Set to true to show feature descriptions on the list
+  # page as well as the view page.
+  # config.show_feature_description_in_list = true
 end
 ```
 
-results in:
+Descriptions show up in the UI like so:
 
-![configure](images/configured-ui.png)
+![description](images/description.png)
 
-### Banner
+#### Banner
 
 Flipper UI can display a banner across the top of the page. The `banner_text` and `banner_class` can be configured by using the `Flipper::UI.configure` block as seen below.
 
@@ -166,15 +167,24 @@ By default the `environment` is set to an empty string so no banner will show. I
 
 The above configuration results in:
 
-![configure](images/environment-banner.png)
+![banner](images/banner.png)
+
+#### Fun mode
+
+By default, Flipper UI displays a videoclip when there are no flags. The `fun` mode can be configured by using the `Flipper::UI.configure` block as seen below.
+
+```ruby
+Flipper::UI.configure do |config|
+  config.fun = false
+end
+```
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. **Fire up the app** (`script/server`)
-4. **Start up guard** (`bundle exec guard` for automatic coffeescript/sass compilation and such).
-5. Run the tests `bundle exec rake`
-6. Commit your changes (`git commit -am 'Added some feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create new Pull Request
+4. Run the tests `bundle exec rake`
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/examples/ui/basic.ru

@@ -34,6 +34,26 @@ 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
+
 # You can uncomment these to get some default data:
 # flipper[:search_performance_another_long_thing].enable
 # flipper[:gauges_tracking].enable

data/flipper-ui.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'UI for the Flipper gem'
-  gem.description   = 'Rack middleware that provides a fully featured web interface for the flipper gem.'
   gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
 
@@ -22,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'rack', '>= 1.4', '< 3'
-  gem.add_dependency 'rack-protection', '>= 1.5.3', '< 2.1.0'
+  gem.add_dependency 'rack-protection', '>= 1.5.3', '< 2.2.0'
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'erubis', '~> 2.7.0'
+  gem.add_dependency 'erubi', '>= 1.0.0', '< 2.0.0'
 end

data/lib/flipper/ui/action.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
+require 'flipper/ui/configuration'
 require 'flipper/ui/error'
-require 'flipper/ui/eruby'
+require 'erubi'
 require 'json'
 
 module Flipper
@@ -205,12 +206,8 @@ module Flipper
       # Private
       def view(name)
         path = views_path.join("#{name}.erb")
-
         raise "Template does not exist: #{path}" unless path.exist?
-
-        contents = path.read
-        compiled = Eruby.new(contents)
-        compiled.result proc {}.binding
+        eval(Erubi::Engine.new(path.read, escape: true).src)
       end
 
       # Internal: The path the app is mounted at.

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

@@ -10,9 +10,12 @@ module Flipper
         route %r{\A/features/(?<feature_name>.*)\Z}
 
         def get
-          @feature = Decorators::Feature.new(flipper[feature_name])
+          flipper_feature = flipper[feature_name]
+          @feature = Decorators::Feature.new(flipper_feature)
+          descriptions = Flipper::UI.configuration.descriptions_source.call([flipper_feature.key])
+          @feature.description = descriptions[@feature.key]
           @page_title = "#{@feature.key} // Features"
-          @percentages = [0, 1, 5, 10, 15, 25, 50, 75, 100]
+          @percentages = [0, 1, 5, 10, 25, 50, 100]
 
           breadcrumb 'Home', '/'
           breadcrumb 'Features', '/features'

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

@@ -10,8 +10,21 @@ module Flipper
 
         def get
           @page_title = 'Features'
+          keys = flipper.features.map(&:key)
+          descriptions = if Flipper::UI.configuration.show_feature_description_in_list?
+            Flipper::UI.configuration.descriptions_source.call(keys)
+          else
+            {}
+          end
+
           @features = flipper.features.map do |feature|
-            Decorators::Feature.new(feature)
+            decorated_feature = Decorators::Feature.new(feature)
+
+            if Flipper::UI.configuration.show_feature_description_in_list?
+              decorated_feature.description = descriptions[feature.key]
+            end
+
+            decorated_feature
           end.sort
 
           @show_blank_slate = @features.empty?

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

@@ -5,7 +5,7 @@ module Flipper
   module UI
     module Actions
       class File < UI::Action
-        route %r{(images|css|js|octicons|fonts)/.*\Z}
+        route %r{(images|css|js|octicons)/.*\Z}
 
         def get
           Rack::File.new(public_path).call(request.env)

data/lib/flipper/ui/assets/javascripts/application.coffee

@@ -1,3 +1,5 @@
-$(() ->
-  $('[data-toggle="tooltip"]').tooltip();
-);
+$ ->
+  $(document).on('click', '.js-toggle-trigger', ->
+    $container = $(this).closest('.js-toggle-container')
+    $container.toggleClass('toggle-on')
+  )

data/lib/flipper/ui/configuration.rb

@@ -3,11 +3,7 @@ require 'flipper/ui/configuration/option'
 module Flipper
   module UI
     class Configuration
-      attr_reader :actors,
-                  :delete,
-                  :groups,
-                  :percentage_of_actors,
-                  :percentage_of_time
+      attr_reader :delete
 
       attr_accessor :banner_text,
                     :banner_class
@@ -26,6 +22,24 @@ module Flipper
       # set to false, users won't be able to delete features from the UI.
       attr_accessor :feature_removal_enabled
 
+      # Public: Are you feeling lucky? Defaults to true. If set to false, users
+      # won't see a videoclip of Taylor Swift when there aren't any features
+      attr_accessor :fun
+
+      # 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".
+      attr_accessor :add_actor_placeholder
+
+      # Public: If you set this, Flipper::UI will fetch descriptions
+      # from your external source. Descriptions for `features` will be shown on `feature`
+      # page, and optionally the `features` pages. Defaults to empty block.
+      attr_accessor :descriptions_source
+
+      # Public: Should feature descriptions be show on the `features` list page.
+      # Default false. Only works when using descriptions.
+      attr_accessor :show_feature_description_in_list
+
       VALID_BANNER_CLASS_VALUES = %w(
         danger
         dark
@@ -37,16 +51,26 @@ module Flipper
         warning
       ).freeze
 
+      DEFAULT_DESCRIPTIONS_SOURCE = ->(_keys) { {} }
+
       def initialize
-        @actors = Option.new("Actors", "Enable actors using the form above.")
-        @groups = Option.new("Groups", "Enable groups using the form above.")
-        @percentage_of_actors = Option.new("Percentage of Actors", "Percentage of actors functions independently of percentage of time. If you enable 50% of Actors and 25% of Time then the feature will always be enabled for 50% of users and occasionally enabled 25% of the time for everyone.") # rubocop:disable Metrics/LineLength
-        @percentage_of_time = Option.new("Percentage of Time", "Percentage of actors functions independently of percentage of time. If you enable 50% of Actors and 25% of Time then the feature will always be enabled for 50% of users and occasionally enabled 25% of the time for everyone.") # rubocop:disable Metrics/LineLength
-        @delete = Option.new("Danger Zone", "Deleting a feature removes it from the list of features and disables it for everyone.") # rubocop:disable Metrics/LineLength
+        @delete = Option.new("Danger Zone", "Deleting a feature removes it from the list of features and disables it for everyone.")
         @banner_text = nil
         @banner_class = 'danger'
         @feature_creation_enabled = true
         @feature_removal_enabled = true
+        @fun = true
+        @add_actor_placeholder = "a flipper id"
+        @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
+        @show_feature_description_in_list = false
+      end
+
+      def using_descriptions?
+        @descriptions_source != DEFAULT_DESCRIPTIONS_SOURCE
+      end
+
+      def show_feature_description_in_list?
+        using_descriptions? && @show_feature_description_in_list
       end
 
       def banner_class=(value)

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

@@ -11,24 +11,15 @@ module Flipper
         # Public: The feature being decorated.
         alias_method :feature, :__getobj__
 
+        # Internal: Used to preload description if descriptions_source is
+        # configured for Flipper::UI.
+        attr_accessor :description
+
         # Public: Returns name titleized.
         def pretty_name
           @pretty_name ||= Util.titleize(name)
         end
 
-        # Public: Returns instance as hash that is ready to be json dumped.
-        def as_json
-          gate_values = feature.gate_values
-          {
-            'id' => name.to_s,
-            'name' => pretty_name,
-            'state' => state.to_s,
-            'gates' => gates.map do |gate|
-              Decorators::Gate.new(gate, gate_values[gate.key]).as_json
-            end,
-          }
-        end
-
         def color_class
           case feature.state
           when :on
@@ -40,6 +31,41 @@ module Flipper
           end
         end
 
+        def gates_in_words
+          return "Fully Enabled" if feature.boolean_value
+
+          statuses = []
+
+          if feature.actors_value.count > 0
+            statuses << %Q(<span data-toggle="tooltip" data-placement="bottom" title="#{Util.to_sentence(feature.actors_value.to_a)}">) + Util.pluralize(feature.actors_value.count, 'actor', 'actors') + "</span>"
+          end
+
+          if feature.groups_value.count > 0
+            statuses << %Q(<span data-toggle="tooltip" data-placement="bottom" title="#{Util.to_sentence(feature.groups_value.to_a)}">) + Util.pluralize(feature.groups_value.count, 'group', 'groups') + "</span>"
+          end
+
+          if feature.percentage_of_actors_value > 0
+            statuses << "#{feature.percentage_of_actors_value}% of actors"
+          end
+
+          if feature.percentage_of_time_value > 0
+            statuses << "#{feature.percentage_of_time_value}% of time"
+          end
+
+          Util.to_sentence(statuses)
+        end
+
+        def gate_state_title
+          case feature.state
+          when :on
+            "Fully enabled"
+          when :conditional
+            "Conditionally enabled"
+          else
+            "Disabled"
+          end
+        end
+
         def pretty_enabled_gate_names
           enabled_gates.map { |gate| Util.titleize(gate.key) }.sort.join(', ')
         end