nametrainer 0.1.0 → 0.2.0

data/README.md

@@ -35,6 +35,8 @@ Additional settings:
 
 These settings facilitate quick recapitulation of already learned names
 or learning of new names.
+Starting the application with `nametrainer --learning-mode` or with
+`nametrainer -l` activates both settings.
 
 Collections
 -----------

data/bin/nametrainer

@@ -1,7 +1,5 @@
 #!/usr/bin/ruby -w
 
-require 'Qt'
-
 require 'nametrainer'
 
 SRCPATH = File.dirname(__FILE__)
@@ -34,5 +32,5 @@ end
 
 # start
 app = Qt::Application.new ARGV
-Nametrainer::GUI.new(options[:collection])
+Nametrainer::GUI.new(options)
 app.exec

data/lib/nametrainer.rb

@@ -16,7 +16,10 @@
 #
 # == Options
 #
-# -d, --demo:: Starts the application with a demo collection.
+# -d, --[no-]demo:: Start the application with a demo collection.
+#
+# -l, --[no-]learning-mode:: Start the application in `learning-mode':
+#                            use non-random order, display names at once.
 #
 # -h, --help:: Prints a brief help message and exits.
 #
@@ -35,7 +38,7 @@ require 'nametrainer/optionparser'
 require 'nametrainer/statistics'
 require 'nametrainer/version'
 
-# This module contains the classes for the +nametrainer+ tool
+# This module contains the classes for the +nametrainer+ tool.
 module Nametrainer
 
   FILE_EXTENSIONS = %w{png jpg jpeg}

data/lib/nametrainer/collection.rb

@@ -105,25 +105,33 @@ module Nametrainer
 
     # Returns a random index, preferring smaller indices.
     def weighted_random_index
-      max_index = self.size - 1
-      weighting_factor = 6  # index 0 will be about weighting_factor times more probable than max_index
-
-      # construct an array with indices by repeatedly adding different parts of a range of indices
-      indices = Array.new
-      range = Array.new(self.size) {|i| i }
-      1.upto(weighting_factor) do
-        |i| indices += range[0..(i.to_f/weighting_factor * max_index).ceil]
-      end
+      indices = indices_urn(:size => self.size, :weighting_factor => 6)
 
       indices[rand(indices.size)]
     end
 
+    # Returns an array of all indices from 0 to :size - 1, where lower indices are
+    # more frequent than higher indices. Index 0 will be about :weighting_factor
+    # times more probable then the highest index.
+    def indices_urn(options)
+      size = options[:size]
+      weighting_factor = options[:weighting_factor]
+      urn = Array.new
+      # repeatedly add partial ranges of indices to urn
+      1.upto(weighting_factor) do |i|
+        count = (i.to_f/weighting_factor * size).ceil
+        urn += (0...count).to_a
+      end
+
+      urn
+    end
+
     # class methods
 
     # Load a collection. Returns an array of Person instances.
     def self.load(directory, extensions)
       extension_list = extensions.join(',')
-      files = Dir.glob("#{directory}/*.{#{extension_list}}")
+      files = Dir.glob("#{directory}/*.{#{extension_list}}").sort
       result = Array.new
       files.each do |file|
         name = get_name(file, extensions)

data/lib/nametrainer/gui.rb

@@ -10,7 +10,7 @@ module Nametrainer
     # You can specify a collection that is loaded at startup.
     #
     # +collection_dir+ - path to collection
-    def initialize(collection_dir = nil)
+    def initialize(options)
       super()
 
       set_window_title 'Name Trainer'
@@ -31,9 +31,15 @@ module Nametrainer
       @ordered_checkbox = Qt::CheckBox.new 'Non-random order'
       @display_checkbox = Qt::CheckBox.new "Display name at once"
 
+      if options[:learning_mode]
+        @ordered_checkbox.set_checked true
+        @display_checkbox.set_checked true
+      end
+
       init_gui
       show
 
+      collection_dir = options[:collection]
       init_collection File.expand_path(collection_dir)  unless collection_dir.nil?
     end
 
@@ -95,9 +101,6 @@ 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
@@ -143,6 +146,7 @@ module Nametrainer
       @collection_label.set_text "Collection: #{File.basename(@collection_dir)}"
       @statistics.reset
       @statistics_label.set_text @statistics.to_s
+      @person = nil
       choose_person
     end
 

data/lib/nametrainer/optionparser.rb

@@ -18,8 +18,9 @@ module Nametrainer
     def self.parse!(argv)
 
       options = {
-        :collection => nil,
-        :demo       => false
+        :collection    => nil,
+        :demo          => false,
+        :learning_mode => false
       }
 
       opt_parser = OptionParser.new do |opt|
@@ -48,8 +49,14 @@ module Nametrainer
           exit
         end
 
-        opt.on('-d', '--demo', 'Starts the application with a demo collection.') do
-          options[:demo] = true
+        opt.on('-d', '--[no-]demo', 'Start the application with a demo collection.') do |d|
+          options[:demo] = d
+        end
+
+        opt.on('-l', '--[no-]learning-mode',
+               "Start the application in `learning-mode':",
+               'use non-random order, display names at once.') do |l|
+          options[:learning_mode] = l
         end
 
         opt.separator ''

data/lib/nametrainer/version.rb

@@ -1,12 +1,12 @@
 module Nametrainer
 
   PROGNAME = 'nametrainer'
-  VERSION  = '0.1.0'
-  DATE     = '2012-04-13'
+  VERSION  = '0.2.0'
+  DATE     = '2012-09-22'
   HOMEPAGE = 'https://github.com/stomar/nametrainer/'
 
   COPYRIGHT = "Copyright (C) 2012 Marcus Stollsteimer.\n" +
-              "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n" +
+              "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.\n" +
               "This is free software: you are free to change and redistribute it.\n" +
               "There is NO WARRANTY, to the extent permitted by law."
 

data/nametrainer.gemspec

@@ -1,4 +1,4 @@
-require 'lib/nametrainer/version'
+require './lib/nametrainer/version'
 
 version  = Nametrainer::VERSION
 date     = Nametrainer::DATE

data/test/test_collection.rb

@@ -55,14 +55,6 @@ describe Nametrainer::Collection do
     @collection.sort.last.name.must_equal 'Albert Einstein'
   end
 
-  it 'can return a random index' do
-    samples = 100
-    indices = Array.new(samples) { @collection.send(:weighted_random_index) }
-    indices.size.must_equal samples
-    indices.sort.first.must_be :>=, 0
-    indices.sort.last.must_be :<, @collection.size
-  end
-
   it 'can return a random person' do
     @collection.sample.must_be_instance_of Nametrainer::Person
   end
@@ -82,4 +74,22 @@ describe Nametrainer::Collection do
     person.increase_score
     @collection.last.score.must_equal 1
   end
+
+  # private methods
+  it 'can return a weighted index list' do
+    expected = [0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2,
+                3, 3, 3, 4, 4, 4, 5, 5, 5,
+                6, 6, 7, 7, 8, 8,
+                9, 10, 11]
+    indices = @collection.send(:indices_urn, :size => 12, :weighting_factor => 4)
+    indices.sort.must_equal expected
+  end
+
+  it 'returns random indices in the correct range' do
+    samples = 100
+    indices = Array.new(samples) { @collection.send(:weighted_random_index) }
+    indices.size.must_equal samples
+    indices.sort.first.must_be :>=, 0
+    indices.sort.last.must_be :<, @collection.size
+  end
 end

data/test/test_optionparser.rb

@@ -9,7 +9,8 @@ describe Nametrainer::Optionparser do
     options = Nametrainer::Optionparser.parse!(['collection'])
     expected = {
       :collection => 'collection',
-      :demo => false
+      :demo => false,
+      :learning_mode => false
     }
     options.must_equal expected
   end
@@ -20,6 +21,22 @@ describe Nametrainer::Optionparser do
     options[:demo].must_equal true
   end
 
+  it 'should recognize the --no-demo option' do
+    options = Nametrainer::Optionparser.parse!(['--no-demo'])
+    options[:demo].must_equal false
+  end
+
+  it 'should recognize the -l option' do
+    options = Nametrainer::Optionparser.parse!(['-l'])
+    options[:collection].must_be_nil
+    options[:learning_mode].must_equal true
+  end
+
+  it 'should recognize the --no-learning-mode option' do
+    options = Nametrainer::Optionparser.parse!(['--no-learning-mode'])
+    options[:learning_mode].must_equal false
+  end
+
   it 'should not accept wrong number of arguments' do
     lambda { Nametrainer::Optionparser.parse!(['collection1', 'collection2']) }.must_raise ArgumentError
     lambda { Nametrainer::Optionparser.parse!(['']) }.must_raise ArgumentError

metadata

@@ -1,59 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nametrainer
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-13 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &72380950 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *72380950
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &72379800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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's names from a collection of images.
+  prerelease: false
+  version_requirements: *72379800
+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: 
+executables:
 - nametrainer
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - Rakefile
 - nametrainer.gemspec
@@ -85,40 +72,35 @@ files:
 - test/collection/002.JPG
 - test/collection/nametrainer.dat
 homepage: https://github.com/stomar/nametrainer/
-licenses: 
+licenses:
 - GPL-3
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-requirements: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - the Qt toolkit and Qt bindings for Ruby
 rubyforge_project: nametrainer
-rubygems_version: 1.7.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: nametrainer is a name learning trainer using the Qt GUI toolkit.
-test_files: 
+test_files:
 - test/test_person.rb
 - test/test_statistics.rb
 - test/test_collection.rb
 - test/test_optionparser.rb
+has_rdoc: