edfize 0.3.0 → 0.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcdc7059a01ece5e471657089a3a4c0ac3b4a898
-  data.tar.gz: 2b5bfc7947e2686e349201f0b4ca3ecb9babbd07
+  metadata.gz: 74554485101498071683bd23ef8fa0870363753b
+  data.tar.gz: f8e9707242fb9f083fd4f3cc9fbc170280f1effb
 SHA512:
-  metadata.gz: f95c81d3eb0ff258ecfdc07f9c03be0a85e020d1faa01df59de059faf7793d8750022799486189465eb3355cadf7bc14132a584eace04fda87b558244a8fbc1d
-  data.tar.gz: 134fcbcf9d5cbf60ab39643b72a6eaad59c697c637404e3530d63a177f6f83779c578f4f45032f83670c29726d5a8ff8d44da13d1c9851da355329b35492573e
+  metadata.gz: eedb38dbc3be913932d53439b7ae53e1638d9257330234379ec33ec629994fb328ea02ca05f2c3c469469a16ef2d07fa8057a2deff8b28f820a99612d2c37e5b
+  data.tar.gz: 0e0e20bb7073dededd9bdb8b21f7e98c2e4b761d74125400f88d72f221dd1d0d787c13922ac2cfc9e20ed275c28c2d791e647d69a62187be0d5dcec7300de88c

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.4.0
+
+### Enhancements
+- **Scripting Changes**
+  - Edfize now provides an enumerator to iterate through a folder of EDFs:
+    - `Edfize.edfs` # Current directory and subdirectories
+    - `Edfize.edfs(recursive: false)` # Only current directory
+  - Deprecated `edfs_in_current_directory_and_subdirectories` in favor of
+    `edf_paths`
+    - Note that while `edf_paths` is a direct replacement for
+      `edfs_in_current_directory_and_subdirectories`, it is recommended to use
+      the new `edfs` enumerator instead
+  - Added `Edf::update` method that allows portions of the header to be updated
+    - Change an EDF's start_date_of_recording to the clipping date, 1 Jan 1985
+    - `edf.update(start_date_of_recording: '01.01.85')`
+    - Change an EDF's start_time_of_recording to midnight
+    - `edf.update(start_time_of_recording: '00.00.00')`
+
 ## 0.3.0 (December 7, 2016)
 
 ### Enhancements

data/README.md

@@ -50,6 +50,26 @@ Use `edfize version` to check the version of Edfize.
 
     edfize version
 
+### Example of how to rewrite the start date of recording for a folder of EDFs
+
+This will update all EDFs in the current directory and subdirectories with a
+start date of 1 Jan 1985.
+
+`rewrite_signal_date.rb`
+```ruby
+# gem install edfize --no-document
+# ruby rewrite_signal_date.rb
+
+require 'rubygems'
+require 'edfize'
+
+CLIPPING_DATE = '01.01.85'.freeze
+
+Edfize.edfs do |edf|
+  edf.update(start_date_of_recording: CLIPPING_DATE)
+end
+```
+
 ### Example of how to Load and Analyze EDFs in a Ruby Script
 
 The following Ruby file demonstrates how to make use of the Edfize gem to load EDF signals into arrays for analysis.
@@ -58,7 +78,7 @@ The following Ruby file demonstrates how to make use of the Edfize gem to load E
 ```ruby
 # Tutorial 01 - Load EDF and Signals
 #
-#   gem install edfize
+#   gem install edfize --no-document
 #
 #   ruby tutorial_01_load_edf_and_signals.rb
 #

data/lib/edfize/edf.rb

@@ -156,6 +156,21 @@ module Edfize
       nil
     end
 
+    def update(hash)
+      hash.each do |section, value|
+        update_header_section(section, value)
+      end
+    end
+
+    def update_header_section(section, value)
+      return false unless HEADER_CONFIG.keys.include?(section)
+      send "#{section}=", value
+      size = HEADER_CONFIG[section][:size]
+      string = format("%-#{size}.#{size}s", send(section).to_s)
+      IO.binwrite(filename, string, send(:compute_offset, section))
+      true
+    end
+
     protected
 
     def read_header

data/lib/edfize/version.rb

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

data/lib/edfize.rb

@@ -23,8 +23,7 @@ module Edfize
 
   def self.print_headers
     puts '----------------'
-    edfs_in_current_directory_and_subdirectories.each do |edf_file_name|
-      edf = Edfize::Edf.new(edf_file_name)
+    edfs.each do |edf|
       edf.print_header
       puts '----------------'
     end
@@ -36,16 +35,16 @@ module Edfize
 
   def self.check(argv)
     test_start_time = Time.now
-    edf_count = edfs_in_current_directory_and_subdirectories.count
+    edf_count = 0
     test_count = 0
     failure_count = 0
     puts "Started\n"
-    edfs_in_current_directory_and_subdirectories.each do |edf_file_name|
-      edf = Edfize::Edf.new(edf_file_name)
+    edfs.each do |edf|
       runner = Edfize::Tests::Runner.new(edf, argv)
       runner.run_tests
       test_count += runner.tests_run
       failure_count += runner.tests_failed
+      edf_count += 1
     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)
@@ -70,7 +69,22 @@ EOT
     puts help_message
   end
 
+  # TODO: Remove in 0.5.0
   def self.edfs_in_current_directory_and_subdirectories
-    Dir.glob('**/*.edf', File::FNM_CASEFOLD)
+    warn "[DEPRECATION] `edfs_in_current_directory_and_subdirectories` is deprecated.  Please use `edf_paths` instead."
+    edf_paths(recursive: true)
+  end
+
+  # Returns an enumerator of EDFs.
+  def self.edfs(recursive: true)
+    return enum_for(:edfs, recursive: recursive) unless block_given?
+    edf_paths(recursive: recursive).each do |file_path|
+      yield Edf.new(file_path)
+    end
+  end
+
+  def self.edf_paths(recursive: true)
+    path = "#{'**/' if recursive}*.edf"
+    Dir.glob(path, File::FNM_CASEFOLD)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edfize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.beta1
 platform: ruby
 authors:
 - Remo Mueller
@@ -94,9 +94,9 @@ 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.6.8