daigaku 0.0.2 → 0.1.0

data/lib/daigaku/views/chapters_menu.rb

@@ -1,53 +1,24 @@
+require 'daigaku/views/menu'
+
 module Daigaku
   module Views
-    require 'wisper'
-
-    class ChaptersMenu
-      include Views
-      include Wisper::Publisher
-
-      def initialize
-        @position = 0
-      end
-
-      def enter_chapters_menu(course)
-        @window = default_window
-        @course = course
-
-        main_panel(@window) do |window|
-          show sub_window_below_top_bar(window)
-        end
-      end
-
-      def reenter_chapters_menu(course, chapter)
-        @course = course
-        @chapter = chapter
 
-        @position = course.chapters.find_index(chapter)
-        enter_chapters_menu(@course)
-      end
+    class ChaptersMenu < Menu
 
       private
 
-      def show(window)
-        draw(window, @position)
-        interact_with(window)
+      def before_enter(*args)
+        @course = args[0]
       end
 
-      def draw(window, active_index = 0)
-        window.attrset(A_NORMAL)
-        window.setpos(0, 1)
-        window.emphasize @course.title
-        window.write ' - available chapters:'
-
-        menu_items.each_with_index do |item, index|
-          window.setpos(index + 2, 1)
-          window.print_indicator(chapters[index])
-          window.attrset(index == active_index ? A_STANDOUT : A_NORMAL)
-          window.write " #{item.to_s} "
-        end
+      def before_reenter(*args)
+        @course = args[0]
+        @chapter = args[1]
+        @position = @course.chapters.find_index(@chapter)
+      end
 
-        window.refresh
+      def header_text
+        "*#{@course.title}* - available chapters:"
       end
 
       def interact_with(window)
@@ -60,29 +31,27 @@ module Daigaku
               @position += 1
               broadcast(:reset_menu_position)
             when 10 # Enter
-              broadcast(:enter_units_menu, @course, chapters[@position])
+              broadcast(:enter, @course, models[@position])
               return
             when 263 # Backspace
-              broadcast(:reenter_courses_menu, @course)
+              broadcast(:reenter, @course)
               return
             when 27 # ESC
               exit
           end
 
-          @position = menu_items.length - 1 if @position < 0
-          @position = 0 if @position >= menu_items.length
+          @position = items.length - 1 if @position < 0
+          @position = 0 if @position >= items.length
           draw(window, @position)
         end
       end
 
-      def chapters
+      def models
         @course.chapters
       end
 
-      def menu_items
-        @menu_items = chapters.map do |chapter|
-          chapter.title
-        end
+      def items
+        models.map(&:title)
       end
 
     end

data/lib/daigaku/views/courses_menu.rb

@@ -1,48 +1,14 @@
+require 'daigaku/views/menu'
+
 module Daigaku
   module Views
-    require 'wisper'
-
-    class CoursesMenu
-      include Views
-      include Wisper::Publisher
-
-      def initialize
-        @position = 0
-      end
-
-      def enter
-        @window = default_window
-
-        main_panel(@window) do |window|
-          show sub_window_below_top_bar(window)
-        end
-      end
 
-      def reenter_courses_menu(course)
-        @current_course = course
-        enter
-      end
+    class CoursesMenu < Menu
 
       private
 
-      def show(window)
-        draw(window, @position)
-        interact_with(window)
-      end
-
-      def draw(window, active_index = 0)
-        window.attrset(A_NORMAL)
-        window.setpos(0, 1)
-        window.write 'Available daigaku courses:'
-
-        course_entries.each_with_index do |item, index|
-          window.setpos(index + 2, 1)
-          window.print_indicator(courses[index])
-          window.attrset(index == active_index ? A_STANDOUT : A_NORMAL)
-          window.write " #{item.to_s} "
-        end
-
-        window.refresh
+      def header_text
+        'Available daigaku courses:'
       end
 
       def interact_with(window)
@@ -55,29 +21,28 @@ module Daigaku
               @position += 1
               broadcast(:reset_menu_position)
             when 10 # Enter
-              broadcast(:enter_chapters_menu, courses[@position])
+              broadcast(:enter, models[@position])
               return
             when 27 # ESC
               exit
           end
 
-          entries = course_entries
-          @position = entries.length - 1 if @position < 0
-          @position = 0 if @position >= entries.length
+          @position = items.length - 1 if @position < 0
+          @position = 0 if @position >= items.length
           draw(window, @position)
         end
       end
 
-      def courses
-        @courses = Loading::Courses.load(Daigaku.config.courses_path)
+      def models
+        Loading::Courses.load(Daigaku.config.courses_path)
       end
 
-      def course_entries
-        non_empty_courses = courses.select { |course| !course.chapters.empty? }
+      def items
+        non_empty_courses = models.select { |course| !course.chapters.empty? }
 
-        @course_entries = non_empty_courses.map do |course|
+        non_empty_courses.map do |course|
           line = "#{course.title}"
-          line << "(#{course.author})" if course.author
+          self.items_info <<= [(course.author ? "(by #{course.author})" : '')]
           line
         end
       end

data/lib/daigaku/views/main_menu.rb

@@ -15,14 +15,14 @@ module Daigaku
         # second has to have method that is broadcasted.
 
         # top down navigation
-        courses_menu.subscribe(chapters_menu, on: :enter_chapters_menu)
-        chapters_menu.subscribe(units_menu, on: :enter_units_menu)
-        units_menu.subscribe(task_view, on: :enter_task_view)
+        courses_menu.subscribe(chapters_menu, on: :enter)
+        chapters_menu.subscribe(units_menu, on: :enter)
+        units_menu.subscribe(task_view, on: :enter)
 
         # bottom up navigation
-        chapters_menu.subscribe(courses_menu, on: :reenter_courses_menu)
-        units_menu.subscribe(chapters_menu, on: :reenter_chapters_menu)
-        task_view.subscribe(units_menu, on: :reenter_units_menu)
+        chapters_menu.subscribe(courses_menu, on: :reenter)
+        units_menu.subscribe(chapters_menu, on: :reenter)
+        task_view.subscribe(units_menu, on: :reenter)
 
         # position reset
         courses_menu.subscribe(chapters_menu, on: :reset_menu_position)

data/lib/daigaku/views/menu.rb

@@ -0,0 +1,89 @@
+require 'wisper'
+
+module Daigaku
+  module Views
+
+    class Menu
+      include Views
+      include Wisper::Publisher
+
+      TOP_BAR_TEXT = [
+        'Use *UP KEY* and *DOWN KEY* for menu navigation',
+        'Enter menu with *RETURN*',
+        'Go back with *BACKSPACE*',
+        'Exit with *ESC*'
+      ].join('  |  ')
+
+      def initialize
+        @position = 0
+      end
+
+      def enter(*args)
+        if self.class.private_method_defined?(:before_enter)
+          before_enter(*args)
+        end
+
+        @window = default_window
+        top_bar = TopBar.new(@window, TOP_BAR_TEXT)
+        show sub_window_below_top_bar(@window, top_bar)
+      end
+
+      def reenter(*args)
+        if self.class.private_method_defined?(:before_reenter)
+          before_reenter(*args)
+        end
+
+        enter(*args)
+      end
+
+      protected
+
+      def show(window)
+        draw(window, @position)
+        interact_with(window)
+      end
+
+      def draw(window, active_index = 0)
+        window.attrset(A_NORMAL)
+        window.setpos(0, 1)
+        window.print_markdown header_text
+
+        items.each_with_index do |item, index|
+          window.setpos(index + 2, 1)
+          window.print_indicator(models[index])
+          window.attrset(index == active_index ? A_STANDOUT : A_NORMAL)
+          window.write " #{item.to_s} "
+          window.attrset(A_NORMAL)
+          window.write " #{items_info[index].try(:join, ' ')}"
+        end
+
+        window.refresh
+      end
+
+      def interact_with(window)
+        raise "Please implement the method #interact_with!"
+      end
+
+      def models
+        raise "Please implement the method #models!"
+      end
+
+      def items
+        raise "Please implement the method #items!"
+      end
+
+      def header_text
+        raise "Please implement the method #header_text!"
+      end
+
+      def items_info
+        @items_info || []
+      end
+
+      def items_info=(items_info)
+        @items_info = items_info
+      end
+    end
+
+  end
+end

data/lib/daigaku/views/task_view.rb

@@ -7,12 +7,20 @@ module Daigaku
       include Views
       include Wisper::Publisher
 
+      TOP_BAR_TEXT = [
+          'Scroll with *UP KEY* and *DOWN KEY*',
+          'Verify solution with *v*',
+          'Open solution file with *o*',
+          'Clear validation with *c*',
+          'Exit with *ESC*'
+          ].join('  |  ')
+
       def initialize
         @lines = []
         @top = nil
       end
 
-      def enter_task_view(course, chapter, unit)
+      def enter(course, chapter, unit)
         @course = course
         @chapter = chapter
         @unit = unit
@@ -30,12 +38,9 @@ module Daigaku
       def set_head(window)
         window.setpos(0, 1)
         window.clear_line
-        window.emphasize @course.title
-        window.write ' > '
-        window.emphasize @chapter.title
-        window.write ' > '
-        window.emphasize @unit.title
-        window.write ':'
+
+        text = "*#{@course.title}* > *#{@chapter.title}* > *#{@unit.title}*:"
+        window.print_markdown(text)
 
         window.setpos(1, 1)
         window.clear_line
@@ -120,7 +125,7 @@ module Daigaku
           scrollable = true
 
           case char
-            when 'v' # Verifiy
+            when 'v' # verify
               print_test_results(window)
               return
             when 'c' # clear
@@ -157,7 +162,7 @@ module Daigaku
               while scroll_down(window)
               end
             when Curses::KEY_BACKSPACE
-              broadcast(:reenter_units_menu, @course, @chapter, @unit)
+              broadcast(:reenter, @course, @chapter, @unit)
               return
             when 27 # ESC
               exit
@@ -181,8 +186,19 @@ module Daigaku
 
       def print_test_results(window)
         result = @unit.solution.verify!
+        @test_result_lines = result.summary_lines
+
+        if result.passed?
+          code_lines = @unit.reference_solution.code_lines
+
+          unless code_lines.empty?
+            code_lines.map! { |line| "  #{line}" }
+            code_lines.unshift('', "Reference code:", '')
+          end
+
+          @test_result_lines += code_lines
+        end
 
-        @test_result_lines = result.summary.strip.split("\n")
         @lines = [''] + @test_result_lines + ['', ''] + @unit.task.markdown.lines
         @examples = result.examples
 
@@ -206,7 +222,9 @@ module Daigaku
 
       def initialize_window(height)
         @window = default_window(height)
-        main_panel(@window) { |window| show sub_window_below_top_bar(window) }
+
+        top_bar = TopBar.new(@window, TOP_BAR_TEXT)
+        show sub_window_below_top_bar(@window, top_bar)
       end
 
       def example_index(heights, index)

data/lib/daigaku/views/top_bar.rb

@@ -4,12 +4,14 @@ module Daigaku
     class TopBar
       include Curses
 
+      HEIGHT = 4
+
       attr_reader :height, :width, :panel
 
-      def initialize(window)
-        @height = 4
+      def initialize(window, text = '')
+        @height = HEIGHT
         @width = window.maxx
-        @panel = create_panel(window, @width, @height)
+        @panel = create_panel(window, @width, @height, text)
       end
 
       def show
@@ -18,23 +20,13 @@ module Daigaku
 
       private
 
-      def create_panel(window, width, heigth)
-        panel = window.subwin(heigth, window.maxx, 0, 0)
+      def create_panel(window, width, height, text)
+        panel = window.subwin(height, window.maxx, 0, 0)
 
         panel.setpos(1, 1)
-        panel.write     'Use '
-        panel.emphasize 'UP KEY'
-        panel.write     ' and '
-        panel.emphasize 'DOWN KEY'
-        panel.write     ' for menu navigation'
-        panel.write     '  |  Enter menu with '
-        panel.emphasize 'RETURN'
-        panel.write     '  |  Go back with '
-        panel.emphasize 'BACKSPACE'
-        panel.write     '  |  Exit with '
-        panel.emphasize 'ESC'
+        panel.print_markdown(text)
         panel.setpos(2, 1)
-        panel.write     '_' * (window.maxx - 3)
+        panel.clear_line(text: '_')
 
         panel
       end

data/lib/daigaku/views/units_menu.rb

@@ -1,56 +1,27 @@
+require 'daigaku/views/menu'
+
 module Daigaku
   module Views
-    require 'wisper'
-
-    class UnitsMenu
-      include Views
-      include Wisper::Publisher
-
-      def initialize
-        @position = 0
-      end
 
-      def enter_units_menu(course, chapter)
-        @window = default_window
-        @course = course
-        @chapter = chapter
-
-        main_panel(@window) do |window|
-          show sub_window_below_top_bar(window)
-        end
-      end
-
-      def reenter_units_menu(course, chapter, unit)
-        @course = course
-        @chapter = chapter
-
-        @position = chapter.units.find_index(unit)
-        enter_units_menu(@course, @chapter)
-      end
+    class UnitsMenu < Menu
 
       private
 
-      def show(window)
-        draw(window, @position)
-        interact_with(window)
+      def before_enter(*args)
+        @course = args[0]
+        @chapter = args[1]
       end
 
-      def draw(window, active_index = 0)
-        window.attrset(A_NORMAL)
-        window.setpos(0, 1)
-        window.emphasize @course.title
-        window.write ' > '
-        window.emphasize @chapter.title
-        window.write ' >  - available units:'
+      def before_reenter(*args)
+        @course = args[0]
+        @chapter = args[1]
+        @unit = args[2]
 
-        menu_items.each_with_index do |item, index|
-          window.setpos(index + 2, 1)
-          window.print_indicator(units[index])
-          window.attrset(index == active_index ? A_STANDOUT : A_NORMAL)
-          window.write " #{item.to_s} "
-        end
+        @position = @chapter.units.find_index(@unit)
+      end
 
-        window.refresh
+      def header_text
+        "*#{@course.title}* > *#{@chapter.title}* - available units:"
       end
 
       def interact_with(window)
@@ -61,29 +32,27 @@ module Daigaku
             when KEY_DOWN
               @position += 1
             when 10 # Enter
-              broadcast(:enter_task_view, @course, @chapter, units[@position])
+              broadcast(:enter, @course, @chapter, models[@position])
               return
             when 263 # Backspace
-              broadcast(:reenter_chapters_menu, @course, @chapter)
+              broadcast(:reenter, @course, @chapter)
               return
             when 27 # ESC
               exit
           end
 
-          @position = menu_items.length - 1 if @position < 0
-          @position = 0 if @position >= menu_items.length
+          @position = items.length - 1 if @position < 0
+          @position = 0 if @position >= items.length
           draw(window, @position)
         end
       end
 
-      def units
+      def models
         @chapter.units
       end
 
-      def menu_items
-        @menu_items = units.map do |unit|
-          unit.title
-        end
+      def items
+        models.map(&:title)
       end
 
     end

data/lib/daigaku/views.rb

@@ -1,6 +1,6 @@
 require 'curses'
 require 'active_support/concern'
-require_relative 'views/top_bar'
+require 'daigaku/views/top_bar'
 
 module Daigaku
   module Views
@@ -38,17 +38,9 @@ module Daigaku
         window
       end
 
-      def top_bar(window)
-        TopBar.new(window)
-      end
-
-      def main_panel(window)
-        top_bar(window).show
-        yield(window) if block_given?
-      end
-
-      def sub_window_below_top_bar(window)
-        top = top_bar(window).height
+      def sub_window_below_top_bar(window, top_bar)
+        top_bar.show
+        top = top_bar.height
         sub_window = window.subwin(window.maxy - top, window.maxx, top, 0)
         sub_window.keypad(true)
         sub_window

data/lib/daigaku/window.rb

@@ -1,4 +1,5 @@
 require 'curses'
+require 'cgi'
 
 module Daigaku
   class Window < Curses::Window
@@ -72,7 +73,7 @@ module Daigaku
 
       x = curx
       setpos(cury, start)
-      write(' ' * (stop - 1), color, text_decoration)
+      write((options[:text] || ' ') * (stop - 1), color, text_decoration)
       setpos(cury, x)
       refresh
     end
@@ -106,8 +107,10 @@ module Daigaku
       h1 = /^\#{1}[^#]+/    # '# heading'
       h2 = /^\#{2}[^#]+/    # '## sub heading'
       bold = /(\*[^*]*\*)/  # '*text*'
-      line = /^-{3,}/        # '---' vertical line
-      code = /(\`*\`)/    # '`code line`'
+      line = /^-{3,}/       # '---' vertical line
+      code = /(\`*\`)/      # '`code line`'
+      ruby_doc_core = /(\(ruby-doc core:.*\))/ # '(ruby-doc core: Kernel#print)'
+      ruby_doc_stdlib = /(\(ruby-doc stdlib:.*\))/ # '(ruby-doc stdlib: CSV#Row::<<)'
 
       case text
         when h1
@@ -149,6 +152,12 @@ module Daigaku
           end
         when line
           write('-' * (Curses.cols - 2))
+        when ruby_doc_core
+          capture = text.match(/\(ruby-doc core:\s?(.*)\)/).captures.first
+          write text.gsub(ruby_doc_core, ruby_doc_core_link(capture))
+        when ruby_doc_stdlib
+          capture = text.match(/\(ruby-doc stdlib:\s?(.*)\)/).captures.first
+          write text.gsub(ruby_doc_stdlib, ruby_doc_stdlib_link(capture))
         else
           write(text)
       end
@@ -165,5 +174,39 @@ module Daigaku
       Curses.init_pair(COLOR_GREEN, GREEN, BACKGROUND)
       Curses.init_pair(COLOR_YELLOW, YELLOW, BACKGROUND)
     end
+
+    private
+
+    def ruby_doc_core_link(text)
+      base_url = "http://ruby-doc.org/core-#{RUBY_VERSION}"
+      class_part = ruby_doc_class_parts(text).join('/')
+      method = ruby_doc_method(text)
+
+      "#{base_url}/#{class_part}.html#{method}"
+    end
+
+    def ruby_doc_stdlib_link(text)
+      base_url = "http://ruby-doc.org/stdlib-#{RUBY_VERSION}"
+      class_parts = ruby_doc_class_parts(text)
+      libdoc_part = "libdoc/#{class_parts.first.downcase}/rdoc"
+      method = ruby_doc_method(text)
+
+      "#{base_url}/#{libdoc_part}/#{class_parts.join('/')}.html#{method}"
+    end
+
+    def ruby_doc_class_parts(text)
+      parts = text.split(/::|#/)
+      parts[0..(parts.count > 1 ? -2 : -1)]
+    end
+
+    def ruby_doc_method(text)
+      parts = text.split(/::|#/)
+
+      if parts.count > 1
+        method_type = text.match(/#/) ? 'i' : 'c'
+        method_name = CGI.escape(parts.last.strip).gsub('%', '-').gsub(/\A-/, '')
+        "#method-#{method_type}-#{method_name}"
+      end
+    end
   end
 end

data/lib/daigaku.rb

@@ -1,3 +1,4 @@
+require 'quick_store'
 require 'daigaku/window'
 
 Dir[File.join("#{File.dirname(__FILE__)}/**/*.rb")].sort.each do |file|
@@ -19,9 +20,5 @@ module Daigaku
       Views::Splash.new
       Views::MainMenu.new
     end
-
-    def database
-      Database.instance
-    end
   end
 end