daigaku 0.2.0 → 1.0.0

data/lib/daigaku/terminal/solutions.rb

@@ -1,46 +1,41 @@
+require 'os'
+require_relative 'output'
+
 module Daigaku
   module Terminal
-
-    require 'os'
-    require_relative 'output'
-
     class Solutions < Thor
       include Terminal::Output
 
       desc 'solutions open [COURSE NAME]', 'Open the solutions folder of a course in a GUI window'
       def open(course_name = '')
-        begin
-          path = File.join(Daigaku.config.solutions_path, course_name)
-
-          unless Dir.exist?(path)
-            text = [
-              "The course directory \"#{File.basename(path)}\" is not available in",
-              "\"#{File.dirname(path)}\".\n",
-              'Hint:',
-              'Run "daigaku scaffold" to create empty solution files for all courses.'
-            ]
-            say_warning text.join("\n")
-
-            unless Loading::Courses.load(Daigaku.config.courses_path).empty?
-              Terminal::Courses.new.list
-            end
-
-            return
+        path = File.join(Daigaku.config.solutions_path, course_name)
+
+        unless Dir.exist?(path)
+          text = [
+            "The course directory \"#{File.basename(path)}\" is not available in",
+            "\"#{File.dirname(path)}\".\n",
+            'Hint:',
+            'Run "daigaku scaffold" to create empty solution files for all courses.'
+          ]
+          say_warning text.join("\n")
+
+          unless Loading::Courses.load(Daigaku.config.courses_path).empty?
+            Terminal::Courses.new.list
           end
 
-          if OS.windows?
-            system "explorer '#{path}'"
-          elsif OS.mac?
-            system "open '#{path}'"
-          elsif OS.linux?
-            system "xdg-open '#{path}'"
-          end
-        rescue ConfigurationError => e
-          say_warning e.message
+          return
         end
-      end
 
+        if OS.windows?
+          system "explorer '#{path}'"
+        elsif OS.mac?
+          system "open '#{path}'"
+        elsif OS.linux?
+          system "xdg-open '#{path}'"
+        end
+      rescue ConfigurationError => e
+        say_warning e.message
+      end
     end
-
   end
 end

data/lib/daigaku/terminal/welcome.rb

@@ -1,22 +1,21 @@
 module Daigaku
   module Terminal
-
     class Welcome
       include Terminal::Output
 
       def self.run
-        self.new.run
+        new.run
       end
 
       def self.about
-        self.new.about
+        new.about
       end
 
       def run
         empty_line
         say Terminal.text :welcome
         empty_line
-        say "For now, let's setup the daigaku paths."
+        say 'For now, let’s setup the daigaku paths.'
         Daigaku::Terminal::Setup.new.init
 
         show_setup_list_announcement
@@ -37,7 +36,7 @@ module Daigaku
         empty_line
         say Terminal.text :about
         empty_line
-        say %x{daigaku help}
+        say `daigaku help`
       end
 
       private
@@ -45,7 +44,7 @@ module Daigaku
       def show_setup_list_announcement
         command = 'daigaku setup list'
         text = [
-          "The courses path and solutions path have been added to your settings.",
+          'The courses path and solutions path have been added to your settings.',
           "Just list your current settings with the \"#{command}\" command:"
         ].join("\n")
 
@@ -56,7 +55,7 @@ module Daigaku
         command = 'daigaku courses list'
         text = [
           "Well done. Now, type \"#{command}\" to see what courses are",
-          "available in your daigaku folder:"
+          'available in your daigaku folder:'
         ].join("\n")
 
         get_command(command, text)
@@ -65,7 +64,7 @@ module Daigaku
       def show_courses_download_announcement
         command = 'daigaku courses download'
         text = [
-          "Oh! You don't have any courses, yet?",
+          'Oh! You don’t have any courses, yet?',
           "Just enter \"#{command}\" to download the basic Daigaku course:"
         ].join("\n")
 
@@ -75,7 +74,7 @@ module Daigaku
       def show_solutions_open_announcement
         command = 'daigaku solutions open'
         text = [
-          "When downloading a course, Daigaku scaffolds empty solution files",
+          'When downloading a course, Daigaku scaffolds empty solution files',
           "for your code on the fly.\n",
           "Type \"#{command}\" to open your solutions folder:"
         ].join("\n")
@@ -86,13 +85,12 @@ module Daigaku
       def show_learn_announcement
         command = 'daigaku learn'
         text = [
-          "Congratulations! You learned the first steps of using daigaku.",
+          'Congratulations! You learned the first steps of using daigaku.',
           "To continue and start learning Ruby type \"#{command}\":"
         ].join("\n")
 
         get_command(command, text)
       end
     end
-
   end
 end

data/lib/daigaku/test.rb

@@ -1,25 +1,24 @@
-module Daigaku
-  require 'fileutils'
+require 'fileutils'
 
+module Daigaku
   class Test
+    CODE_REGEX = /\[\['solution::code'\]\]/
 
     attr_reader :path
 
-    CODE_REGEX = /\[\['solution::code'\]\]/
-
     def initialize(path)
       @unit_path = path
-      @path = Dir[File.join(path, '*spec.rb')].first
+      @path      = Dir[File.join(path, '*spec.rb')].first
     end
 
     def run(solution_code)
-      spec_code = File.read(@path)
+      spec_code         = File.read(@path)
       patched_spec_code = insert_code(spec_code, solution_code.to_s)
 
       temp_spec = File.join(File.dirname(@path), "temp_#{File.basename(@path)}")
       create_temp_spec(temp_spec, patched_spec_code)
 
-      result = %x{ rspec --color --format j #{temp_spec} }
+      result = `rspec --no-color --order defined --format j #{temp_spec}`
       remove_file(temp_spec)
 
       TestResult.new(result)
@@ -33,14 +32,12 @@ module Daigaku
 
     def create_temp_spec(path, content)
       base_path = File.dirname(path)
-      FileUtils.mkdir_p(base_path) unless Dir.exist?(base_path)
+      FileUtils.makedirs(base_path) unless Dir.exist?(base_path)
       File.open(path, 'w') { |f| f.puts content }
     end
 
     def remove_file(path)
       FileUtils.rm(path) if File.exist?(path)
     end
-
   end
-
 end

data/lib/daigaku/test_result.rb

@@ -1,25 +1,33 @@
-module Daigaku
+require 'json'
 
+module Daigaku
   class TestResult
-    require 'json'
+    CODE_ERROR_MESSAGE = ':( You got an error in your code!'.freeze
 
     attr_reader :examples, :example_count, :failure_count
 
     def initialize(result_json)
       @result = begin
         JSON.parse(result_json, symbolize_names: true)
-      rescue
-        syntax_error_json
+      rescue => error
+        syntax_error_json(error)
       end
 
-      @example_count = @result[:summary][:example_count]
-      @failure_count = @result[:summary][:failure_count]
+      @example_count = @result.dig(:summary, :example_count)
+      @failure_count = @result.dig(:summary, :failure_count)
+      error_count = @result.dig(:summary, :errors_outside_of_examples_count) || 0
+
+      if error_count > 0
+        @failure_count = error_count
+        details = error_details(@result)
+        @result = error_json(details)
+      end
 
       @examples = @result[:examples].map do |example|
         description = example[:full_description]
-        status = example[:status]
-        exception = example[:exception]
-        message = exception ? exception[:message] : nil
+        status      = example[:status]
+        exception   = example[:exception]
+        message     = exception ? exception[:message] : nil
 
         TestExample.new(description: description, status: status, message: message)
       end
@@ -47,40 +55,65 @@ module Daigaku
 
     def build_failed_summary
       message = examples.map do |example|
-        "#{example.description}\n#{example.status}: #{example.message}"
+        "#{example.description}\n#{example.status}: #{example.message}".strip
       end
 
-      summary = message.map(&:strip).join("\n" * 3)
+      message.join("\n" * 3)
     end
 
-    def syntax_error_json
+    def syntax_error_json(error)
+      details = failure_details(error)
+      error_json(details)
+    end
+
+    def error_details(result)
+      result[:messages]
+        .first
+        .split('\n')
+        .each_with_index
+        .select { |line, index| index > 0 && line.matches?(/temp_.+\.rb/) }
+        .first.to_s
+    end
+
+    def error_json(details)
       {
         summary: {},
         examples: [
           {
-            status: 'failed',
-            exception: { message: ":( You got a syntax error in your code!" }
+            status: TestExample::FAILED,
+            exception: { message: "#{CODE_ERROR_MESSAGE}\n\n#{details}" }
           }
         ]
       }
     end
+
+    def failure_details(error)
+      line = error.backtrace.first
+      error_message = remove_colorization(error.message)
+      "#{error.class} in #{line}:\n#{error_message}"
+    end
+
+    def remove_colorization(text)
+      text.gsub(/\x1b\[[0-9]*m/i, '')
+    end
   end
 
   class TestExample
+    PASSED = 'passed'.freeze
+    FAILED = 'failed'.freeze
 
     attr_reader :description, :status, :message
 
-    EXAMPLE_PASSED_MESSAGE = "Your code passed this requirement."
+    EXAMPLE_PASSED_MESSAGE = 'Your code passed this requirement.'.freeze
 
-    def initialize(args = {})
-      @description = args[:description]
-      @status = args[:status]
-      @message = args[:message] || EXAMPLE_PASSED_MESSAGE
+    def initialize(status:, description: nil, message: nil)
+      @description = description
+      @status      = status
+      @message     = message || EXAMPLE_PASSED_MESSAGE
     end
 
     def passed?
-      @status == 'passed'
+      @status == PASSED
     end
   end
-
 end

data/lib/daigaku/unit.rb

@@ -1,10 +1,9 @@
 module Daigaku
   class Unit
-
     attr_reader :title, :task
 
     def initialize(path)
-      @path = path
+      @path  = path
       @title = File.basename(path).gsub(/\_+/, ' ')
     end
 
@@ -17,12 +16,11 @@ module Daigaku
     end
 
     def solution
-      @solution = Solution.new(@path)
+      @solution ||= Solution.new(@path)
     end
 
     def mastered?
       solution.verified?
     end
-
   end
 end

data/lib/daigaku/version.rb

@@ -1,3 +1,3 @@
 module Daigaku
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'.freeze
 end

data/lib/daigaku/views.rb

@@ -1,51 +1,47 @@
 require 'curses'
-require 'active_support/concern'
 require 'daigaku/views/top_bar'
 
 module Daigaku
   module Views
-    extend ActiveSupport::Concern
+    include Curses
 
-    included do
-      include Curses
-
-      def reset_menu_position
-        @position = 0
-      end
-
-      private
+    def reset_menu_position
+      @position = 0
+    end
 
-      def default_window(height = nil, width = nil, top = 0, left = 0)
-        init_screen
+    private
 
-        noecho
-        crmode
-        curs_set(0) # invisible cursor
+    def default_window(height = nil, width = nil, top = 0, left = 0)
+      init_screen
 
-        height ||= lines
-        width ||= cols + 1
+      noecho
+      crmode
+      curs_set(0) # invisible cursor
 
-        window = Daigaku::Window.new(height, width, top, left)
+      height ||= lines
+      width  ||= cols + 1
 
-        Curses.lines.times do |line|
-          window.setpos(line, 0)
-          window.clear_line
-        end
+      window = Daigaku::Window.new(height, width, top, left)
 
-        window.keypad(true)
-        window.scrollok(true)
-        window.refresh
-        window
+      Curses.lines.times do |line|
+        window.setpos(line, 0)
+        window.clear_line
       end
 
-      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
-      end
+      window.keypad(true)
+      window.scrollok(true)
+      window.refresh
+      window
     end
 
+    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
+    end
   end
 end

data/lib/daigaku/views/chapters_menu.rb

@@ -2,9 +2,7 @@ require 'daigaku/views/menu'
 
 module Daigaku
   module Views
-
     class ChaptersMenu < Menu
-
       private
 
       def before_enter(*args)
@@ -12,8 +10,8 @@ module Daigaku
       end
 
       def before_reenter(*args)
-        @course = args[0]
-        @chapter = args[1]
+        @course   = args[0]
+        @chapter  = args[1]
         @position = @course.chapters.find_index(@chapter)
       end
 
@@ -24,20 +22,20 @@ module Daigaku
       def interact_with(window)
         while char = window.getch
           case char
-            when KEY_UP
-              @position -= 1
-              broadcast(:reset_menu_position)
-            when KEY_DOWN
-              @position += 1
-              broadcast(:reset_menu_position)
-            when 10 # Enter
-              broadcast(:enter, @course, models[@position])
-              return
-            when 263 # Backspace
-              broadcast(:reenter, @course)
-              return
-            when 27 # ESC
-              exit
+          when KEY_UP
+            @position -= 1
+            broadcast(:reset_menu_position)
+          when KEY_DOWN
+            @position += 1
+            broadcast(:reset_menu_position)
+          when 10 # Enter
+            broadcast(:enter, @course, models[@position])
+            return
+          when 263 # Backspace
+            broadcast(:reenter, @course)
+            return
+          when 27 # ESC
+            exit
           end
 
           @position = items.length - 1 if @position < 0
@@ -53,8 +51,6 @@ module Daigaku
       def items
         models.map(&:title)
       end
-
     end
-
   end
 end