edfize 0.2.0 → 0.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b82a603335cdafd99e0c4661b2224c33f9430fe
-  data.tar.gz: 0c61be32124471148d108fd367e2535a2ab6391f
+  metadata.gz: d66122964586be58ce465e8b40c8a9bd5b9cbacc
+  data.tar.gz: 690f94d0574fbc563fa8f0dd154dcdaaa9210bfb
 SHA512:
-  metadata.gz: 5754f8f4f4d71c0f2b6d10fd3e00e138ec05948bbabd2524f97e5f97304baf35c8ee1854182b0a713e83082d296fc37d6202c5836cb2300364fab75a7e26a24d
-  data.tar.gz: 135eb30a80bdf44511520090054695b8766a0f23c8277b049d84e0c3c19f856cecf91c2a65b4f0df6d54ae3076e3b14888912784d9cb29ed787e5e5777a9e0ea
+  metadata.gz: 14babae1e4a88344a373071784076b3eb12010504a1f1acbbe3aa4c2232b2d2b60efc91a6e3b1ae6f5cff5443a92f603ca4c1c6aa4baf413e9b0eec504dbc429
+  data.tar.gz: 650ec8d719d3e34e59fdd6721a95728d4084ade204679a4782021bc1004afe146f937ee3d3e0be96475dea91bd13a88e73512ade0112e9e8957a72cc25f8befc

data/CHANGELOG.md

@@ -1,7 +1,25 @@
+## 0.3.0
+
+### Enhancements
+- **Test Changes**
+  - Added a test to make sure date in EDF and EDF+ formats are valid
+    - The EDF header date is checked in the following manner: (a) Is the EDF+
+      header (29-FEB-2100) a valid date, if (yes) check that the EDF header date
+      (29.02.00) matches the EDF+ date, if (no) check that the EDF header date
+      (29.02.00) is a valid date. The EDF+ header date is checked first since
+      (29-FEB-2100) is NOT a valid date as leap years only occur in a century
+      years divisible by 400, while the truncated EDF date would be (02.29.00)
+      which would be incorrectly seen as valid since 2000 is a leap year.
+- **Gem Changes**
+  - Updated to Ruby 2.3.0
+  - Updated to colorize 0.7.7
+  - Updated simplecov to 0.11.2
+
 ## 0.2.0 (March 12, 2015)
 
 ### Enhancements
-- EDFs can now be partially loaded by specifying the epoch number and epoch size in seconds
+- EDFs can now be partially loaded by specifying the epoch number and epoch size
+  in seconds
 - Use of Ruby 2.2.1 is now recommended
 
 ### Testing
@@ -10,21 +28,24 @@
 ## 0.1.0 (May 28, 2014)
 - Initial EDF class to load headers and signals into Ruby objects
 - `edfize` command has the following actions:
-  - `test`: Validates EDFs in the current directory and subdirectories for errors
+  - `test`: Validates EDFs in the current directory and subdirectories for
+    errors
     - To only show failing tests, add the flag `--failing`
       - `edfize test --failing`
     - To suppress descriptive test failures, add the flag `--quiet`
       - `edfize test --quiet`
     - Both flags can be used together
       - `edfize test --failing --quiet`
-  - `run`: Prints out the headers of all edfs in the current directory and subdirectories
-  - `help`: Displays information about `edfize` along with all available commands
+  - `run`: Prints out the headers of all EDFs in the current directory and
+    subdirectories
+  - `help`: Displays information about `edfize` along with all available
+    commands
   - `version`: Displays the current `edfize` version
 - `edfize test` checks for the following:
   - Expected Length Check: The expected total size is computed from the (`number
-    of data records` * `total samples across all signals`) + `size of header` and
-    this is compared to the actual file size.
-  - Reserved Area Checks: The header and the individual header reserved areas are
-    checked to validate that they are blank. Non-blank areas are a sign that the
-    edf header is corrupt and that data from the signal data block have leaked into
-    the header itself.
+    of data records` * `total samples across all signals`) + `size of header`
+    and this is compared to the actual file size.
+  - Reserved Area Checks: The header and the individual header reserved areas
+    are checked to validate that they are blank. Non-blank areas are a sign that
+    the EDF header is corrupt and that data from the signal data block have
+    leaked into the header itself.

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Division of Medicine Program of Sleep Medicine Epidemiology
+Copyright (c) 2016 Division of Sleep and Circadian Disorders
 https://github.com/sleepepi
 
 

data/README.md

@@ -2,9 +2,9 @@
 
 [![Build Status](https://travis-ci.org/sleepepi/edfize.svg?branch=master)](https://travis-ci.org/sleepepi/edfize)
 [![Dependency Status](https://gemnasium.com/sleepepi/edfize.svg)](https://gemnasium.com/sleepepi/edfize)
-[![Code Climate](https://codeclimate.com/github/sleepepi/edfize.png)](https://codeclimate.com/github/sleepepi/edfize)
+[![Code Climate](https://codeclimate.com/github/sleepepi/edfize/badges/gpa.svg)](https://codeclimate.com/github/sleepepi/edfize)
 
-Ruby gem used to load, validate, and parse European Data Format files. Used for batch testing EDFs for errors. Ruby 2.0+ compatible.
+Ruby gem used to load, validate, and parse European Data Format files. Used for batch testing EDFs for errors. Ruby 2.2+ compatible.
 
 ## Installation
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
@@ -6,6 +8,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
+  t.warning = false
   t.verbose = false
 end
 

data/bin/edfize

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require File.expand_path('../../lib/edfize', __FILE__)
 

data/edfize.gemspec

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 # Compiling the Gem
 # gem build edfize.gemspec
 # gem install ./edfize-x.x.x.gem --no-ri --no-rdoc --local
@@ -6,28 +9,28 @@
 # gem list -r edfize
 # gem install edfize
 
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'edfize/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "edfize"
+  spec.name          = 'edfize'
   spec.version       = Edfize::VERSION::STRING
-  spec.authors       = ["Remo Mueller"]
-  spec.email         = ["remosm@gmail.com"]
-  spec.summary       = %q{Load, validate, and parse European Data Format files. Used for batch testing EDFs for errors.}
-  spec.description   = %q{Load, validate, and parse European Data Format files. Used for batch testing EDFs for errors. Run `edfize` on command line to view full list of options.}
-  spec.homepage      = "https://github.com/sleepepi/edfize"
-  spec.license       = "CC BY-NC-SA 3.0"
+  spec.authors       = ['Remo Mueller']
+  spec.email         = ['remosm@gmail.com']
+  spec.summary       = 'Load, validate, and parse European Data Format files. Used for batch testing EDFs for errors.'
+  spec.description   = 'Load, validate, and parse European Data Format files. Used for batch testing EDFs for errors. \
+Run `edfize` on command line to view full list of options.'
+  spec.homepage      = 'https://github.com/sleepepi/edfize'
+  spec.license       = 'CC BY-NC-SA 3.0'
 
-  spec.files         = Dir['{bin,lib}/**/*'] + ['CHANGELOG.md', 'LICENSE.txt', 'Rakefile', 'README.md', 'edfize.gemspec']
+  spec.files         = Dir['{bin,lib}/**/*'] + %w(CHANGELOG.md LICENSE Rakefile README.md edfize.gemspec)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "colorize", "~> 0.7.5"
+  spec.add_dependency 'colorize', '~> 0.7.7'
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake'
 end

data/lib/edfize/edf.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'edfize/signal'
 
 module Edfize
+  # Class used to load and manipulate EDFs
   class Edf
     # EDF File Path
     attr_reader   :filename
@@ -40,7 +43,7 @@ module Edfize
     RESERVED_SIZE = HEADER_CONFIG[:reserved][:size]
 
     def self.create(filename, &block)
-      edf = self.new(filename)
+      edf = new(filename)
       yield edf if block_given?
       edf
     end
@@ -66,7 +69,7 @@ module Edfize
     end
 
     def size_of_header
-      HEADER_OFFSET + ns * Signal::SIGNAL_CONFIG.collect{|k,h| h[:size]}.inject(:+)
+      HEADER_OFFSET + ns * Signal::SIGNAL_CONFIG.collect { |_k, h| h[:size] }.inject(:+)
     end
 
     def expected_size_of_header
@@ -88,27 +91,25 @@ module Edfize
     end
 
     def section_value_to_string(section)
-      self.instance_variable_get("@#{section}").to_s
+      instance_variable_get("@#{section}").to_s
     end
 
     def section_units(section)
       units = HEADER_CONFIG[section][:units].to_s
-      result = if units == ''
+      if units == ''
         ''
       else
-        " #{units}" + (self.instance_variable_get("@#{section}") == 1 ? '' : 's')
+        " #{units}" + (instance_variable_get("@#{section}") == 1 ? '' : 's')
       end
-      result
     end
 
     def section_description(section)
       description = HEADER_CONFIG[section][:description].to_s
-      result = if description == ''
+      if description == ''
         ''
       else
         " #{description}"
       end
-      result
     end
 
     def print_header
@@ -133,6 +134,27 @@ module Edfize
       puts "Expected Total Size     (bytes): #{expected_edf_size}"
     end
 
+    def start_date
+      (dd, mm, yy) = start_date_of_recording.split('.')
+      dd = parse_integer(dd)
+      mm = parse_integer(mm)
+      yy = parse_integer(yy)
+      yyyy = if yy && yy >= 85
+               yy + 1900
+             else
+               yy + 2000
+             end
+      Date.strptime("#{mm}/#{dd}/#{yyyy}", '%m/%d/%Y')
+    rescue
+      nil
+    end
+
+    def parse_integer(string)
+      Integer(format('%g', string))
+    rescue
+      nil
+    end
+
     protected
 
     def read_header

data/lib/edfize/signal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Edfize
   class Signal
     attr_accessor :label, :transducer_type, :physical_dimension,
@@ -26,7 +28,7 @@ module Edfize
     end
 
     def self.create(&block)
-      signal = self.new
+      signal = new
       yield signal if block_given?
       signal
     end
@@ -45,6 +47,5 @@ module Edfize
     def samples
       @physical_values
     end
-
   end
 end

data/lib/edfize/tests/check_length.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Edfize
   module Tests
     module CheckLength
@@ -6,7 +8,7 @@ module Edfize
       def test_expected_length(runner)
         result = Result.new
         result.passes = (runner.edf.expected_edf_size == runner.edf.edf_size)
-        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize( result.passes ? :green : :red ) + " Expected File Size"
+        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize(result.passes ? :green : :red) + ' Expected File Size'
         result.expected  = "    Expected : #{runner.edf.expected_edf_size} bytes"
         result.actual    = "    Actual   : #{runner.edf.edf_size} bytes"
         result

data/lib/edfize/tests/check_reserved_area.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Edfize
   module Tests
+    # This test checks that the reserved area in the header is blank
     module CheckReservedArea
-      # This test checks that the reserved area in the header is blank
       def test_reserved_area_blank(runner)
         result           = Result.new
         result.passes    = (runner.edf.reserved == ' ' * Edf::RESERVED_SIZE)
-        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize( result.passes ? :green : :red ) + " Reserved Area Blank"
+        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize(result.passes ? :green : :red) + ' Reserved Area Blank'
         result.expected  = "    Expected : #{(' ' * Edf::RESERVED_SIZE).inspect}"
         result.actual    = "    Actual   : #{runner.edf.reserved.to_s.inspect}"
         result

data/lib/edfize/tests/check_reserved_signal_areas.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Edfize
   module Tests
+    # This test checks that the reserved areas in the signal headers are blank
     module CheckReservedSignalAreas
-      # This test checks that the reserved areas in the signal headers are blank
       def test_reserved_signal_areas_blank(runner)
         reserved_areas = runner.edf.signals.collect(&:reserved_area)
 
         result = Result.new
         result.passes = (reserved_areas.reject{|r| r.to_s.strip == ''}.count == 0)
-        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize( result.passes ? :green : :red ) + " Signal Reserved Area Blank"
+        result.pass_fail = "  #{result.passes ? 'PASS' : 'FAIL'}".colorize(result.passes ? :green : :red) + ' Signal Reserved Area Blank'
         result.expected  = "    Expected : #{[''] * runner.edf.signals.count}"
         result.actual    = "    Actual   : #{reserved_areas}"
         result

data/lib/edfize/tests/check_valid_date.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Edfize
+  module Tests
+    # This test checks that the date is valid
+    module CheckValidDate
+      def test_valid_date(runner)
+        result = Result.new
+        result.passes = !runner.edf.start_date.nil?
+        result.pass_fail = pass_fail(result.passes, 'Valid Date')
+        result.expected  = '    Expected : Valid Date'
+        result.actual    = "    Actual   : #{runner.edf.start_date_of_recording}"
+        result
+      end
+
+      def pass_fail(passes, message)
+        if passes
+          '  PASS'.colorize(:green) + " #{message}"
+        else
+          '  FAIL'.colorize(:red) + " #{message}"
+        end
+      end
+    end
+  end
+end

data/lib/edfize/tests/result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Edfize
   module Tests
     class Result

data/lib/edfize/tests/runner.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Edfize
   module Tests
+    # Runs a series of tests on an EDF
     class Runner
       attr_reader :tests_run, :tests_failed, :edf, :verbose, :show_passing
 
-      TESTS = %w( expected_length reserved_area_blank reserved_signal_areas_blank )
+      TESTS = %w(expected_length reserved_area_blank reserved_signal_areas_blank valid_date)
 
       def initialize(edf, argv)
         @tests_run = 0
@@ -23,16 +26,16 @@ module Edfize
           results << result
         end
 
-        puts "\n#{@edf.filename}" if results.reject{|r| r.passes}.count > 0 or @show_passing
+        puts "\n#{@edf.filename}" if results.reject(&:passes).count > 0 || @show_passing
         results.each do |result|
           print_result(result)
         end
       end
 
       def print_result(result)
-        if self.show_passing or !result.passes
+        if show_passing || !result.passes
           puts result.pass_fail
-          unless result.passes or not self.verbose
+          unless result.passes || !verbose
             puts result.expected
             puts result.actual
           end

data/lib/edfize/tests.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 require 'edfize/tests/result'
 require 'edfize/tests/runner'
 require 'edfize/tests/check_length'
 require 'edfize/tests/check_reserved_area'
 require 'edfize/tests/check_reserved_signal_areas'
+require 'edfize/tests/check_valid_date'
 
 module Edfize
   module Tests
     extend CheckLength
     extend CheckReservedArea
     extend CheckReservedSignalAreas
+    extend CheckValidDate
   end
 end

data/lib/edfize/version.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Edfize
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
+    MINOR = 3
     TINY = 0
-    BUILD = nil
+    BUILD = 'beta1'
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

data/lib/edfize.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'edfize/edf'
 require 'edfize/tests'
 require 'edfize/version'
 
 require 'colorize'
 
+# Loads EDFs, prints information, runs tests
 module Edfize
   def self.launch(argv)
     case argv.first.to_s.scan(/\w/).first
@@ -19,11 +22,11 @@ module Edfize
   end
 
   def self.print_headers
-    puts "----------------"
+    puts '----------------'
     edfs_in_current_directory_and_subdirectories.each do |edf_file_name|
       edf = Edfize::Edf.new(edf_file_name)
       edf.print_header
-      puts "----------------"
+      puts '----------------'
     end
   end
 
@@ -45,7 +48,7 @@ module Edfize
       failure_count += runner.tests_failed
     end
     puts "\nFinished in #{Time.now - test_start_time}s"
-    puts "#{edf_count} EDF#{'s' unless edf_count == 1}, #{test_count} test#{'s' unless test_count == 1}, " + "#{failure_count} failure#{'s' unless failure_count == 1}".colorize( failure_count == 0 ? :green : :red )
+    puts "#{edf_count} EDF#{'s' unless edf_count == 1}, #{test_count} test#{'s' unless test_count == 1}, " + "#{failure_count} failure#{'s' unless failure_count == 1}".colorize(failure_count == 0 ? :green : :red)
   end
 
   def self.help

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edfize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.beta1
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,8 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Load, validate, and parse European Data Format files. Used for batch
-  testing EDFs for errors. Run `edfize` on command line to view full list of options.
+description: |-
+  Load, validate, and parse European Data Format files. Used for batch testing EDFs for errors. \
+  Run `edfize` on command line to view full list of options.
 email:
 - remosm@gmail.com
 executables:
@@ -62,7 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/edfize
@@ -74,6 +75,7 @@ files:
 - lib/edfize/tests/check_length.rb
 - lib/edfize/tests/check_reserved_area.rb
 - lib/edfize/tests/check_reserved_signal_areas.rb
+- lib/edfize/tests/check_valid_date.rb
 - lib/edfize/tests/result.rb
 - lib/edfize/tests/runner.rb
 - lib/edfize/version.rb
@@ -92,12 +94,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: Load, validate, and parse European Data Format files. Used for batch testing