resource_monitor 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d2f558aa24ed692b92657bca03260f2b16c4dcb
-  data.tar.gz: 951c07c6590528a64ec2b689f2f6a7e7af6cdc9b
+  metadata.gz: b9cff3d45a83f8e83d3297d05360bc74aabf34e7
+  data.tar.gz: 61dd96132acfdf3b75fa5ffd61f11c1e1c538115
 SHA512:
-  metadata.gz: c72ce0bac76d767f0d92a11c3687e14af5a1ff9829d9daf5c85c10ac8d0fd8e339648c0e358ac532fcca043165e476733fc4b3ebe40c07251e936e23b4153624
-  data.tar.gz: 23cd4a512529aca82144f698f03bf1ce7739a66e293ca0e5fe6d1bffccf6ff659ee91897600d92f6e905a54cea9ccc11be1779d47cdfdd91b20727ef779f8412
+  metadata.gz: 11843bbb8f9c150e0687f78fdaa7f936d04682e45cf398e5f96cbc56dcd3651088142e1de4ed1a17d4d5b9d8fd3fd0830d261813925f3d9010502f6a3c5868c8
+  data.tar.gz: 117e13d29e5ed610285f992c495256815881b0cce37a5fdd73d9bb2135ccab1f60739f41c9b5302d4d88442d0122a83d966024feb7ff6107eb1585e6cb99621a

data/README.md

@@ -8,7 +8,9 @@ Creates a simple page under /resources/ that is updated with CPU/RAM usage in re
 
 Although not a major performance hog, this should only be run in production when there is evidence of resource overuse, look under the Usage section for instructions for disabling the gem.
 
-Current Project Status: Usable
+Latest Version: 0.1.2
+Last Feature Set: Engine created, no need to manually install dashboard.
+Recommended Installation: Uninstall dashboard, then remove Gemfile.lock and rebundle.
 
 ## Installation
 
@@ -22,11 +24,7 @@ And then execute:
 
     $ bundle install
 
-This following line will add a set of views/controllers/and channels into your app.
-
-    $ rake resource_monitor:install_dashboard
-
-And then add the following to the top of your application.rb file
+Add the following to the top of your application.rb file
 You can also only add it to the controllers you think may be causing some issues.
 
 ```ruby
@@ -37,15 +35,6 @@ def resource_monitor_app
   ResourceMonitor.benchmark(self)
 end
 ```
-
-## Uninstall
-
-If you added the dashboard to your project, you can remove it using this.
-
-    $ rake resource_monitor:uninstall_dashboard
-
-This will leave behind a "resource" folder in your views but it's less risky than removing folders from your views folder.
-
 ## Usage
 
 You can try out the gem by using
@@ -58,7 +47,7 @@ Once inside irb, you can use the following
   ResourceMonitor.benchmark(self)
 ```
 
-Install the dashboard, deploy and browse to /resources/.
+Bundle install and browse to /resources/.
 
 If you want to disable this, you can easily comment out the contents of resource_monitor_app or use an ENV variable such as below.
 

data/Rakefile

@@ -1,2 +1,38 @@
-require "bundler/gem_tasks"
-Dir.glob('lib/tasks/*.rake').each {|r| import r}
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ResourceMonitor'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+#load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+load 'lib/tasks/resource_monitor_tasks.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/channels/resource_monitor/resource_channel.rb

@@ -0,0 +1,8 @@
+module ResourceMonitor
+  class ResourceChannel < ApplicationCable::Channel
+    def subscribed
+      stream_from "resources"
+      ResourceMonitor.benchmark()
+    end
+  end
+end

data/app/controllers/resource_monitor/application_controller.rb

@@ -0,0 +1,5 @@
+module ResourceMonitor
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/resource_monitor/resource_controller.rb

@@ -0,0 +1,7 @@
+module ResourceMonitor
+  class ResourceController < ApplicationController
+    def index
+      render layout: false
+    end
+  end
+end

data/app/views/{resource → resource_monitor/resource}/index.html.erb

@@ -7,7 +7,7 @@
     <script>
       App.cable = ActionCable.createConsumer("//<%= request.host_with_port %>/cable");
       //App.cable = ActionCable.createConsumer("ws://localhost:3000/websocket");
-      App.data = App.cable.subscriptions.create({ channel: "ResourceChannel" }, {
+      App.data = App.cable.subscriptions.create({ channel: "ResourceMonitor::ResourceChannel" }, {
         received: function(data) {
           var json = JSON.parse(data)
           var process_id = json['process_id']

data/config/routes.rb

@@ -0,0 +1,3 @@
+ResourceMonitor::Engine.routes.draw do
+  get '/' => 'resource#index'
+end

data/lib/resource_monitor/engine.rb

@@ -0,0 +1,5 @@
+module ResourceMonitor
+  class Engine < ::Rails::Engine
+    isolate_namespace ResourceMonitor
+  end
+end

data/lib/resource_monitor/version.rb

@@ -1,3 +1,3 @@
 module ResourceMonitor
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/resource_monitor.rb

@@ -1,5 +1,5 @@
+require "resource_monitor/engine"
 require "resource_monitor/version"
-require "resource_monitor/railtie" if defined?(Rails)
 
 module ResourceMonitor
   def self.benchmark(controller=nil)

data/lib/tasks/resource_monitor_tasks.rake

@@ -0,0 +1,31 @@
+namespace :resource_monitor do
+  # Works perfectly as a quick test environment.
+  task :console do
+    # require 'irb'
+    # require 'irb/completion'
+    # require 'resource_monitor' # You know what to do.
+    # ARGV.clear
+    # IRB.start
+    puts "This functionality is broken in engine mode. Research further."
+  end
+
+  # Works correctly.
+  task :install_dashboard do
+    if defined?(Rails)
+      puts "Add the following to your routes/config.rb\n"
+      puts "mount ResourceMonitor::Engine => '/resources'"
+    else
+      puts "This installer should be run inside a Rails project."
+    end
+  end
+
+  # Does nothing at all.
+  task :uninstall_dashboard do
+    if defined?(Rails)
+      puts "Remove the following to your routes/config.rb\n"
+      puts "mount ResourceMonitor::Engine => '/resources'"
+    else
+      puts "This uninstaller should be run inside a Rails project."
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: resource_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lazaro Herrera
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-09 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -17,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,7 +45,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +59,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -60,21 +74,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- app/channels/resource_channel.rb
-- app/controllers/resource_controller.rb
-- app/views/resource/index.html.erb
-- bin/setup
+- app/channels/resource_monitor/resource_channel.rb
+- app/controllers/resource_monitor/application_controller.rb
+- app/controllers/resource_monitor/resource_controller.rb
+- app/views/resource_monitor/resource/index.html.erb
+- config/routes.rb
 - lib/resource_monitor.rb
-- lib/resource_monitor/railtie.rb
+- lib/resource_monitor/engine.rb
 - lib/resource_monitor/version.rb
-- lib/tasks/rm_console.rake
-- resource_monitor.gemspec
+- lib/tasks/resource_monitor_tasks.rake
 homepage: http://writecodeeveryday.github.io/projects/resource_monitor
 licenses:
 - MIT

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at lazherrera@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in resource_monitor.gemspec
-gemspec

data/app/channels/resource_channel.rb

@@ -1,6 +0,0 @@
-class ResourceChannel < ApplicationCable::Channel
-  def subscribed
-    stream_from "resources"
-    ResourceMonitor.benchmark()
-  end
-end

data/app/controllers/resource_controller.rb

@@ -1,5 +0,0 @@
-class ResourceController < ApplicationController
-  def index
-    render layout: false
-  end
-end

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/resource_monitor/railtie.rb

@@ -1,5 +0,0 @@
-class ResourceMonitor::Railtie < Rails::Railtie
-  rake_tasks do
-    load 'tasks/rm_console.rake'
-  end
-end

data/lib/tasks/rm_console.rake

@@ -1,39 +0,0 @@
-namespace :resource_monitor do
-  # Works perfectly as a quick test environment.
-  task :console do
-    require 'irb'
-    require 'irb/completion'
-    require 'resource_monitor' # You know what to do.
-    ARGV.clear
-    IRB.start
-  end
-
-  # Works correctly.
-  task :install_dashboard do
-    if defined?(Rails)
-      path = Gem.loaded_specs['resource_monitor'].full_gem_path
-      puts "Copying from #{path}/app/ to #{Rails.root.to_s}/app/"
-      FileUtils.cp_r "#{path}/app/.", "#{Rails.root.to_s}/app/"
-      puts "IMPORTANT: Remember to add the following route to your config/routes.rb"
-      puts "get '/resources/' => 'resource#index'"
-    else
-      puts "This installer should be run inside a Rails project."
-    end
-  end
-
-  # Does nothing at all.
-  task :uninstall_dashboard do
-    if defined?(Rails)
-      path = Gem.loaded_specs['resource_monitor'].full_gem_path
-      records = Dir.glob("#{path}/app/**/**").select { |f| File.file?(f) }
-      records.each do |item|
-        puts "Removing #{Rails.root.to_s}#{item.split(path)[1]}"
-        FileUtils.rm "#{Rails.root.to_s}#{item.split(path)[1]}"
-      end
-      puts "IMPORTANT: Remember to remove the following route from your config/routes.rb"
-      puts "get '/resources/' => 'resource#index'"
-    else
-      puts "This uninstaller should be run inside a Rails project."
-    end
-  end
-end

data/resource_monitor.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'resource_monitor/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "resource_monitor"
-  spec.version       = ResourceMonitor::VERSION
-  spec.authors       = ["Lazaro Herrera"]
-  spec.email         = ["lazherrera@gmail.com"]
-
-  spec.summary       = %q{A Rails 5 ActionCable gem for simple resource usage monitoring.}
-  spec.description   = %q{This gem creates a dashboard for monitoring of ongoing CPU/RAM usage of your processes.}
-  spec.homepage      = "http://writecodeeveryday.github.io/projects/resource_monitor"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "actioncable"
-end