scbi_headers 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 2012-05-28
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+lib/scbi_headers/scbi_header.rb
+lib/scbi_headers.rb
+Manifest.txt
+PostInstall.txt
+Rakefile
+README.rdoc
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_scbi_headers.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on scbi_headers, see http://scbi_headers.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,114 @@
+= scbi_headers
+
+* http://www.scbi.uma.es/downloads
+
+== DESCRIPTION:
+
+scbi_headers is a gem that provides consistent text headers for command line applications.
+
+== FEATURES/PROBLEMS:
+
+Can show the following information
+
+* Corporate infomation
+* Application name
+* Version
+* Description
+* Authors
+* Articles to be referenced
+
+== SYNOPSIS:
+
+This sample code:
+
+  require 'scbi_headers'
+
+
+  @header = ScbiHeader.new('SAMPLE_PROGRAM','101')
+
+  @header.description="A long description for this program. It may include a few lines of text. In such cases, a word based wrap will be applied."
+
+  @header.copyright='2012'
+
+  @header.authors<< "Dario Guerrero"
+  @header.authors<< "Other"
+
+  @header.articles<< "Article one: with one description line"
+  @header.articles<< "Article two: with one description line"
+  
+  # The main title can also be changed:
+  
+  @header.title=[]
+  @header.title << "SuperComputing and BioInformatics - SCBI"
+  @header.title << "University of Malaga - Spain"
+  @header.title << "http://www.scbi.uma.es"  
+
+  # To output the header
+  puts @header
+
+
+Will produce the following output:
+
+  #==============================================================================#
+  #                   SuperComputing and BioInformatics - SCBI                   #
+  #                         University of Malaga - Spain                         #
+  #                            http://www.scbi.uma.es                            #
+  #------------------------------------------------------------------------------#
+  #                                                                              #
+  # SAMPLE_PROGRAM - version: 101 - (c) 2012                                     #
+  #                                                                              #
+  #------------------------------------------------------------------------------#
+  #                                                                              #
+  #  A long description for this program. It may include a few lines of text. In #
+  #  such cases, a word based wrap will be applied.                              #
+  #                                                                              #
+  #------------------------------------------------------------------------------#
+  #                                                                              #
+  # Authors                                                                      #
+  #       -Dario Guerrero                                                        #
+  #       -Other                                                                 #
+  #------------------------------------------------------------------------------#
+  #                                                                              #
+  # **NOTE: If you find this program useful, please cite the following articles: #
+  #                                                                              #
+  #       -Article one: with one description line                                #
+  #       -Article two: with one description line                                #
+  #==============================================================================#  
+  
+
+
+== REQUIREMENTS:
+
+None
+
+== INSTALL:
+
+Common install with gem install:
+
+  gem install scbi_headers
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Dario Guerrero
+
+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,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/scbi_headers'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'scbi_headers' do
+  self.developer 'Dario Guerrero', 'dariogf@scbi.uma.es'
+#  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/scbi_headers/scbi_header.rb

@@ -0,0 +1,166 @@
+
+# A class to print information headers in all command line applications of SCBI
+
+class ScbiHeader
+
+  attr_accessor :description,:l1_separator_char,:l2_separator_char,:program_name,:program_version,:width
+
+  attr_accessor :title,:authors, :articles, :copyright
+
+  def initialize(program_name, program_version, use_default_title = true, width = 80)
+    @res=[]
+    @comment_char='#'
+    @l1_separator_char='='
+    @l2_separator_char='*'
+    @l3_separator_char='-'
+
+    @title=[]
+
+    @copyright=''
+
+    if use_default_title
+      default_title
+    end
+
+    @authors=[]
+    @articles=[]
+
+    @program_name=program_name
+    @description=description
+    @program_version=program_version
+    @width=width
+
+  end
+
+  def default_title
+
+    @title << "SuperComputing and BioInformatics - SCBI"
+    @title << "University of Malaga - Spain"
+    @title << "http://www.scbi.uma.es"
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    populate_header
+    @res.join("\n")
+  end
+
+  private
+
+
+    # build the real string into @res
+    def populate_header()
+
+      separator(@l1_separator_char)
+
+      @title.each do |title_line|
+        centered_line(title_line)
+      end
+      separator(@l3_separator_char)
+      empty_line
+
+      name_line="#{@program_name} - version: #{@program_version}"
+
+      if !@copyright.empty?
+        name_line+=" - (c) #{@copyright}"
+      end
+
+      left_line(name_line)
+
+      empty_line
+
+      separator(@l3_separator_char)
+      empty_line
+
+      wrap(@description,@width).each do |line|
+        left_line(line)
+      end
+      empty_line
+
+      if !@authors.empty?
+        separator(@l3_separator_char)
+
+        empty_line
+        left_line('Authors')
+
+        @authors.each do |line|
+          left_line(' '*6+'-'+line)
+        end
+      end
+
+
+      if !@articles.empty?
+        separator(@l3_separator_char)
+
+        empty_line
+        left_line('**NOTE: If you find this program useful, please cite the following articles:')
+        empty_line
+        @articles.each do |line|
+          left_line(' '*6+'-'+line)
+        end
+      end
+
+      separator(@l1_separator_char)
+
+
+    end
+
+
+    # make a simple wrap of complete words
+    def wrap(s,width)
+      res=[]
+      lines=s.split("\n")
+
+      lines.each do |input_line|
+        words=input_line.split(/\s/)
+        line=''
+        words.each do |w|
+          if (line.length+w.length)>(width-4)
+            res << line
+            line=''
+          end
+
+          line << ' '+w
+
+        end
+
+        if !line.empty?
+          res << line
+          line=''
+        end
+
+      end
+
+      res
+    end
+
+    def separator(level_char)
+      @res << @comment_char + level_char*(@width-2)+@comment_char
+
+    end
+
+    def add_line(line)
+      @res << @comment_char + ' '+line+' '+@comment_char
+    end
+
+    def centered_line(line)
+      add_line(line.center(@width-4))
+    end
+
+    def empty_line()
+      centered_line('')
+    end
+
+    def left_line(line)
+      add_line(line.ljust(@width-4))
+    end
+
+
+    def right_line(line)
+      add_line(line.rjust(@width-4))
+    end
+
+end

data/lib/scbi_headers.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'scbi_headers/scbi_header'
+
+module ScbiHeaders
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scbi_headers.rb'}"
+puts "Loading scbi_headers gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

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

data/test/test_scbi_headers.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestScbiHeaders < Test::Unit::TestCase
+
+  def setup
+    @header = ScbiHeader.new('SAMPLE_PROGRAM','101')
+    @header.description="A long description for this program. It may include a few lines of text. In such cases, a word based wrap will be applied."
+    
+    @header.copyright='2012'
+    
+    @header.authors<< "Dario Guerrero"
+    @header.authors<< "Other"
+    
+    @header.articles<< "Article one: with one description line"
+    @header.articles<< "Article two: with one description line"
+    
+    puts @header
+  end
+  
+  def test_truth
+
+    assert true
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: scbi_headers
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dario Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+description: scbi_headers is a gem that provides consistent text headers for command line applications.
+email: 
+- dariogf@scbi.uma.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- lib/scbi_headers/scbi_header.rb
+- lib/scbi_headers.rb
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- README.rdoc
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_scbi_headers.rb
+homepage: http://www.scbi.uma.es/downloads
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: scbi_headers
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: scbi_headers is a gem that provides consistent text headers for command line applications.
+test_files: 
+- test/test_helper.rb
+- test/test_scbi_headers.rb