daigaku 0.2.0 → 1.0.0

data/lib/daigaku/congratulator.rb

@@ -1,13 +1,25 @@
 module Daigaku
-
   class Congratulator
-
     def self.message
-      lines = Terminal.text(:congratulations).lines.map(&:strip).compact
-      count = lines.count.zero? ? 0 : (lines.count - 1)
-      random_value = rand(0..count)
+      new.message
+    end
+
+    def message
       lines[random_value]
     end
 
+    private
+
+    def lines
+      @lines ||= Terminal.text(:congratulations).lines.map(&:strip).compact
+    end
+
+    def random_value
+      rand(0..lines_count)
+    end
+
+    def lines_count
+      [lines.count - 1, 0].max
+    end
   end
 end

data/lib/daigaku/course.rb

@@ -2,12 +2,11 @@ require 'fileutils'
 
 module Daigaku
   class Course
-
     attr_reader :title, :path, :author, :link
 
     def initialize(path)
-      @path = path
-      @title = File.basename(path).gsub(/\_+/, ' ')
+      @path   = path
+      @title  = File.basename(path).gsub(/\_+/, ' ')
       @author = QuickStore.store.get(key(:author))
     end
 
@@ -16,11 +15,11 @@ module Daigaku
     end
 
     def started?
-      chapters.reduce(false) { |started, chapter| started ||= chapter.started? }
+      chapters.any?(&:started?)
     end
 
     def mastered?
-      chapters.reduce(true) { |mastered, chapter| mastered &&= chapter.mastered? }
+      chapters.all?(&:mastered?)
     end
 
     def key(key_name)
@@ -44,7 +43,6 @@ module Daigaku
 
         Zip::File.open(file_path) do |zip_file|
           zip_file.each do |entry|
-
             if options[:github_repo]
               first, *others = entry.to_s.split('/')
               directory = File.join(first.split('-')[0..-2].join('-'), others)
@@ -66,10 +64,13 @@ module Daigaku
         end
 
         FileUtils.rm(file_path)
-      rescue Exception => e
+      rescue StandardError => e
         puts e
         old_dir = "#{course_dir}_old/"
-        FileUtils.copy_entry(old_dir, "#{course_dir}/", true) if Dir.exist?(old_dir)
+
+        if Dir.exist?(old_dir)
+          FileUtils.copy_entry(old_dir, "#{course_dir}/", true)
+        end
       ensure
         old_dir = "#{course_dir}_old/"
         FileUtils.rm_r(old_dir) if Dir.exist?(old_dir)

data/lib/daigaku/exceptions.rb

@@ -1,5 +1,4 @@
 module Daigaku
-
   class Error < StandardError; end
   class CourseNotFoundError < Error; end
   class ChaptersNotFoundError < Error; end
@@ -15,5 +14,4 @@ module Daigaku
     class NoUrlError < Error; end
     class NoZipFileUrlError < Error; end
   end
-
 end

data/lib/daigaku/generator.rb

@@ -1,21 +1,21 @@
-module Daigaku
-  require 'fileutils'
-  require 'active_support'
-  require 'active_support/core_ext'
+require 'fileutils'
 
+module Daigaku
   class Generator
+    LEADING_NUMBERS = /^\d+[\_\-\s]/
+    PART_JOINTS     = /[\_\-\s]+/
 
     def scaffold(courses_path, target_path)
-      Dir[File.join(courses_path, "*/*/*/*.md")].each do |file|
+      Dir[File.join(courses_path, '*/*/*/*.md')].each do |file|
         content_dir_parts = file.split('/')[-4..-2].map do |part|
           clean_up_path_part(part)
         end
 
         content_dir = File.join(content_dir_parts)
-        directory = File.join(target_path, File.dirname(content_dir))
+        directory   = File.join(target_path, File.dirname(content_dir))
 
         solution_file = File.basename(content_dir) + Solution::FILE_SUFFIX
-        file_path = File.join(directory, solution_file)
+        file_path     = File.join(directory, solution_file)
 
         create_dir(directory)
         create_file(file_path)
@@ -25,9 +25,9 @@ module Daigaku
     def prepare
       begin
         solutions_path = Daigaku.config.solutions_path
-      rescue ConfigurationError => e
-        base_dir = File.dirname(Daigaku.config.courses_path)
-        solutions_dir = Daigaku::Configuration::SOLUTIONS_DIR
+      rescue ConfigurationError
+        base_dir       = File.dirname(Daigaku.config.courses_path)
+        solutions_dir  = Daigaku::Configuration::SOLUTIONS_DIR
         solutions_path = File.join(base_dir, solutions_dir)
       end
 
@@ -41,20 +41,18 @@ module Daigaku
     private
 
     def create_dir(path)
-      return if path.blank?
+      return if path.nil? || path.empty?
       FileUtils.makedirs(path) unless Dir.exist?(path)
     end
 
     def create_file(path)
-      return if path.blank?
+      return if path.nil? || path.empty?
       create_dir(File.dirname(path))
       FileUtils.touch(path) unless File.exist?(path)
     end
 
     def clean_up_path_part(text)
-      leading_numbers = /^\d+[\_\-\s]/
-      part_joints = /[\_\-\s]+/
-      text.gsub(leading_numbers, '').gsub(part_joints, '_').downcase
+      text.gsub(LEADING_NUMBERS, '').gsub(PART_JOINTS, '_').downcase
     end
   end
 end

data/lib/daigaku/github_client.rb

@@ -4,7 +4,6 @@ require 'date'
 
 module Daigaku
   module GithubClient
-
     # Returns the url to the master zip file of the Github repo.
     def self.master_zip_url(user_and_repo)
       "https://github.com/#{user_and_repo}/archive/master.zip"
@@ -13,7 +12,7 @@ module Daigaku
     # Returns the timestamp of updated_at for the repo from the Github API.
     def self.updated_at(user_and_repo)
       url = "https://api.github.com/repos/#{user_and_repo}"
-      JSON.parse(open(url).read)['updated_at']
+      JSON.parse(URI.open(url).read)['updated_at']
     end
 
     # Returns whether the pushed_at time from Github API is newer than the
@@ -21,9 +20,10 @@ module Daigaku
     def self.updated?(user_and_repo)
       return false unless user_and_repo
 
-      course = Course.new(user_and_repo.split('/').last)
-      stored_time = QuickStore.store.get(course.key(:updated_at))
-      current_time = self.updated_at(user_and_repo)
+      course       = Course.new(user_and_repo.split('/').last)
+      stored_time  = QuickStore.store.get(course.key(:updated_at))
+      current_time = updated_at(user_and_repo)
+
       DateTime.parse(stored_time) < DateTime.parse(current_time)
     end
   end

data/lib/daigaku/loadable.rb

@@ -1,23 +1,32 @@
 module Daigaku
   module Loadable
-
-    require 'active_support/inflector'
-
     def load(path)
-      if Dir.exist?(path)
-        dirs = Dir.entries(path).select do |entry|
-          !entry.match(/\./)
-        end
+      return [] unless Dir.exist?(path)
 
-        dirs.sort.map do |dir|
-          dir_path = File.join(path, dir)
-          class_name = self.to_s.demodulize.singularize
-          "Daigaku::#{class_name}".constantize.new(dir_path)
-        end
-      else
-        Array.new
+      dirs = Dir.entries(path).select do |entry|
+        !entry.match(/\./)
       end
+
+      dirs.sort.map do |dir|
+        dir_path   = File.join(path, dir)
+        module_name = demodulize(to_s)
+        class_name = singularize(module_name)
+        daigaku_class(class_name).new(dir_path)
+      end
+    end
+
+    private
+
+    def demodulize(string)
+      string.split('::').last
     end
 
+    def singularize(string)
+      string.end_with?('s') ? string[0..-2] : string
+    end
+
+    def daigaku_class(name)
+      Kernel.const_get("Daigaku::#{name}")
+    end
   end
 end

data/lib/daigaku/loading/chapters.rb

@@ -1,9 +1,7 @@
 module Daigaku
   module Loading
-
     class Chapters
       extend Daigaku::Loadable
     end
-
   end
 end

data/lib/daigaku/loading/courses.rb

@@ -1,9 +1,7 @@
 module Daigaku
   module Loading
-
     class Courses
       extend Daigaku::Loadable
     end
-
   end
 end

data/lib/daigaku/loading/units.rb

@@ -1,9 +1,7 @@
 module Daigaku
   module Loading
-
     class Units
       extend Daigaku::Loadable
     end
-
   end
 end

data/lib/daigaku/markdown.rb

@@ -1 +1,2 @@
 require 'daigaku/markdown/ruby_doc'
+require 'daigaku/markdown/printer'

data/lib/daigaku/markdown/printer.rb

@@ -0,0 +1,89 @@
+require 'curses'
+require_relative 'ruby_doc'
+
+module Daigaku
+  module Markdown
+    class Printer
+      H1   = /\A\#{1}[^#]+/ # '# heading'
+      H2   = /\A\#{2}[^#]+/ # '## sub heading'
+      BOLD = /\*[^*]*\*/    # '*text*'
+      LINE = /\A-{3,}/      # '---' vertical line
+      CODE = /`[^`]*`/      # '`code line`'
+
+      attr_reader :window
+
+      def initialize(window:)
+        @window = window
+      end
+
+      def print(text)
+        text_line = RubyDoc.parse(text)
+
+        case text_line
+        when H1                  then print_h1(text_line)
+        when H2                  then print_h2(text_line)
+        when /(#{CODE}|#{BOLD})/ then print_code_or_bold(text_line)
+        when BOLD                then print_bold(text_line)
+        when LINE                then print_line
+        else print_escaped(text_line)
+        end
+      end
+
+      def print_h1(text)
+        window.heading(text.sub(/\A#\s?/, ''))
+      end
+
+      def print_h2(text)
+        text_decoration = Curses::A_UNDERLINE | Curses::A_NORMAL
+        window.emphasize(text.sub(/\A##\s?/, ''), text_decoration)
+      end
+
+      def print_code_or_bold(text)
+        emphasized  = false
+        highlighted = false
+
+        text.chars.each_with_index do |char, index|
+          if char == '*' && text[index - 1] != '\\'
+            emphasized = !emphasized
+            next
+          end
+
+          if char == '`'
+            highlighted = !highlighted
+            next
+          end
+
+          character = text[index..(index + 1)] == '\\*' ? '' : char
+
+          if highlighted
+            window.red(character)
+          elsif emphasized
+            window.emphasize(character)
+          else
+            window.write(character)
+          end
+        end
+      end
+
+      def print_bold(text)
+        text.chars.each_with_index do |char, index|
+          if char == '*' && text[index - 1] != '\\'
+            emphasized = !emphasized
+            next
+          end
+
+          character = text[index..(index + 1)].to_s == '\\*' ? '' : char
+          emphasized ? window.emphasize(character) : window.write(character)
+        end
+      end
+
+      def print_line
+        window.write('-' * (Curses.cols - 2))
+      end
+
+      def print_escaped(text)
+        window.write(text.gsub(/(\\#)/, '#'))
+      end
+    end
+  end
+end

data/lib/daigaku/markdown/ruby_doc.rb

@@ -1,15 +1,14 @@
 require 'cgi'
 
 module Daigaku
-  class Markdown
+  module Markdown
     class RubyDoc
-
-      RUBY_DOC_URL    = "http://ruby-doc.org".freeze
+      RUBY_DOC_URL    = 'http://ruby-doc.org'.freeze
       CORE_BASE_URL   = "#{RUBY_DOC_URL}/core-#{RUBY_VERSION}".freeze
       STDLIB_BASE_URL = "#{RUBY_DOC_URL}/stdlib-#{RUBY_VERSION}".freeze
 
-      CORE_REGEX      = /\(ruby-doc core:\s?(.*)\)/.freeze
-      STDLIB_REGEX    = /\(ruby-doc stdlib:\s?(.*)\)/.freeze
+      CORE_REGEX      = /\(ruby-doc core:\s?(.*)\)/
+      STDLIB_REGEX    = /\(ruby-doc stdlib:\s?(.*)\)/
 
       class << self
         def parse(text)
@@ -43,19 +42,19 @@ module Daigaku
       end
 
       def doc_regex(type, capture)
-        /\(ruby-doc #{type}: #{capture}\)/
+        Regexp.new(Regexp.escape("(ruby-doc #{type}: #{capture})"))
       end
 
       def core_link(text)
         constants = ruby_constants(text).join('/')
-        method = ruby_method(text)
+        method    = ruby_method(text)
 
         "#{CORE_BASE_URL}/#{constants}.html#{method}"
       end
 
       def stdlib_link(text)
-        constants = ruby_constants(text).join('/')
-        method = ruby_method(text)
+        constants   = ruby_constants(text).join('/')
+        method      = ruby_method(text)
         libdoc_part = "libdoc/#{ruby_stdlib(text)}/rdoc"
 
         "#{STDLIB_BASE_URL}/#{libdoc_part}/#{constants}.html#{method}"
@@ -68,7 +67,7 @@ module Daigaku
       # Else the lib is created from the constants, e.g.
       #   (ruby-doc stdlib: Time) => 'time'
       def ruby_stdlib(text)
-        parts = text.split(' ')
+        parts = text.split
 
         if parts.length > 1
           parts.first.strip.downcase
@@ -78,7 +77,7 @@ module Daigaku
       end
 
       def ruby_constants(text)
-        parts = text.split(' ').last.split(/::|#/)
+        parts = text.split.last.split(/::|#/)
         select_capitalized(parts)
       end
 
@@ -86,19 +85,20 @@ module Daigaku
         method = text.split(/::|#/).last
         return '' unless downcased?(method)
 
-        method_type = text.match(/#/) ? 'i' : 'c'
-        method_name = CGI.escape(method.strip).gsub('%', '-').gsub(/\A-/, '')
+        method_type = text =~ /#/ ? 'i' : 'c'
+        method_name = CGI.escape(method.strip).tr('%', '-').gsub(/\A-/, '')
         "#method-#{method_type}-#{method_name}"
       end
 
       def select_capitalized(parts)
-        parts.select { |part| part[0] == part[0].upcase }
+        parts.select do |part|
+          part[0].match(/\w/) && part[0] == part[0].upcase
+        end
       end
 
       def downcased?(text)
         text == text.downcase
       end
-
     end
   end
 end