castle-log 0.0.1

data/lib/castle/log/file.rb

@@ -0,0 +1,87 @@
+require 'open-uri'
+
+module Castle
+  module Log
+
+    # Represents a single Castle data logger file.
+    class File
+
+      attr_reader :date_saved
+
+      # @return [String] Notes at the beginning of the file
+      attr_reader :notes
+
+      # @return [Array<Session>] Sessions contained in this file
+      attr_reader :sessions
+
+      def initialize uri
+        @sessions = []
+
+        open(uri, 'rb') do |file|
+
+          i = 0
+          in_comment = false
+          lines = file.readlines.map(&:strip).group_by do |line|
+            if line.start_with?('#') && !in_comment
+              in_comment = true
+              i += 1
+            elsif !line.start_with?('#') && in_comment
+              in_comment = false
+            end
+            i
+          end
+
+          # session 1 has some extra metadata, scrape that out first
+          notes = lines[1].select { |line| line.start_with?('# Note') }
+          meta = lines[1].select { |line| line.start_with?('# Graph Data') }
+
+          @sessions = extract_sessions(lines)
+
+          @notes = (notes.map { |line| /Note -(?<note>.*)$/.match(line)[:note].strip }).join("\n")
+
+          # TODO validate expected number of sessions from meta
+          # TODO extract date_saved
+
+        end
+
+      rescue
+        raise ArgumentError, 'File does not appear to be an Castle data log'
+      end
+
+      private
+
+      def extract_sessions line_hash
+
+        keys = line_hash.keys.sort!
+        keys.map do |session_index|
+          lines = line_hash[session_index]
+          start = lines.select { |line| line.start_with?('# Start Of Session') }
+          reset = lines.select { |line| line.start_with?('# Reset Source') }
+          tick = /Sample Time: (?<tick>\d+.\d+)/.match(start[0])[:tick].strip.to_f
+          source = /\(Cause of reset\): (?<source>.*)/.match(reset[0])[:source].strip
+
+          # XXX can we use CSV for this instead?
+
+          # strip out comment rows
+          raw_rows = lines.reject { |line| line.start_with?('#') }
+
+          # pop off header rows
+          headers = raw_rows.shift.split(',').map(&:strip)
+          booleans = raw_rows.shift.split(',').map(&:strip) # XXX unused, what is this?
+
+          # split the rows up and flip them into columns of data
+          columns = (raw_rows.map { |row| row.split(',').map(&:strip) }).transpose
+
+          # build the data hash as expected by the session
+          data = (columns.each_with_index.map { |column, idx| { headers[idx] => column } }).reduce({}, :merge)
+
+          Session.new(tick, source, data)
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/castle/log/session.rb

@@ -0,0 +1,24 @@
+module Castle
+  module Log
+
+    # Represents a single session from a Castle data logger file.
+    class Session
+
+      attr_reader :tick
+
+      attr_reader :source
+
+      def initialize tick, source, data
+        @tick = tick
+        @source = source
+        @data = data
+      end
+
+      def duration
+        tick * @data.values[0].length
+      end
+
+    end
+
+  end
+end

data/lib/castle/log/version.rb

@@ -0,0 +1,5 @@
+module Castle
+  module Log
+    VERSION = "0.0.1"
+  end
+end

data/lib/castle/log.rb

@@ -0,0 +1,3 @@
+require 'castle/log/file'
+require 'castle/log/session'
+require 'castle/log/version'

data/spec/file_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Castle::Log::File do
+
+  context 'data file long-flight.csv' do
+
+    subject { Castle::Log::File.new(data_file('long-flight.csv')) }
+
+    it { should have(1).sessions }
+
+  end
+
+  context 'data file multi-line-notes.csv' do
+
+    subject { Castle::Log::File.new(data_file('multi-line-notes.csv')) }
+
+    it { should have(1).sessions }
+
+    it 'should have a multi-line note field' do
+      subject.notes.split("\n").should have(3).lines
+    end
+
+  end
+
+  context 'data file multi-session-1.csv' do
+
+    subject { Castle::Log::File.new(data_file('multi-session-1.csv')) }
+
+    it { should have(5).sessions }
+
+    its(:notes) { should eql('Agri-duck 14 sep 12') }
+
+  end
+
+  context 'data file multi-session-2.csv' do
+
+    subject { Castle::Log::File.new(data_file('multi-session-2.csv')) }
+
+    it { should have(7).sessions }
+
+  end
+
+  context 'data file sample-1.csv' do
+
+    subject { Castle::Log::File.new(data_file('sample-1.csv')) }
+
+    it { should have(1).sessions }
+
+  end
+
+  it 'should raise on bad input' do
+    expect { Castle::Log::File.new(__FILE__) }.to raise_error
+  end
+
+end

data/spec/session_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Castle::Log::Session do
+
+  context 'data file long-flight.csv' do
+
+    let(:file) { Castle::Log::File.new(data_file('long-flight.csv')) }
+
+    subject { file }
+
+    it { should have(1).sessions }
+
+    context 'session 1' do
+
+      subject { file.sessions[0] }
+
+      its(:duration) { should be_within(0.1).of(569.2) }
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+require 'castle/log'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+def data_file(name)
+  path = Pathname.new("#{File.dirname(__FILE__)}/../data/#{name}")
+  path.realpath
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: castle-log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Veys
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: Read and interpret Castle Creations data log files.
+email:
+- nick@codelever.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- castle-log.gemspec
+- data/long-flight.csv
+- data/multi-line-notes.csv
+- data/multi-session-1.csv
+- data/multi-session-2.csv
+- data/sample-1.csv
+- lib/castle/log.rb
+- lib/castle/log/file.rb
+- lib/castle/log/session.rb
+- lib/castle/log/version.rb
+- spec/file_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Castle Creations data log file reader
+test_files:
+- spec/file_spec.rb
+- spec/session_spec.rb
+- spec/spec_helper.rb
+has_rdoc: