loadfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 752facc20baaa2818801edebd9141ea44b9b4829
+  data.tar.gz: d7dff27e0136af6fc2305851b0c1d31a72acba25
+SHA512:
+  metadata.gz: 11210d5375941ee4f133ec2138ce5c2a8631273d26e03a4ccf54fb6003e34a85669315967da75534783aaaaae7e8c00e53e5e45838bef1c435ba5dca6ee1b916
+  data.tar.gz: 87058cc19f9f396498c2e814aca9fe407f9f9a99c7306942149e543531d6537b37e51e1b12e6cfb1d12452c652af051e0a6db08d04eb2389a63ccabf7117e665

data/README.md

@@ -0,0 +1,41 @@
+loadfile
+---------
+A ruby gem to manipulate
+.opt and .log files for Concordance® / Opticon®,
+.lfp files for Ipro eCap,
+and .dii files for Summation®.
+This software is not made or endorsed by Ipro®, Lexis-Nexis® or Dataflight®."
+
+Installation
+---------
+`gem install loadfile`
+
+or, if you want the latest and the greatest, 
+
+    git clone https://github.com/loadfile
+    cd loadfile
+    rake install
+
+(use `sudo` as necessary)
+
+Runtime Requirements
+---------
+ruby >= 1.8.7
+
+Build Requirements
+---------
+rake
+
+Inspiration and History
+---------
+This is the start of converting
+https://github.com/nbirnel/eed-tools
+to ruby.
+
+License
+---------
+© 2014 Noah Birnel
+MIT license
+
+[![Build Status](https://travis-ci.org/nbirnel/loadfile.png?branch=master)](https://travis-ci.org/nbirnel/loadfile)
+[![Code Climate](https://codeclimate.com/github/nbirnel/loadfile.png)](https://codeclimate.com/github/nbirnel/loadfile)

data/lib/loadfile.rb

@@ -0,0 +1,5 @@
+require 'loadfile/version'
+require 'opticon/opticon'
+require 'opticon/opt_parser'
+
+

data/lib/loadfile/version.rb

@@ -0,0 +1,3 @@
+module Loadfile
+  VERSION = '0.1.0'
+end

data/lib/opticon/opt_parser.rb

@@ -0,0 +1,40 @@
+module Loadfile
+
+  ##
+  # This class converts an opticon text file or data stream to an instance 
+  # of Opticon
+  
+  class OptParser
+
+    ##
+    # Create a new parser for Opticon
+
+    def initialize
+      @records   = []
+    end
+
+    ##
+    # Parse text from IO object +input+. It is the caller's responsibility to
+    # open and close the +input+ correctly.
+
+    def parse input
+      c_doc     = []
+      while line = input.gets
+        l = line.chomp.split(',')
+        c_record = {
+          :key    => l[0],
+          :volume => l[1],
+          :path   => l[2],
+          :break  => l[3],
+          :empty1 => l[4],
+          :empty2 => l[5],
+          :pages  => l[6],
+        }
+        @records.push c_record
+      end
+      Loadfile::Opticon.new  @records
+    end
+
+  end
+
+end

data/lib/opticon/opticon.rb

@@ -0,0 +1,80 @@
+##
+# classes for manipulating electronic evidence discovery loadfiles
+
+module Loadfile
+
+  ##
+  # Represent the data in a Concordance® Opticon® image loadfile.
+
+  class Opticon
+    attr_reader :records
+
+    ## 
+    # Create a new opticon composed of +records+.
+    
+    def initialize records
+      @records = records
+    end
+
+    ## 
+    # Return the first and last image keys
+    
+    def beg_end
+      b = @records[0][:key]
+      e = @records[-1][:key]
+      [b, e]
+    end
+
+    ##
+    # Return a list of begining and end image keys for each document. 
+    # FIXME not yet implemented.
+    
+    def beg_end_list
+    end
+
+    ## 
+    # Return a count of documents.
+    
+    def doc_count
+      @records.select{|r| r[:break]}.length
+    end
+
+    ## 
+    # Return a count of images
+    
+    def image_count
+      @records.length
+    end
+
+    ## 
+    # Return a count of tiffs
+    
+    def tiff_count
+      @records.select{|r| r[:path] =~ /\.tif$/}.length
+    end
+
+    ## 
+    # Return a count of jpegs
+    
+    def jpeg_count
+      @records.select{|r| r[:path] =~ /\.jpg$/}.length
+    end
+
+    ## 
+    # Return a list of volumes
+    
+    def volumes
+      @records.map{|r| r[:volume]}.uniq
+    end
+
+    ##
+    # Return a new opticon data stream, suitable for loading.
+    
+    def to_s
+      l = @records.map{|r| r.values.join ','}
+      l.join("\r\n") << "\r\n"
+    end
+
+  end
+
+end

data/loadfile.gemspec

@@ -0,0 +1,29 @@
+require  "#{File.dirname(__FILE__)}/lib/loadfile/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'loadfile'
+  s.version     = Loadfile::VERSION
+  s.date        = '2014-03-28'
+  s.required_ruby_version = '>=1.8.7'
+  s.summary     = "manipulate electronic evidence discovery loadfiles"
+  s.description = "A ruby gem to manipulate
+    .opt and .log files for Concordance® / Opticon®,
+    .lfp files for Ipro eCap,
+    and .dii files for Summation®.
+    This software is not made or endorsed by Ipro®, Lexis-Nexis® or Dataflight®."
+  s.authors     = ['Noah Birnel']
+  s.email       = 'nbirnel@gmail.com'
+  s.homepage    = 'http://github.com/nbirnel/loadfile'
+  s.files       = [
+    'README.md',
+    'loadfile.gemspec',
+    'lib/loadfile.rb',
+    'lib/loadfile/version.rb',
+    'lib/opticon/opticon.rb',
+    'lib/opticon/opt_parser.rb',
+    'spec/loadfile_spec.rb'
+  ]
+  s.has_rdoc    = true
+  s.license     = 'MIT'
+end
+

data/spec/loadfile_spec.rb

@@ -0,0 +1,57 @@
+require  "#{File.dirname(__FILE__)}/../lib/loadfile"
+
+describe Loadfile do
+
+  describe Loadfile::Opticon do
+
+    before do
+      @parser = Loadfile::OptParser.new
+      @sample = "#{File.dirname(__FILE__)}/../sample/sample.opt"
+      @io = File.new(@sample,'r')
+      @opt = @parser.parse @io
+    end
+
+    it 'returns a beg - end' do
+      @opt.beg_end.should eq ["CTRL-000001", "CTRL-000018"]
+    end
+
+    it 'returns a document count' do
+      @opt.doc_count.should eq 3
+    end
+
+    it 'returns an image count' do
+      @opt.image_count.should eq 18
+    end
+
+    it 'returns a tiff count' do
+      @opt.tiff_count.should eq 17
+    end
+
+    it 'returns a jpeg count' do
+      @opt.jpeg_count.should eq 1
+    end
+
+    it 'returns an list of volumes' do
+      @opt.volumes.should eq ["SAMPLE_VOLUME_001", "SAMPLE_VOLUME_002"]
+    end
+
+    it 'prints itself' do
+      @opt.to_s.length.should eq 1122
+    end
+
+    it 'returns a beg-end list' do
+      pending
+      @opt.beg_end_list.should eq 'foo'
+    end
+
+    it 'returns an Ipro lfp' do
+      pending
+    end
+
+    it 'returns a Summation dii' do
+      pending
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: loadfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noah Birnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  A ruby gem to manipulate
+      .opt and .log files for Concordance® / Opticon®,
+      .lfp files for Ipro eCap,
+      and .dii files for Summation®.
+      This software is not made or endorsed by Ipro®, Lexis-Nexis® or Dataflight®.
+email: nbirnel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/loadfile.rb
+- lib/loadfile/version.rb
+- lib/opticon/opt_parser.rb
+- lib/opticon/opticon.rb
+- loadfile.gemspec
+- spec/loadfile_spec.rb
+homepage: http://github.com/nbirnel/loadfile
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: manipulate electronic evidence discovery loadfiles
+test_files: []