linux_fortune 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-03-23
+
+* 1 major enhancement:
+  * Initial release

data/Manifest

@@ -0,0 +1,7 @@
+History.txt
+Manifest
+README.rdoc
+Rakefile
+lib/linux_fortune.rb
+test/test_helper.rb
+test/test_linux_fortune.rb

data/README.rdoc

@@ -0,0 +1,67 @@
+= LinuxFortune
+
+* http://github.com/srejbi/linux_fortune_gem
+
+== DESCRIPTION:
+
+Provides a wrapper to the 'fortune' program on linux (and unix /parameters
+might differ/) platforms. As most (good) web servers are running on these
+platforms, a 'local' fortune gem seemed like a good idea to play around and
+discover ruby gem development through a practical example.
+
+If you need a network-based fortune service, though, you might want to check out
+lacco's ruby_fortunes at http://github.com/lacco/ruby-fortunes
+
+== FEATURES:
+
+* allows generating messages from all or specific fortune database modules
+* possibility to generate short (up to LinuxFortune.short_length characters) messages
+
+== ISSUES:
+
+* LinuxFortune.long = true seem to have no effect due to issue with fortune (?)
+
+== SYNOPSIS:
+
+To use it:
+
+  require 'rubygems'
+  require 'linux_fortune'
+  f = LinuxFortune.generate("chucknorris")
+  puts f.body
+
+== REQUIREMENTS:
+
+* fortune must be installed, with some fortune db modules
+
+== INSTALL:
+
+* gentoo: 
+  sudo emerge fortune
+* ubuntu, debian:
+  apt-get install fortune
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 György Schreiber
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('linux_fortune', '0.0.1') do |p|
+  p.description    = "A gem that provides a wrapper for the linux fortune program"
+  p.url            = "http://github.com/srejbi/linux_fortune"
+  p.author         = "George Schreiber"
+  p.email          = "gy.schreiber @nospam@ mobility.hu"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+

data/lib/linux_fortune.rb

@@ -0,0 +1,221 @@
+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)
+  def self.binary_path=(path)
+    @@binary_path = path unless @@binary_path == path
+  end
+
+  # gets the current path to the linux fortune program
+  def self.binary_path
+    @@binary_path
+  end
+
+  @@offensive = false
+
+  # <tt>off</tt> - Choose only from potentially offensive aphorisms.  This option is ignored if a fortune directory is specified.
+  def self.offensive=(off = true)
+    @@offensive = off
+  end
+
+  def self.offensive
+    @@offensive
+  end
+
+  @@equalsize = false
+
+  # <tt>eq</tt> - Consider all fortune files to be of equal size (see discussion below on multiple files).
+  def self.equalsize=(eq = true)
+    @@equalsize = eq
+  end
+
+  # returns the current state of <tt>equalsize</tt>
+  def self.equalsize
+    @@equalsize
+  end
+
+  @@short_length = 160
+
+  # Set  the longest fortune length (in characters) considered to be ``short'' (the default is 160).  All
+  # fortunes longer than this are considered ``long''.  Be careful!  If you set the length too short  and
+  # ask  for  short  fortunes, or too long and ask for long ones, fortune goes into a never-ending thrash
+  # loop.
+  def self.short_length=(shortlength = 160)
+    @@short_length = shortlength
+  end
+
+  # gets the current maximum length considered short
+  def self.short_length
+    @@short_length
+  end
+
+  @@short = false
+
+  # turns on/off short message generation
+  def self.short=(shortfortunes = true)
+    @@long = false if shortfortunes
+    @@short = shortfortunes
+  end
+
+  # get the state of short message generation
+  def self.short
+    @@short
+  end
+
+  @@long = false
+
+  # turns on/off long message generation
+  def self.long=(longfortunes = true)
+    @@short = false if longfortunes
+    @@long = longfortunes
+  end
+
+  # gets the state of long message generation
+  def self.long
+    @@long
+  end
+
+  @@ignore_case = true
+
+  # turns on/off case-insensitivity for search
+  def self.ignore_case=(ignore = true)
+    @@ignore_case = ignore
+  end
+
+  # gets the state of case-insensitivity
+  def self.ignore_case
+    @@ignore_case
+  end
+
+  # fortune source
+  class FortuneSource
+    @path = "/usr/share/fortune"
+    @source = ""
+    @weight = 0
+
+    def init(source = nil, path = "/usr/share/fortune", weight = nil )
+      @source = source
+      @path = path
+      @weight = weight
+    end
+
+    # sets the fortune source path
+    def path=(srcpath)
+      @path = srcpath
+    end
+
+    # gets the source path (directory with source)
+    def path
+      @path
+    end
+
+    # sets the source file name (file in FortuneSource.path)
+    def source=(src)
+      @source = src
+    end
+
+    # gets source file name
+    def source
+      @source
+    end
+
+    def weight
+      @weight
+    end
+
+    # gets full path to the source
+    def fullpath
+      File.join(@path, @source)
+    end
+  end
+
+
+  # The Fortune class is basicly 2 strings, source and body
+  class Fortune
+    @source = ""
+    @body = ""
+
+    # attribute accessors
+
+    # gets the fortune text
+    def body
+      @body
+    end
+    # gets the fortune text (alias for body)
+    alias_method(:to_s, :body)
+
+    # gets the fortune source
+    def source
+      @source
+    end
+
+    def body=(text = "")
+      @body = text
+    end
+
+    def source=(src = "")
+      @source = src
+    end
+
+  end
+
+  # list available sources
+  def self.get_sources
+    sources = []
+    path = nil
+    srclist = `#{self.binary_path} -f 2>&1`
+    srclist.each do |source|
+      weight,src = source.strip.split
+      if src.match(/(\/.*)*/)
+        puts "#{src} -> #{weight}"
+        path = src
+      else
+        sources << FortuneSource.new( :path => path, :source => src, :weight => weight )
+      end
+    end
+    sources
+  end
+
+  # executes the fortune program
+  def self.fortune(sources = nil)
+    puts "executing #{self.binary_path} -c #{fortune_options} #{sources.each { |s| s; } unless sources.nil?} 2>&1"
+    `#{self.binary_path} -c #{fortune_options} #{sources.each { |s| s; } unless sources.nil?} 2>&1`
+  end
+
+  # generates a fortune message
+  # <tt>sources</tt> - array of sources
+  def self.generate(sources = nil)
+    lf = LinuxFortune::Fortune.new
+    lf.body = ""
+    ftn = self.fortune(sources)
+    ftn.each do |s|
+      if s.match(/\(.*\)/)
+        lf.source = s.gsub(/(^\()|(\)$)/, "")
+      else
+        lf.body << s unless s.match(/^%\n/)
+      end
+    end
+    lf
+  end
+
+  # searches fortune sources and returns hits
+  def self.search(pattern = nil)
+    # TODO
+  end
+
+  protected
+
+  # construct command line options for fortune
+  def self.fortune_options
+    opts = ""
+    opts << "-o " if @@offensive
+    opts << "-e " if @@equalsize
+    opts << "-l " if @@long
+    opts << "-s " if @@short
+    opts << "-n #{@@short_length}" unless @@short_length == 160 or (!@@long and !@@short)
+    opts 
+  end
+end
+

data/linux_fortune.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{linux_fortune}
+  s.version = "0.0.1"
+
+  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-23}
+  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.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Linux_fortune", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{linux_fortune}
+  s.rubygems_version = %q{1.3.5}
+  s.signing_key = %q{/home/george/.ssh/gem/gem-private_key.pem}
+  s.summary = %q{A gem that provides a wrapper for the linux fortune program}
+  s.test_files = ["test/test_helper.rb", "test/test_linux_fortune.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/linux_fortune'

data/test/test_linux_fortune.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestLinuxFortune < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_binary_path
+    LinuxFortune.binary_path=`which fortune`.strip
+    assert !LinuxFortune.binary_path.nil?
+    assert File.exist?(LinuxFortune.binary_path)
+  end
+
+  # test if fortune is generated
+  def test_basic_generation
+    lf = LinuxFortune.generate
+    assert !lf.nil?                             # fortune should be present
+    assert !lf.body.nil? && !lf.body.empty?     # body should be present
+    assert !lf.source.nil? && !lf.source.empty? # source should be present
+  end
+
+  # verify that long gets set to false if configuring for short messages
+  def test_short
+    LinuxFortune.short = true
+    assert LinuxFortune.short           # short should be set to true
+    assert LinuxFortune.long == false   # long to false
+    assert LinuxFortune.fortune_options.include?("-s")
+    assert LinuxFortune.fortune_options.include?("-n")
+    10.times do                             # check multiple times if the generated length is ok
+      lf = LinuxFortune.generate
+      assert lf.body.size < LinuxFortune.short_length # check if actual size is less than the max. short length
+    end
+  end
+
+  # verify that short gets set to false if configuring for long messages
+  def test_long
+    LinuxFortune.long = true
+    assert LinuxFortune.long            # long should be set to short
+    assert LinuxFortune.short == false  # short to false
+    assert LinuxFortune.fortune_options.include?("-l")
+    assert LinuxFortune.fortune_options.include?("-n")
+    5.times do                           # check multiple times if the generated length is ok
+      lf = LinuxFortune.generate
+      #puts "#{lf.body.size} characters"
+      # TODO apparently there is an issue with 'fortune -l'; check fortune docs & bugs (manual mentions a different problem
+      assert lf.body.size+10 >= LinuxFortune.short_length # check if actual size is greater than the max. short length
+    end
+  end
+
+  # Fortune.body should be the same as Fortune.to_s
+  def test_to_s
+    lf = LinuxFortune.generate
+    assert lf.body == lf.to_s
+  end
+
+  # test that there are sources
+  # TODO refine test case
+  def test_sources
+    src = LinuxFortune.get_sources
+    #src.each { |s| s.strip!; weight,name = s.split(" "); puts "#{name} -> #{weight}" }
+    assert !src.nil?
+  end
+
+  # test if fortune messages are from the sources requested
+  # TODO pick random sources from sources
+  def test_fortune_from_sources
+    5.times do
+      lf = LinuxFortune.generate(["chucknorris"])
+      #puts lf.source
+      #puts lf.source.split("/").last
+      assert ["chucknorris"].include?(lf.source.split("/").last.strip)
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: linux_fortune
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- George Schreiber
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRUwEwYDVQQDDAxneS5z
+  Y2hyZWliZXIxGDAWBgoJkiaJk/IsZAEZFghtb2JpbGl0eTESMBAGCgmSJomT8ixk
+  ARkWAmh1MB4XDTEwMDMyMjIyMjcyN1oXDTExMDMyMjIyMjcyN1owRTEVMBMGA1UE
+  AwwMZ3kuc2NocmVpYmVyMRgwFgYKCZImiZPyLGQBGRYIbW9iaWxpdHkxEjAQBgoJ
+  kiaJk/IsZAEZFgJodTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMJJ
+  s2WBsiNww5bbNAiHZEoEQgvmZA2G3+wiojnk7pYzecLbO5EIUy/SAGbOknjo5oZV
+  ltBcHezhvrC1rz1yGZj99rHRqIdVZeMDhWBqy0UlQ4sUFo/XMyTLCrjgR/uAC30R
+  8VH862M5X437OOWzQtRA4HhO//7Wgnyqk5XDf9/4yPA7ZR9D9ByqsFMSB/lUbn1a
+  rvUqEYVjYG79n3Cr8xZ6N1Tq97Boyomnr1kfokpuvkSDXdjkOIvxrxcWADbpIDW6
+  hNl+aM43lvILA2XfoxnvNSl0kKWfMFJqEZZBpQUjYKCIf035qFEvM8bSYwsgJjBB
+  IZGcOiAN0cM1WdoYFXMCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFAqua0hB8DclDhesGYAgmSOOYXLcMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAV+IGpY3FuM3hwGQzEHIvRbZiHl2xRMWjsyspgKAXi65ecAZo8LIsgdGznrOB7
+  Dd6QV4mzDVOnlCea92b3hZ3Cs0aKFDgXFbX8GChJ00vU32vOxFloMGX+TY8oApmR
+  sHX07jF6alv1gyAy1vk4K2aaOCQP8R87hjKJVosg/LCVDjYnpGgctiDIrWOQw6pm
+  ZYkcwKLRgPyxXGaiHG7b9JC9c7Zh9pHHGzOixPR6Hk8OFbtB4h2l4I5wHdv5Aey/
+  aIXWbEzN9SxPazhq7J72gIvE7VMxbKRVdZM4VY6Gk1Ucs9uimgYoaF2Pzzs8I9v4
+  0ps4N+22wwDW/tu5hg8+hebo
+  -----END CERTIFICATE-----
+
+date: 2010-03-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A gem that provides a wrapper for the linux fortune program
+email: gy.schreiber @nospam@ mobility.hu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/linux_fortune.rb
+files: 
+- History.txt
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/linux_fortune.rb
+- test/test_helper.rb
+- test/test_linux_fortune.rb
+- linux_fortune.gemspec
+has_rdoc: true
+homepage: http://github.com/srejbi/linux_fortune
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Linux_fortune
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: linux_fortune
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A gem that provides a wrapper for the linux fortune program
+test_files: 
+- test/test_helper.rb
+- test/test_linux_fortune.rb