notes-structured-text-strip-bodies 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Trampoline Systems Ltd
+
+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,19 @@
+= notes-structured-text-strip-bodies
+
+Description goes here.
+
+== Contributing to notes-structured-text-strip-bodies
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Trampoline Systems Ltd. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "notes-structured-text-strip-bodies"
+  gem.homepage = "http://github.com/trampoline/notes-structured-text-strip-bodies"
+  gem.license = "MIT"
+  gem.summary = %Q{strip message bodies from Lotus Notes Structured Text exports}
+  gem.description = %Q{a command-line utility for removing message body text from Lotus Notes Structured Text export files}
+  gem.email = "craig@trampolinesystems.com"
+  gem.authors = ["mccraigmccraig"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "rspec", "~> 1.3.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.add_development_dependency "rcov", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "notes-structured-text-strip-bodies #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/bin/notes_structured_text_strip_bodies

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'notes_structured_text_strip_bodies'
+require 'optparse'
+require 'logger'
+
+options={}
+
+USAGE = "Usage: #{File.basename(__FILE__)} <output_dir> <input_files> [<input_file>]* "
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} <output_dir> <input_files> [<input_file>]* "
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+end.parse!
+
+raise USAGE if ARGV.length<2
+
+output_dir = ARGV[0]
+input_files = ARGV[1..-1]
+raise "<output_dir>: #{output_dir} must be a directory\n#{USAGE}" if !File.directory?(output_dir)
+
+NotesStructuredTextStripBodies.logger = Logger.new($stderr)
+if options[:verbose]
+  NotesStructuredTextStripBodies.logger.level=Logger::DEBUG
+else
+  NotesStructuredTextStripBodies.logger.level=Logger::INFO
+end
+NotesStructuredTextStripBodies.strip_files(output_dir, input_files, options)

data/lib/notes_structured_text_strip_bodies.rb

@@ -0,0 +1,50 @@
+module NotesStructuredTextStripBodies
+  class << self
+    attr_accessor :logger
+  end
+
+  module_function
+
+  def log
+    yield logger if logger
+  end
+
+  def strip_files(output_dir, input_files, options={})
+    log{|logger| logger.info("stripping to output directory: #{output_dir}")}
+    input_files = [*input_files]
+    input_files.each do |input_file|
+      strip_file(output_dir, input_file)
+    end
+  end
+
+  def strip_file(output_dir, input_file, options={})
+    output_file = File.join(output_dir, File.basename(input_file))
+    raise "<input_file>: #{input_file} does not exist or is not a regular file" if !File.file?(input_file)
+    File.open(input_file, "r") do |input|
+      File.open(output_file, "w") do |output|
+        log{|logger| logger.debug("stripping: #{input_file} => #{output_file}")}
+        strip(output, input)
+      end
+    end
+  end
+
+  def read_block(input)
+    return nil if input.eof?
+    block = []
+    begin
+      l = input.readline.chomp
+      block << l if l.length>0
+    end while !input.eof? && l != ""
+    block
+  end
+
+  def is_header_block?(block)
+    !!block.find{|l| l =~ /^\$MessageID: /}
+  end
+
+  def strip(output, input)
+    while block=read_block(input)
+      block.each{|l| output << l << "\n"} if is_header_block?(block)
+    end
+  end
+end

data/spec/notes_structured_text_strip_bodies_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'stringio'
+
+describe NotesStructuredTextStripBodies do
+  describe "strip_files" do
+    it "should call strip_file once per input_file with one input file" do
+      output_dir = Object.new
+      input_file = Object.new
+      mock(NotesStructuredTextStripBodies).strip_file(output_dir, input_file)
+      NotesStructuredTextStripBodies.strip_files(output_dir, input_file)
+    end
+
+    it "should call strip_file once per input_file with multiple input files" do
+      output_dir = Object.new
+      input_files = [Object.new, Object.new]
+      mock(NotesStructuredTextStripBodies).strip_file(output_dir, input_files[0])
+      mock(NotesStructuredTextStripBodies).strip_file(output_dir, input_files[1])
+      NotesStructuredTextStripBodies.strip_files(output_dir, input_files)
+    end
+  end
+  
+  describe "strip_file" do
+    it "should open a new output file for writing, the input file for reading and call strip" do
+      output_dir = "/foo/bar"
+      input_file = "baz/boo.txt"
+
+      logdev = Object.new
+      stub(NotesStructuredTextStripBodies).logdev{logdev}
+      logger = Object.new
+      stub(NotesStructuredTextStripBodies).logger{logger}
+
+      output_stream = Object.new
+      mock(File).open("/foo/bar/boo.txt", "w") do |f, mode, block|
+        block.call(output_stream)
+      end
+
+      input_stream = Object.new
+      mock(File).open("baz/boo.txt", "r") do |f, mode, block|
+        block.call(input_stream)
+      end
+
+      mock(logger).debug(anything){|msg|
+        msg.should =~ %r{/foo/bar/boo.txt}
+        msg.should =~ %r{baz/boo.txt}
+      }
+      mock(NotesStructuredTextStripBodies).strip(output_stream, input_stream)
+
+      NotesStructuredTextStripBodies.strip_file(output_dir, input_file)
+    end
+  end
+
+  describe "readblock" do
+    it "should return lines read from a stream until the first empty line" do
+      input = <<-EOF
+foo
+bar
+
+baz
+boo
+EOF
+      io = StringIO.new(input)
+      NotesStructuredTextStripBodies.read_block(io).should == ["foo", "bar"]
+      NotesStructuredTextStripBodies.read_block(io).should == ["baz", "boo"]
+    end
+
+    it "should return nil if the input stream is at EOF" do
+      io = StringIO.new("foo\nbar")
+      NotesStructuredTextStripBodies.read_block(io).should == ["foo", "bar"]
+      NotesStructuredTextStripBodies.read_block(io).should == nil
+    end
+  end
+
+  describe "is_header_block?" do
+    it "should return true if the block contains a line which start with '$MessageID: ' " do
+      NotesStructuredTextStripBodies.is_header_block?( ["foo", "$MessageID: bar", "baz"] ).should == true
+    end
+
+    it "should return false if there are no lines starting with '$MessageID: ' in the block" do
+      NotesStructuredTextStripBodies.is_header_block?( ["foo", "bar", "baz"] ).should == false
+    end
+  end
+  
+  describe "strip" do
+    it "should write each line of each header block to output" do
+      output = Object.new
+      input = Object.new
+
+      block1 = [Object.new, Object.new, Object.new]
+      block2 = [Object.new, Object.new, Object.new]
+      block3 = [Object.new, Object.new]
+
+      blocks = [block3, block2, block1]
+      stub(NotesStructuredTextStripBodies).read_block(input){
+        raise "no more blocks" if !blocks
+        blocks = nil if blocks.empty?
+        blocks.pop if blocks
+      }
+      
+      mock(NotesStructuredTextStripBodies).is_header_block?(block1){true}
+      mock(NotesStructuredTextStripBodies).is_header_block?(block2){false}
+      mock(NotesStructuredTextStripBodies).is_header_block?(block3){true}
+
+      mock(output).<<(block1[0]){output}
+      mock(output).<<("\n").times(5){output}
+      mock(output).<<(block1[1]){output}
+      mock(output).<<(block1[2]){output}
+      mock(output).<<(block3[0]){output}
+      mock(output).<<(block3[1]){output}
+
+      NotesStructuredTextStripBodies.strip(output, input)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+require 'rr'
+require 'notes_structured_text_strip_bodies'
+
+Spec::Runner.configure do |config|
+  config.mock_with RR::Adapters::Rspec
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: notes-structured-text-strip-bodies
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mccraigmccraig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +01:00
+default_executable: notes_structured_text_strip_bodies
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: a command-line utility for removing message body text from Lotus Notes Structured Text export files
+email: craig@trampolinesystems.com
+executables: 
+- notes_structured_text_strip_bodies
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/notes_structured_text_strip_bodies
+- lib/notes_structured_text_strip_bodies.rb
+- spec/notes_structured_text_strip_bodies_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/trampoline/notes-structured-text-strip-bodies
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: strip message bodies from Lotus Notes Structured Text exports
+test_files: 
+- spec/notes_structured_text_strip_bodies_spec.rb
+- spec/spec_helper.rb