remote_logger 0.0.1 → 0.0.3

data/.gitignore

@@ -1,21 +1,21 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/HISTORY

@@ -0,0 +1,11 @@
+== 0.0.0 / 2010-09-06
+
+* Birthday!
+
+== 0.0.2 / 2010-09-06
+
+* Migrated to new project structure
+
+== 0.0.3 / 2010-09-06
+
+* Gemspec fixed

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 arvicco
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2010 Arvicco
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -1,61 +1,61 @@
-remote_logger
-    by: arvicco
-    url: http://github.com/arvicco/remote_logger
-
-== DESCRIPTION:
-
-Log server/client with sensible defaults that can be used for remote/centralized logging.
-
-== FEATURES:
-
-Log4r is a customizable logger with advanced functionality. Unfortunately, it only supports (rarely used) ROMP protocol
-for remote logging support. This project aims to improve remote logging by creatting a wrapper around Log4r that:
-* Exposes Log4r functionality remotely through multiple protocols
-* Writes to (log server) stdout AND log file 'remote.log' by default
-* Allows client to use Drb uri or Ring server to find the logger service
-
-== PROBLEMS/TODO:
-
-* TODO: add AMQP rpc support
-
-  Work in progress, please do not use it just yet...
-
-== SYNOPSIS:
-
-server:
----
-  include RemoteLogger
-  start_drb_logger [options] # or,
-  start_ringy_logger [options]
----
-
-client:
----
-  include RemoteLogger
-  log = find_drb_logger [options] # or,
-  log = find_ringy_logger [options]
-  log.info 'This is my log message'
----
-
-== REQUIREMENTS:
-
-* FIXME (list of requirements)
-
-== INSTALL:
-
-  sudo gem install remote_logger
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 arvicco. See LICENSE for details.
+remote_logger
+    by: arvicco
+    url: http://github.com/arvicco/remote_logger
+
+== DESCRIPTION:
+
+Log server/client with sensible defaults that can be used for remote/centralized logging.
+
+== FEATURES:
+
+Log4r is a customizable logger with advanced functionality. Unfortunately, it only supports (rarely used) ROMP protocol
+for remote logging support. This project aims to improve remote logging by creatting a wrapper around Log4r that:
+* Exposes Log4r functionality remotely through multiple protocols
+* Writes to (log server) stdout AND log file 'remote.log' by default
+* Allows client to use Drb uri or Ring server to find the logger service
+
+== PROBLEMS/TODO:
+
+* TODO: add AMQP rpc support
+
+  Work in progress, please do not use it just yet...
+
+== INSTALL:
+
+  sudo gem install remote_logger
+
+
+== SYNOPSIS:
+
+server:
+---
+  include RemoteLogger
+  start_drb_logger [options] # or,
+  start_ringy_logger [options]
+---
+
+client:
+---
+  include RemoteLogger
+  log = find_drb_logger [options] # or,
+  log = find_ringy_logger [options]
+  log.info 'This is my log message'
+---
+
+== REQUIREMENTS:
+
+* FIXME (list of requirements)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 arvicco. See LICENSE for details.

data/Rakefile

@@ -1,57 +1,24 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "remote_logger"
-    gem.summary = %Q{Remote logger based on Log4r}
-    gem.description = %Q{Remote logger based on Log4r}
-    gem.email = "arvitallian@gmail.com"
-    gem.homepage = "http://github.com/arvicco/remote_logger"
-    gem.authors = ["arvicco"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "cucumber", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "remote_logger #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'pathname'
+NAME = 'remote_logger'
+BASE_PATH = Pathname.new(__FILE__).dirname
+LIB_PATH =  BASE_PATH + 'lib'
+PKG_PATH =  BASE_PATH + 'pkg'
+DOC_PATH =  BASE_PATH + 'rdoc'
+
+$LOAD_PATH.unshift LIB_PATH.to_s
+require 'version'
+
+CLASS_NAME = RemoteLogger
+VERSION = CLASS_NAME::VERSION
+
+begin
+  require 'rake'
+rescue LoadError
+  require 'rubygems'
+  gem 'rake', '~> 0.8.3.1'
+  require 'rake'
+end
+
+# Load rakefile tasks
+Dir['tasks/*.rake'].sort.each { |file| load file }
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.3

data/bin/remote_logger

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+require Pathname.new(__FILE__).dirname + '../lib/remote_logger'
+
+# Put your code here
+

data/features/remote_logger.feature

@@ -1,9 +1,9 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -1,4 +1,7 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'remote_logger'
-
-require 'spec/expectations'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'remote_logger'
+require 'spec/expectations'
+require 'spec/stubs/cucumber'
+
+require 'pathname'
+BASE_PATH = Pathname.new(__FILE__).dirname + '../..'

data/lib/remote_logger/remote_logger.rb

@@ -1,104 +1,104 @@
-#encoding: UTF-8
-# TODO: Set up ACL, SSL and other security stuff
-module RemoteLogger
-  include Log4r
-
-  DRB_URI = 'druby://127.0.0.1:61626'
-  LOGGER_NAME = 'RemoteLogger' # Default service/logger name - used by Ring or retrieved via Log4R::Logger[LOGGER_NAME]
-  FILE_NAME = 'remote.log' # File name of log file
-  FILE_ENCODING = 'CP1251:UTF-8' # Encoding pair of log file ('File external:Ruby internal')
-  STDOUT_ENCODING = 'CP866:UTF-8' # Encoding pair of stdout ('Stdout external:Ruby internal')
-  PATTERN = '%1.1l %d - %m' # Log entry pattern
-  DATE_PATTERN = '%Y-%m-%d %H:%M:%S.%3N'
-
-  # Creates a new Log4r logger. The following options are available:
-  #
-  # <tt>:name</tt>:: Service/logger name - default 'RemoteLogger'
-  # <tt>:outputters</tt>:: Replace outputters (should be Log4r::Outputter subclasses) - default [log file, stdout]
-  # <tt>:file_name</tt>:: Log file name - default 'remote.log'
-  # <tt>:file_encoding</tt>:: Log file encoding - default FILE_ENCODING (Windows Cyrillic)
-  # <tt>:stdout_encoding</tt>:: Stdout encoding - default STDOUT_ENCODING (DOS/IBM Cyrillic)
-  # <tt>:replace</tt>:: Replacement for undefined conversion chars - default '?'
-  # <tt>:pattern</tt>:: Log message pattern - default PATTERN
-  # <tt>:date_pattern</tt>:: Timestamp pattern - default DATE_PATTERN
-  # <tt>:trunc</tt>:: Truncate (rewrite) log file upon creation  - default false (append to file)
-  # <tt>:verbose</tt>:: Log all internal messages of RemoteLogger - default false (do not log logger-specific messages)
-  #
-  def self.create_logger options = {}
-    # define outputters: http://log4r.sourceforge.net/rdoc/files/log4r/outputter/outputter_rb.html
-    if options[:outputters]
-      outputters = options[:outputters]
-    else
-      # specify log message format: http://log4r.sourceforge.net/rdoc/files/log4r/formatter/patternformatter_rb.html
-      format = PatternFormatter.new :pattern => options[:pattern]||PATTERN,
-                                    :date_pattern => options[:date_pattern]||DATE_PATTERN
-
-      # Set up IO streams with correct transcoding and conversion options: log file and (Windows) console
-      conversion = {:undef=>:replace, :replace=>options[:replace]||'?'}
-      file = File.new(options[:file_name]||FILE_NAME, (options[:trunc] ? 'w:' : 'a:') +
-              (options[:file_encoding]||FILE_ENCODING), conversion )
-      $stdout.set_encoding(options[:stdout_encoding]||STDOUT_ENCODING, conversion)
-
-      outputters = [StdoutOutputter.new('console', :formatter => format),
-                    IOOutputter.new('file', file, :formatter => format) ]
-#   file_o = FileOutputter.new 'file', :filename => 'remote.log', :trunc => false, :formatter => format # wrong encoding
-#   err_o = StderrOutputter.new 'error', :formatter => format # just in case
-    end
-
-    # create new logger named LOG_NAME
-    Logger.new(options[:name]||LOGGER_NAME).tap do |logger|
-      logger.outputters = outputters
-      logger.info "#{name}: Logger created" if options[:verbose]
-    end
-  end
-
-  def self.start_ringy_logger(name = LOGGER_NAME, options = {})
-    # Adding some security (disable remote eval)
-    $SAFE = 1
-
-    # Creating logger instance
-    logger = create_logger options
-
-    DRb.start_service
-
-    # Raising new RingyDingy service
-    logger.info "#{name}: Initializing service..." if options[:verbose]
-    RingyDingy.new(logger, name.to_sym).run
-    logger.info "#{name}: Service started" if options[:verbose]
-
-    DRb.thread.join
-    logger.info "#{name}: Service finished" if options[:verbose]
-  end
-
-  def self.find_ringy_logger(name = LOGGER_NAME, options = {})
-    DRb.start_service
-    # Connecting to Logger
-    ring_server = Rinda::RingFinger.primary
-    service = ring_server.read [:name, name.to_sym, nil, nil]
-    service[2]
-  end
-
-  def self.start_drb_logger(name = LOGGER_NAME, options = {})
-    # Adding some security (disable remote eval)
-    $SAFE = 1
-
-    # Creating logger instance
-    logger = create_logger options
-
-    # Raising new RingyDingy service
-    logger.info "#{name}: Initializing service..." if options[:verbose]
-    DRb.start_service(options[:uri]||DRB_URI, logger)
-    logger.info "#{name}: Service started" if options[:verbose]
-
-    DRb.thread.join
-    logger.info "#{name}: Service finished" if options[:verbose]
-  end
-
-  def self.find_drb_logger(name = LOGGER_NAME, options = {})
-    DRb.start_service
-    # Connecting to Logger
-    log = DRbObject.new_with_uri(options[:uri]||DRB_URI)
-  end
-
-
-end
+#encoding: UTF-8
+# TODO: Set up ACL, SSL and other security stuff
+module RemoteLogger
+  include Log4r
+
+  DRB_URI = 'druby://127.0.0.1:61626'
+  LOGGER_NAME = 'RemoteLogger' # Default service/logger name - used by Ring or retrieved via Log4R::Logger[LOGGER_NAME]
+  FILE_NAME = 'remote.log' # File name of log file
+  FILE_ENCODING = 'CP1251:UTF-8' # Encoding pair of log file ('File external:Ruby internal')
+  STDOUT_ENCODING = 'CP866:UTF-8' # Encoding pair of stdout ('Stdout external:Ruby internal')
+  PATTERN = '%1.1l %d - %m' # Log entry pattern
+  DATE_PATTERN = '%Y-%m-%d %H:%M:%S.%3N'
+
+  # Creates a new Log4r logger. The following options are available:
+  #
+  # <tt>:name</tt>:: Service/logger name - default 'RemoteLogger'
+  # <tt>:outputters</tt>:: Replace outputters (should be Log4r::Outputter subclasses) - default [log file, stdout]
+  # <tt>:file_name</tt>:: Log file name - default 'remote.log'
+  # <tt>:file_encoding</tt>:: Log file encoding - default FILE_ENCODING (Windows Cyrillic)
+  # <tt>:stdout_encoding</tt>:: Stdout encoding - default STDOUT_ENCODING (DOS/IBM Cyrillic)
+  # <tt>:replace</tt>:: Replacement for undefined conversion chars - default '?'
+  # <tt>:pattern</tt>:: Log message pattern - default PATTERN
+  # <tt>:date_pattern</tt>:: Timestamp pattern - default DATE_PATTERN
+  # <tt>:trunc</tt>:: Truncate (rewrite) log file upon creation  - default false (append to file)
+  # <tt>:verbose</tt>:: Log all internal messages of RemoteLogger - default false (do not log logger-specific messages)
+  #
+  def self.create_logger options = {}
+    # define outputters: http://log4r.sourceforge.net/rdoc/files/log4r/outputter/outputter_rb.html
+    if options[:outputters]
+      outputters = options[:outputters]
+    else
+      # specify log message format: http://log4r.sourceforge.net/rdoc/files/log4r/formatter/patternformatter_rb.html
+      format = PatternFormatter.new :pattern => options[:pattern]||PATTERN,
+                                    :date_pattern => options[:date_pattern]||DATE_PATTERN
+
+      # Set up IO streams with correct transcoding and conversion options: log file and (Windows) console
+      conversion = {:undef=>:replace, :replace=>options[:replace]||'?'}
+      file = File.new(options[:file_name]||FILE_NAME, (options[:trunc] ? 'w:' : 'a:') +
+              (options[:file_encoding]||FILE_ENCODING), conversion )
+      $stdout.set_encoding(options[:stdout_encoding]||STDOUT_ENCODING, conversion)
+
+      outputters = [StdoutOutputter.new('console', :formatter => format),
+                    IOOutputter.new('file', file, :formatter => format) ]
+#   file_o = FileOutputter.new 'file', :filename => 'remote.log', :trunc => false, :formatter => format # wrong encoding
+#   err_o = StderrOutputter.new 'error', :formatter => format # just in case
+    end
+
+    # create new logger named LOG_NAME
+    Logger.new(options[:name]||LOGGER_NAME).tap do |logger|
+      logger.outputters = outputters
+      logger.info "#{name}: Logger created" if options[:verbose]
+    end
+  end
+
+  def self.start_ringy_logger(name = LOGGER_NAME, options = {})
+    # Adding some security (disable remote eval)
+    $SAFE = 1
+
+    # Creating logger instance
+    logger = create_logger options
+
+    DRb.start_service
+
+    # Raising new RingyDingy service
+    logger.info "#{name}: Initializing service..." if options[:verbose]
+    RingyDingy.new(logger, name.to_sym).run
+    logger.info "#{name}: Service started" if options[:verbose]
+
+    DRb.thread.join
+    logger.info "#{name}: Service finished" if options[:verbose]
+  end
+
+  def self.find_ringy_logger(name = LOGGER_NAME, options = {})
+    DRb.start_service
+    # Connecting to Logger
+    ring_server = Rinda::RingFinger.primary
+    service = ring_server.read [:name, name.to_sym, nil, nil]
+    service[2]
+  end
+
+  def self.start_drb_logger(name = LOGGER_NAME, options = {})
+    # Adding some security (disable remote eval)
+    $SAFE = 1
+
+    # Creating logger instance
+    logger = create_logger options
+
+    # Raising new RingyDingy service
+    logger.info "#{name}: Initializing service..." if options[:verbose]
+    DRb.start_service(options[:uri]||DRB_URI, logger)
+    logger.info "#{name}: Service started" if options[:verbose]
+
+    DRb.thread.join
+    logger.info "#{name}: Service finished" if options[:verbose]
+  end
+
+  def self.find_drb_logger(name = LOGGER_NAME, options = {})
+    DRb.start_service
+    # Connecting to Logger
+    log = DRbObject.new_with_uri(options[:uri]||DRB_URI)
+  end
+
+
+end

data/lib/remote_logger.rb

@@ -1,24 +1,29 @@
-require 'log4r'
-require 'rinda/ring'
-require 'ringy_dingy'
-#require 'ringy_dingy/ring_server'
-
-module RemoteLogger
-
-  # Utility method used to require all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-
-end  # module RemoteLogger
-
-RemoteLogger.require_all_libs_relative_to(__FILE__)
-
+require 'version'
+require 'log4r'
+require 'rinda/ring'
+require 'ringy_dingy'
+#require 'ringy_dingy/ring_server'
+
+module RemoteLogger
+
+#  require "bundler"
+#  Bundler.setup
+
+  # Requires ruby source file(s). Accepts either single filename/glob or Array of filenames/globs.
+  # Accepts following options:
+  # :*file*:: Lib(s) required relative to this file - defaults to __FILE__
+  # :*dir*:: Required lib(s) located under this dir name - defaults to gem name
+  #
+  def self.require_libs( libs, opts={} )
+    file = Pathname.new(opts[:file] || __FILE__)
+    [libs].flatten.each do |lib|
+      name = file.dirname + (opts[:dir] || file.basename('.*')) + lib.gsub(/(?<!.rb)$/, '.rb')
+      Pathname.glob(name.to_s).sort.each {|rb| require rb}
+    end
+  end
+end  # module RemoteLogger
+
+# Require all ruby source files located under directory lib/remote_logger
+# If you need files in specific order, you should specify it here before the glob
+RemoteLogger.require_libs %W[**/*]
+

data/lib/version.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+module RemoteLogger
+
+  VERSION_FILE = Pathname.new(__FILE__).dirname + '../VERSION'   # :nodoc:
+  VERSION = VERSION_FILE.exist? ? VERSION_FILE.read.strip : nil
+
+end