oxidized-web 0.13.1 → 0.15.0

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 gemspec = eval(File.read(Dir['*.gemspec'].first))
-gemfile = [gemspec.name, gemspec.version].join('-') + '.gem'
+gemfile = "#{[gemspec.name, gemspec.version].join('-')}.gem"
 
 # Integrate Rubocop if available
 begin
@@ -26,6 +26,7 @@ task :test do
   Rake::TestTask.new do |t|
     t.libs << 'spec'
     t.test_files = FileList['spec/**/*_spec.rb']
+    t.ruby_opts = ['-W:deprecated']
     t.warning = true
     t.verbose = true
   end
@@ -44,18 +45,17 @@ end
 
 desc 'Tag the release'
 task :tag do
-  system "git tag #{gemspec.version}"
+  system "git tag #{gemspec.version} -m 'Release #{gemspec.version}'"
 end
 
 desc 'Push to rubygems'
-task :push => :tag do
+task push: :tag do
   system "gem push pkg/#{gemfile}"
 end
 
 desc 'Normalise file permissions'
 task :chmod do
-  xbit = %w[
-  ]
+  xbit = %w[]
   dirs = []
   %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.each do |file|
     dirs.push(File.dirname(file))
@@ -64,4 +64,48 @@ task :chmod do
   dirs.sort.uniq.each { |dir| File.chmod(0o0755, dir) }
 end
 
+desc 'Copy web packages from npm into public'
+task :weblibs do
+  weblibs = []
+  fonts = []
+
+  # jQuery
+  weblibs << 'node_modules/jquery/dist/jquery.js'
+
+  # Bootstrap
+  weblibs << 'node_modules/bootstrap/dist/js/bootstrap.js'
+  weblibs << 'node_modules/bootstrap/dist/js/bootstrap.js.map'
+  weblibs << 'node_modules/bootstrap/dist/css/bootstrap.css'
+  weblibs << 'node_modules/bootstrap/dist/css/bootstrap.css.map'
+  weblibs << 'node_modules/bootstrap/dist/js/bootstrap.bundle.js'
+  weblibs << 'node_modules/bootstrap/dist/js/bootstrap.bundle.js.map'
+
+  # Bootstrap-icons
+  weblibs << 'node_modules/bootstrap-icons/font/bootstrap-icons.css'
+  fonts << 'node_modules/bootstrap-icons/font/fonts/bootstrap-icons.woff'
+  fonts << 'node_modules/bootstrap-icons/font/fonts/bootstrap-icons.woff2'
+
+  # Datatables
+  weblibs << 'node_modules/datatables.net/js/dataTables.js'
+
+  # Datatables + Bootstrap
+  weblibs << 'node_modules/datatables.net-bs5/js/dataTables.bootstrap5.js'
+  weblibs << 'node_modules/datatables.net-bs5/css/dataTables.bootstrap5.css'
+
+  # Datatables Buttons + Bootstrap
+  weblibs << 'node_modules/datatables.net-buttons-bs5/js/buttons.bootstrap5.js'
+  weblibs << 'node_modules/datatables.net-buttons-bs5/css/buttons.bootstrap5.css'
+  # colVis
+  weblibs << 'node_modules/datatables.net-buttons/js/dataTables.buttons.js'
+  weblibs << 'node_modules/datatables.net-buttons/js/buttons.colVis.js'
+
+  weblibs.each do |w|
+    cp(w, 'lib/oxidized/web/public/weblibs')
+  end
+
+  fonts.each do |f|
+    cp(f, 'lib/oxidized/web/public/weblibs/fonts')
+  end
+end
+
 task default: :test

data/docs/development.md

@@ -0,0 +1,182 @@
+# Index
+1. [Run from git](#how-to-run--develop-oxidized-web-from-git)
+2. [Update weblibs](#update-the-weblibs)
+3. [Release](#how-to-release-a-new-version-of-oxidized-web)
+
+# How to run / develop oxidized-web from git
+## Using the latest oxidized package
+When you develop oxidized-web, it is quite simple to run it from git. As it depends on oxidized,
+oxidized will be included in `bundle install`, and you just have to run `bundle exec oxidized`.
+You need bundler, if not installed yet. On debian-based systems, you can run `sudo apt install ruby-bundler` to install it.
+
+All steps in one to copy & pase:
+```shell
+git clone git@github.com:ytti/oxidized-web.git
+cd oxidized-web
+bundle config set --local path 'vendor/bundle'
+bundle install
+bundle exec oxidized
+```
+
+Changes to haml templates are reloaded on the fly. For changes to the ruby
+scripts, you have to stop an restart `bundle exec oxidized`.
+
+## Paralell development between oxidized and oxidized-web
+You may need to make some changes in oxidized **and** oxidized-web. For this,
+git clone oxidized and oxidized-web in a common root directory.
+
+Then you can link your oxidized-web with the oxidized, add the direct
+dependency to ../oxidized-web in oxidized and run oxidized from the oxidized
+repo:
+
+```shell
+git clone git@github.com:ytti/oxidized-web.git
+git clone git@github.com:ytti/oxidized.git
+cd oxidized
+bundle config set --local path 'vendor/bundle'
+echo "gem 'oxidized-web', path: '../oxidized-web'" >> Gemfile
+bundle install
+bundle exec bin/oxidized
+```
+
+Be careful when commiting your work in oxidized *NOT* to include the changes to
+Gemfile, as this is a local change for development. I (@robertcheramy) didn't
+find a better way to do this, better ideas are welcome :-)
+
+If your changes to oxidized **AND** oxidzed-web are dependent from another, make
+sure you document this in the respectives CHANGELOG.md, so that everyone is
+informed at the next release.
+
+Note: you can also add the dependency to oxidized in oxidized-web, in the same
+fashion:
+```shell
+git clone git@github.com:ytti/oxidized-web.git
+git clone git@github.com:ytti/oxidized.git
+cd oxidized-web
+bundle config set --local path 'vendor/bundle'
+echo "gem 'oxidized', path: '../oxidized'" >> Gemfile
+bundle install
+bundle exec oxidized
+```
+
+
+# Update the weblibs
+The weblibs are beeing downloaded and maintained by `npm`.
+
+Run `npm install` to download the weblibs. They will be stored under
+`node_modules`.
+The file `package-lock.json` (wich is tracked in git) ensures that every
+developer gets the same versions.
+
+Run `npm outdated` to get a list of new releases:
+
+```shell
+oxidized-web$ npm outdated
+Package             Current  Wanted  Latest  Location                         Depended by
+datatables.net-bs5    2.0.7   2.0.8   2.0.8  node_modules/datatables.net-bs5  oxidized-web
+```
+
+Run `npm update` to get the latest releases. They still are not used
+oxidzed-web. Run `rake weblibs` to sync `node_modules` with
+`lib/oxidized/web/public/weblibs`.
+
+Test, and commit the changes to the weblibs **and** package-lock.json. Don't
+forget to document your changes in CHANGELOG.md.
+
+# How to release a new version of Oxidized-web?
+
+## Review changes
+Run `git diff 0.xx.yy..master` (where `0.xx.yy` is to be changed to the last
+release) and review all the changes that have been done. Have a specific look
+at changes you don't understand.
+
+It is nicer to read in a GUI, so you can use something like
+`git difftool --tool=kdiff3 -d 0.xx.yy..master` to see it in kdiff3.
+
+## Update the gem dependencies to the latest versions
+```
+bundle outaded
+bundle update
+bundle outaded
+```
+
+Retest after updating!
+
+## Update the weblibs to the latest versions
+```
+npm outdated
+```
+
+Retest after updating!
+
+## Update rubocup .rubocop_todo.yml
+Run `bundle exec rubocop --auto-gen-config`,
+and make sure `bundle exec rake` passes after it.
+
+If you change some code => Restart the release process at the beginning ;-)
+
+## Make sure the file permissions are correct
+Run `bundle exec rake chmod`
+
+## Test, test test!
+Run `bundle exec rake` on the git repository to check the code against rubocop and rund the
+defined tests in `/spec`.
+
+Run Oxidized-web from git against the latest Oxidized version `bundle exec oxdized`
+
+Run Oxidized-web from git against the latest git of Oxidized (see above).
+
+Do not integrate late PRs into master if they do not fix issues for the release. The must wait for the next release.
+
+## Version numbering
+Oxidized-web versions are nummered like 0.major.minor
+- major is incremented when releasing new features. minor is then set to 0
+- minor is incremented when releasing fixes only, just after a major version.
+
+## Release
+1. Checkout the master branch of oxidized-web. Make sure you are up to date with origin.
+2. Change the version in lib/oxidized/web/version.rb
+3. Change CHANGELOG.md to replace [Unreleased] with [0.xx.yy – 202Y-MM-DD]
+4. Run `git diff` to check your changes
+5. Commit the changes to the local git repository with a commit message “chore(release): release version 0.xx.yy”
+6. Tag the commit with `git tag -a 0.xx.yy -m "Release 0.xx.yy"`
+7. Build the gem with ‘rake build’
+8. Install an test the gem locally:
+```
+gem install --user-install pkg/oxidized-web-0.xx.yy.gem
+~/.local/share/gem/ruby/3.1.0/bin/oxidized
+```
+## Release in github
+1. Push the commit and the tag to github:
+```
+git push
+git push origin 0.xx.yy
+```
+
+2. Make a release from the tag in github
+- Thank the contributors
+- Only describe major changes, and refer to CHANGELOG.md
+- List new contributors (generated automatically)
+
+## Release in rubygems
+Push the gem with ‘rake push’
+
+You need an account at rubygems which is allowed to push oxidized
+
+## Update CHANGELOG.md for next release
+Add
+```
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+```
+And push to github
+
+## Congratulate yourself
+Great job! Treat yourself to your favorite drink, you deserve it!
+

data/lib/oxidized/web/public/css/oxidized.css

@@ -0,0 +1,59 @@
+/* Display status of device in /nodes and /stats */
+.status, .success, .no_connection, .never {
+  float: right;
+  width: 15px;
+  height: 15px;
+  border: 1px solid;
+  margin-right: 70%;
+  margin-bottom: 0px;
+  border-radius: 2px; }
+
+.success {
+  background-color: #64FE2E; }
+
+.no_connection {
+  background-color: #FF0000; }
+
+.never {
+  background-color: #58ACFA; }
+
+/* node/version/diffs */
+.added {
+  background-color: #DBFFDB; }
+
+.deleted {
+  background-color: #FFDDDD; }
+
+
+.diff-index {
+  background-color: #FFFF99; }
+
+.diff-empty {
+  background-color: #F0F0F0; }
+
+.diffs, .diffs_old, .diffs_new {
+  background-color: #FAFAFA;
+  border: 2px solid #ccc;
+  border-radius: 5px;
+  padding: 3px;
+  font-family: Consolas, "Lucida Console", monospace;
+  white-space: pre; }
+
+.diffs_old {
+  float: left;
+  width: 49%;
+  overflow: auto; }
+
+.diffs_new {
+  margin-left: 51%;
+  width: 49%;
+  overflow: auto; }
+
+.old_version_title {
+  float: left;
+  width: 49%;
+  font-weight: bold; }
+
+.new_version_title {
+  margin-left: 51%;
+  font-weight: bold; }

data/lib/oxidized/web/public/scripts/oxidized.js

@@ -1,40 +1,3 @@
-// Add a line for a new file to upload
-var add_file_upload = function() {
-  var rancidDbDiv = $("div[id^='rancidDb']:last");
-  var num = parseInt(rancidDbDiv.prop("id").match(/\d+/g)) + 1;
-  rancidDbDiv.clone(true)
-    .prop("id", "rancidDb" + num)
-    .insertAfter(rancidDbDiv);
-  $("input[id^='file']:last")
-    .prop("id", "file" + num)
-    .prop("name", "file" + num)
-    .parents('.input-group')
-    .find(':text')
-    .val('');
-  $("input[id^='group']:last")
-    .prop("id", "group" + num)
-    .prop("name", "group" + num);
-};
-
-var onFileSelected = function() {
-  $(document).on('change', '.btn-file :file', function() {
-    var input = $(this),
-        numFiles = input.get(0).files ? input.get(0).files.length : 1,
-        label = input.val().replace(/\\/g, '/').replace(/.*\//, '');
-    input.trigger('fileSelect', [numFiles, label]);
-  });
-};
-
-// fix colvis buttons
-var fixColVisBtn = function() {
-  $('.ColVis_Button').each(function() {
-    $(this).addClass('btn btn-default');
-  });
-  $('.ColVis_MasterButton').each(function() {
-    $(this).addClass('pull-right');
-  });
-};
-
 var convertTime = function() {
   /* Convert UTC times to local browser times
   *  Requires that the times on the server are UTC
@@ -53,24 +16,14 @@ var convertTime = function() {
     var hour = ("0" + date.getHours()).slice(-2);
     var minute = ("0" + date.getMinutes()).slice(-2);
     var second = ("0" + date.getSeconds()).slice(-2);
-    var timeZone = date.toString().match(/\(.*\)/)[0].match(/[A-Z]/g).join('');
+    var timeZone = date.toString().match(/[A-Z]{3,4}[+-][0-9]{4}/)[0];
     $(this).text(year + '-' + month + '-' + day + ' ' + hour + ':' + minute + ':' + second + ' ' + timeZone);
   });
 };
 
 $(function() {
   onFileSelected();
-  fixColVisBtn();
   convertTime();
-  // Add a row to the migration form
-  $("#add").click(function() {
-    add_file_upload();
-  });
-
-  // Updates textbox with filename on fileSelect event
-  $('.btn-file :file').on('fileSelect', function(e, numFiles, label) {
-    $(this).parents('.input-group').find(':text').val(label);
-  });
 
   // Reloads the nodes from a source by calling the /reload.json URI
   $('#reload').click(function() {