nametrainer 0.0.1 → 0.1.0

data/README.md

@@ -15,7 +15,7 @@ use `nametrainer --demo` or `nametrainer -d`.
 
 With a collection loaded, the application window will look similar to this:
 
-<img src="https://github.com/stomar/nametrainer/raw/master/screenshot.png" alt="Screenshot" width="431" height="405" />
+<img src="https://github.com/stomar/nametrainer/raw/master/screenshot.png" alt="Screenshot" width="455" height="403" />
 
 `nametrainer` shows a randomly chosen image.
 You can then display the corresponding name and tell the application
@@ -24,7 +24,17 @@ Persons that you do not know will be shown more often.
 
 Note that for reasons of speed and convenience it is not necessary
 to type in the name (so be honest to yourself).
-There are also keyboard shortcuts for "power users".
+There are also keyboard shortcuts for "power users" (see the application's `Help`).
+
+Additional settings:
+
+-   Check `Non-random order` to show the images in ordered sequence.
+
+-   Check `Display name at once` to display the names immediately when
+    a person is shown.
+
+These settings facilitate quick recapitulation of already learned names
+or learning of new names.
 
 Collections
 -----------

data/lib/nametrainer/collection.rb

@@ -38,16 +38,14 @@ module Nametrainer
       super()
       @directory = directory
       @extensions = extensions.to_set
-      @extensions.merge extensions.map {|i| i.upcase}
+      @extensions.merge extensions.map {|i| i.upcase }
       self.concat self.class.load(@directory, @extensions.to_a)
     end
 
     # Returns an array of all names.
     def names
       all_names = Array.new
-      self.each do |person|
-        all_names << person.name
-      end
+      self.each {|person| all_names << person.name }
 
       all_names
     end
@@ -55,9 +53,7 @@ module Nametrainer
     # Returns a hash with the score of all persons (name => score).
     def scores
       all_scores = {}
-      self.each do |person|
-        all_scores[person.name] = person.score
-      end
+      self.each {|person| all_scores[person.name] = person.score }
 
       all_scores
     end
@@ -81,9 +77,7 @@ module Nametrainer
     # Export all scores to file (YAML).
     def export_scores
       filename = File.expand_path("#{@directory}/#{SCORE_FILE}")
-      File.open(filename, 'w') do |f|
-        f.write(scores.to_yaml)
-      end
+      File.open(filename, 'w') {|f| f.write(scores.to_yaml) }
     end
 
     # Returns a random element, preferring persons with a smaller score.
@@ -91,6 +85,17 @@ module Nametrainer
       self.shuffle.sort[weighted_random_index]  # shuffle first, so that elements with equal scores get mixed up
     end
 
+    # Returns the successor of the specified element.
+    # The successor of the last element is the first element.
+    #
+    # +element+ - element whose successor should be returned
+    def successor(element)
+      index = self.index(element)
+      return nil  if index.nil?
+
+      (index == self.size - 1) ? self[0] : self[index + 1]
+    end
+
     private
 
     # Returns a random index (obsolete).
@@ -132,7 +137,7 @@ module Nametrainer
     # from file name (remove extension, convert underscores).
     def self.get_name(file, extensions)
       name = file.dup
-      extensions.each {|ext| name.gsub!(/\.#{ext}$/, '') }  # remove file extension
+      extensions.each {|ext| name.gsub!(/\.#{ext}\Z/, '') }  # remove file extension
       begin
         info_file = "#{name}.txt"
         File.read(info_file).chomp

data/lib/nametrainer/gui.rb

@@ -28,6 +28,8 @@ module Nametrainer
       @image = Qt::Pixmap.new
       @name_label = Qt::Label.new
       @statistics_label = Qt::Label.new @statistics.to_s
+      @ordered_checkbox = Qt::CheckBox.new 'Non-random order'
+      @display_checkbox = Qt::CheckBox.new "Display name at once"
 
       init_gui
       show
@@ -93,13 +95,19 @@ module Nametrainer
       answer_buttons.add_widget @correct
       answer_buttons.add_widget @wrong
 
+      @ordered_checkbox.set_checked false
+      @display_checkbox.set_checked false
+
       right = Qt::VBoxLayout.new
       right.add_widget @show
       right.add_layout answer_buttons
       right.add_stretch 1
       right.add_widget Qt::Label.new 'Statistics:'
       right.add_widget @statistics_label
-      right.add_stretch 3
+      right.add_stretch 1
+      right.add_widget @ordered_checkbox
+      right.add_widget @display_checkbox
+      right.add_stretch 1
       right.add_widget load_collection
       right.add_widget help
       right.add_widget quit
@@ -215,13 +223,20 @@ module Nametrainer
     end
 
     # Chooses and displays the next person,
-    # erases the displayed name and enables the <tt>Display Name</tt> button.
+    # erases the displayed name, and enables the <tt>Display Name</tt> button.
+    # "Next" means a random sample or, if the <tt>Non-random order</tt> checkbox is checked,
+    # the successor of the current person in the collection array.
     def choose_person
       @name_label.set_text ''
-      @person = @collection.sample
+      if @ordered_checkbox.is_checked
+        @person = @person.nil? ? @collection[0] : @collection.successor(@person)
+      else
+        @person = @collection.sample
+      end
       @image.load @person.image or @image = Qt::Pixmap.new  # delete image when load fails
       show_image
       enable_buttons
+      display_name  if @display_checkbox.is_checked
     end
 
     # Repaints the image when the application window is resized.

data/lib/nametrainer/person.rb

@@ -12,7 +12,7 @@ module Nametrainer
   #   person1 = Person.new('Albert', nil)
   #   person2 = Person.new('Isaac', nil)
   #   person1.increase_score
-  #   puts [person1, person2].sort.map{|p| p.name}  => Isaac, Albert
+  #   puts [person1, person2].sort.map{|p| p.name }  => Isaac, Albert
   class Person
 
     attr_reader :name, :image

data/lib/nametrainer/version.rb

@@ -1,8 +1,8 @@
 module Nametrainer
 
   PROGNAME = 'nametrainer'
-  VERSION  = '0.0.1'
-  DATE     = '2012-04-06'
+  VERSION  = '0.1.0'
+  DATE     = '2012-04-13'
   HOMEPAGE = 'https://github.com/stomar/nametrainer/'
 
   COPYRIGHT = "Copyright (C) 2012 Marcus Stollsteimer.\n" +

data/nametrainer.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.summary = 'nametrainer is a name learning trainer using the Qt GUI toolkit.'
   s.description = s.summary + ' ' +
-              'It will assist you in learning people’s names from a collection of images.'
+              "It will assist you in learning people's names from a collection of images."
 
   s.authors = ['Marcus Stollsteimer']
   s.email = 'sto.mar@web.de'
@@ -31,11 +31,11 @@ Gem::Specification.new do |s|
 
   s.files = %w{
       README.md
-      screenshot.png
       Rakefile
       nametrainer.gemspec
+      screenshot.png
     } +
-    Dir.glob('{bin,demo_collection,lib,man,test}/**/*')
+    Dir.glob('{bin,demo_collection,lib,test}/**/*')
 
   #s.add_dependency('iconv')  # only for 1.8; problematic on Windows (build tools necessary)
   s.add_development_dependency('rake')

data/test/test_collection.rb

@@ -67,6 +67,15 @@ describe Nametrainer::Collection do
     @collection.sample.must_be_instance_of Nametrainer::Person
   end
 
+  it 'can return the successor of a person' do
+    p1 = @collection[0]
+    p2 = @collection[1]
+    p3 = @collection[2]
+    @collection.successor(p1).name.must_equal p2.name
+    @collection.successor(p2).name.must_equal p3.name
+    @collection.successor(p3).name.must_equal p1.name
+  end
+
   it 'can increase the score for a specified person' do
     person = @collection.last
     person.score.must_equal 0

data/test/test_person.rb

@@ -25,8 +25,8 @@ describe Nametrainer::Person do
     p1 = Nametrainer::Person.new('Albert', nil)
     p2 = Nametrainer::Person.new('Isaac', nil)
     p1.score = 1
-    [p1, p2].sort.map{|p| p.name}.must_equal ['Isaac', 'Albert']
+    [p1, p2].sort.map{|p| p.name }.must_equal ['Isaac', 'Albert']
     p2.score = 2
-    [p1, p2].sort.map{|p| p.name}.must_equal ['Albert', 'Isaac']
+    [p1, p2].sort.map{|p| p.name }.must_equal ['Albert', 'Isaac']
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nametrainer
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Marcus Stollsteimer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-06 00:00:00 Z
+date: 2012-04-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: "nametrainer is a name learning trainer using the Qt GUI toolkit. It will assist you in learning people\xE2\x80\x99s names from a collection of images."
+description: nametrainer is a name learning trainer using the Qt GUI toolkit. It will assist you in learning people's names from a collection of images.
 email: sto.mar@web.de
 executables: 
 - nametrainer
@@ -55,9 +55,9 @@ extra_rdoc_files: []
 
 files: 
 - README.md
-- screenshot.png
 - Rakefile
 - nametrainer.gemspec
+- screenshot.png
 - bin/nametrainer
 - demo_collection/Erwin_Schroedinger.png
 - demo_collection/Erwin_Schroedinger.txt