rb.rotate 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+
+gem "pony", ">= 1.1"
+gem "sys-uname", ">= 0.8.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.12)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    pony (1.1)
+      mail (> 2.0)
+    rake (0.8.7)
+    sys-uname (0.8.5)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  pony (>= 1.1)
+  sys-uname (>= 0.8.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Martin Kozák
+
+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.md

@@ -0,0 +1,81 @@
+rb.rotate
+=========
+
+**rb.rotate** is an alternative to classical `logrotate` tool. 
+It implements very similar functionallity, features openess and 
+flexibility of the scripting environment and removes some most known 
+`logrotate` limitations.
+
+And of sure, it adds some features and it doesn't implement some
+features of the original for now.
+
+### Removed `logrotate` Limitations
+
+* log directory and archive directory can be on **different drives**,
+* it can **follow symbolic links** both for directories and files,
+* it can **respect the subdirectories structure** of the log directory,
+  so archive directory can have the same structure as original log 
+  directory.
+  
+### Additional Features
+
+* elegant, well documented and easy-to-understand [YAML][2] configuration 
+  file,
+* flexible and in fact unlimited possibility to define hooks while 
+  "put file to archive" action and run them in mix with pre-build 
+  actions in whatever required order.
+  
+Installation
+------------
+
+After installing the `rb.rotate` gem, simply type following as root and 
+then add the `rb.rotate` entry to cron.
+
+    rb.rotate install
+
+Be warn, it works for *Linux* and *FreeBSD* only. On other platforms,
+please: 
+
+1. copy initial configuration files in `<gem-path>/lib/rb.rotate/install` 
+to appropriate location on your platform (remove the `.initial` extension,
+of sure),
+2. create the `<gem-path>/lib/paths.conf` file with path to 
+`rotate.yaml` file,
+3. change paths in `rotate.yaml` file to directories appropriate for 
+your platfom,
+4. [report back][1] to the project output of the `rb.rotate sysname` 
+command and appropriate configuration locations for including them in 
+next release.
+
+
+Status
+------
+Currently in **pre-beta** version. All features are implemented, some 
+of them such as *hooks* are untested.
+
+### Documentation
+
+See the configuration file. It's pretty well documented with possible values
+listed and a lot of explaining.
+
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][1] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright (c) 2010 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[1]: http://github.com/martinkozak/rb.rotate/issues
+[2]: http://www.yaml.org/
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rb.rotate"
+  gem.homepage = "http://github.com/martinkozak/rb.rotate"
+  gem.license = "MIT"
+  gem.summary = %Q{More modern alternative to 'logrotate' with more features and less limitations.}
+  gem.description = %Q{An alternative to classical 'logrotate' tool. It implements very similar functionallity, features openess and flexibility of the scripting environment and removes some most known 'logrotate' limitations.}
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  gem.executables = ["rb.rotate"]
+  gem.post_install_message = "\nINSTALLATION DONE!\nFor remaining part of installation run 'rb.rotate install'\nand then eventually setup running the 'rb.rotate' by cron.\n\nBe warn, it's still BETA VERSION.\n\n"
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  # gem.add_runtime_dependency 'sys-uname', '>= 0.8.5'
+  # gem.add_runtime_dependency 'pony', '>= 1.1'
+  # gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rb.rotate #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/rb.rotate

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "rb.rotate"
+if ARGV[0] 
+    case ARGV[0].to_sym
+        when :install
+            RbRotate::install!
+        when :sysname
+            RbRotate::sysname!
+    end
+else
+    RbRotate::run!
+end

data/lib/rb.rotate.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require "rb.rotate/dispatcher"
+
+module RbRotate
+
+    ##
+    # Runs the application.
+    #
+    
+    def self.run!
+        Dispatcher::new::run!
+    end
+
+    ##
+    # Installs the application.
+    #
+    
+    def self.install!
+        Dispatcher::new::install!
+    end
+    
+    ##
+    # Prints out the system name.
+    #
+    
+    def self.sysname!
+        Dispatcher::new::sysname!
+    end
+    
+end

data/lib/rb.rotate/configuration.rb

@@ -0,0 +1,312 @@
+# encoding: utf-8
+
+require "yaml"
+require "rb.rotate/directory"
+
+module RbRotate
+
+    ##
+    # Directory configuration.
+    #
+    
+    class DirectoryConfiguration
+    
+        ##
+        # Holds currently selected directory section.
+        #
+        
+        @directory
+        
+        ##
+        # Holds configuration data.
+        #
+        
+        @data
+    
+        ##
+        # Constructor.
+        #
+        # Expects file path and directory section specification 
+        # as symbol.
+        #
+        
+        def initialize(directory)
+            # TODO: this should handle configuration inheritance
+            @directory = directory
+        end
+        
+        ##
+        # Returns configuration file setting.
+        #
+        
+        def configuration
+            Configuration::get
+        end
+        
+        ##
+        # Returns configuration data.
+        #
+
+        def data
+            if @data.nil?
+                data = self.configuration[:dirs][@directory]
+                @data = { }
+                
+                # Converts strings to symbols
+                data.each_pair do |key, value|
+                    @data[key.to_sym] = value
+                end
+                
+                self.handle_inheritance!
+            end
+            
+            return @data
+        end
+        
+        ##
+        # Handles configuration inheritance.
+        #
+
+        def handle_ihneritance!
+            if @data.include? :parent
+                @data.merge! self.class::new(@data[:parent]).data
+            end
+        end
+        
+        ##
+        # Returns some item.
+        #
+        
+        def [](name)
+            self.data[name]
+        end
+        
+        ##
+        # Handles method calls.
+        #
+        
+        def method_missing(name)
+            self[name]
+        end
+        
+    end
+    
+    ##
+    # General configuration file.
+    #
+    
+    class Configuration
+    
+        ##
+        # Brings self instance. (Class is singletone.)
+        #
+        
+        @@self = nil
+        
+        ##
+        # Holds data.
+        #
+        
+        @data
+        
+        ##
+        # Opens the file. (Shortcut for instance call.)
+        #
+        
+        def self.read(file)
+            self::get.read(file)
+        end
+        
+        ##
+        # Returns the single instance.
+        #
+        
+        def self.get
+            if @@self.nil?
+                @@self = self::new
+            end
+            
+            return @@self
+        end
+        
+        ##
+        # Traverses through each directory configuration. 
+        # (Shortcut for instace call.)
+        
+        def self.each_directory(&block)
+            self::get.each_directory(&block)
+        end
+        
+        ##
+        # Alias for #find_path.
+        #
+        
+        def self.find_path(path)
+            self::get.find_path(path)
+        end
+        
+        ##
+        # Opens the file.
+        # 
+        
+        def read(file)
+            data = YAML.load(::File.read(file))
+            @data = { }
+            
+            # Converts strings to symbols
+            data.each_pair do |name, section|
+                section_data = { }
+                @data[name.to_sym]= section_data
+                
+                if section.kind_of? Hash
+                    section.each_pair do |key, value|
+                        section_data[key.to_sym] = value
+                    end
+                end
+            end
+            
+            defaults = YAML.load(::File.read(@data[:paths][:"defaults file"]))
+            
+            # Merges with defaults
+            defaults.each_pair do |name, section|
+                name = name.to_sym
+                if not @data.has_key? name
+                    @data[name] = value
+                elsif section.kind_of? Hash
+                    section.each_pair do |key, value|
+                        key = key.to_sym
+                        if not @data[name].has_key? key
+                            @data[name][key] = value
+                        end
+                    end
+                end
+            end
+        end
+        
+        ##
+        # Returns an item.
+        #
+        
+        def [](name)
+            @data[name]
+        end
+        
+        ##
+        # Handles method calls.
+        #
+        
+        def method_missing(name)
+            self[name]
+        end
+        
+        ##
+        # Traverses through each directory configuration.
+        #
+        
+        def each_directory
+            @data[:dirs].each_pair do |name, dir|
+                yield Directory::new(name, dir)
+            end
+        end
+        
+        ##
+        # Looks for directory in configuration.
+        #
+        
+        def find_path(path)
+            @data.each_pair do |name, dir|
+                if dir[:directory] == path
+                    return Directory::new(name, dir)
+                end
+            end
+            
+            return nil
+        end
+        
+    end
+    
+end
+
+# String extensions
+
+class String
+
+    TO_TIME_MATCHER = /(\d+)\s*((?:year|month|week|day|hour|minute|second))s?/i
+
+    ##
+    # Converts number with units to bytes count.
+    #
+    
+    def to_bytes
+        value = self.to_i
+        if value == 0
+            raise Exception::new("Invalid size specification: " << self << ".")
+        end
+        
+        exponent = nil
+        case self[-1]
+            when ?M
+                exponent = 2
+            when ?G
+                exponent = 3
+            when ?K
+                exponent = 1
+            when ?0, ?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9
+                exponent = 0
+            else
+                raise Exception::new("Invalid unit in size specification: " << self << ".")
+        end
+        
+        return value * (1024 ** exponent)
+    end
+    
+    ##
+    # Converts string identifier of time period to seconds.
+    #
+    
+    def to_seconds
+    
+        period = nil
+        case self.to_sym
+            when :yearly
+                period = "1 year"
+            when :monthly
+                period = "1 month"
+            when :weekly
+                period = "1 week"
+            when :daily
+                period = "1 day"
+            when :hourly
+                period = "1 hour"
+            else
+                period = self
+        end
+        
+        matches = period.match(self.class::TO_TIME_MATCHER)
+        if matches.nil?
+            raise Exception::new("Invalid period specification: " << self << ".")
+        end
+        
+        count = matches[1].to_i
+        unit = matches[2].to_sym
+        seconds = nil
+        
+        case unit
+            when :year
+                seconds = 365 * 24 * 60 * 60
+            when :month
+                seconds = 30 * 24 * 60 * 60
+            when :week
+                seconds = 7 * 24 * 60 * 60
+            when :day
+                seconds = 24 * 60 * 60
+            when :hour
+                seconds = 60 * 60
+            when :second
+                seconds = 1
+        end
+        
+        return seconds * count
+    end
+        
+end