stress_reporter 0.0.4 → 0.0.5

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
@@ -8,3 +8,24 @@ end
 
 desc "Run tests"
 task :default => :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+project_root = File.expand_path(File.dirname(__FILE__))
+doc_destination = File.join(project_root, 'doc')
+
+YARD::Rake::YardocTask.new(:generate) do |yt|
+  yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+    [ File.join(project_root, 'README.md') ]
+  yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
+end
+
+# Rake::RDocTask.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'doc'
+#   rdoc.main = 'README.md'
+# #  rdoc.rdoc_files.include 'README.md', 'CHANGELOG.txt', "config/**/*\.rb", "helpers/**/*\.rb", "script/**/*\.rb"
+#   rdoc.rdoc_files.include 'README.md', "lib/**/*\.rb"
+#   rdoc.options << '--line-numbers'
+#   rdoc.options << '--all'
+# end

data/lib/stress_reporter/actions/free.rb

@@ -1,9 +1,8 @@
 module StressReporter
   module Actions
-    # Actions to report on passenger usage.
-    # Current requests, urls, pids
-    # TODO: We should not assume that xm_last_url_for_{pid} are in /tmp
-    # TODO: Spawning passenger-status is slow
+    # Returns output of free command
+    #
+    # TODO: Should read /proc directly
     class Free
 
       # Report returns a string array
@@ -12,4 +11,4 @@ module StressReporter
       end
     end
   end
-end
+end

data/lib/stress_reporter/actions/xmanager.rb

@@ -1,15 +1,22 @@
 module StressReporter
+  # Classes under this namespace define specific things to do
+  # to include in reporting. They have to respond to #report with
+  # a string array.
   module Actions
-    # Actions to report on passenger usage.
-    # Current requests, urls, pids
+    # Reports on passenger usage by calling passenger-status
+    # (pid and current request)
+    #
     # TODO: We should not assume that xm_last_url_for_{pid} are in /tmp
-    # TODO: Spawning passenger-status is slow
+    #
+    # TODO: Spawning passenger-status is slow, probably we should include
+    # the passenger gem and use its methods.
     class Xmanager
 
       CMD = "passenger-status"
       PID_REGEX = /PID:\s*(\d+)/
 
-      # Report returns a string array
+      # Report lines
+      # @return [Array<String>]
       def self.report
         out = []
         Xmanager.current_requests.each_pair do |pid, url|
@@ -30,8 +37,7 @@ module StressReporter
       def self.current_requests
         requests = {}
         pids.each do |pid|
-          requests[pid] =
-            File.read("/tmp/xm_last_url_for_#{ pid }").chomp rescue "Not xmanager or fresh process"
+          requests[pid] = File.read("/tmp/xm_last_url_for_#{ pid }").chomp rescue "Not xmanager or fresh process"
         end
         requests
       end

data/lib/stress_reporter/checker.rb

@@ -1,12 +1,13 @@
 # This class has the knowledge of when to run the reporting.
-# It may well become a strategy, or a DSL parser; for the time
-# being the check is very crude, just check last minute load
+# It may well become a strategy, or a DSL parser.
+# For the time being the check is very crude, just check last  minute load
 # average
 class StressReporter::Checker
 
-  # This limit is going to be passed in as a command line arg
+  # This limit can be passed in as a command line arg
+  #
   # Defaults to 1.0
-  LIMIT = ARGV.empty? ? 1 : ARGV[0].to_f
+  LIMIT = ARGV.empty? ? 1.0 : ARGV[0].to_f
 
   # starts at 0.0
   @@load_average = 0.0
@@ -17,7 +18,8 @@ class StressReporter::Checker
     @@load_average > LIMIT
   end
 
-  # Returns last load average
+  # Returns last checked load average
+  # @return [Float]
   def self.load_average
     @@load_average
   end

data/lib/stress_reporter/version.rb

@@ -1,3 +1,3 @@
 module StressReporter
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/stress_reporter.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'sys-cpu'
-#  gem.add_runtime_dependency 'passenger'
   gem.add_runtime_dependency 'SystemTimer'
 
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'redcarpet'
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stress_reporter
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Marcello Colacino
@@ -60,6 +60,34 @@ dependencies:
         version: "0"
   requirement: *id003
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yard
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: redcarpet
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  type: :development
 description: Daemon that runs and reports on stressful stuff
 email: 
 - marcello.colacino@interact.it
@@ -119,3 +147,4 @@ specification_version: 3
 summary: Was born with specific needs but may be extended to cover more scenarios
 test_files: 
 - test/test_checker.rb
+has_rdoc: