daigaku 0.0.1

data/lib/daigaku/terminal/solutions.rb

@@ -0,0 +1,46 @@
+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
+          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
+end

data/lib/daigaku/terminal/texts/about.txt

@@ -0,0 +1,19 @@
+**********************************************************************
+                         ◇  ABOUT DAIGAKU! ◇
+**********************************************************************
+
+Daigaku is the Japanese word for "university".
+With Daigaku you can master your way of learning the Ruby programming
+language with courses that are created by the community.
+
+Daigaku is a command line tool and a text based interface and provides
+you with a number of learning tasks and explanations about the Ruby
+programming language. You will learn Ruby step by step by solving small
+language-explaining programming tasks.
+
+Daigaku's command line interface provides several commands which you
+can use in your terminal to setup the system, download new courses,
+and navigate through your solutions.
+
+By typing "daigaku help" in you terminal you are provided with an
+overview of all available commands.

data/lib/daigaku/terminal/texts/courses_empty.txt

@@ -0,0 +1,3 @@
+There are no courses available in your current courses path.
+
+Go and insert some to your courses path!

data/lib/daigaku/terminal/texts/hint_course_download.txt

@@ -0,0 +1,13 @@
+You can download a new daigaku course by using the
+"daigaku courses download [URL] [OPTIONS]" command, e.g.:
+
+$ daigaku courses download https://github.com/daigaku-ruby/Get_started_with_Ruby/archive/master.zip
+
+For Github resources you can also use the `--github` (short `-g`) option:
+
+$ daigaku courses download -g daigaku-ruby/Get_started_with_Ruby
+
+If you want to quick start with Daiaku's "Get started with Ruby"
+course just run:
+
+$ daigaku courses download

data/lib/daigaku/terminal/texts/welcome.txt

@@ -0,0 +1,12 @@
+**********************************************************************
+                      ◇  WELCOME TO DAIGAKU! ◇
+**********************************************************************
+
+To get started, you need a folder where you can save your courses and
+solutions. By default, daigaku uses the same base path for both.
+Your courses will be saved to a "courses" folder and your solutions
+can be found in a "solutions" folder.
+
+The "solutions" path and "courses" path can be changed later on.
+See which command you can use to update your setup by simply typing
+"daigaku setup help set" in your command line.

data/lib/daigaku/terminal/welcome.rb

@@ -0,0 +1,98 @@
+module Daigaku
+  module Terminal
+
+    class Welcome
+      include Terminal::Output
+
+      def self.run
+        self.new.run
+      end
+
+      def self.about
+        self.new.about
+      end
+
+      def run
+        empty_line
+        say Terminal.text :welcome
+        empty_line
+        say "For now, let's setup the daigaku paths."
+        Daigaku::Terminal::Setup.new.init
+
+        show_setup_list_announcement
+        show_courses_list_announcement
+
+        courses = Loading::Courses.load(Daigaku.config.courses_path)
+
+        if courses.empty?
+          show_courses_download_announcement
+          show_solutions_open_announcement
+        end
+
+        empty_line
+        show_learn_announcement
+      end
+
+      def about
+        empty_line
+        say Terminal.text :about
+        empty_line
+        say %x{daigaku help}
+      end
+
+      private
+
+      def show_setup_list_announcement
+        command = 'daigaku setup list'
+        text = [
+          "The courses path and solutions path have been added to your settings.",
+          "Just list your current settings with the \"#{command}\" command:"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+
+      def show_courses_list_announcement
+        command = 'daigaku courses list'
+        text = [
+          "Well done. Now, type \"#{command}\" to see what courses are",
+          "available in your daigaku folder:"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+
+      def show_courses_download_announcement
+        command = 'daigaku courses download'
+        text = [
+          "Oh! You don't have any courses, yet?",
+          "Just enter \"#{command}\" to download the basic Daigaku course:"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+
+      def show_solutions_open_announcement
+        command = 'daigaku solutions open'
+        text = [
+          "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")
+
+        get_command(command, text)
+      end
+
+      def show_learn_announcement
+        command = 'daigaku learn'
+        text = [
+          "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

@@ -0,0 +1,46 @@
+module Daigaku
+  require 'fileutils'
+
+  class Test
+
+    attr_reader :path
+
+    CODE_REGEX = /\[\['solution::code'\]\]/
+
+    def initialize(path)
+      @unit_path = path
+      @path = Dir[File.join(path, '*spec.rb')].first
+    end
+
+    def run(solution_code)
+      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} }
+      remove_file(temp_spec)
+
+      TestResult.new(result)
+    end
+
+    private
+
+    def insert_code(spec, code)
+      spec.gsub(CODE_REGEX, code)
+    end
+
+    def create_temp_spec(path, content)
+      base_path = File.dirname(path)
+      FileUtils.mkdir_p(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

@@ -0,0 +1,69 @@
+module Daigaku
+
+  class TestResult
+    require 'json'
+
+    attr_reader :examples, :example_count, :failure_count
+
+    TEST_PASSED_MESSAGE = "Your code passed all tests. Congratulations!"
+
+    def initialize(result_json)
+      @result = JSON.parse(result_json, symbolize_names: true)
+
+      @example_count = @result[:summary][:example_count]
+      @failure_count = @result[:summary][:failure_count]
+
+      @examples = @result[:examples].map do |example|
+        description = example[:full_description]
+        status = example[:status]
+        exception = example[:exception]
+        message = exception ? exception[:message] : nil
+
+        TestExample.new(description: description, status: status, message: message)
+      end
+    end
+
+    def passed?
+      @examples.reduce(true) do |passed, example|
+        passed && example.passed?
+      end
+    end
+
+    def summary
+      if passed?
+        TEST_PASSED_MESSAGE
+      else
+        build_failed_summary
+      end
+    end
+
+    private
+
+    def build_failed_summary
+      message = examples.map do |example|
+        "#{example.description}\n#{example.status}: #{example.message}"
+      end
+
+      summary = message.map(&:strip).join("\n" * 3)
+    end
+
+  end
+
+  class TestExample
+
+    attr_reader :description, :status, :message
+
+    EXAMPLE_PASSED_MESSAGE = "Your code passed this requirement."
+
+    def initialize(args = {})
+      @description = args[:description]
+      @status = args[:status]
+      @message = args[:message] || EXAMPLE_PASSED_MESSAGE
+    end
+
+    def passed?
+      @status == 'passed'
+    end
+  end
+
+end

data/lib/daigaku/unit.rb

@@ -0,0 +1,28 @@
+module Daigaku
+  class Unit
+
+    attr_reader :title, :task
+
+    def initialize(path)
+      @path = path
+      @title = File.basename(path).gsub(/\_+/, ' ')
+    end
+
+    def task
+      @task ||= Task.new(@path)
+    end
+
+    def reference_solution
+      @reference_solution ||= ReferenceSolution.new(@path)
+    end
+
+    def solution
+      @solution = Solution.new(@path)
+    end
+
+    def mastered?
+      solution.verified?
+    end
+
+  end
+end

data/lib/daigaku/version.rb

@@ -0,0 +1,3 @@
+module Daigaku
+  VERSION = "0.0.1"
+end

data/lib/daigaku/views.rb

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

data/lib/daigaku/views/chapters_menu.rb

@@ -0,0 +1,91 @@
+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
+
+      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.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
+
+        window.refresh
+      end
+
+      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_units_menu, @course, chapters[@position])
+              return
+            when 263 # Backspace
+              broadcast(:reenter_courses_menu, @course)
+              return
+            when 27 # ESC
+              exit
+          end
+
+          @position = menu_items.length - 1 if @position < 0
+          @position = 0 if @position >= menu_items.length
+          draw(window, @position)
+        end
+      end
+
+      def chapters
+        @course.chapters
+      end
+
+      def menu_items
+        @menu_items = chapters.map do |chapter|
+          chapter.title
+        end
+      end
+
+    end
+
+  end
+end