plug 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65c4f54bdd1454243d715208b42cd5bc3b01e1c2
-  data.tar.gz: 0d08310207a10fa05ebb95cc0972f6e47fe1c035
+  metadata.gz: e1f4d0ccf9b5a963bf47b5ad06b51a717dfe87b7
+  data.tar.gz: 32be30ca94c6d54a846f1d8fc312f94e4c2537cc
 SHA512:
-  metadata.gz: e590d7750b5fc039237991a2f1a3d26c8cd95cf052ed0538d0be71632f26b344df5c2380606ada39f7524304790aa410dbe474032248e9e10678a837966ecee3
-  data.tar.gz: eb75ff4a9548a455aefced4c477723638f2c29225783166a421759463258122c870c7d6dc4357ce977093c263327960117fee192b96e00b468f10737cfa119f6
+  metadata.gz: a0bd0322aef2ed5d88a4891fbc9b17e9a7f4fb8a337ae7ba67631e4a375df353f1eae3807a051f6432d9426f93a09f419beb058167a92687c3af372b24d8d9db
+  data.tar.gz: 66bcb2d3ef8cd2fd8352f4105ab54c89576b5eb8ab896578d530b5ef300667b7fc9aadb4c947a450d293bf29f7ca457a939ffffe37fde2c9efd8473ae099fcea

data/README.md

@@ -1,4 +1,4 @@
-# 🔌 Plug
+# Plug [![Maintainability](https://api.codeclimate.com/v1/badges/6246b1cd8e42603c42f6/maintainability)](https://codeclimate.com/github/DigitalNZ/plug/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/6246b1cd8e42603c42f6/test_coverage)](https://codeclimate.com/github/DigitalNZ/plug/test_coverage) [![Build Status](https://travis-ci.org/DigitalNZ/plug.svg?branch=master)](https://travis-ci.org/DigitalNZ/plug)
 
 A Rails engine to turn on/off features (Feature flipper).
 
@@ -6,7 +6,7 @@ A Rails engine to turn on/off features (Feature flipper).
 
 - Supports Rails 3 and above
 - MySQL
-- Set notices (WIP)
+- Set notices
 
 ### Prerequisites
 
@@ -55,6 +55,47 @@ Rails.application.routes.draw do
 end
 ```
 
+Notices can be displayed using the `Plug.notice` method.
+
+```erb
+<%= Plug.notice('my-awesome-feature-slug') %>
+```
+
+If you have custom HTML for notice, you can pass a block.
+
+
+```erb
+<% Plug.notice('my-awesome-feature-slug') do |notice| %>
+  <div class="alert">
+    <p><%= notice %></p>
+  </div>
+<% end %>
+```
+
+### Running the tests
+
+```bash
+→ bundle exec rspec spec
+```
+
+### Publishing to `rubygems.org`
+
+Make sure to bump the version. Rubygems don't accept version overrides.
+
+```bash
+→ gem build plug.gemspec
+→ gem push plug-<version>.gem
+```
+
+### TODOs
+
+- Ability to disable all features using one button
+- Add screenshot
+- Allow block parameters for `enabled?` method
+- Versioning of features
+- History of feature activities
+
+
 ### Questions/Issues?
 
 File a new [issue](https://github.com/boost/plug/issues/new) if you have questions or issues.

data/app/assets/stylesheets/plug/application.scss

@@ -34,4 +34,5 @@
 
 // Blocks
 @import 'blocks/nav';
-@import 'blocks/plugs';
+@import 'blocks/notice';
+@import 'blocks/state';

data/app/assets/stylesheets/plug/blocks/_nav.scss

@@ -1,4 +1,7 @@
 .nav {
+  border-bottom: 1px solid $gallery;
+  margin-bottom: 2rem;
+
   @include element('logo') {
     color: $studio;
     font-weight: 700;

data/app/assets/stylesheets/plug/blocks/_notice.scss

@@ -0,0 +1,4 @@
+.notice {
+  background: $gallery;
+  padding: 2rem;
+}

data/app/assets/stylesheets/plug/blocks/_state.scss

@@ -0,0 +1,9 @@
+.state {
+  @include element('enabled') {
+    color: $jungle-green;
+  }
+
+  @include element('disabled') {
+    color: $tall-poppy;
+  }
+}

data/app/assets/stylesheets/plug/variables/_colors.scss

@@ -1,5 +1,7 @@
-$white:     #ffffff;
-$studio:    #3F46AD;
-$pale-sky:  #637381;
-$alabaster: #f7f7f7;
-$gallery:   #ebebeb;
+$white:         #ffffff;
+$studio:        #3F46AD;
+$pale-sky:      #637381;
+$alabaster:     #f7f7f7;
+$gallery:       #ebebeb;
+$tall-poppy:    #c0392b;
+$jungle-green:  #27ae60;

data/app/assets/stylesheets/plug/variables/_typography.scss

@@ -1 +1,5 @@
-@import url('https://fonts.googleapis.com/css?family=Roboto');
+@import url('https://fonts.googleapis.com/css?family=Roboto');
+
+.strong {
+  font-weight: 700;
+}

data/app/controllers/plug/features_controller.rb

@@ -3,9 +3,9 @@ require_dependency 'plug/application_controller'
 module Plug
   class FeaturesController < ApplicationController
     if Rails.version.to_i < 5
-      before_filter :set_feature, only: [:show, :edit, :update, :destroy]
+      before_filter :set_feature, only: [:edit, :update, :destroy]
     else
-      before_action :set_feature, only: [:show, :edit, :update, :destroy]
+      before_action :set_feature, only: [:edit, :update, :destroy]
     end
 
     # GET /features
@@ -14,8 +14,7 @@ module Plug
     end
 
     # GET /features/1
-    def show
-    end
+    # def show; end
 
     # GET /features/new
     def new
@@ -23,15 +22,14 @@ module Plug
     end
 
     # GET /features/1/edit
-    def edit
-    end
+    def edit; end
 
     # POST /features
     def create
       @feature = Feature.new(feature_params)
 
       if @feature.save
-        redirect_to @feature, notice: 'Feature was successfully created.'
+        redirect_to features_path, notice: 'Feature was successfully created.'
       else
         render :new
       end
@@ -40,7 +38,7 @@ module Plug
     # PATCH/PUT /features/1
     def update
       if @feature.update_attributes(feature_params)
-        redirect_to @feature, notice: 'Feature was successfully updated.'
+        redirect_to features_path, notice: 'Feature was successfully updated.'
       else
         render :edit
       end

data/app/views/plug/features/_form.html.haml

@@ -12,8 +12,14 @@
   .field
     = f.label :description
     = f.text_area :description, rows: 5
+  .field
+    = f.label :notice
+    = f.text_area :notice, rows: 10
   .field
     = f.label :state
     = f.select :state, ['enabled', 'disabled']
-  .actions
-    = f.submit 'Save'
+  .actions.clearfix
+    .float-left
+      = link_to 'Back', features_path, class: 'button'
+    .float-right
+      = f.submit 'Save'

data/app/views/plug/features/edit.html.haml

@@ -2,8 +2,4 @@
   .column
     %h4 Editing feature
 
-    = render 'form'
-
-    = link_to 'Show', @feature, class: 'button'
-    \|
-    = link_to 'Back', features_path, class: 'button'
+    = render 'form'

data/app/views/plug/features/index.html.haml

@@ -1,6 +1,13 @@
 .row
   .column
-    %h4 Features
+    - if notice
+      %p.notice= notice
+
+    .clearfix
+      .float-left
+        %h4 Features
+      .float-right
+        = link_to 'New Feature', new_feature_path, class: 'button'
 
     %table
       %thead
@@ -9,21 +16,20 @@
           %th Description
           %th Slug
           %th State
-          %th
-          %th
-          %th
 
       %tbody
         - @features.each do |feature|
           %tr
-            %td= feature.name
+            %td= link_to feature.name, edit_feature_path(feature), class: 'strong'
             %td= feature.description
             %td= feature.slug
-            %td= feature.state
-            %td= link_to 'Show', feature
-            %td= link_to 'Edit', edit_feature_path(feature)
+            %td
+              - if feature.state == 'enabled'
+                %i.fas.fa-check-circle.fa-2x.state__enabled
+              - else
+                %i.fas.fa-times-circle.fa-2x.state__disabled
 
             - if Plug.allow_delete
               %td= link_to 'Destroy', feature, method: :delete, data: { confirm: 'Are you sure?' }
 
-    = link_to 'New Feature', new_feature_path, class: 'button'
+    

data/app/views/plug/features/new.html.haml

@@ -1,7 +1,7 @@
 .row
   .column
-    %h4 New feature
+    .clearfix
+      .float-left
+        %h4 New feature
 
     = render 'form'
-
-    = link_to 'Back', features_path, class: 'button'

data/app/views/plug/shared/_head.html.haml

@@ -5,4 +5,6 @@
 
   = stylesheet_link_tag     'plug/application', media: 'all'
   = javascript_include_tag  'plug/application'
-  = csrf_meta_tags
+  = csrf_meta_tags
+
+  %script{ defer: '', src: 'https://use.fontawesome.com/releases/v5.0.4/js/all.js' }

data/app/views/plug/shared/_nav.html.haml

@@ -3,4 +3,4 @@
     .column
       %h3
         = link_to 'Plug', plug.root_path, class: 'nav__logo'
-        %small /Unplug features
+        %small /unplug features

data/config/routes.rb

@@ -1,5 +1,5 @@
 Plug::Engine.routes.draw do
   root to: 'features#index'
 
-  resources :features
+  resources :features, except: :show
 end

data/db/migrate/20180128202026_add_notice_to_plug_features.rb

@@ -0,0 +1,5 @@
+class AddNoticeToPlugFeatures < ActiveRecord::Migration
+  def change
+    add_column :plug_features, :notice, :text
+  end
+end

data/lib/generators/plug/install_generator.rb

@@ -1,13 +1,13 @@
 module Plug
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('../templates', __FILE__)
 
     def copy_initializer_file
       copy_file 'plug.rb', 'config/initializers/plug.rb'
     end
 
     def mount_engine
-      inject_into_file('config/routes.rb', "\n  mount Plug::Engine => '/plug', as: 'plug'\n\n", :before => /^end/)
+      inject_into_file('config/routes.rb', "\n  mount Plug::Engine => '/plug', as: 'plug'\n\n", before: /^end/)
     end
   end
-end
+end

data/lib/plug.rb

@@ -6,18 +6,42 @@ module Plug
   extend self
   extend Configuration
 
-  # 
+  #
   # [enabled? returns true of false]
   # @param arg [String, Symbol] The slug or name of the Feature
-  # 
-  # @return [Boolean] true - feature found and enabled | true - feature not found (We don't want to block) | false - feature was set to disabled
+  #
+  # @return [Boolean] true - Feature found and enabled | true - Feature not found (We don't want to block) | false - Feature was set to disabled
   def enabled?(arg)
-    arg = arg.to_s if arg.is_a? Symbol
-    feature = Plug::Feature.slug_and_name(arg).first
-
-    return true unless feature
-    return feature.enabled?
+    return get_feature(arg).enabled?
   rescue
     return true
   end
+
+  #
+  # Returns the notice of a given Feature
+  # @param arg [String] The slug or name of the Feature
+  # @param &block [Proc] The block of HTML/String for the notice
+  #
+  # @return [String] The block of HTML/String with notice
+  def notice(arg, &block)
+    feature = get_feature(arg)
+
+    render_notice(feature.notice, &block) unless feature.enabled? || feature.notice.blank?
+  rescue
+    return nil
+  end
+
+  private
+
+    def get_feature(arg)
+      arg = arg.to_s if arg.is_a? Symbol
+
+      return Plug::Feature.slug_and_name(arg).first
+    end
+
+    def render_notice(notice, &block)
+      return notice unless block_given?
+
+      yield(notice)
+    end
 end

data/lib/plug/configuration.rb

@@ -20,4 +20,4 @@ module Plug
       Hash[ * VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
     end
   end
-end
+end

data/lib/plug/constraint.rb

@@ -10,4 +10,4 @@ module Plug
       true
     end
   end
-end
+end

data/lib/plug/version.rb

@@ -1,3 +1,3 @@
 module Plug
-  VERSION = '0.1.9'
+  VERSION = '0.1.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Ben
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -196,8 +196,8 @@ files:
 - app/assets/stylesheets/plug/_settings.scss
 - app/assets/stylesheets/plug/application.scss
 - app/assets/stylesheets/plug/blocks/_nav.scss
-- app/assets/stylesheets/plug/blocks/_plugs.scss
-- app/assets/stylesheets/plug/features.scss
+- app/assets/stylesheets/plug/blocks/_notice.scss
+- app/assets/stylesheets/plug/blocks/_state.scss
 - app/assets/stylesheets/plug/foundation_and_overrides.scss
 - app/assets/stylesheets/plug/milligram.scss
 - app/assets/stylesheets/plug/mixins/_bem.scss
@@ -217,11 +217,11 @@ files:
 - app/views/plug/features/edit.html.haml
 - app/views/plug/features/index.html.haml
 - app/views/plug/features/new.html.haml
-- app/views/plug/features/show.html.haml
 - app/views/plug/shared/_head.html.haml
 - app/views/plug/shared/_nav.html.haml
 - config/routes.rb
 - db/migrate/20171207020316_create_plug_features.rb
+- db/migrate/20180128202026_add_notice_to_plug_features.rb
 - lib/generators/plug/install_generator.rb
 - lib/generators/plug/templates/plug.rb
 - lib/plug.rb

data/app/assets/stylesheets/plug/blocks/_plugs.scss

@@ -1,17 +0,0 @@
-.plugs {
-  margin-top: 2rem;
-
-  @include element('content') {
-    background: $white;
-    border: 1px solid $gallery;
-    
-    @include element('item') {
-      padding: .5rem;
-      border-bottom: 1px solid $gallery;
-
-      &:last-of-type {
-        border-bottom: none;
-      }
-    }
-  }
-}

data/app/assets/stylesheets/plug/features.scss

@@ -1,3 +0,0 @@
-// Place all the styles related to the Features controller here.
-// They will automatically be included in application.css.
-// You can use Sass (SCSS) here: http://sass-lang.com/

data/app/views/plug/features/show.html.haml

@@ -1,20 +0,0 @@
-.row
-  .column
-    %p#notice= notice
-
-    %p
-      %b Name:
-      = @feature.name
-    %p
-      %b Description:
-      = @feature.description
-    %p
-      %b Slug:
-      = @feature.slug
-    %p
-      %b State:
-      = @feature.state
-
-    = link_to 'Edit', edit_feature_path(@feature), class: 'button'
-    \|
-    = link_to 'Back', features_path, class: 'button'