noicycle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60aa6d9277caeac5964fbcfbe4829c3cd3bd69c0
+  data.tar.gz: 8fe3ef0bd93e30895584d4c00a155a81da266dd8
+SHA512:
+  metadata.gz: e03f0f758dcca553be78cbfbce7b0e1977607d6db08aa9395d74f15b50d380bd4461b388b1b46cdde3096db15ca370cb61185a34f132c8b5d3334d659ce987e7
+  data.tar.gz: 127428a0775cff3b125b4e77e3501367069aae9b82a639fb0d37484efe6892504bc71cc1c4104c3c2f950ee0736f06adc23363a3865b5d58a14c1a220e40911b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p0@noicycle"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.20 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in noicycle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mickaël Floc'hlay
+
+MIT License
+
+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,44 @@
+# Noicycle
+
+Utility gem to calculate dates involved in a Tower of Hanoi backup rotation method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'noicycle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noicycle
+
+## Usage
+
+To get the dates of a 7-tape backup from a give reference date:
+
+    ref_date = Date.parse("5th May 2013")
+    noicycle.tapes(ref_date, 7)
+    
+The result is a Hash that contains tape-keys and date values. For instance, on 24th september 2013, the upper code returned the following hash:
+
+    {
+        2=>#<Date: 2013-09-24 ((2456560j,0s,0n),+0s,2299161j)>, 
+        1=>#<Date: 2013-09-23 ((2456559j,0s,0n),+0s,2299161j)>, 
+        3=>#<Date: 2013-09-22 ((2456558j,0s,0n),+0s,2299161j)>, 
+        4=>#<Date: 2013-09-18 ((2456554j,0s,0n),+0s,2299161j)>, 
+        7=>#<Date: 2013-09-10 ((2456546j,0s,0n),+0s,2299161j)>, 
+        5=>#<Date: 2013-08-25 ((2456530j,0s,0n),+0s,2299161j)>, 
+        6=>#<Date: 2013-08-09 ((2456514j,0s,0n),+0s,2299161j)>
+    }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/noicycle.rb

@@ -0,0 +1,74 @@
+require "noicycle/version"
+
+module Noicycle
+  class Noicycle
+    def tapes(ref_date, nb_tapes = 3, cur_date = nil, weekly = false, weekly_ref_day = 0)
+      result = Hash.new
+      function = function_for_nb_of_tapes(nb_tapes)
+      Date.today
+
+      # Change the starting date if we're weekly so that it coincides with the desired weekly_ref_day
+      l_date = cur_date
+      l_date ||= Date.today
+      if weekly
+        while l_date.wday != weekly_ref_day do
+          l_date = l_date - 1
+        end
+      end
+
+      nb_of_tapes_found = 0
+      nb_of_days = (l_date - ref_date).to_i
+      nb_of_days = (nb_of_days / 7).to_i if weekly
+      for i in 0..nb_of_days
+        i_date = (weekly ? (l_date - 7*i) : (l_date - i))
+        i_tape = tape_for(i_date, ref_date, function, weekly)
+        if result[i_tape].nil?
+          result[i_tape] = i_date
+          nb_of_tapes_found = nb_of_tapes_found + 1
+          if nb_of_tapes_found == 7
+            return result
+          end
+        end
+      end
+
+      result
+    end
+
+    private
+
+    def pretty_function(function)
+      function.sort.map do |key,value|
+        puts "function(#{key}) = #{value}"
+      end
+    end
+
+    def function_for_nb_of_tapes(nb_of_tapes)
+      raise "There must be at least 2 tapes" unless nb_of_tapes > 1
+
+      # Fill the function
+      elements = 2 ** (nb_of_tapes - 1)
+      function = Hash.new
+      for i in 1..nb_of_tapes
+        index = 2 ** (i - 1)
+        while (index <= elements) do
+          function[index] = i
+          index = index + 2 ** i
+        end
+      end
+
+      # Create 0 value with last value:
+      # - This will allow the first backup (ie index 0) to be available the longest possible time
+      # - Will make further modulo operations much easier to achieve
+      function[0] = function[elements]
+      function.delete(elements)
+      function
+    end
+
+    def tape_for(date, ref_date, function, weekly = false)
+      nb_of_days = (date - ref_date).to_i
+      nb_of_days = (nb_of_days / 7).to_i if weekly
+      modulo = nb_of_days % function.length
+      function[modulo]
+    end
+  end
+end

data/lib/noicycle/version.rb

@@ -0,0 +1,3 @@
+module Noicycle
+  VERSION = "0.0.1"
+end

data/noicycle.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'noicycle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "noicycle"
+  spec.version       = Noicycle::VERSION
+  spec.authors       = ["Mickaël Floc'hlay"]
+  spec.email         = ["dirtyhenry@gmail.com"]
+  spec.description   = %q{Provide Tower of Hanoi backup rotation method dates"}
+  spec.summary       = %q{Utility gem to calculate dates involved in a Tower of Hanoi backup rotation method}
+  spec.homepage      = "http://dirtyhenry.github.io/noicycle/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/noicycle_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Noicycle do
+  it "returns a hash with as many results as requested when the reference date is old enough" do 
+    noicycle = Noicycle::Noicycle.new
+    ref_date = Date.parse("5th May 2013")
+    for i in 3..5
+      tapes = noicycle.tapes(ref_date, i)
+      tapes.size.should eq(i)
+    end
+  end
+
+  it "returns the right result for a given example DAILY" do 
+    noicycle = Noicycle::Noicycle.new
+    ref_date = Date.parse("5th May 2013")
+    cur_date = Date.parse("24th September 2013")
+    tapes = noicycle.tapes(ref_date, 7, cur_date)
+
+    tapes.size.should eq(7)
+    tapes[1].should == Date.parse("23rd September 2013")
+    tapes[2].should == Date.parse("24th September 2013")
+    tapes[3].should == Date.parse("22nd September 2013")
+    tapes[4].should == Date.parse("18th September 2013")
+    tapes[5].should == Date.parse("25th August 2013")
+    tapes[6].should == Date.parse("9th August 2013")
+    tapes[7].should == Date.parse("10th September 2013")
+  end
+
+  it "returns the right result for a given example WEEKLY" do 
+    noicycle = Noicycle::Noicycle.new
+    ref_date = Date.parse("5th May 2013")
+    cur_date = Date.parse("24th September 2013")
+    tapes = noicycle.tapes(ref_date, 7, cur_date, true)
+
+    tapes.size.should eq(6)
+    tapes[1].should == Date.parse("15th September 2013")
+    tapes[2].should == Date.parse("8th September 2013")
+    tapes[3].should == Date.parse("22nd September 2013")
+    tapes[4].should == Date.parse("30th June 2013")
+    tapes[5].should == Date.parse("25th August 2013")
+    tapes[6].should == nil
+    tapes[7].should == Date.parse("5th May 2013")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'noicycle'
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: noicycle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mickaël Floc'hlay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide Tower of Hanoi backup rotation method dates"
+email:
+- dirtyhenry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/noicycle.rb
+- lib/noicycle/version.rb
+- noicycle.gemspec
+- spec/lib/noicycle_spec.rb
+- spec/spec_helper.rb
+homepage: http://dirtyhenry.github.io/noicycle/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Utility gem to calculate dates involved in a Tower of Hanoi backup rotation
+  method
+test_files:
+- spec/lib/noicycle_spec.rb
+- spec/spec_helper.rb