linux_fortune 0.0.4 → 0.0.5

data/History.txt

@@ -18,4 +18,11 @@
 
 * 2 minor enhancements:
   * some of "gregory's anonymous class hacks":http://blog.rubybestpractices.com/posts/gregory/anonymous_class_hacks.html rbp's implemented
-  * updated testing
+  * updated testing
+
+=== 0.0.5 2010-03-30
+
+* 1 major enhancement:
+  * fortunes can be searched
+* minor enhancements:
+  * code comments & cleanups

data/README.rdoc

@@ -30,6 +30,17 @@ To use it:
   f = LinuxFortune.generate("chucknorris")
   puts f.body
 
+To search fortunes:
+
+  require 'rubygems'
+  require 'linux_fortune'
+  fs = LinuxFortune.search("develop")
+  puts "#{fs.size} hits:"
+  fs.each do |f|
+    puts f.source
+    puts f.body
+  end
+
 == REQUIREMENTS:
 
 * fortune must be installed, with some fortune db modules

data/Rakefile

@@ -2,9 +2,9 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('linux_fortune', '0.0.4') do |p|
+Echoe.new('linux_fortune', '0.0.5') do |p|
   p.description    = "A gem that provides a wrapper for the linux fortune program"
-  p.url            = "http://github.com/srejbi/linux_fortune"
+  p.url            = "http://srejbi.info/posts/5_linux_fortune"
   p.author         = "George Schreiber"
   p.email          = "gy.schreiber @nospam@ mobility.hu"
   p.ignore_pattern = ["tmp/*", "script/*"]

data/lib/linux_fortune.rb

@@ -1,6 +1,5 @@
 module LinuxFortune
   # <tt>@@binary_path</tt> - path to the 'fortune' binary
-  #mattr_accessor :binary_path
   @@binary_path = "/usr/bin/fortune"
 
   # sets the path of the linux fortune program ("/usr/bin/fortune" by default)
@@ -117,27 +116,52 @@ module LinuxFortune
 
   # The Fortune class is basicly 2 strings, source and body
   Fortune = Class.new do
+    # attribute accessors
+    attr_reader :body, :source
+
     # pass the string from the fortune program
     def initialize(fortunestring)
       # check lines of the string, extract source and separate from the rest of the body
-      src = ""
-      bod = ""
-      fortunestring.each do |s|
-        if s.match(/\(.*\)/) and src.empty?
-          src = s.gsub(/(^\()|(\)$)/, "").strip
-        else
-          bod += s unless s.match(/^%\n/)
+      temp_source = ""
+      temp_body = ""
+      fortunestring.each do |fortune_line|
+        # in fortune strings, source is a path included in brackets
+        if fortune_line.match(/\(.*\)/) and temp_source.empty?
+          temp_source = fortune_line.gsub(/(^\()|(\)$)/, "").strip
+        else  # if not a source
+          # it is a body line, unless it is a 'field separator' - a line with a single percent sign
+          temp_body += fortune_line unless fortune_line.match(/^%\n/)
         end
       end
-      @source = src
-      @body = bod
+      @source = temp_source
+      @body = temp_body
     end
-    # attribute accessors
-
-    attr_reader :body, :source
 
     # gets the fortune text (alias for body)
     alias_method(:to_s, :body)
+
+    # processes a fortune search output string and returns an array of fortunes
+    def self.fortunes(fortunesstring)
+      ret = []
+      # check lines of the string, extract source and separate from the rest of the body
+      temp_source = ""
+      temp_body = ""
+      # parse results string
+      fortunesstring.each do |fortunes_line|
+        if fortunes_line.strip.match(/^%$/)     # field separator?
+          if temp_source != "" and temp_body != ""
+            fortunesource = "#{temp_source}\n%\n#{temp_body}"
+            ret << Fortune.new(fortunesource)
+          end
+          temp_body = ""
+        elsif fortunes_line.match(/^\(.*\)$/)   # source field?
+          temp_source = fortunes_line.strip
+        else                                    # if not a source or a separator
+          temp_body += fortunes_line
+        end
+      end
+      ret
+    end
   end
   
 
@@ -160,7 +184,7 @@ module LinuxFortune
   # executes the fortune program
   def self.fortune(sources = nil)
     #puts "executing #{self.binary_path} -c #{fortune_options} #{sources.each { |s| s.strip }.join(" ") unless sources.nil?} 2>&1"
-    `#{self.binary_path} -c #{fortune_options} #{sources.each { |s| s.to_s }.join(" ") unless sources.nil?} 2>&1`
+    `#{self.binary_path} -c #{fortune_options} #{sources.each { |source| source.to_s }.join(" ") unless sources.nil?} 2>&1`
   end
 
   # generates a fortune message
@@ -170,8 +194,16 @@ module LinuxFortune
   end
 
   # searches fortune sources and returns hits
-  def self.search(pattern = nil)
-    # TODO
+  # <tt>pattern</tt> - search pattern (grep-like)
+  # <tt>sources</tt> - array of sources to be searched (all if not specified)
+  def self.search(pattern = nil, sources = nil)
+    # reset long / short filters
+    LinuxFortune.long = false
+    LinuxFortune.short = false
+    # run fortune
+    results = `#{self.binary_path} -c -m "#{pattern.gsub(/"/, '\\"')}" #{fortune_options} #{sources.each { |source| source.to_s }.join(" ") unless sources.nil?} 2>&1`
+    # process results
+    LinuxFortune::Fortune.fortunes(results)
   end
 
   protected

data/linux_fortune.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{linux_fortune}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["George Schreiber"]
   s.cert_chain = ["/home/george/.ssh/gem/gem-public_cert.pem"]
-  s.date = %q{2010-03-25}
+  s.date = %q{2010-03-30}
   s.description = %q{A gem that provides a wrapper for the linux fortune program}
   s.email = %q{gy.schreiber @nospam@ mobility.hu}
   s.extra_rdoc_files = ["README.rdoc", "lib/linux_fortune.rb"]
   s.files = ["History.txt", "Manifest", "README.rdoc", "Rakefile", "lib/linux_fortune.rb", "test/test_helper.rb", "test/test_linux_fortune.rb", "linux_fortune.gemspec"]
-  s.homepage = %q{http://github.com/srejbi/linux_fortune}
+  s.homepage = %q{http://srejbi.info/posts/5_linux_fortune}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Linux_fortune", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{linux_fortune}

data/test/test_linux_fortune.rb

@@ -84,4 +84,15 @@ class TestLinuxFortune < Test::Unit::TestCase
     fortunes << LinuxFortune.generate( sources )
     assert !fortunes.empty?
   end
+
+  # test that search executes, array of fortunes is returned
+  def test_search
+    fortunes = LinuxFortune.search('develop', ['chucknorris'])
+    assert fortunes.is_a?(Array)
+    assert fortunes.size > 0
+    fortunes.each do |fortune|
+      assert fortune.is_a?(LinuxFortune::Fortune)
+      assert fortune.source.include?('chucknorris')
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - George Schreiber
@@ -35,7 +35,7 @@ cert_chain:
   0ps4N+22wwDW/tu5hg8+hebo
   -----END CERTIFICATE-----
 
-date: 2010-03-25 00:00:00 +01:00
+date: 2010-03-30 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -58,7 +58,7 @@ files:
 - test/test_linux_fortune.rb
 - linux_fortune.gemspec
 has_rdoc: true
-homepage: http://github.com/srejbi/linux_fortune
+homepage: http://srejbi.info/posts/5_linux_fortune
 licenses: []
 
 post_install_message: