rfortune 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Helge Rausch
+
+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

@@ -0,0 +1,30 @@
+= rfortune
+
+A Library for handling cookie jar files as known from 'fortune'.
+
+== INSTALLATION
+
+The latest development version can be found at GitHub:
+
+http://github.com/tsujigiri/rfortune
+
+The latest stable version can be installed from Gemcutter:
+
+gem install rfortune
+
+== SYNOPSIS:
+
+To instantiate a RFortune you have to give the relative path to a
+cookie jar file as an argument. If there is no such file relative to the
+current directory it will be searched beneath /usr/share/games/fortunes.
+
+  cookies = RFortune.new 'cookie_jar_file'
+
+To get a random cookie from the jar simply do:
+
+  puts cookies.random
+
+== Copyright
+
+Copyright (c) 2009 Helge Rausch. See LICENSE for details.
+

data/VERSION

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

data/lib/rfortune.rb

@@ -0,0 +1,117 @@
+# This library provides handling of cookie jar files as used by
+# 'fortune' to read its fortunes from.
+#
+# Author::	Helge Rausch (mailto:helge@rauschenimweltnetz.de)
+# Copyright::	Copyright (c) 2009 Helge Rausch
+# License::	Distributes under the same terms as Ruby
+
+# The RFortune class reads the contents from a cookie jar file and
+# stores its content in an array. It takes the path of a cookie jar file
+# as an argument and searches for it first locally (relative or
+# absolute), than beneath /usr/share/games/fortunes.
+
+class RFortune
+
+  FortunesPath = '/usr/share/games/fortunes/'
+
+  # Looks for the specified cookie jar file first localy, than under
+  # /usr/share/games/fortunes, opens it and reads its content to the
+  # @cookies array. Without an argument or if the file specified does
+  # not exist it creates a new cookie jar.
+  def initialize file_path = nil
+
+    @file_path = file_path
+
+    unless @file_path.nil?
+
+      if File.exist?( @file_path )
+
+	if File.writable?( @file_path )
+	  mode = 'r+'
+	else
+	  mode = 'r'
+	end
+
+	cookie_jar_file =  File.open( @file_path, mode )
+
+      elsif File.exist?( FortunesPath + @file_path )
+
+	cookie_jar_file =  File.open( FortunesPath + @file_path, 'r' )
+
+      elsif File.exist?( FortunesPath + 'off/' + @file_path )
+
+	cookie_jar_file =  File.open( FortunesPath + 'off/' + @file_path, 'r' )
+
+      end
+
+    end
+
+    unless  cookie_jar_file.nil?
+
+      @cookies = cookie_jar_file.read.split( '%' )
+
+      cookie_jar_file.close
+
+      # delete empty cookies
+      @cookies.delete_if { |cookie| cookie.match( /^[\r\n\s]+$/ ) }
+
+    else
+
+      @cookies = []
+
+    end
+
+  end
+
+
+  # Returns a random cookie
+  def random
+
+    @cookies[ rand( @cookies.size ) ]
+
+  end
+
+
+  # Returns the number of cookies in the jar
+  def count
+
+    @cookies.size
+
+  end
+
+  # Adds a cookie to the jar
+  def add cookie
+
+    @cookies += [ cookie ] unless cookie.empty?
+
+  end
+
+  # Returns all cookies as an array
+  def all
+
+    @cookies
+
+  end
+
+  # Returns all cookies in cookie jar file format
+  def all_formated
+
+    all_cookies = @cookies.collect { |c| c = "\n%\n" + c }
+
+    all_cookies += [ "\n%\n" ]
+
+    all_cookies.to_s.sub( /^\n+/, '' )
+
+  end
+
+  # Saves the content of the jar to the file specified by argument given
+  # to itself or to the new method
+  def save new_file_path = nil
+
+    new_file_path or new_file_path = @file_path or raise 'No file name given'
+
+    File.open( new_file_path, 'w') { |jar| jar.puts all_formated }
+
+  end
+
+end

data/test/test_rfortune.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'lib/rfortune'
+
+Cookie_jar_file = 'food'
+
+class RFortuneTest < Test::Unit::TestCase
+
+  def test_init
+    assert_not_nil RFortune.new( Cookie_jar_file ), 'Instantiated a new RFortune'
+  end
+
+  def test_random
+    assert_instance_of String, RFortune.new( Cookie_jar_file ).random, 'Got a random cookie from the jar'
+  end
+
+  def test_count
+    assert_instance_of Fixnum, RFortune.new( Cookie_jar_file ).count
+  end
+
+  def test_add_cookie_and_save
+
+    cookies = RFortune.new( 'tmp_test_new_cookie_jar' )
+
+    cookies.add( 'Simsalabimbambasaladusaladim' )
+
+    cookies.save
+
+    jar_file_content = ''
+
+    if File.exist?( 'tmp_test_new_cookie_jar' )
+
+      jar_file_content = File.open( 'tmp_test_new_cookie_jar', 'r' ).read
+
+      File.delete( 'tmp_test_new_cookie_jar' )
+
+    end
+
+    assert_equal "%\nSimsalabimbambasaladusaladim\n%\n", jar_file_content, 'Check if the cookie jar file has been written'
+  end
+
+  def test_init_without_argument_and_save
+
+    cookies = RFortune.new
+
+    assert_not_nil cookies, 'Instantiate RFortune without specifying a file'
+
+    assert_raise RuntimeError do
+
+      cookies.save
+
+    end 
+
+    assert_nothing_raised do
+
+      cookies.save 'tmp_test_cookie_jar'
+
+    end
+
+    File.exist?( 'tmp_test_cookie_jar' ) and File.delete( 'tmp_test_cookie_jar' )
+
+  end
+
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: rfortune
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Helge Rausch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-30 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: RFortune provides handling of cookie jar files as known from 'fortune'
+email: helge@rauschenimweltnetz.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rfortune.rb
+- test/test_rfortune.rb
+- LICENSE
+- README.rdoc
+- VERSION
+has_rdoc: true
+homepage: http://github.com/tsujigiri/rfortune
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: RFortune provides handling of cookie jar files as known from 'fortune'
+test_files: []
+