belajar 0.1.1

data/lib/belajar/terminal/setup.rb

@@ -0,0 +1,115 @@
+require 'thor'
+
+module Belajar
+  module Terminal
+
+    require_relative 'output'
+
+    class Setup < Thor
+      include Terminal::Output
+
+      desc 'init', 'Initially setup belajar paths'
+      def init
+        empty_line
+        say 'Please type the base path in which you want to save your belajar'
+        say 'files. The "courses" folder and "solutions" folder will be created'
+        say 'automatically.'
+
+        loop do
+          path = get 'path:'
+
+          begin
+            @belajar_path = File.expand_path("#{path}", Dir.pwd)
+          rescue
+            say_warning "#{path} is no valid path name. Try another!"
+            next
+          end
+
+          say_warning 'Do you want to use the following path as your belajar base path?'
+          say "\"#{@belajar_path}\""
+
+          confirmation = get '(yes|no)'
+          break if confirmation.downcase == 'yes'
+
+          empty_line
+          say 'No Problem. Just type another one!'
+        end
+
+        prepare_directories(@belajar_path)
+      end
+
+      desc 'list', 'List the current belajar setup'
+      def list
+        say_info "Your current belajar setup is:\n\n#{Belajar.config.summary}"
+      end
+
+      desc 'set [OPTIONS]', 'Update the settings of your belajar environment'
+      method_option :courses_path,
+                    type: :string,
+                    aliases: '-c',
+                    desc: 'Set courses_path directory'
+      method_option :solutions_path,
+                    type: :string,
+                    aliases: '-s',
+                    desc: 'Set solutions_path directory'
+      method_option :paths,
+                    type: :string,
+                    aliases: '-p',
+                    desc: 'Set all belajar paths to a certain path'
+      def set
+        courses_path = options[:paths] || options[:courses_path]
+        solutions_path = options[:paths] || options[:solutions_path]
+
+        if courses_path.nil? && solutions_path.nil?
+          say_warning "Please specify options when using this command!"
+          say %x{ belajar setup help set }
+          return
+        end
+
+        update_config(:courses_path, courses_path) if courses_path
+        update_config(:solutions_path, solutions_path) if solutions_path
+
+        Belajar.config.save
+        list
+      end
+
+      private
+
+      def prepare_directories(path)
+        courses_dir = Belajar::Configuration::COURSES_DIR
+        courses_path = File.join(path, courses_dir)
+        Belajar.config.courses_path = courses_path
+
+        solutions_dir = Belajar::Configuration::SOLUTIONS_DIR
+        solutions_path = File.join(path, solutions_dir)
+
+        if Dir.exist? solutions_path
+          Belajar.config.solutions_path = solutions_path
+        end
+
+        generator = Belajar::Generator.new
+        generator.prepare
+
+        text = [
+          "Your Belajar directory is now set up.\n",
+          "Belajar created/updated following two paths for you:",
+          courses_path,
+          solutions_path
+        ]
+
+        say_info text.join("\n")
+      end
+
+      def update_config(attribute, value)
+        begin
+          path = File.expand_path(value, Dir.pwd)
+          Belajar.config.send("#{attribute}=", path)
+        rescue Exception => e
+          say_warning e.message
+        end
+      end
+
+    end
+
+  end
+end

data/lib/belajar/terminal/solutions.rb

@@ -0,0 +1,46 @@
+module Belajar
+  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(Belajar.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 "belajar scaffold" to create empty solution files for all courses.'
+            ]
+            say_warning text.join("\n")
+
+            unless Loading::Courses.load(Belajar.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/belajar/terminal/texts/about.txt

@@ -0,0 +1,19 @@
+**********************************************************************
+                         ◇  ABOUT BELAJAR! ◇
+**********************************************************************
+
+Belajar is the Japanese word for "university".
+With Belajar you can master your way of learning the Ruby programming
+language with courses that are created by the community.
+
+Belajar 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.
+
+Belajar'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 "belajar help" in you terminal you are provided with an
+overview of all available commands.

data/lib/belajar/terminal/texts/congratulations.txt

@@ -0,0 +1,12 @@
+Well done!
+Three cheers!
+You did it!
+Congrats!
+Bravo!
+Hip, hip, hurrah!
+Congratulations!
+Kudos!
+Props!
+Hats off!
+Yay!
+Well done! Ready for the next task?

data/lib/belajar/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/belajar/terminal/texts/hint_course_download.txt

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

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

@@ -0,0 +1,12 @@
+**********************************************************************
+                      ◇  WELCOME TO BELAJAR! ◇
+**********************************************************************
+
+To get started, you need a folder where you can save your courses and
+solutions. By default, belajar 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
+"belajar setup help set" in your command line.

data/lib/belajar/terminal/welcome.rb

@@ -0,0 +1,98 @@
+module Belajar
+  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 belajar paths."
+        Belajar::Terminal::Setup.new.init
+
+        show_setup_list_announcement
+        show_courses_list_announcement
+
+        courses = Loading::Courses.load(Belajar.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{belajar help}
+      end
+
+      private
+
+      def show_setup_list_announcement
+        command = 'belajar 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 = 'belajar courses list'
+        text = [
+          "Well done. Now, type \"#{command}\" to see what courses are",
+          "available in your belajar folder:"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+
+      def show_courses_download_announcement
+        command = 'belajar courses download'
+        text = [
+          "Oh! You don't have any courses, yet?",
+          "Just enter \"#{command}\" to download the basic Belajar course:"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+
+      def show_solutions_open_announcement
+        command = 'belajar solutions open'
+        text = [
+          "When downloading a course, Belajar 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 = 'belajar learn'
+        text = [
+          "Congratulations! You learned the first steps of using belajar.",
+          "To continue and start learning Ruby type \"#{command}\":"
+        ].join("\n")
+
+        get_command(command, text)
+      end
+    end
+
+  end
+end

data/lib/belajar/test.rb

@@ -0,0 +1,46 @@
+module Belajar
+  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/belajar/test_result.rb

@@ -0,0 +1,86 @@
+module Belajar
+
+  class TestResult
+    require 'json'
+
+    attr_reader :examples, :example_count, :failure_count
+
+    def initialize(result_json)
+      @result = begin
+        JSON.parse(result_json, symbolize_names: true)
+      rescue
+        syntax_error_json
+      end
+
+      @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?
+        "Your code passed all tests. #{Belajar::Congratulator.message}"
+      else
+        build_failed_summary
+      end
+    end
+
+    def summary_lines
+      summary.lines.map(&:strip)
+    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
+
+    def syntax_error_json
+      {
+        summary: {},
+        examples: [
+          {
+            status: 'failed',
+            exception: { message: ":( You got a syntax error in your code!" }
+          }
+        ]
+      }
+    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