simple_rotate 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2011-12-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/simple_rotate.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_simple_rotate.rb
+lib/simple_rotate/simple_rotate.rb
+README.jpn

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on simple_rotate, see http://simple_rotate.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.jpn

@@ -0,0 +1,76 @@
+□ Description
+
+Ruby 1.8.7 動作確認。1.9でもいけるんじゃないかにゃ。
+
+
+□ Class Method
+
+　　new([log_file_name [,max_size [,rotate [,log_format, [log_message]]]]])
+
+　　　　SimpleRotate オブジェクトを生成します。
+　　　　4つのオプションは任意です。
+
+　　　　log_file_name にはログを保存するファイル名を指定します。
+　　　　指定しないと「実行ファイル名.log」という名前でファイルができます。
+　　　　既に同じ名前のファイルがある場合は、そのファイルに追記されます。
+
+　　　　max_size でログファイルの最大サイズを指定します。
+　　　　このサイズを超えた場合、rotate を false にしていない限り、新しいファイルにログを書きます。
+　　　　その際、古いファイルはリネームされます。
+　　　　log_file_name.1、log_file_name.2、log_file_name.3、log_file_name.4 という具合に、
+　　　　古いログファイルほど古い数字が記されます。
+　　　　ただし、new で既存のログファイルのサイズを評価しますので、
+　　　　new の時点でログファイルのサイズが 999KB だった場合は e までのログは既存のファイルに吐きます。
+　　　　従ってログファイルのサイズが max_size を超えることはあります。
+　　　　デフォルトは 1MBです。
+
+　　　　rotate は古いログファイルの世代交代をする回数を指定します。
+　　　　例えば rotate に 4 を設定すると、古いログファイルは
+　　　　log_file_name.1、log_file_name.2、log_file_name.3、log_file_name.4 の4世代まで作られます。
+　　　　この場合、新しいログファイルを入れると全部で5世代でローテーションされます。
+　　　　この値を true に設定すると世代交代を行わず、無限にログファイルを残します。
+　　　　長期間放置しておくとディスク領域を圧迫する可能性がありますので、
+　　　　手ごろな回数で世代交代することをおすすめします。
+　　　　false にすると、log_file_name.1、log_file_name.2 ... のような古いログは残さず、
+　　　　max_size に到達した時点でログファイルは一度フラッシュされ、また同じログファイルにログを記録します。
+　　　　デフォルトは true です。
+
+　　　　log_format は古いログファイル（log_file_namexxxxxN）の xxxxx を指定できます。
+　　　　デフォルトは `.' です。
+
+　　　　log_message はログの開始時の終了時に日付とPIDを記録するかどうかの設定です。
+　　　　true は記録、false は記録しないです。
+　　　　デフォルトは true です。
+
+
+□ Method
+
+　　w(string [,true|false ,[true|false]])
+　　　　string をログファイルに記録します。
+　　　　デフォルトでは標準出力には出力しませんが、
+　　　　第二引数に true を与える標準出力にも出力するようになります。
+　　　　第三引数に true を与えると w を実行するごとに日付や時間を記録します。
+
+　　e
+　　　　ログの記録を終了します。
+
+　　flush
+　　　　ログファイルをフラッシュします。
+　　　　フラッシュされた時点で、max_size に達していないログファイルでも
+　　　　強制的にローテーションさせることができます。
+　　　　クーロンと組み合わせることで一日ごとにログをローテーションさせる、
+　　　　といった使い方ができます。
+
+
+□ Example
+
+  require 'optparse'
+  opt = OptionParser.new
+  log = "logfile"
+  opt.on('--log val'){|v| log = v }
+  opt.parse!(ARGV)
+
+  logf = SimpleRotate.new(log)
+  logf.w("ここに残したいログを！")
+  logf.w("こんな感じで！")
+  logf.e

data/README.rdoc

@@ -0,0 +1,52 @@
+= simple_rotate
+
+== DESCRIPTION:
+
+[Class Method]
+  new([log_file_name [,max_size [,rotate [,log_format, [log_message]]]]])
+
+[Method]
+  w(string [,true|false ,[true|false]])
+
+  e
+
+  flush
+
+== FEATURES/PROBLEMS:
+
+tested only with Ruby 1.8.7.
+
+== SYNOPSIS:
+
+to rotate the ruby's log file.
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+sudo gem install simple_lotate
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 nyanko
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/simple_rotate'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'simple_rotate' do
+  self.developer 'nyanko', 'hotta_1234@yahoo.co.jp'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/simple_rotate.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module SimpleRotateVersionInfo
+  VERSION = '0.0.1'
+end
+
+require 'simple_rotate/simple_rotate'

data/lib/simple_rotate/simple_rotate.rb

@@ -0,0 +1,94 @@
+class SimpleRotate
+
+  def initialize(log_file=$0+".log", max_size=1000000, rotate=true, log_format=".", log_mess=true)
+    @log_file   = log_file
+    @max_size   = max_size
+    @log_format = log_format
+    @rotate     = rotate
+    @log_mess   = log_mess
+    @rotate = false if @rotate == 0
+
+    if File.exist?(@log_file)
+      if over_size(@log_file)
+        ch_name(@log_file)
+        @logf = File.open(@log_file, "w+")
+      else
+        @logf = File.open(@log_file, "a+")
+      end
+    else
+      @logf = File.open(@log_file, "w+")
+    end
+    @size = File.size(@log_file)
+    w("\n----- Start Logs [Date: #{get_time('milestone')}] [PID: #{$$}] -----\n") if @log_mess
+  end
+
+  def over_size(f)
+    if File.size(f) > @max_size
+      return true
+    else
+      return false
+    end
+  end
+
+  def ch_name(f)
+    cnt      = 1
+    rename_f = "#{@log_file}#{@log_format}#{cnt}"
+
+    if File.exist?(rename_f)
+      while File.exist?(rename_f)
+        cnt     += 1
+        rename_f = "#{@log_file}#{@log_format}#{cnt}"
+      end
+      wait_rename = Array.new
+      for nc in 1...cnt
+        break if @rotate == 1
+        wait_rename << "File.rename('#{@log_file}#{@log_format}#{nc}', '#{@log_file}#{@log_format}#{nc+1}')"
+        if @rotate
+          next if @rotate.class == TrueClass
+          break if @rotate <= nc+1
+        end
+      end
+
+      wait_rename.reverse!
+      wait_rename.each{ |do_rename|
+        eval(do_rename)
+      }
+      File.rename(f, "#{@log_file}#{@log_format}1") if @rotate
+
+    else
+      File.rename(f, rename_f) if @rotate
+    end
+  end
+
+  def get_time(request)
+    if request == "party"
+      return Time.now.strftime("[%Y/%m/%d %H:%M:%S] ")
+    elsif request == "milestone"
+      return Time.now.strftime("%Y/%m/%d %H:%M:%S")
+    end
+  end
+
+  def flush
+    e
+    ch_name(@log_file)
+    @logf = File.open(@log_file, "w+")
+    @size = File.size(@log_file)
+    w("\n----- Start Logs [Date: #{get_time('milestone')}] [PID: #{$$}] -----\n") if @log_mess
+  end
+
+  def w(str, output=false, rec_time=false)
+    if rec_time
+      @logf.puts(get_time('party')+str)
+      puts get_time('party')+str if output
+    else
+      @logf.puts(str)
+      puts str if output
+    end
+  end
+
+  def e
+    w("----- End Logs [Date: #{get_time('milestone')}] [PID: #{$$}] -----\n") if @log_mess
+    @logf.close
+  end
+
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/simple_rotate.rb'}"
+puts "Loading simple_rotate gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/simple_rotate'

data/test/test_simple_rotate.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSimpleRotate < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: simple_rotate
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- nyanko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+description: |-
+  [Class Method]
+    new([log_file_name [,max_size [,rotate [,log_format, [log_message]]]]])
+  
+  [Method]
+    w(string [,true|false ,[true|false]])
+  
+    e
+  
+    flush
+email: 
+- hotta_1234@yahoo.co.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/simple_rotate.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_simple_rotate.rb
+- lib/simple_rotate/simple_rotate.rb
+- README.jpn
+- .gemtest
+homepage: 
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: simple_rotate
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: "[Class Method] new([log_file_name [,max_size [,rotate [,log_format, [log_message]]]]])  [Method] w(string [,true|false ,[true|false]])  e  flush"
+test_files: 
+- test/test_helper.rb
+- test/test_simple_rotate.rb