bastion 0.1.7 → 0.1.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWE2NzFhNTdkY2M5MTIyMjQyNzA4ZDg0MzczMjU0ZDdiMWQzMDUxYQ==
+    MjRjMDk5MzlkZWQ1ZDFjZWRhNzQ2YTU5ZjhmYjA3NTBhM2VmODUxMA==
   data.tar.gz: !binary |-
-    YTcyZjMyYThkNTUyY2ZhOTVmOWUzMTlhYzYwMTljMmZiYTE2OTYyNQ==
+    ZjkxNWNlNTJiYWJhOTVhZWIzY2YwMDQ5ODA4ZDVlODkwY2QzYmNmNg==
 SHA512:
   metadata.gz: !binary |-
-    NmI3MDBjNTFlNmUzMGRkNWQ3MmMwM2M1NWJiMjJjZTBiYTBkNGRmMjEzNjY3
-    ZGE5NmU3ZTM0YjFmMDI0YTg3N2FkM2YxYTY3YTI5N2E5OGU5ODZhMmJiOTU5
-    ZWFhYTc3OTYwYWNlZTQ2OTBkZWQ1OTBkNjJkYmU4OGNiMjJkNzQ=
+    YmY4MjVjZTcxNzI2ZDEwNzdlNTdiNTRkNzJmNjhjMjQxY2U3NjdhZDI1OGNk
+    MDRhMTRkMjExNTAzM2FlZGM5ODFiYjljYmNhNzliMjcyYzRmZTIyOGNiNDA4
+    YTk5NWI0ZWJmZWI1NzY2MTBhZWI3NzU4ZWJhN2E3MTI4MWUzNDQ=
   data.tar.gz: !binary |-
-    OTU4ZTlmOWMzN2ExOTg5Y2Y0MTkzNTc1YTY5ODk3ZTBiYTFmOWZmMzM2YTZj
-    ZTU1ODhmNWI2YjFiYWNkNGMxNjk3MDIzOTcwZWQ2ZDFlYzkxMTU2OTMxNGM2
-    NjM4MGI5OGM4NjYxMmE2ODA2YTBiNTMzZDg1ZTgyNDE1Yzg4ZTE=
+    ZDUyZGUxMTIyNDFhYjExNmMxOGM5YzBjYzk0YTRkMjFlOWVkZTM5YjQ0ODc5
+    M2Y2YjEyM2U3MzFjZGFlNWM3YzdmYjU0YjgxZjcwOTY4NDhhN2MwMDM5Yzhi
+    MWY2YzU5ZGRmYzAwNjBjNTA1Mjg0ODA0NTU5MzYyYWM5YjRkZjI=

data/README.md

@@ -1,8 +1,285 @@
-# Bastion: The Katello UI Engine #
+# Bastion: AngularJS based Foreman UI Engine #
 
-Bastion is a single page AngularJS based web client for the Katello server. This means that all Bastion "pages" are served from a single static page without the need for a round trip to the server.
+Bastion is a single page AngularJS based web client for the Foreman server. This means that all Bastion "pages" are served from a single static page without the need for a round trip to the server.
 All URLs are relative to the application root, `/content-hosts` and `/content_views`, for example, are able to be bookmarked, and work with the browser's back button.
-The only real difference, as far as the user is concerned, is that the application is much quicker between Bastion "page loads" since only the HTML needed to render the next page is loaded instead of the entire page.
+The only real difference, as far as the user is concerned, is that the application is much quicker between Bastion "page loads" since only the HTML needed to render the next page is loaded instead of the entire page. Bastion is designed to work in the context of Foreman and is not a stand-alone gem or engine.
+
+## Plugins ##
+
+Bastion is designed to provide a set of common functionality and integration points that other Foreman Plugins can take advantage. This allows UI developers to focus on implementation without having to deal with the boilerplate loading of routes and pages to enable the Single Page Application structure to work with Foreman. A basic Bastion plugin declaration looks like the following:
+
+```
+Bastion.register_plugin(
+  :name => 'bastion_katello',
+  :javascript => 'bastion_katello/bastion_katello',
+  :pages => %w(
+    content_hosts
+    content_views
+  )
+)
+```
+
+**name**: The name of the plugin and Rails engine being declared, this should correspond to the engine's namespace
+**javascript**: The javascript files (often a Sprockets manifest) that will contain all your plugin's Javascript files
+**pages**: The top level pages that your plugin is providing. This often corresponds to a top level route. For example, the activation_keys page will treat all routes rooted at `/activation_keys` as a single page HTML5 application and allow routing to be handled client side.
+
+In order to add third party or custom AngularJS modules, add the following to your the top of your modulename.module.js file or in a separate mymodulename-bootstrap.js file):
+
+```javascript
+BASTION_MODULES.push('myModuleName');
+```
+
+### Plugin Development ###
+
+Bastion supplies a common set of testing and development using Grunt. These Grunt based tasks have been wrapped in Rake to make them more familiar to a Rails developer. To setup your development environment, from your plugin's checkout:
+
+```
+rake bastion:setup
+```
+
+To run your plugin's tests and lint them:
+
+```
+rake bastion:ci
+```
+
+### Basics of Adding a New Entity ###
+
+Sometimes adding new functionality requires creating a new entity which maps to an external resource. There are a few common steps that a developer will need to take.
+
+Create a folder in `app/assets/javascripts/<plugin_name>` using the plural form of the entity name (e.g. content-hosts). Then create a file to hold the module definition and the resource.
+
+```bash
+cd app/assets/javascripts/<plugin_name>
+mkdir content-hosts
+touch content-hosts/content-hosts.module.js
+touch content-host.factory.js
+```
+
+#### Module
+
+The module defines a namespace that contains all functionality related to this entity. This makes testing and compining components together less coupled. For example, the content-hosts module definition might look like:
+
+```javascript
+(function () {
+    'use strict';
+
+    /**
+    * @ngdoc module
+    * @name  Bastion.content-hosts
+    *
+    * @description
+    *   Module for content-hosts related functionality.
+    */
+    angular
+        .module('Bastion.content-hosts', [
+          'ngResource',
+          'alchemy',
+          'alch-templates',
+          'ui.router',
+          'Bastion.widgets'
+        ]);
+
+})();
+```
+
+The module definition creates the 'Bastion.content-hosts' namespace and tells Angular to make available the libraries `ngResource`, `alchemy`, `alch-templates`, `ui.router` and `Bastion.widgets`. These libraries are other similarly defined Angular modules.
+
+#### Routing
+
+In order to display a Bastion page you must add a route for the page. Start by adding a routes file:
+
+```javascript
+touch content-hosts/content-hosts.routes.js
+```
+
+Now add the basics of a route setup to the file:
+
+```javascript
+(function () {
+    'use strict';
+
+    /**
+     * @ngdoc config
+     * @name  Bastion.content-hosts.config
+     *
+     * @description
+     *   Defines the routes for content-hosts
+     */
+    function ContentHostRoutes($stateProvider) {
+
+    }
+
+    angular
+        .module('Bastion.content-hosts')
+        .config(ContentHostRoutes);
+
+    ContentHostRoutes.$inject = ['$stateProvider'];
+
+})();
+```
+
+A route to view all content-hosts may look like this:
+
+```javascript
+$stateProvider.state('content-hosts.index', {
+    url: '/content_hosts',
+    views: {
+        'table': {
+            controller: 'ContentHostTableController',
+            templateUrl: 'content-hosts/views/content-hosts-table-full.html'
+        }
+    }
+});
+```
+
+The views object contains a list of addressable views that allow the association of Angular controllers and templates with a URL.
+See the UI router [documentation](http://angular-ui.github.io/ui-router/site/#/api/ui.router) for more information.
+
+#### Resource
+
+A resource serves as a representation of an API endpoint for an entity and provides functions to make RESTful calls. User the single form of the entity for the name of the resource and filename. For example the resource for the `content-hosts` module is in `content-host.factory.js` and represented by:
+
+```javascript
+(function () {
+    'use strict';
+
+    /**
+     * @ngdoc config
+     * @name  Bastion.content-hosts.factory:ContentHost
+     *
+     * @description
+     *   Defines the API endpoint for Content Host
+     */
+    function ContentHost(BastionResource) {
+          return BastionResource('/api/v2/content-hosts/:id/:action',
+              {id: '@uuid'},
+              {
+                  update: {method: 'PUT'},
+                  query: {method: 'GET', isArray: false},
+                  releaseVersions: {method: 'GET', params: {action: 'releases'}
+              }
+          });
+    }
+
+    angular
+        .module('Bastion.content-hosts')
+        .factory('ContentHost', ContentHost);
+
+    ContentHost.$inject = ['BastionResource'];
+
+})();
+```
+
+Here we have created an angular factory named `content-host` and attached it to the `Bastion.content-hosts` namespace. You can read more about the $resource service here - http://code.angularjs.org/1.0.7/docs/api/ngResource.$resource
+
+#### Asset Pipeline
+
+In order to get your newly created assets available to the web pages, we need to add them to the master manifest file for your plugin. For our content-host example, open app/assets/javascripts/<plugin_name>/<plugin_name>.js, add a reference to the module file and a line to load all files within our directory. We must include the module definition first so that all factories, controllers etc. that attach to the namespace have that namespace available.
+
+Open the file, and add the following lines (with empty lines above and below for readability):
+
+```javascript
+//= require "<plugin_name>/content-hosts/content-hosts.module"
+//= require_tree "./content-hosts"
+```
+
+## Developing Bastion ##
+
+To setup a development environment, clone the repository or your fork of the repository. From the git checkout, setup the required development dependencies by running:
+
+```
+rake bastion:setup
+```
+
+After making changes, tests and linting can be run via:
+
+```
+rake bastion:ci
+```
+
+### Dependencies ###
+
+Web asset dependencies are stored in `bower.json`. This file denotes what library files are being used and their versions.
+
+#### Installing a New Dependency ####
+
+In order to add a new web asset dependency, a new entry into the `bower.json` file must be made along with noting what file(s) to extract from the new package to be placed into source control. For example, to add the `angular-blocks` library, open `bower.json` and add an entry under the `dependencies` section:
+
+```javascript
+"angular-blocks": "~>0.1.8"
+```
+
+Since Bower is based off the use of a git repository to define the package contents, installing `angular-blocks` will pull down more files than we want. In order to limit the files places into source control, add an entry to the `exportsOverride` section like so:
+
+```javascript
+"angular-blocks": {
+  "javascripts/bastion": "src/angular-blocks.js"
+}
+```
+
+If needing to extract multiple asset types, one can do:
+
+```javascript
+"alchemy": {
+  "javascripts/bastion": "alchemy.js",
+  "stylesheets/bastion": "*.scss"
+}
+```
+
+A set of files can be included by using an array instead of a string to list the files. After defining the new dependency and the associated file(s), run the following to install the new library:
+
+    grunt bower:update
+
+#### Updating a Dependency ####
+
+To update a dependency, the version must be bumped in the `bower.json` file, installed and committed to source control. To bump the version, open `bower.json`, locate the proper entry and change the version number. Now, install the new version:
+
+```bash
+grunt bower:update
+```
+
+Lastly, double check the new files with something like `git status`, add them and commit them with a message indicating that a new dependency version is being committed. We prefer that when committing a new depenendency, a single commit is generated with just the changes from the update.
+
+#### Example Dependency Errors ####
+
+[See *Fixing Dependency Errors*](#fixing-dependency-errors) for more commands to help fix errors such as these:
+
+**Error 1: local Npm module not installed**
+
+`Local Npm module "grunt-angular-gettext" not found. Is it installed?`
+
+Running `npm install` and `grunt bower:dev` again should fix the issue.
+
+**Error 2: the unmet dependency**
+
+*Traceback abbreviated to highlight error*
+
+```
+npm WARN unmet dependency /usr/lib/node_modules/block-stream requires inherits@'~2.0.0' but will load
+npm WARN unmet dependency undefined
+```
+
+Running `sudo npm update -g phantomjs bower grunt-cli` should fix the issue.
+
+#### Fixing Dependency Errors ####
+
+[See *Example Dependency Errors*](#example-dependency-errors) to see common errors and their fixes.
+
+Over time libraries, packages, and/or dependencies are often updated or added so you may have to rerun one or more
+of the following commands to fix them:
+
+**Note**: You only need to run `grunt bower update` when updating or pulling in changes to `bower.json` where the
+version of a component has been bumped.
+
+[See also *Installing a New Dependency*](#installing-a-new-dependency) as well as the related section
+[*Updating a New Dependency*](#updating-a-new-dependency)
+
+- `sudo npm update -g phantomjs bower grunt-cli`
+- `npm install`
+- `grunt bower:dev`
+
 
 ## Contributing ##
+
 We welcome contributions, please see the Bastion [developer guide](https://github.com/Katello/katello.org/blob/master/docs/developer_guide/bastion/index.md).

data/Rakefile

@@ -1,4 +1,4 @@
-require File.expand_path("lib/bastion", File.dirname(__FILE__))
+require File.expand_path("lib/bastion/engine", File.dirname(__FILE__))
 
 namespace :bastion do
 
@@ -17,7 +17,13 @@ namespace :bastion do
     Rake::Task["plugin:assets:precompile"].invoke('bastion')
   end
 
-  desc 'Run linting and tests'
+  desc 'Run linting and tests for the plugin'
+  task 'ci' do
+    success = grunt('ci')
+    exit!(1) if !success
+  end
+
+  desc 'Run any grunt task by specifying the argument'
   task 'grunt', [:task] do |task, args|
     success = grunt(args[:task])
     exit!(1) if !success

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

@@ -26,15 +26,6 @@ angular.module('Bastion', [
     'Bastion.widgets'
 ]);
 
-/**
- * @ngdoc constant
- * @name Bastion.constant:RootURL
- *
- * @description
- *   Provides a configurable URL root for all requests.
- */
-angular.module('Bastion').constant('RootURL', '/katello');
-
 /**
  * @ngdoc config
  * @name  Bastion.config
@@ -44,15 +35,14 @@ angular.module('Bastion').constant('RootURL', '/katello');
  * @requires $locationProvider
  * @requires $provide
  * @requires BastionConfig
- * @requires RootURL
  *
  * @description
  *   Used for establishing application wide configuration such as adding the Rails CSRF token
  *   to every request and adding Xs to translated strings.
  */
 angular.module('Bastion').config(
-    ['$httpProvider', '$urlRouterProvider', '$locationProvider', '$provide', 'BastionConfig', 'RootURL',
-    function ($httpProvider, $urlRouterProvider, $locationProvider, $provide, BastionConfig, RootURL) {
+    ['$httpProvider', '$urlRouterProvider', '$locationProvider', '$provide', 'BastionConfig',
+    function ($httpProvider, $urlRouterProvider, $locationProvider, $provide, BastionConfig) {
         var oldBrowserBastionPath = '/bastion#';
 
         $httpProvider.defaults.headers.common = {
@@ -94,8 +84,6 @@ angular.module('Bastion').config(
                         if ($templateCache.get(config.url) === undefined) {
                             config.url = '/' + config.url;
                         }
-                    } else if (!config.url.match(/^\/foreman_tasks/)) {
-                        config.url = RootURL + config.url;
                     }
 
                     return config || $q.when(config);
@@ -133,19 +121,17 @@ angular.module('Bastion').config(
  * @requires $window
  * @requires PageTitle
  * @requires markActiveMenu
- * @requires RootURL
  *
  * @description
  *   Set up some common state related functionality and set the current language.
  */
-angular.module('Bastion').run(['$rootScope', '$state', '$stateParams', 'gettextCatalog', 'currentLocale', '$location', '$window', 'PageTitle', 'markActiveMenu', 'RootURL',
-    function ($rootScope, $state, $stateParams, gettextCatalog, currentLocale, $location, $window, PageTitle, markActiveMenu, RootURL) {
+angular.module('Bastion').run(['$rootScope', '$state', '$stateParams', 'gettextCatalog', 'currentLocale', '$location', '$window', 'PageTitle', 'markActiveMenu',
+    function ($rootScope, $state, $stateParams, gettextCatalog, currentLocale, $location, $window, PageTitle, markActiveMenu) {
         var fromState, fromParams, orgSwitcherRegex;
 
         $rootScope.$state = $state;
         $rootScope.$stateParams = $stateParams;
         $rootScope.transitionTo = $state.transitionTo;
-        $rootScope.RootURL = RootURL;
 
         $rootScope.isState = function (stateName) {
             return $state.is(stateName);

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

@@ -10,9 +10,12 @@
   </div>
 
   <div class="row nutupane-details-bar">
-    <div class="col-sm-3">
+    <div class="col-sm-4">
       <div data-block="search">
         <div class="input-group input-group">
+
+          <span data-block="search-filter"></span>
+
           <input type="text"
                  class="form-control"
                  placeholder="{{ 'Search...' | translate }}"
@@ -29,22 +32,10 @@
       <span class="nutupane-info" data-block="result-count" translate>Showing {{ detailsTable.rows.length }} of {{ detailsTable.resource.subtotal }} ({{ detailsTable.resource.total }} Total)</span>
     </div>
 
-    <div class="col-sm-2" ng-show="detailsTable.working">
-      <i class="icon-spinner icon-spin"></i>
-      <span translate>Working...</span>
-    </div>
-
     <div class="col-sm-4 fr">
       <div class="fr">
         <span class="nutupane-info fl" data-block="selection-summary">
           <span translate>{{ detailsTable.numSelected }} Selected</span>
-          <span>|</span>
-          <a class="deselect-action"
-             translate
-             ng-class="{ 'disabled-link' : detailsTable.numSelected == 0 }"
-             ng-click="detailsTable.selectAllResults(false)">
-            Deselect All
-          </a>
         </span>
 
         <span class="fl">
@@ -52,7 +43,11 @@
         </span>
       </div>
     </div>
+  </div>
 
+  <div class="working-indicator text-center" ng-show="detailsTable.working">
+    <i class="icon-spinner icon-spin"></i>
+    <span translate>Working...</span>
   </div>
 
   <div class="nutupane" alch-table="detailsTable" nutupane-table>

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

@@ -31,13 +31,6 @@
     <div class="fr">
       <div class="nutupane-info fl" ng-if="table.rowSelect">
         <span translate>{{ table.numSelected }} Selected</span>
-        <span>|</span>
-        <a class="deselect-action"
-           translate
-           ng-class="{ 'disabled-link' : table.numSelected == 0 }"
-           ng-click="table.selectAllResults(false)">
-          Deselect All
-        </a>
       </div>
 
       <div class="fl">

data/app/assets/stylesheets/bastion/nutupane.less

@@ -149,16 +149,19 @@ td.row-select {
 }
 
 .info-label {
-  font-weight: 600;
   display: inline-block;
-  width: 25%;
+  font-weight: 600;
   vertical-align: top;
+  width: 25%;
+  word-break: break-all;
+  word-wrap: break-word;
 }
 
 .info-value {
-  width: 69%;
   display: inline-block;
   padding-left: 4px;
+  width: 69%;
+  word-break: break-all;
   word-wrap: break-word;
 }
 
@@ -290,20 +293,6 @@ td.row-select {
   }
 }
 
-.info-label {
-  font-weight: 600;
-  display: inline-block;
-  width: 25%;
-  vertical-align: top;
-}
-
-.info-value {
-  width: 69%;
-  display: inline-block;
-  padding-left: 4px;
-  word-wrap: break-word;
-}
-
 .select-action {
   margin-top: 6px;
 
@@ -391,3 +380,7 @@ div.alch-dialog.open.info-value {
 .details-section {
   padding: 0 15px;
 }
+
+.working-indicator {
+  font-size: 200%;
+}

data/lib/bastion/version.rb

@@ -1,3 +1,3 @@
 module Bastion
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bastion
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Katello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: angular-rails-templates
@@ -357,32 +357,32 @@ signing_key:
 specification_version: 4
 summary: Summary of Bastion.
 test_files:
-- test/widgets/page-title.service.test.js
-- test/widgets/path-selector.directive.test.js
-- test/widgets/page-title.directive.test.js
-- test/bastion/test-constants.js
-- test/bastion/bastion-resource.factory.test.js
 - test/menu/menu-expander.service.test.js
-- test/utils/form-utils.service.test.js
-- test/utils/as.filter.test.js
-- test/incubator/alch-alert.directive.test.js
+- test/widgets/page-title.directive.test.js
+- test/widgets/path-selector.directive.test.js
+- test/widgets/page-title.service.test.js
+- test/incubator/alch-flyout.directive.test.js
 - test/incubator/alch-menu.directive.test.js
 - test/incubator/alch-dropdown.directive.test.js
-- test/incubator/alch-infinite-scroll.directive.test.js
-- test/incubator/alch-container-scroll.directive.test.js
-- test/incubator/alch-form-group.directive.test.js
 - test/incubator/alch-modal.directive.test.js
-- test/incubator/nutupane-table.directive.test.js
-- test/incubator/format/unlimited-filter.filter.test.js
-- test/incubator/format/key-value-to-string.filter.test.js
-- test/incubator/format/array-to-string.filter.test.js
+- test/incubator/alch-edit.directive.test.js
+- test/incubator/alch-form-group.directive.test.js
 - test/incubator/format/boolean-to-yes-no.filter.test.js
+- test/incubator/format/array-to-string.filter.test.js
+- test/incubator/format/key-value-to-string.filter.test.js
+- test/incubator/format/unlimited-filter.filter.test.js
 - test/incubator/format/capitalize.filter.test.js
-- test/incubator/alch-form-buttons.directive.test.js
-- test/incubator/alch-edit.directive.test.js
-- test/incubator/nutupane.factory.test.js
-- test/incubator/alch-flyout.directive.test.js
+- test/incubator/alch-container-scroll.directive.test.js
 - test/incubator/alch-table.directive.test.js
+- test/incubator/nutupane.factory.test.js
+- test/incubator/alch-form-buttons.directive.test.js
+- test/incubator/alch-infinite-scroll.directive.test.js
+- test/incubator/nutupane-table.directive.test.js
+- test/incubator/alch-alert.directive.test.js
+- test/utils/as.filter.test.js
+- test/utils/form-utils.service.test.js
+- test/i18n/translate.service.test.js
 - test/auth/authorization.service.test.js
 - test/test-mocks.module.js
-- test/i18n/translate.service.test.js
+- test/bastion/bastion-resource.factory.test.js
+- test/bastion/test-constants.js