runit-man 2.4.0a2 → 2.4.0

data/.gitignore

@@ -2,5 +2,7 @@
 *.gem
 .bundle/
 .vagrant
+.yardoc/
+doc/
 Gemfile.lock
 

data/.yardopts

@@ -0,0 +1,14 @@
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--no-private
+--readme README.md
+--title "runit-man Documentation"
+-
+README.md
+INSTALL.md
+CHANGELOG.md
+README_ru.md
+LICENSE
+DESCRIPTION
+

data/{CHANGELOG.markdown → CHANGELOG.md}

@@ -1,8 +1,13 @@
 ## Changes
 
+### Version 2.4.0
+
+* LogLocationCache completely removed to keep codebase small and readable.
+* Code refactoring to support multiple log file downloads and to avoid errors in case of file absence.
+
 ### Version 2.3.21
 
-* Running using <tt>bundle exec</tt> is fixed.
+* Running using `bundle exec` is fixed.
 * Initial staging environment added using [http://vagrantup.com/](Vagrant "Vagrant").
 * Fix internal error when log downloads directory is absent.
 
@@ -23,8 +28,8 @@
 
 ### Version 2.3.8
 
-* Minor update of handling logger log directories (we should remove last character from log directory name if it's equal to ':').
-* Enabling of using 'bundle exec rake ...' command.
+* Minor update of handling logger log directories (we should remove last character from log directory name if it equals to ':').
+* Enable of using `bundle exec rake ...` command.
 
 ### Version 2.3.7
 
@@ -41,7 +46,7 @@
 
 ### Version 2.3.4
 * Rack::File used to serve static files in old Sinatra releases (Sinatra 1.3.0 have this functionality built-in). Requires Rack 1.3.0 or higher.
-* rainbows configuration now uses sendfile gem if it's available to decrease CPU usage on serving large files.
+* rainbows configuration now uses sendfile gem if its available to decrease CPU usage on serving large files.
 
 ### Version 2.3.3
 * Typo (very old one).
@@ -99,7 +104,7 @@
 * Support for gzipped logs.
 
 ### Version 2.0.2
-* Fix log link hint, that's broken from 1.11.x (thanks to verm666).
+* Fix log link hint, thats broken from 1.11.x (thanks to verm666).
 
 ### Version 2.0.1
 * Use Bundler to simplify development tasks.
@@ -216,7 +221,7 @@
 * runit-man now can show custom count of lines per log.
 
 ### Version 1.4.5
-* Fix error when ran on machine when it's name cannot be resolved by DNS.
+* Fix error when ran on machine when its name cannot be resolved by DNS.
 * /services.json added to provide automation API. 
 
 ### Version 1.4.3
@@ -224,7 +229,7 @@
 * Script renamed to runit-man without extension.
 
 ### Version 1.4.1
-* Workaround for rubygems behavior (sometimes it doesn't update binaries).
+* Workaround for rubygems behavior (sometimes it doesnt update binaries).
 
 ### Version 1.4
 * Automated registration with given options.
@@ -254,3 +259,4 @@
 
 ### Version 0.1
 * First working release
+

data/Gemfile

@@ -7,3 +7,7 @@ group :rainbows do
   gem "sendfile", :platforms => "mri_18"
 end
 
+group :development do
+  gem "ripper", :platforms => "ruby_18"
+end
+

data/INSTALL.md

@@ -0,0 +1,49 @@
+## Requirements
+
+You need ruby 1.8.6 or above and rubygems installed.
+
+## Installation
+
+Use following command to install runit-man:
+
+```bash
+gem install runit-man
+```
+
+Take a look at runit-man script options:
+
+ * -p - Port to listen (4567 by default)
+ * -b - IP Address to bind (0.0.0.0 by default)
+ * -a - Directory of activated services (/etc/service by default)
+ * -f - Directory of all known services (/etc/sv by default)
+ * -u - User and password delimited by ':' for HTTP authentication (disabled by default)
+ * -r - Register runit-man as runit service (as defined by other options)
+ * --rackup='command' - Runs specified command in folder where is runit'man's config.ru located.
+
+### Using thin
+
+Usually you need thin gem to run runit-man effectively.
+
+```bash
+gem install thin
+```
+
+### Using rainbows
+
+When You need to handle large files (logs etc.) by runit-man script You need another setup:
+
+ * Install rainbows gem (it prevents memory consumption).
+ * Install sendfile gem if possible (It decreases CPU usage in combination with rainbows).
+ * Run runit-man as:
+
+```bash
+runit-man --rackup='rainbows -E production -c rainbows.conf -p $PORT'
+```
+
+Any localization can be done by editing of `./i18n/*.yml` locale files.
+Contributions are welcome.
+
+* [runit home page](http://smarden.org/runit/)
+* [runit-man home page](https://github.com/Undev/runit-man)
+
+Yours sincerely, Akzhan.

data/{README.markdown → README.md}

@@ -11,14 +11,20 @@ Server will run by **runit-man** script. Take a note that **runit-man** must hav
 ## Installation
 
 Usually You should install both **runit-man** and **thin** gems to run this tool fine.
-`gem install runit-man thin`
+
+```bash
+gem install runit-man thin
+```
 
 Pragmatic approach is to setup runit-man as runit service like this:
-`runit-man -p 14500 -r`
 
-This command installs runit-man as runit service (using default folders */etc/sv/* and */etc/service/*). 
+```bash
+runit-man -p 14500 -r
+```
+
+This command installs runit-man as runit service (using default folders `/etc/sv/` and `/etc/service/`).
 
-Look at INSTALL for details.
+Look at {file:INSTALL.md} for details.
 
 ### rackup configuration
 
@@ -31,17 +37,17 @@ This tool can provide additional information or actions through it's Web page.
 
 ### View names and content of files that related to concrete service
 
-For each known runit service this tool looks for **./runit-man/files-to-view/** folder.
+For each known runit service this tool looks for `./runit-man/files-to-view/` folder.
 Every symlink here will be shown as link to view target file content.
 
 ### Show links that related to concrete service
 
-For each known runit service this tool looks for **./runit-man/urls-to-view/** folder.
+For each known runit service this tool looks for `./runit-man/urls-to-view/` folder.
 Every file ended with .url will be shown as link to view target location (location should be written as content of this file).
 
 ### Show buttons that send signals to concrete service
 
-For each known runit service this tool looks for **./runit-man/allowed-signals/** folder.
+For each known runit service this tool looks for `./runit-man/allowed-signals/` folder.
 Each one-letter-named file declares that signal button should be shown in Web UI.
 
 Signal letters listed below in REST API section.
@@ -86,10 +92,17 @@ You can read tail of service log using
 `GET /<service name>/log/<count of tailing lines>.txt`
 
 Note that to use this feature You must do logging using 
-`exec svlogd options log_directory_location`
+
+```bash
+exec svlogd <options> $LOG_DIRECTORY_LOCATION
+```
 
 #### logger
 Use logger like:
-`exec logger  -i -t "runit-man" -p local1.info`
-and use option -l "logger:/var/log/" where base logs directory shown after period.
+
+```bash
+exec logger  -i -t "runit-man" -p local1.info
+```
+
+and use option `-l "logger:/var/log/"` where base logs directory shown after period.
 

data/{README_ru.markdown → README_ru.md}

@@ -11,14 +11,19 @@
 ## Инсталляция
 
 Обычно вам нужно поставить гемы **runit-man** и **thin** совместно, чтобы эта утилита работала эффективно.
-`gem install runit-man thin`
+
+```bash
+gem install runit-man thin
+```
 
 Прагматично установить runit-man как один из сервисов runit, например, так:
-`runit-man -p 14500 -r`
+```bash
+runit-man -p 14500 -r
+```
 
-Эта команда создаёт сервис runit-man, как один из обычных активных сервисов runit (используя каталоги */etc/sv/* and */etc/service/* по умолчанию).
+Эта команда создаёт сервис runit-man, как один из обычных активных сервисов runit (используя каталоги `/etc/sv/` and `/etc/service/` по умолчанию).
 
-Подробнее смотрите файл INSTALL.
+Подробнее смотрите файл {file:INSTALL.md}.
 
 ### Конфигурирование под Rack
 
@@ -31,17 +36,17 @@
 
 ### Просмотр имён и содержимого файлов, относящихся к конкретному сервису
 
-Для каждого известного сервиса runit эта утилита просматривает каталог **./runit-man/files-to-view/**.
+Для каждого известного сервиса runit эта утилита просматривает каталог `./runit-man/files-to-view/`.
 Каждый симлинк в этом каталоге будет показан как ссылка на просмотр содержимого целевого файла.
 
 ### Показ ссылок, относящихся к конкретному сервису
 
-Для каждого известного сервиса runit эта утилита просматривает каталог **./runit-man/urls-to-view/**.
+Для каждого известного сервиса runit эта утилита просматривает каталог `./runit-man/urls-to-view/`.
 Каждый файл, имеющий расширение .url, будет показан, как сылка на просмотр целевой локации (которая берётся как содержимое файла).
 
 ### Показ кнопок, которые посылают сигналы выбранному процессу
 
-Для каждого известного сервиса runit эта утилита просматривает каталог **./runit-man/allowed-signals/**.
+Для каждого известного сервиса runit эта утилита просматривает каталог `./runit-man/allowed-signals/`.
 Каждый однобуквенно-именованный файл определяет, что кнопка для сигнала должна появиться в пользовательском интерфейсе.
 
 Соответствия между буквами и сигналами перечислены ниже, в секции REST API.
@@ -85,13 +90,19 @@
 Вы можете читать хвост лога сервиса, используя
 `GET /<service name>/log/<count of tailing lines>.txt`
 
-Учитывайте, что этот функционал работает, только если Вы логгируете сервис с использованием команды вида 
-`exec svlogd options log_directory_location`
+Учитывайте, что этот функционал работает, только если Вы логгируете сервис с использованием команды вида
+
+```bash
+exec svlogd <options> $LOG_DIRECTORY_LOCATION
+```
 
 #### logger
 
 Если Вы предпочитаете logger, используйте его вот так:
-`exec logger -i -t "runit-man" -p local1.info`
 
-При этом нужно использовать опцию -l "logger:/var/log/", где после двоеточия надо указывать базовый каталог логов.
+```bash
+exec logger -i -t "runit-man" -p local1.info
+```
+
+При этом нужно использовать опцию `-l "logger:/var/log/"`, где после двоеточия надо указывать базовый каталог логов.
 

data/Rakefile

@@ -1,6 +1,15 @@
 # encoding: utf-8
 
 require 'rubygems'
+
+begin
+  require 'bundler'
+  Bundler.setup(:default, :development, :test)
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  $stderr.puts "Bundler not available. Install it with: gem install bundler"
+end
+
 $LOAD_PATH.unshift('./lib')
 
 require 'runit-man/version'
@@ -23,10 +32,10 @@ rescue LoadError
 end
 
 begin
-  require 'bundler'
-  Bundler.setup(:default)
-  Bundler::GemHelper.install_tasks
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
 rescue LoadError
-  $stderr.puts "Bundler not available. Install it with: gem install bundler"
+  $stderr.puts "YARD not available. Install it with: gem install yard"
 end
 

data/lib/runit-man/service_info.rb

@@ -1,6 +1,8 @@
 # Namespace: Information about service
 module ServiceInfo
   class << self
+    # Actual descendant class used to instantiate service information instances.
+    # @return [Class] Actual descendant class.
     attr_accessor :klass
   end
 end

data/lib/runit-man/service_info/logger.rb

@@ -65,7 +65,7 @@ class ServiceInfo::Logger < ServiceInfo::Base
         label = "#{Utils.host_name}-#{subdirname}-#{filename}"
 
         stats = File.stat(filepath)
-        stat_times = [stats.ctime.utc, stats.atime.utc, stats.mtime.utc]
+        stat_times = [stats.ctime.utc, stats.mtime.utc]
         min_time, max_time = stat_times.min, stat_times.max
 
         r << {

data/lib/runit-man/service_info/svlogd.rb

@@ -31,10 +31,16 @@ class ServiceInfo::Svlogd < ServiceInfo::Base
       next  unless File.readable?(path)
 
       stats = File.stat(path)
-      stat_times = [stats.ctime.utc, stats.atime.utc, stats.mtime.utc]
+      stat_times = [stats.ctime.utc, stats.mtime.utc]
       min_time, max_time = stat_times.min, stat_times.max
 
-      label = "#{Utils.host_name}-#{self.name}-#{I18n.l(min_time)}-#{I18n.l(max_time)}.log"
+      if min_time != max_time
+        stat_times = "#{I18n.l(min_time)}-#{I18n.l(max_time)}"
+      else
+        stat_times = I18n.l(min_time)
+      end
+
+      label = "#{Utils.host_name}-#{self.name}-#{stat_times}.log"
       label = label.gsub(/[\:\s\,]/, '-').gsub(/[\\\/]/, '.')
       r << {
         :name     => name,

data/lib/runit-man/utils.rb

@@ -1,8 +1,12 @@
 require 'socket'
 require 'i18n'
 
+# Utilities.
 class Utils
   class << self
+    # Gets local host name.
+    # @return [String] Host name.
+    # @note Caches host name on first access.
     def host_name
       unless @host_name
         begin
@@ -15,8 +19,11 @@ class Utils
       @host_name
     end
 
+    # I18n.t shortcut.
+    # @return [String] Translated string.
     def t(*args)
       I18n.t(*args)
     end
   end
 end
+

data/lib/runit-man/version.rb

@@ -1,4 +1,6 @@
+# runit-man namespace.
 module RunitMan
-  VERSION = '2.4.0a2'.freeze
+  # runit-man version.
+  VERSION = '2.4.0'.freeze
 end
 

data/runit-man.gemspec

@@ -13,8 +13,11 @@ spec = Gem::Specification.new do |s|
   s.requirements << 'none'
   s.require_path = 'lib'
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+
   s.extra_rdoc_files = [
-    "README.markdown"
+    "README.md",
+    "INSTALL.md",
+    "CHANGELOG.md"
   ]
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -30,6 +33,8 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'rr'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'bundler', ['~> 1.0', '> 1.0.10']
+  s.add_development_dependency 'yard', '~> 0.7.5'
+  s.add_development_dependency 'redcarpet', '~> 1.17.2'
   s.description = File.open(File.join(File.dirname(__FILE__), 'DESCRIPTION')).read
 end
 

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: runit-man
 version: !ruby/object:Gem::Version
-  version: 2.4.0a2
-  prerelease: 5
+  version: 2.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Akzhan Abdulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2158419480 !ruby/object:Gem::Requirement
+  requirement: &2153692900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158419480
+  version_requirements: *2153692900
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2158418760 !ruby/object:Gem::Requirement
+  requirement: &2153692360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158418760
+  version_requirements: *2153692360
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2158418300 !ruby/object:Gem::Requirement
+  requirement: &2153691880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2158418300
+  version_requirements: *2153691880
 - !ruby/object:Gem::Dependency
   name: sinatra-content-for2
-  requirement: &2158417420 !ruby/object:Gem::Requirement
+  requirement: &2153691360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *2158417420
+  version_requirements: *2153691360
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2158416360 !ruby/object:Gem::Requirement
+  requirement: &2153690820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2158416360
+  version_requirements: *2153690820
 - !ruby/object:Gem::Dependency
   name: file-tail
-  requirement: &2158414440 !ruby/object:Gem::Requirement
+  requirement: &2153690260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2158414440
+  version_requirements: *2153690260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2158413020 !ruby/object:Gem::Requirement
+  requirement: &2153689620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +90,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *2158413020
+  version_requirements: *2153689620
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &2158412020 !ruby/object:Gem::Requirement
+  requirement: &2153688780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +101,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158412020
+  version_requirements: *2153688780
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &2158410660 !ruby/object:Gem::Requirement
+  requirement: &2153688140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +112,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158410660
+  version_requirements: *2153688140
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &2158410240 !ruby/object:Gem::Requirement
+  requirement: &2153686480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,10 +123,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158410240
+  version_requirements: *2153686480
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2158409720 !ruby/object:Gem::Requirement
+  requirement: &2153685940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -134,10 +134,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158409720
+  version_requirements: *2153685940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2158408740 !ruby/object:Gem::Requirement
+  requirement: &2153685060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -148,7 +148,29 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *2158408740
+  version_requirements: *2153685060
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153683440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: *2153683440
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &2153682560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+  type: :development
+  prerelease: false
+  version_requirements: *2153682560
 description: ! 'Simple runit (http://smarden.org/runit/) web management tool with
   i18n.
 
@@ -164,17 +186,20 @@ executables:
 - runit-man
 extensions: []
 extra_rdoc_files:
-- README.markdown
+- README.md
+- INSTALL.md
+- CHANGELOG.md
 files:
 - .gitignore
 - .gitmodules
-- CHANGELOG.markdown
+- .yardopts
+- CHANGELOG.md
 - DESCRIPTION
 - Gemfile
-- INSTALL
+- INSTALL.md
 - LICENSE
-- README.markdown
-- README_ru.markdown
+- README.md
+- README_ru.md
 - Rakefile
 - Vagrantfile
 - bin/runit-man
@@ -240,13 +265,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1381096489065286937
+      hash: -2528648994926986438
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -2528648994926986438
 requirements:
 - none
 rubyforge_project: 
@@ -257,3 +285,4 @@ summary: Runit web management tool.
 test_files:
 - spec/functional/runit-man_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/INSTALL

@@ -1,33 +0,0 @@
-You need ruby 1.8.6 or above and rubygems installed.
-
-Use following command to install runit-man:
-  gem install runit-man
-
-Take a look at runit-man script options:
-
- -p - Port to listen (4567 by default)
- -b - IP Address to bind (0.0.0.0 by default)
- -a - Directory of activated services (/etc/service by default)
- -f - Directory of all known services (/etc/sv by default)
- -u - User and password delimited by ':' for HTTP authentication (disabled by default)
- -r - Register runit-man as runit service (as defined by other options)
- --rackup='command' - Runs specified command in folder where is runit'man's config.ru located.
-
-Usually you need thin gem to run runit-man effectively.
-  gem install thin
-
-When You need to handle large files (logs etc.) by runit-man script You need another setup:
- * Install rainbows gem (it prevents memory consumption).
- * Upgrade rack gem to version 1.3 or higher and install sendfile gem if possible (It decreases CPU usage in combination with rainbows).
- * Run runit-man as:
-
-    runit-man --rackup='rainbows -E production -c rainbows.conf -p <PORT>'
-
-Any localization can be done by editing of ./i18n/*.yml locale files.
-Contributions are welcome.
-
-runit home page: http://smarden.org/runit/
-runit-man home page: https://github.com/Undev/runit-man
-
-Yours sincerely,
-  Akzhan.