ascii-data-tools 0.9

data/spec/ascii-data-tools/record_type/normaliser_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module AsciiDataTools
+  module RecordType
+    module Normaliser
+      describe Normaliser do
+        include RecordTypeHelpers
+        before do
+          @fields = fields do
+             field "field1", :length => 3
+             field "field2", :length => 5, :normalised => true
+             field "field3", :length => 3, :normalised => true
+             field "field4", :length => 1
+           end
+           @type = Struct.new(:fields).new(@fields)
+           @type.extend(Normaliser)
+        end
+
+        it "should X out the characters in fields configured for normalisation" do
+          @type.normalise("123ABCDEXYZ\n").should == "123XXXXXXXX\n"
+        end
+      end
+    end
+  end
+end

data/spec/ascii-data-tools/record_type_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+module AsciiDataTools
+  module RecordType
+    describe Type do
+      include RecordTypeHelpers
+      
+      before do
+        @type = type("ABC") do
+          field "field100"
+          field "field1"
+          field "field10"
+        end
+      end
+      
+      it "should have a name" do
+        @type.name.should == "ABC"
+      end
+      
+      it "should provide the field names" do
+        @type.field_names.should == ["field100", "field1", "field10"]
+      end
+      
+      it "should provide the number of content fields" do
+        @type.number_of_content_fields.should == 3
+      end
+      
+      it "should provide the length of the field with the longest name" do
+        @type.length_of_longest_field_name.should == 8
+      end
+      
+      it "should provide an empty constraints description when there are no constraints" do
+        @type.constraints_description.should be_empty
+      end
+      
+      it "should provide a list of comma-delimited field constraints as the constraints description" do
+        @type.field_with_name("field100").should_be_constrained_to("ABC")
+        @type.constraints_description.should == "field100 = ABC"
+        
+        @type.field_with_name("field10").should_be_constrained_to("DEF")
+        @type.constraints_description.should == "field100 = ABC, field10 = DEF"          
+      end
+      
+      it "should have an inbuilt filename meta field" do
+        @type.field_with_name(:filename).should_not be_nil
+      end
+      
+      it "should provide a shortcut for constraining the filename" do
+        @type.filename_should_match /abc/
+        @type.field_with_name(:filename).constraint_description.should == "filename =~ /abc/"
+      end
+    end
+    
+    describe FixedLengthType do
+      include RecordTypeHelpers
+      
+      before do
+        @type = type("ABC") do
+          field "field100", :length => 3
+          field "field1",   :length => 5
+          field "field10",  :length => 1
+        end
+      end
+      
+      it "should provide the total length of the fields" do
+        @type.total_length_of_fields.should == 9
+      end
+    end
+    
+    describe UnknownType do
+      it "should provide the name" do
+        UnknownType.new.name.should == UnknownType::UNKNOWN_RECORD_TYPE_NAME
+      end
+      
+      it "should have one field (UNKNOWN)" do
+        UnknownType.new.field_names.should == ["UNKNOWN"]
+      end
+      
+      it "should decode the entire ascii string into the UNKNOWN field" do
+        record = UnknownType.new.decode(:ascii_string => "any string\n")
+        record["UNKNOWN"].should == "any string\n"
+      end
+    end
+    
+    describe TypeDeterminer do
+      it "should determine the type that matches" do
+        all_types = mock(RecordTypeRepository, :identify_type_for => mock(Type, :name => "ABC"))
+        TypeDeterminer.new(all_types).determine_type_for(:ascii_string => "any encoded record").name.should == "ABC"
+      end
+      
+      it "should accept the context filename as an optional parameter" do        
+        all_types = mock(RecordTypeRepository, :identify_type_for => mock(Type, :name => "ABC"))
+        TypeDeterminer.new(all_types).determine_type_for(:ascii_string => "any encoded record", :filename => "context filename").name.should == "ABC"
+      end
+      
+      it "should determine the type to be unknown when no matching real type can be found" do
+        TypeDeterminer.new(mock(RecordTypeRepository, :identify_type_for => nil)).determine_type_for(:ascii_string => "any encoded record").should be_an(UnknownType)
+      end
+      
+      it "should cache previously matched types and try to match them first" do
+        first_type = mock("type 1")
+        second_type = mock("type 2")
+        
+        all_types = mock(RecordTypeRepository)
+        all_types.should_receive(:identify_type_for).with(:ascii_string => "record 1").ordered.and_return(first_type)
+
+        determiner = TypeDeterminer.new(all_types)
+        determiner.determine_type_for(:ascii_string => "record 1").should == first_type
+
+        first_type.should_receive(:able_to_decode?).with(:ascii_string => "record 2").once.ordered.and_return(false)
+
+        all_types.should_receive(:identify_type_for).with(:ascii_string => "record 2").ordered.and_return(second_type)
+
+        determiner.determine_type_for(:ascii_string => "record 2").should == second_type
+      end
+    end
+    
+    describe RecordTypeRepository do
+      it "should be enumerable" do
+        should be_a_kind_of(Enumerable)
+      end
+      
+      it "should have a reset switch" do
+        repo = RecordTypeRepository.new
+        repo << mock(Type, :name => "ABC") << mock(Type, :name => "DEF")
+        repo.clear
+        repo.type("ABC").should be_nil
+        repo.type("DEF").should be_nil        
+      end
+      
+      it "should find record types by name" do
+        repo = RecordTypeRepository.new
+        repo << mock(Type, :name => "ABC") << mock(Type, :name => "DEF")
+        repo.find_by_name("ABC").name.should == "ABC"
+        repo.type("ABC").name.should == "ABC"
+        repo.find_by_name("XYZ").should be_nil
+      end
+      
+      it "should find record types which match a certain record" do
+        repo = RecordTypeRepository.new
+        repo << mock(Type, :name => "ABC", :able_to_decode? => false) << mock(Type, :name => "DEF", :able_to_decode? => :true)
+        repo.identify_type_for(:ascii_string => "some record", :filename => "context").name.should == "DEF"
+      end
+      
+      it "should store each type only once" do
+        type = mock(Type)
+        repo = RecordTypeRepository.new([type, type])
+        repo.map {|type| type}.should have(1).item
+      end
+      
+      it "should find types by name" do
+        repo = RecordTypeRepository.new
+        repo << mock(Type, :name => "ABC") << mock(Type, :name => "DEF") << mock(Type, :name => "XYZ")
+        found_type_names = []
+        repo.for_names_matching(/ABC|DEF/) {|type| found_type_names << type.name}
+        found_type_names.sort.should == ["ABC", "DEF"]
+      end
+      
+      it "should find types by name using a block" do
+        repo = RecordTypeRepository.new
+        repo << mock(Type, :name => "ABC") << mock(Type, :name => "DEF") << mock(Type, :name => "XYZ")
+        found_type_names = []
+        matcher = lambda {|name| ["ABC", "DEF"].include?(name) }
+        repo.for_names_matching(matcher) {|type| found_type_names << type.name}
+        found_type_names.sort.should == ["ABC", "DEF"]        
+      end
+      
+      it "should include the builder for new types for convenience" do
+        repo = RecordTypeRepository.new
+        repo.record_type("ABC") { field "xyz", :length => 3 }
+        repo.type("ABC").number_of_content_fields.should == 1
+      end
+    end    
+  end
+end

data/spec/filter_helper.rb

@@ -0,0 +1,24 @@
+Spec::Matchers.define :output do |expected_output|
+  chain :from_upstream do |*filters|
+    @filters = filters.map {|filter| filter.is_a?(String) ? input_source_containing(filter) : filter }
+  end
+
+  match do |filter|
+    # connect upstream and downstream
+    ([filter] + @filters).each_cons(2) {|downstream, upstream| downstream << upstream }
+    output = StringIO.new
+    
+    filter.write(output)
+    
+    @actual_string = output.string
+    output.string == expected_output
+  end
+  
+  failure_message_for_should do |filter|
+    "filter should output #{expected_output.inspect} but instead outputs #{@actual_string.inspect}"
+  end
+end
+
+def input_source_containing(content)
+  AsciiDataTools::InputSource.new("some file", StringIO.new(content))
+end

data/spec/record_type_helpers.rb

@@ -0,0 +1,8 @@
+module RecordTypeHelpers
+  include AsciiDataTools::RecordType::Builder::TypeBuilder
+  
+  alias :type :build_type
+  alias :fields :build_fields
+  alias :make_field :build_field
+end
+  

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--diff
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+lib_path = File.expand_path("#{File.dirname(__FILE__)}/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'ascii-data-tools'
+require File.join(File.dirname(__FILE__), 'record_type_helpers')

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: ascii-data-tools
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Jake Benilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-31 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: &2160999340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160999340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160998940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160998940
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &2160998480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160998480
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: &2160998060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160998060
+description: A tool for decoding and modifying ASCII CDRs.
+email:
+- benilov@gmail.com
+executables:
+- ascii-data-cat
+- ascii-data-edit
+- ascii-data-norm
+- ascii-data-qdiff
+- ascii-data-tools-config
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.GPL2
+- README.rdoc
+- Rakefile
+- TODO
+- ascii-data-tools.gemspec
+- bin/ascii-data-cat
+- bin/ascii-data-edit
+- bin/ascii-data-norm
+- bin/ascii-data-qdiff
+- bin/ascii-data-tools-config
+- examples/big
+- examples/built_in_records.gz
+- examples/slightly_modified_built_in_records.gz
+- features/ascii-data-cat.feature
+- features/ascii-data-edit.feature
+- features/ascii-data-qdiff.feature
+- features/encoding_decoding.feature
+- features/normaliser.feature
+- features/plugins.feature
+- features/record_recognition.feature
+- features/step_definitions/ascii-data-cat_steps.rb
+- features/step_definitions/ascii-data-edit_steps.rb
+- features/step_definitions/ascii-data-norm_steps.rb
+- features/step_definitions/ascii-data-qdiff_steps.rb
+- features/step_definitions/encoding_decoding_steps.rb
+- features/step_definitions/plugins_steps.rb
+- features/step_definitions/record_recognition_steps.rb
+- features/support/env.rb
+- lib/ascii-data-tools.rb
+- lib/ascii-data-tools/configuration.rb
+- lib/ascii-data-tools/configuration_printer.rb
+- lib/ascii-data-tools/controller.rb
+- lib/ascii-data-tools/discover.rb
+- lib/ascii-data-tools/external_programs.rb
+- lib/ascii-data-tools/filter.rb
+- lib/ascii-data-tools/filter/diffing.rb
+- lib/ascii-data-tools/formatting.rb
+- lib/ascii-data-tools/global_autodiscovery.rb
+- lib/ascii-data-tools/record.rb
+- lib/ascii-data-tools/record_type.rb
+- lib/ascii-data-tools/record_type/builder.rb
+- lib/ascii-data-tools/record_type/decoder.rb
+- lib/ascii-data-tools/record_type/encoder.rb
+- lib/ascii-data-tools/record_type/field.rb
+- lib/ascii-data-tools/record_type/normaliser.rb
+- lib/ascii-data-tools/ruby_extensions.rb
+- lib/ascii-data-tools/version.rb
+- spec/ascii-data-tools/configuration_printer_spec.rb
+- spec/ascii-data-tools/configuration_spec.rb
+- spec/ascii-data-tools/discover_spec.rb
+- spec/ascii-data-tools/filter/diffing_spec.rb
+- spec/ascii-data-tools/filter_spec.rb
+- spec/ascii-data-tools/formatting_spec.rb
+- spec/ascii-data-tools/record_spec.rb
+- spec/ascii-data-tools/record_type/builder_spec.rb
+- spec/ascii-data-tools/record_type/decoder_spec.rb
+- spec/ascii-data-tools/record_type/encoder_spec.rb
+- spec/ascii-data-tools/record_type/field_spec.rb
+- spec/ascii-data-tools/record_type/normaliser_spec.rb
+- spec/ascii-data-tools/record_type_spec.rb
+- spec/filter_helper.rb
+- spec/record_type_helpers.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/benilovj/ascii-data-tools
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A tool for decoding and modifying ASCII CDRs.
+test_files:
+- features/ascii-data-cat.feature
+- features/ascii-data-edit.feature
+- features/ascii-data-qdiff.feature
+- features/encoding_decoding.feature
+- features/normaliser.feature
+- features/plugins.feature
+- features/record_recognition.feature
+- features/step_definitions/ascii-data-cat_steps.rb
+- features/step_definitions/ascii-data-edit_steps.rb
+- features/step_definitions/ascii-data-norm_steps.rb
+- features/step_definitions/ascii-data-qdiff_steps.rb
+- features/step_definitions/encoding_decoding_steps.rb
+- features/step_definitions/plugins_steps.rb
+- features/step_definitions/record_recognition_steps.rb
+- features/support/env.rb
+- spec/ascii-data-tools/configuration_printer_spec.rb
+- spec/ascii-data-tools/configuration_spec.rb
+- spec/ascii-data-tools/discover_spec.rb
+- spec/ascii-data-tools/filter/diffing_spec.rb
+- spec/ascii-data-tools/filter_spec.rb
+- spec/ascii-data-tools/formatting_spec.rb
+- spec/ascii-data-tools/record_spec.rb
+- spec/ascii-data-tools/record_type/builder_spec.rb
+- spec/ascii-data-tools/record_type/decoder_spec.rb
+- spec/ascii-data-tools/record_type/encoder_spec.rb
+- spec/ascii-data-tools/record_type/field_spec.rb
+- spec/ascii-data-tools/record_type/normaliser_spec.rb
+- spec/ascii-data-tools/record_type_spec.rb
+- spec/filter_helper.rb
+- spec/record_type_helpers.rb
+- spec/spec.opts
+- spec/spec_helper.rb