netrand 2.0.0 → 3.0.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+3.0.0
+========
+*Preformance, size and bug fixes
+*Improvements in CLI (like... it works! ;)
+*Massive changes in handling of file and sequence randomization
+*Added Netrand.dice function
+*Better documentation
+
 2.0.0
 ========
 *Added list order randomizer

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    netrand (2.0.0)
+    netrand (3.0.0)
 
 GEM
   specs:

data/README.md

@@ -1,3 +1,6 @@
-Wrapper around Random.org random number and string generator.
-Pretty much every parameter has maximum of 10 000.
-For more info look in the RDocs.
+Wrapper around Random.org random number and string generator.  
+Pretty much every parameter has maximum of 10 000.  
+For more info look in the RDocs.  
+install using *sudo gem install Netrand*   
+Remember, that the tests only test the module, not Random.org service.   
+[Information about Random.org](http://www.random.org/faq/ "Random.org FAQ")

data/bin/netrand

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-require "Netrand"
-
-def self.loadstring
+require "netrand"
+def loadstring
   upperalpha  = ARGV.include?("-ua")  ? :upperalpha : nil
   loweralpha  = ARGV.include?("-la")  ? :loweralpha : nil
   digits      = ARGV.include?("-d")   ? :digits : nil
@@ -9,10 +8,43 @@ def self.loadstring
   Netrand.string(ARGV[1].to_i, ARGV[2].to_i, digits, upperalpha, loweralpha, unique)
 end
 
+def invalid_args
+  puts "Invalid arguments! Stop."
+  exit 1
+end
+
+def loadint
+  if ARGV.length < 3 then invalid_args end
+  if ARGV.length < 4 and ARGV.include?("-u") then invalid_args end
+  if ARGV.include?("-u") #This must be first, so that we can process it independently from its position
+    uniq = :uniq
+    ARGV.delete("-u")
+  else
+    uniq = :notuniq
+  end
+  numget = ARGV[1].to_i
+  max = ARGV[2].to_i
+  if ARGV[3] == nil
+    min = 1
+  else
+    min = ARGV[3].to_i
+  end
+  Netrand.int(numget, max, min, uniq)
+end
+
+def loadsequence
+  if ARGV.length == 2
+    Netrand.sequence(ARGV[1].to_i, 1)
+  else
+    Netrand.sequence(ARGV[1].to_i, ARGV[2].to_i)
+  end
+end
+
 def self.usage
-  puts "netrand int|sequence|string|list"
+  puts "netrand int|sequence|string|file|dice"
   puts "You provide additional arguments according to documentation in ri Netrand"
   puts "You can force int to provide unique numbers by using -u flag at the end of command."
+  puts "file invokes randomize_file_lines function"
   puts "String mode flags:"
   puts ":upperalpha is activated using -ua switch"
   puts ":loweralpha using -la"
@@ -20,21 +52,32 @@ def self.usage
   puts ":unique using -u"
 end
 
+
+def cmdout(arr)
+  arr.each do |e| 
+    print e
+    print ", "
+  end
+  print "\n"
+end
+
 case ARGV[0]
   when "int"
-    out = Netrand.int(ARGV[1].to_i, ARGV[2].to_i, ARGV[3].to_i, if ARGV[4] == "-u" then :unique end)
+    out = loadint
   when "sequence"
-    out = Netrand.uniqint(ARGV[1].to_i, ARGV[2].to_i)
-  when "list"
-    out = Netrand.list(ARGV[1])
+    out = loadsequence
+  when "file"
+    out = Netrand.randomize_file_lines(ARGV[1])
   when "string"
-    out = self.loadstring
+    out = loadstring
+  when "dice"
+    out = Netrand.dice(ARGV[1])
   else
     self.usage
 end
 
 if out.class == Array
-  out.each {|i| print i + ","} 
+  cmdout(out)
 else 
   puts out
 end

data/lib/functions/common.rb

@@ -0,0 +1,31 @@
+require "open-uri"
+module Netrand
+  #Generates exception if quota of random.org is exhausted.
+  
+  def self.check_quota
+    quota = nil
+    open("http://www.random.org/quota/?format=plain") do |c|
+      quota = c.read.to_i
+      self.check_quota_value(quota)
+    end
+    quota
+  end
+  
+  private
+  
+  class QuotaExhaustedException < RuntimeError; end
+  
+  #Harvests lines in plaintext output (private)
+  def self.harvest(address)
+    values = []
+    open(address) do |c|
+      c.each_line {|l| values << l.chop.to_i}
+    end
+    values
+  end
+  
+  def self.check_quota_value(quota)
+    if quota < 0 then raise QuotaExhaustedException, "Random.org quota exhausted, please try again after 0:00 UTC" end
+  end
+
+end

data/lib/functions/dice.rb

@@ -0,0 +1,10 @@
+require_relative "int"
+module Netrand
+  # Simulates dice rolls.
+  # Example: <br>
+  # Netrand.dice(10) <br>
+  # Can return array like this: [2, 4, 6, 3, 1, 5, 3, 2] <br>
+  def self.dice(dices)
+    self.int(dices, 6)
+  end
+end

data/lib/functions/int.rb

@@ -1,5 +1,4 @@
-require "open-uri"
-require_relative "quota"
+require_relative "common"
 module Netrand
   
   #Generates numget random numbers using random.org service.
@@ -7,27 +6,26 @@ module Netrand
   #Returns Array of numbers.
   #If you use :unique flag, then there won't be two same numbers in the array.
   
-  def Netrand.int(numget, max, min = 1, uniq = :notuniq)
-    if numget == 0  then raise ArgumentError, "You must ask for more numbers than 0" end
-    if max == 0     then raise ArgumentError, "Maximum number must be bigger than 0" end
-    if min > max    then raise ArgumentError, "max must be bigger than min!" end
+  def self.int(numget, max, min = 1, uniq = :notuniq)
+    raise ArgumentError, "You must ask for more numbers than 0" if numget == 0
+    raise ArgumentError, "Maximum number must be bigger than 0" if max == 0
+    raise ArgumentError, "max must be bigger than min!"         if min > max
     self.check_quota
-    values = self.load_random_integers(numget, max, min)
-    if uniq == :unique
-      values.uniq!
-      while values.length != numget do
-        values << self.load_random_integers(numget - values.length, max, min)
-        values.uniq!
-      end
-    end
+    values = self.harvest("http://www.random.org/integers/?num=#{numget}&min=#{min}&max=#{max}&format=plain&col=1&base=10")
+    if uniq == :unique then self.get_unique_ints(numget, max, min, values) end
     values
   end
   
-  def Netrand.load_random_integers(num, max, min)
-    values = []
-    open("http://www.random.org/integers/?num=#{num}&min=#{min}&max=#{max}&format=plain&col=1&base=10") do |c|
-      c.each_line {|l| values << l.chop.to_i}
+  private
+  
+  #Gets unique integers in a way that is fast and conserves bandwidth (private)
+  def self.get_unique_ints(numget, max, min, values = [])
+    values.uniq!
+    while values.length != numget do
+      values << self.harvest("http://www.random.org/integers/?num=#{numget - values.length}&min=#{min}&max=#{max}&format=plain&col=1&base=10")
+      values.uniq!
     end
     values
   end
+  
 end

data/lib/functions/list.rb

@@ -1,25 +1,39 @@
 require_relative "sequence"
 module Netrand
   
-  #Writes lines from file into randomized_file
-  #File must be shorter than 10000 lines
-  def Netrand.list(file)
-    src = File.new(file, "r")
-    out = File.new("randomized_#{file}", "w")
-    lines = countlines(file)
-    rand = self.sequence(lines)
-    rand.each do |pos|
-      (pos-1).times {src.gets}
-      line = src.gets
-      out.puts(line)
-      src.rewind
+  #Randomizes order of items in array
+  #Array must be shorter than 10 000 items
+  #Example: <br>
+  #Netrand.list([1, 2, 3]) <br>
+  #May return [2, 1, 3] 
+ 
+  def self.list(arr)
+    randarr = []
+    random_positions = self.sequence(arr.length - 1, 0)
+    arr = arr.to_enum
+    random_positions.each do |pos|
+      randarr[pos] = arr.next
     end
+    randarr
+  end
+  
+ #Randomizes order of lines in file
+ #They are saved to file called input_file_name-randomized.type
+ 
+  def self.randomize_file_lines(filename)
+    src = File.new(filename, "r")
+    out = File.new(assemble_randomized_path(src), "w")
+    values = src.readlines
+    randomized_values = self.list(values)
+    randomized_values.each {|value| out.write(value)}
     src.close
     out.close
   end
   
+  private
+  
   #Counts lines in file
-  def Netrand.countlines(file_to_count)
+  def self.countlines(file_to_count)
     count = 0
     File.open(file_to_count, "r") do |f| 
       ret = 0
@@ -30,5 +44,19 @@ module Netrand
     end
     count
   end
+  
+  #Assembles the filename, so that it won't corrupt paths
+  def self.assemble_randomized_path(input_file)
+    path            = input_file.path
+    dir             = File.dirname(path)
+    
+    filename        = path.split("/")[-1]
+    filename        = filename.split(".") 
+    filename        = filename[0, filename.length - 1]
+    
+    filetype        = File.extname(path)
+    fn_with_suffix  = filename[0] + "-randomized"
+    return dir + "/" + fn_with_suffix + filetype
+  end
 
 end

data/lib/functions/sequence.rb

@@ -1,16 +1,11 @@
-require "open-uri"
-require_relative "quota"
+require_relative "common"
 module Netrand
-  #Returns numbers from min to max in random order.
   
-  def Netrand.sequence(max, min = 1)
+  #Returns sequence of numbers from min to max in random order.
+  def self.sequence(max, min = 1)
     if max == 0 then raise ArgumentError, "Maximum number must be bigger than 0" end
     if min > max then raise ArgumentError, "max must be bigger than min!" end
     self.check_quota
-    order = Array.new()
-    open("http://www.random.org/sequences/?min=#{min}&max=#{max}&col=1&format=plain&rnd=new") do |c|
-      c.each_line {|l| order << l.chop.to_i}
-    end
-    order
+    order = self.harvest("http://www.random.org/sequences/?min=#{min}&max=#{max}&col=1&format=plain&rnd=new")
   end
 end

data/lib/functions/string.rb

@@ -1,12 +1,15 @@
-require "open-uri"
-require_relative "quota"
+require_relative "common"
 module Netrand
   
   #Generates num random strings of len length.
   #They can contain digits, uppercase and lowercase letters.
   #They can be set to be unique.
+  #Example:<br>
+  #Netrand.string(10, 5, :upperalpha, :loweralpha, :digits, :unique) <br>
+  #Will produce 10 5 characters long strings containing uppercase, lowercase letters and digits. 
+  #There won't be 2 same characters in one string. This example used all of the possible options
   
-  def Netrand.string(num, len, *opts)
+  def self.string(num, len, *opts)
     digits      = opts.include?(:digits)      ? "on" : "off"
     upperalpha  = opts.include?(:upperalpha)  ? "on" : "off"
     loweralpha  = opts.include?(:loweralpha)  ? "on" : "off"

data/lib/netrand.rb

@@ -1,4 +1,6 @@
+require_relative "functions/common"
 require_relative "functions/string"
 require_relative "functions/sequence"
 require_relative "functions/int"
-require_relative "functions/list"
+require_relative "functions/list"
+require_relative "functions/dice"

data/netrand.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 
 Gem::Specification.new do |s| 
-  s.name       = "netrand"
-  s.summary    = "Generate true random numbers using random.org"
-  s.description= "Wrapper around Random.org random number and string generator."
-  s.requirements =  [ 'Working internet connection' ]
-  s.version     = "2.0.0"
+  s.name        = "netrand"
+  s.summary     = "Generate true random numbers using random.org"
+  s.description = "Wrapper around Random.org random number and string generator."
+  s.requirements=  [ 'Working internet connection' ]
+  s.version     = "3.0.0"
   s.author      = "Róbert Selvek"
   s.email       = "me@sellweek.eu"
   s.homepage    = "http://github.com/sellweek/netrand"

data/tests/ZoznamOkresov-randomized.txt

@@ -0,0 +1,79 @@
+Svidník
+Skalica
+Detva
+Dolný Kubín
+Komárno
+Šaľa
+Zlaté Moravce
+Bratislava V
+Trebišov
+Malacky
+Nové Mesto nad Váhom
+Partizánske
+Bratislava I
+Žilina
+Piešťany
+Lučenec
+Košice II
+Levice
+Snina
+Hlohovec
+Zvolen
+Prešov
+Bratislava IV
+Pezinok
+Dunajská Streda
+Myjava
+Liptovský Mikuláš
+Bratislava II
+Košice III
+Ružomberok
+Martin
+Kysucké Nové Mesto
+Čadca
+Sobrance
+Poprad
+Kežmarok
+Stará Ľubovňa
+Gelnica
+Michalovce
+Humenné
+Trenčín
+Krupina
+Banská Bystrica
+Tvrdošín
+Nitra
+Sabinov
+Košice-okolie
+Nové Zámky
+Trnava
+Poltár
+Púchov
+Brezno
+Veľký Krtíš
+Senica
+Levoča
+Topoľčany
+Bardejov
+Medzilaborce
+Galanta
+Ilava
+Košice IV
+Bytča
+Spišská Nová Ves
+Prievidza
+Bratislava III
+Košice I
+Považská Bystrica
+Žiar nad Hronom
+Rimavská Sobota
+Žarnovica
+Bánovce nad Bebravou
+Turčianske Teplice
+Vranov nad Topľou
+Stropkov
+Revúca
+Senec
+Námestovo
+Banská Štiavnica
+Rožňava

data/tests/ZoznamOkresov.txt

@@ -76,4 +76,4 @@ Zlaté Moravce
 Zvolen
 Žarnovica
 Žiar nad Hronom
-Žilina
+Žilina

data/tests/test.rb

@@ -1,5 +1,5 @@
-puts "The Netrand.list tests are going to fail. Move them to folder you have write rights to and then try it."
 require_relative "test_int"
 require_relative "test_sequence"
 require_relative "test_string"
-require_relative "test_list"
+require_relative "test_list"
+require_relative "test_dice"

data/tests/test_dice.rb

@@ -0,0 +1,7 @@
+require "netrand"
+require "test/unit"
+class TestDice < MiniTest::Unit::TestCase
+  def test_real_dice
+    Netrand.dice(20).each {|n| assert n<=6}
+  end
+end

data/tests/test_int.rb

@@ -1,5 +1,4 @@
-require "Netrand"
-
+require "netrand"
 require "test/unit"
 class TestInt < MiniTest::Unit::TestCase
   

data/tests/test_list.rb

@@ -1,20 +1,21 @@
-require "Netrand"
-
+require "netrand"
 require "test/unit"
 class TestList < MiniTest::Unit::TestCase
-  def test_randomization
+  def setup
+    Netrand.randomize_file_lines("#{File.dirname(__FILE__)}/ZoznamOkresov.txt")
+  end
+  def test_file_randomization
     original   = Array.new
     randomized = Array.new
     line = 0
-    File.open("ZoznamOkresov.txt", "r") do |f|
+    File.open("#{File.dirname(__FILE__)}/ZoznamOkresov.txt", "r") do |f|
       until line == nil
         line = f.gets
         original << line
       end
     end
     
-    Netrand.list("ZoznamOkresov.txt")
-    File.open("randomized_ZoznamOkresov.txt", "r") do |f|
+    File.open("#{File.dirname(__FILE__)}/ZoznamOkresov-randomized.txt", "r") do |f|
       until line == nil
         line = f.gets
         randomized << line
@@ -23,20 +24,18 @@ class TestList < MiniTest::Unit::TestCase
     refute_equal(randomized, original)
   end
   
-  def test_not_same
+  def test_file_not_same
     rand1 = Array.new
     rand2 = Array.new
     line = 0
-    Netrand.list("ZoznamOkresov.txt")
-    File.open("randomized_ZoznamOkresov.txt", "r") do |f|
+    File.open("#{File.dirname(__FILE__)}/ZoznamOkresov-randomized.txt", "r") do |f|
       until line == nil
         line = f.gets
         rand1 << line
       end
     end
     
-    Netrand.list("ZoznamOkresov.txt")
-    File.open("randomized_ZoznamOkresov.txt", "r") do |f|
+    File.open("#{File.dirname(__FILE__)}/ZoznamOkresov-randomized.txt", "r") do |f|
       until line == nil
         line = f.gets
         rand2 << line

data/tests/test_sequence.rb

@@ -1,5 +1,4 @@
-require "Netrand"
-
+require "netrand"
 require "test/unit"
 class TestSequence < MiniTest::Unit::TestCase
   def test_randomization

data/tests/test_string.rb

@@ -1,5 +1,4 @@
-require "Netrand"
-
+require "netrand"
 require "test/unit"
 class TestString < MiniTest::Unit::TestCase
   def test_not_same

metadata

@@ -2,7 +2,7 @@
 name: netrand
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors: 
 - "R\xC3\xB3bert Selvek"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 Z
+date: 2011-07-12 00:00:00 Z
 dependencies: []
 
 description: Wrapper around Random.org random number and string generator.
@@ -26,21 +26,25 @@ files:
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
+- lib/functions/common.rb
+- lib/functions/dice.rb
 - lib/functions/int.rb
 - lib/functions/list.rb
-- lib/functions/quota.rb
 - lib/functions/sequence.rb
 - lib/functions/string.rb
 - lib/netrand.rb
 - LICENSE
 - netrand.gemspec
+- pkg/netrand-3.0.0.gem
 - Rakefile
 - README.md
 - tests/test.rb
+- tests/test_dice.rb
 - tests/test_int.rb
 - tests/test_list.rb
 - tests/test_sequence.rb
 - tests/test_string.rb
+- tests/ZoznamOkresov-randomized.txt
 - tests/ZoznamOkresov.txt
 homepage: http://github.com/sellweek/netrand
 licenses: []
@@ -61,14 +65,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1609978401844798295
+      hash: 1909816175611674823
       segments: 
       - 0
       version: "0"
 requirements: 
 - Working internet connection
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Generate true random numbers using random.org

data/lib/functions/quota.rb

@@ -1,16 +0,0 @@
-require "open-uri"
-require_relative "quota"
-module Netrand
-  #Generates exception if quota of random.org is exhausted.
-  
-  def Netrand.check_quota
-    quota = nil
-    open("http://www.random.org/quota/?format=plain") do |c|
-      quota = c.read.to_i
-      if quota < 0 then raise QuotaExhaustedException, "Random.org quota exhausted, please try again after 0:00 UTC" end
-    end
-    quota
-  end
-  
-  class QuotaExhaustedException < RuntimeError; end
-end