bastion 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215e758692928b45be50032619813c27e60d4f9a
-  data.tar.gz: f94dde9b9f3a7c2b8f23f06d9d1535576460779c
+  metadata.gz: 2fcf73544fbe6e9a9e68742306223e6f36b82882
+  data.tar.gz: f3fdd0f88aee4adcdacfcc8c7c0bf7bc260694c6
 SHA512:
-  metadata.gz: 1b1b70043f1d2dde8ef1f67fd73ef0a5f773fd2ec0787cb1cab5eccf41be2586e08fa88ee6703277afd5c0a517c9394732bb1325da531db3942bbc5a516c5e89
-  data.tar.gz: 921f02922c74e79c88f84308195a6f01612a27d8faec0860bd2ae75d00b4842ec89cdfd35d0d25fd388b29dae549ebcf9c59b43ede36bced14565f8195e31cfd
+  metadata.gz: fa572a934c298e2a979aff62f00f27e12cd53098fcbe9f163542bee38de07cc63ef0cba468c941b022c4d2aff6d111198e6d63fa74311197e62cc985f687de27
+  data.tar.gz: 778313790e3ddd06bd55b1deb0d5ba2ea35627152235ee2f6787b165945e12ce8eeba1a76b6ce9126cd2e6da5eeea927f2d2b563ec60cb69cf3596f0db606649

data/app/assets/javascripts/bastion/bastion-bootstrap.js

@@ -25,4 +25,5 @@ BASTION_MODULES = [
     'Bastion.auth',
     'Bastion.menu',
     'Bastion.i18n',
+    'Bastion.features'
 ];

data/app/assets/javascripts/bastion/bastion.js

@@ -43,4 +43,7 @@
 //= require "bastion/utils/utils.module"
 //= require_tree "./utils"
 
+//= require "bastion/features/features.module"
+//= require_tree "./features"
+
 //= require "bastion/bastion-bootstrap"

data/app/assets/javascripts/bastion/features/bst-feature-flag.directive.js

@@ -0,0 +1,61 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ **/
+
+
+(function () {
+    'use strict';
+
+    /**
+     * @ngdoc directive
+     * @name Bastion.features.directive:FeatureFlag
+     *
+     * @description
+     *   Handles checking if a given feature is enabled within HTML.
+     *
+     * @example
+     *   HTML:
+     *     <button class="btn btn-default"
+     *             bst-feature-flag="custom_products"
+     *             ui-sref="products.discovery.scan">
+     *       <i class="icon-screenshot"></i>
+     *       {{ "Repo Discovery" | translate }}
+     *     </button>
+     *
+     *   Routes:
+     */
+    function bstFeatureFlag(ngIfDirective, FeatureFlag) {
+        var ngIf = ngIfDirective[0];
+
+        return {
+            transclude: ngIf.transclude,
+            priority: ngIf.priority,
+            terminal: ngIf.terminal,
+            restrict: ngIf.restrict,
+            scope: true,
+            link: function (scope, element, attrs) {
+                attrs.ngIf = function () {
+                    return FeatureFlag.featureEnabled(attrs['bstFeatureFlag']);
+                };
+
+                ngIf.link.apply(ngIf, arguments);
+            }
+        };
+    }
+
+    angular
+        .module('Bastion.features')
+        .directive('bstFeatureFlag', bstFeatureFlag);
+
+    bstFeatureFlag.$injector = ['ngIfDirective', 'FeatureFlag'];
+
+})();

data/app/assets/javascripts/bastion/features/feature-flag.run.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ **/
+
+
+(function () {
+
+    /**
+     * @ngdoc service
+     * @name Bastion.run:FeatureFlag
+     *
+     * @description
+     *   Handles checking if a state is enabled on state change. If the state is disabled, the user
+     *   is redirected to a 404 page.
+     */
+    function FeaturesInit($rootScope, $window, FeatureFlag) {
+        $rootScope.$on('$stateChangeStart', function (event, toState) {
+            if (!FeatureFlag.stateEnabled(toState.name)) {
+                $window.location.href = '/404';
+            }
+        });
+    }
+
+    angular
+        .module('Bastion.features')
+        .run(FeaturesInit);
+
+    FeaturesInit.$inject = ['$rootScope', '$window', 'FeatureFlag'];
+
+})();

data/app/assets/javascripts/bastion/features/feature-flag.service.js

@@ -0,0 +1,104 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ **/
+
+
+(function () {
+
+    /**
+     * @ngdoc service
+     * @name Bastion.features.service:FeatureFlag
+     *
+     * @description
+     *   Provides a service for checking whether a given feature or state based on a feature
+     *   is enabled. States may be added to a features state set via the service (see example).
+     *
+     * @example
+     *   Add states:
+     *     FeatureFlag.addStates('custom_products', ['products.new']);
+     *
+     *   Check feature enabled:
+     *     FeatureFlag.stateEnabled('custom_products');
+     *
+     *   Check state enabled:
+     *     FeatureFlag.stateEnabled('products.new');
+     *
+     */
+    function FeatureFlag(Features) {
+        var featureFlags = {};
+
+        angular.forEach(Features, function (enabled, feature) {
+            featureFlags[feature] = {states: [], enabled: enabled};
+        });
+
+        /**
+         * Returns whether a given feature is enabled or not
+         *
+         * @param {String} flag Name of a feature flag
+         *
+         * @returns {Boolean}
+         */
+        this.featureEnabled = function (flag) {
+            return (featureFlags[flag] === undefined) ? true : featureFlags[flag].enabled;
+        };
+
+        /**
+         * Returns whether a given state is enabled or not.
+         * If a state is defined for multiple flags, returns true if the
+         * flag is true for any state that is defined for that flag.
+         *
+         * @param {String} state ui-router state to check against
+         *
+         * @returns {Boolean}
+         */
+        this.stateEnabled = function (state) {
+            var enabled = [];
+
+            angular.forEach(featureFlags, function (feature) {
+                if (feature.states.indexOf(state) > -1) {
+                    enabled.push(feature.enabled);
+                }
+            });
+
+            return ((enabled.length === 0) ? true : enabled.indexOf(true) > -1);
+        };
+
+        /**
+         * Add states to a feature flag
+         *
+         * @param {String} feature The feature to add states to
+         * @param {Array}  states  The set of states to add to the feature
+         *
+         * @returns {Object} Returns the service itself, can be chained
+         */
+        this.addStates = function (feature, states) {
+            feature = featureFlags[feature];
+
+            if (feature === undefined) {
+                feature = {states: []};
+            } else if (feature.states === undefined) {
+                feature.states = [];
+            }
+
+            feature.states = feature.states.concat(states);
+
+            return this;
+        };
+    }
+
+    angular
+        .module('Bastion.features')
+        .service('FeatureFlag', FeatureFlag);
+
+    FeatureFlag.$inject = ['Features'];
+
+})();

data/app/assets/javascripts/bastion/features/features.module.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ **/
+
+
+(function () {
+
+    angular
+        .module('Bastion.features', []);
+
+})();

data/app/assets/javascripts/bastion/features/features.service.js

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ **/
+
+
+(function () {
+
+    /**
+     * @ngdoc factory
+     * @name Bastion.features.factory:Features
+     *
+     * @description
+     *   Wraps the
+     */
+    function Features($injector) {
+        var features;
+
+        try {
+            features = $injector.get('FeatureSettings');
+        } catch (e) {
+            features = {};
+        }
+
+        return features;
+    }
+
+    angular
+        .module('Bastion.features')
+        .factory('Features', Features);
+
+    Features.$inject = ['$injector'];
+
+})();

data/app/assets/javascripts/bastion/layouts/nutupane.html

@@ -13,6 +13,9 @@
   <div class="row nutupane-bar">
     <div class="col-sm-3">
       <div class="input-group input-group">
+
+        <span data-block="search-filter"></span>
+
         <input type="text"
                class="form-control"
                placeholder="{{ 'Search...' | translate }}"

data/app/views/bastion/layouts/application.html.erb

@@ -16,6 +16,7 @@
 <% content_for(:javascripts) do %>
   <%= javascript_include_tag 'bastion/bastion' %>
   <script type="text/javascript">
+    angular.module('Bastion.features').value('FeatureSettings', angular.fromJson(<%= SETTINGS[:features].nil? ? {} : SETTINGS[:features].to_json.html_safe %>));
     angular.module('Bastion').value('currentLocale', '<%= I18n.locale %>');
     angular.module('Bastion').value('CurrentOrganization', "<%= Organization.current.id if Organization.current %>");
     angular.module('Bastion').value('Permissions', angular.fromJson('<%= User.current.roles.collect { |role| role.permissions }.flatten.to_json.html_safe %>'));

data/grunt/karma.js

@@ -30,7 +30,6 @@ module.exports = {
             basePath + 'vendor/assets/javascripts/bastion/ngUpload/ng-upload.js',
             basePath + '.tmp/bower_components/angular-mocks/angular-mocks.js',
 
-            basePath + 'app/assets/javascripts/bastion/bastion-bootstrap.js',
             basePath + 'app/assets/javascripts/bastion/bastion.module.js',
             basePath + 'app/assets/javascripts/bastion/bastion-resource.factory.js',
             basePath + 'app/assets/javascripts/bastion/i18n/i18n.module.js',
@@ -41,6 +40,8 @@ module.exports = {
             basePath + 'app/assets/javascripts/bastion/utils/*.js',
             basePath + 'app/assets/javascripts/bastion/menu/menu.module.js',
             basePath + 'app/assets/javascripts/bastion/menu/*.js',
+            basePath + 'app/assets/javascripts/bastion/features/features.module.js',
+            basePath + 'app/assets/javascripts/bastion/features/*.js',
             basePath + 'app/assets/javascripts/bastion/components/components.module.js',
             basePath + 'app/assets/javascripts/bastion/components/*.js',
             basePath + 'app/assets/javascripts/bastion/components/formatters/components-formatters.module.js',
@@ -54,6 +55,8 @@ module.exports = {
             'app/assets/javascripts/' + pluginName + '/**/*.js',
             'app/assets/javascripts/' + pluginName + '/**/*.html',
 
+            basePath + 'app/assets/javascripts/bastion/bastion-bootstrap.js',
+
             basePath + 'test/test-mocks.module.js',
             'test/**/*test.js'
         ],

data/lib/bastion/version.rb

@@ -1,3 +1,3 @@
 module Bastion
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/test/features/bst-feature-flag.directive.test.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ */
+
+describe('Directive:bstFeatureFlag', function() {
+    var element, scope;
+
+    beforeEach(module('Bastion.features'));
+
+    beforeEach(module(function ($provide) {
+        $provide.value('FeatureSettings', {'custom_products': false});
+    }));
+
+    beforeEach(inject(function($injector) {
+        var compile = $injector.get('$compile');
+
+        element = angular.element('<div bst-feature-flag="custom_products"><button>New Product</button><span>Test</span></div>');
+        scope = $injector.get('$rootScope').$new();
+
+        compile(element)(scope);
+        scope.$digest();
+    }));
+
+    it("should remove the element if the feature is disabled", function () {
+        expect(element.find('button').length).toBe(0);
+    });
+
+});

data/test/features/feature-flag.service.test.js

@@ -0,0 +1,45 @@
+/**
+ * Copyright 2014 Red Hat, Inc.
+ *
+ * This software is licensed to you under the GNU General Public
+ * License as published by the Free Software Foundation; either version
+ * 2 of the License (GPLv2) or (at your option) any later version.
+ * There is NO WARRANTY for this software, express or implied,
+ * including the implied warranties of MERCHANTABILITY,
+ * NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
+ * have received a copy of GPLv2 along with this software; if not, see
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
+ */
+
+describe('Service:FeatureFlag', function() {
+    var FeatureFlag;
+
+    beforeEach(module('Bastion.features'));
+
+    beforeEach(module(function ($provide) {
+        $provide.value('FeatureSettings', {'custom_products': false});
+    }));
+
+    beforeEach(inject(function($injector) {
+        FeatureFlag = $injector.get('FeatureFlag');
+        FeatureFlag.addStates('custom_products', ['products', 'products.new']);
+    }));
+
+    it("should allow checking if a feature is enabled", function () {
+        expect(FeatureFlag.featureEnabled('custom_products')).toBe(false);
+    });
+
+    it("should default to true if a feature is undefined", function () {
+        expect(FeatureFlag.featureEnabled('fake_flag')).toBe(true);
+    });
+
+    it("should allow checking if a state is enabled", function () {
+        expect(FeatureFlag.stateEnabled('products')).toBe(false);
+        expect(FeatureFlag.stateEnabled('products.fake')).toBe(true);
+    });
+
+    it("should allow adding states to a feature", function () {
+        expect(FeatureFlag.addStates('custom_products', ['products.new.form'])).toBe(FeatureFlag);
+        expect(FeatureFlag.stateEnabled('products.new.form')).toBe(false);
+    });
+});

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bastion
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Katello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: angular-rails-templates
@@ -118,6 +118,11 @@ files:
 - app/assets/javascripts/bastion/components/views/bst-save-control.html
 - app/assets/javascripts/bastion/components/views/current-tasks.html
 - app/assets/javascripts/bastion/components/views/path-selector.html
+- app/assets/javascripts/bastion/features/bst-feature-flag.directive.js
+- app/assets/javascripts/bastion/features/feature-flag.run.js
+- app/assets/javascripts/bastion/features/feature-flag.service.js
+- app/assets/javascripts/bastion/features/features.module.js
+- app/assets/javascripts/bastion/features/features.service.js
 - app/assets/javascripts/bastion/i18n/README
 - app/assets/javascripts/bastion/i18n/i18n.module.js
 - app/assets/javascripts/bastion/i18n/katello.pot
@@ -184,6 +189,8 @@ files:
 - test/components/page-title.service.test.js
 - test/components/path-selector.directive.test.js
 - test/components/typeahead-empty.directive.test.js
+- test/features/bst-feature-flag.directive.test.js
+- test/features/feature-flag.service.test.js
 - test/i18n/translate.service.test.js
 - test/menu/menu-expander.service.test.js
 - test/test-mocks.module.js
@@ -380,5 +387,7 @@ test_files:
 - test/bastion/bastion-resource.factory.test.js
 - test/i18n/translate.service.test.js
 - test/auth/authorization.service.test.js
+- test/features/bst-feature-flag.directive.test.js
+- test/features/feature-flag.service.test.js
 - test/utils/form-utils.service.test.js
 - test/utils/as.filter.test.js